Database
class¶
edgy.Database
¶
Database(url=None, *, force_rollback=None, config=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:
|
**options |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
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 |
|
__copy__
¶
__copy__()
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
199 200 |
|
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
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
|
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
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
|
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
256 257 |
|
connect
async
¶
connect()
Establish the connection pool.
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
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 |
|
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
295 296 |
|
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
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 |
|
fetch_all
async
¶
fetch_all(query, values=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
356 357 358 359 360 361 362 363 |
|
fetch_one
async
¶
fetch_one(query, values=None, pos=0)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
pos |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
365 366 367 368 369 370 371 372 373 374 |
|
fetch_val
async
¶
fetch_val(query, values=None, column=0, pos=0)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
column |
TYPE:
|
pos |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
376 377 378 379 380 381 382 383 384 385 |
|
execute
async
¶
execute(query, values=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
387 388 389 390 391 392 393 394 |
|
execute_many
async
¶
execute_many(query, values=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
396 397 398 399 400 401 |
|
iterate
async
¶
iterate(query, values=None, chunk_size=None)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
chunk_size |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
403 404 405 406 407 408 409 410 411 412 |
|
batched_iterate
async
¶
batched_iterate(query, values=None, batch_size=None, batch_wrapper=tuple)
PARAMETER | DESCRIPTION |
---|---|
query |
TYPE:
|
values |
TYPE:
|
batch_size |
TYPE:
|
batch_wrapper |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
414 415 416 417 418 419 420 421 422 423 424 |
|
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
426 427 428 |
|
run_sync
async
¶
run_sync(fn, *args, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
fn |
TYPE:
|
*args |
TYPE:
|
**kwargs |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
430 431 432 433 434 435 436 437 438 |
|
create_all
async
¶
create_all(meta, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
meta |
TYPE:
|
**kwargs |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
440 441 442 443 |
|
drop_all
async
¶
drop_all(meta, **kwargs)
PARAMETER | DESCRIPTION |
---|---|
meta |
TYPE:
|
**kwargs |
TYPE:
|
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
445 446 447 448 |
|
connection
¶
connection()
Source code in .venv/lib/python3.11/site-packages/databasez/core/database.py
450 451 452 453 454 455 456 457 458 |
|
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
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 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
|
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
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
|