Database
class¶
edgy.Database
¶
Database(url=None, *, force_rollback=None, config=None, full_isolation=None, poll_interval=None, **options)
An abstraction on the top of the EncodeORM databases.Database object.
This object allows to pass also a configuration dictionary in the format of
DATABASEZ_CONFIG = { "connection": { "credentials": { "scheme": 'sqlite', "postgres"... "host": ..., "port": ..., "user": ..., "password": ..., "database": ..., "options": { "driver": ... "ssl": ... } } } }
PARAMETER | DESCRIPTION |
---|---|
url |
TYPE:
|
force_rollback |
TYPE:
|
config |
TYPE:
|
full_isolation |
TYPE:
|
poll_interval |
TYPE:
|
**options |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
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 |
|
__copy__
¶
__copy__()
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
267 268 |
|
inc_refcount
async
¶
inc_refcount()
Internal method to bump the ref_count.
Return True if ref_count is 0, False otherwise.
Should not be used outside of tests. Use connect and hooks instead. Not multithreading safe!
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
|
decr_refcount
async
¶
decr_refcount()
Internal method to decrease the ref_count.
Return True if ref_count drops to 0, False otherwise.
Should not be used outside of tests. Use disconnect and hooks instead. Not multithreading safe!
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
connect_hook
async
¶
connect_hook()
Refcount protected connect hook. Executed begore engine and global connection setup.
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
324 325 |
|
connect
async
¶
connect()
Establish the connection pool.
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
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 |
|
disconnect_hook
async
¶
disconnect_hook()
Refcount protected disconnect hook. Executed after connection, engine cleanup.
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
373 374 |
|
disconnect
async
¶
disconnect(force=False, *, parent_database=None)
Close all connections in the connection pool.
PARAMETER | DESCRIPTION |
---|---|
force |
TYPE:
|
parent_database |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
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 |
|
fetch_all
async
¶
fetch_all(query, values=None, timeout=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
439 440 441 442 443 444 445 446 |
|
fetch_one
async
¶
fetch_one(query, values=None, pos=0, timeout=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
pos |
TYPE:
|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
448 449 450 451 452 453 454 455 456 |
|
fetch_val
async
¶
fetch_val(query, values=None, column=0, pos=0, timeout=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
column |
TYPE:
|
pos |
TYPE:
|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
|
execute
async
¶
execute(query, values=None, timeout=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
475 476 477 478 479 480 481 482 |
|
execute_many
async
¶
execute_many(query, values=None, timeout=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
484 485 486 487 488 489 490 491 |
|
iterate
async
¶
iterate(query, values=None, chunk_size=None, timeout=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
chunk_size |
TYPE:
|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
493 494 495 496 497 498 499 500 501 502 |
|
batched_iterate
async
¶
batched_iterate(query, values=None, batch_size=None, batch_wrapper=tuple, timeout=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
batch_size |
TYPE:
|
batch_wrapper |
TYPE:
|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
|
transaction
¶
transaction(*, force_rollback=False, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
force_rollback |
TYPE:
|
**kwargs |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
525 526 |
|
run_sync
async
¶
run_sync(fn, *args, timeout=None, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
fn |
TYPE:
|
*args |
TYPE:
|
timeout |
TYPE:
|
**kwargs |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
528 529 530 531 532 533 534 535 536 |
|
create_all
async
¶
create_all(meta, timeout=None, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
meta |
TYPE:
|
timeout |
TYPE:
|
**kwargs |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
538 539 540 541 542 |
|
drop_all
async
¶
drop_all(meta, timeout=None, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
meta |
TYPE:
|
timeout |
TYPE:
|
**kwargs |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
544 545 546 547 548 |
|
_non_global_connection
¶
_non_global_connection(timeout=None)
PARAMETER | DESCRIPTION |
---|---|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
550 551 552 553 554 555 556 557 558 559 560 |
|
connection
¶
connection(timeout=None)
PARAMETER | DESCRIPTION |
---|---|
timeout |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
562 563 564 565 566 567 |
|
get_backends
classmethod
¶
get_backends(scheme='', *, overwrite_paths=['databasez.overwrites'], database_name='Database', connection_name='Connection', transaction_name='Transaction', database_class=None, connection_class=None, transaction_class=None)
PARAMETER | DESCRIPTION |
---|---|
scheme |
TYPE:
|
overwrite_paths |
TYPE:
|
database_name |
TYPE:
|
connection_name |
TYPE:
|
transaction_name |
TYPE:
|
database_class |
TYPE:
|
connection_class |
TYPE:
|
transaction_class |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 |
|
apply_database_url_and_options
classmethod
¶
apply_database_url_and_options(url, *, overwrite_paths=['databasez.overwrites'], **options)
PARAMETER | DESCRIPTION |
---|---|
url |
TYPE:
|
overwrite_paths |
TYPE:
|
**options |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 |
|