schemas.py
Schema
¶
A schema object is a decorator for UserTable classes that binds them to their database.
It also specifies the namespace context
in which other UserTable classes are defined.
Source code in datajoint/schemas.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
|
__call__(cls, *, context=None)
¶
Binds the supplied class to a schema. This is intended to be used as a decorator.
:param cls: class to decorate. :param context: supplied when called from spawn_missing_classes
Source code in datajoint/schemas.py
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
__init__(schema_name=None, context=None, *, connection=None, create_schema=True, create_tables=True, add_objects=None)
¶
Associate database schema schema_name
. If the schema does not exist, attempt to
create it on the server.
If the schema_name is omitted, then schema.activate(..) must be called later to associate with the database.
:param schema_name: the database schema to associate. :param context: dictionary for looking up foreign key references, leave None to use local context. :param connection: Connection object. Defaults to datajoint.conn(). :param create_schema: When False, do not create the schema and raise an error if missing. :param create_tables: When False, do not create tables and raise errors when accessing missing tables. :param add_objects: a mapping with additional objects to make available to the context in which table classes are declared.
Source code in datajoint/schemas.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
|
activate(schema_name=None, *, connection=None, create_schema=None, create_tables=None, add_objects=None)
¶
Associate database schema schema_name
. If the schema does not exist, attempt to
create it on the server.
:param schema_name: the database schema to associate. schema_name=None is used to assert that the schema has already been activated. :param connection: Connection object. Defaults to datajoint.conn(). :param create_schema: If False, do not create the schema and raise an error if missing. :param create_tables: If False, do not create tables and raise errors when attempting to access missing tables. :param add_objects: a mapping with additional objects to make available to the context in which table classes are declared.
Source code in datajoint/schemas.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
|
drop(force=False)
¶
Drop the associated schema if it exists
Source code in datajoint/schemas.py
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
|
exists()
property
¶
:return: true if the associated schema exists on the server
Source code in datajoint/schemas.py
379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
|
jobs()
property
¶
schema.jobs provides a view of the job reservation table for the schema
:return: jobs table
Source code in datajoint/schemas.py
394 395 396 397 398 399 400 401 402 403 404 |
|
list_tables()
¶
Return a list of all tables in the schema except tables with ~ in first character such as ~logs and ~job
:return: A list of table names from the database schema.
Source code in datajoint/schemas.py
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
|
save(python_filename=None)
¶
Generate the code for a module that recreates the schema. This method is in preparation for a future release and is not officially supported.
:return: a string containing the body of a complete Python module defining this schema.
Source code in datajoint/schemas.py
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
|
size_on_disk()
property
¶
:return: size of the entire schema in bytes
Source code in datajoint/schemas.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
|
spawn_missing_classes(context=None)
¶
Creates the appropriate python user relation classes from tables in the schema and places them in the context.
:param context: alternative context to place the missing classes into, e.g. locals()
Source code in datajoint/schemas.py
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
|
VirtualModule
¶
Bases: types.ModuleType
A virtual module imitates a Python module representing a DataJoint schema from table definitions in the database. It declares the schema objects and a class for each table.
Source code in datajoint/schemas.py
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 |
|
__init__(module_name, schema_name, *, create_schema=False, create_tables=False, connection=None, add_objects=None)
¶
Creates a python module with the given name from the name of a schema on the server and automatically adds classes to it corresponding to the tables in the schema.
:param module_name: displayed module name :param schema_name: name of the database in mysql :param create_schema: if True, create the schema on the database server :param create_tables: if True, module.schema can be used as the decorator for declaring new :param connection: a dj.Connection object to pass into the schema :param add_objects: additional objects to add to the module :return: the python module containing classes from the schema object and the table classes
Source code in datajoint/schemas.py
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 |
|
list_schemas(connection=None)
¶
:param connection: a dj.Connection object :return: list of all accessible schemas on the server
Source code in datajoint/schemas.py
536 537 538 539 540 541 542 543 544 545 546 547 548 549 |
|
ordered_dir(class_)
¶
List (most) attributes of the class including inherited ones, similar to dir
build-in function,
but respects order of attribute declaration as much as possible.
:param class_: class to list members for :return: a list of attributes declared in class_ and its superclasses
Source code in datajoint/schemas.py
22 23 24 25 26 27 28 29 30 31 32 33 |
|