Skip to main content

Wrapper for connection to database

Project description

ConnectKit Database [en|ru]


ConnectKit Database is a wrapper under SQLAlchemy with some utils.

Include pydantic settings, custom json serializer, template code.

Installation


Three types of connectors are supported:

-[x] PostgreSQL (sync/async) -[x] MySQL (MariaDB) (sync/async) -[x] Sqlite3 (sync/async)

By default, the DB connector package is not installed, extensions are specified for installation.

To install sync versions:

pip install ConnectKit-Database[postgresql]  # Установка коннектора PostgreSQL
pip install ConnectKit-Database[mysql]       # Установка коннектора MySQL/MariaDB
pip install ConnectKit-Database[all]         # Установка всех sync коннекторов

To install async versions:

pip install ConnectKit-Database[asyncpg]        # Установка коннектора PostgreSQL
pip install ConnectKit-Database[aiomysql]       # Установка коннектора MySQL/MariaDB
pip install ConnectKit-Database[aiosqlite]      # Установка коннектора Sqlite3
pip install ConnectKit-Database[asyncall]       # Установка всех async коннекторов

Usage


Environment variables are used for connection by default. Variables are extracted from the environment:

DB_ADDR=  # Address for default connection to postgres or mysql(mariadb) (default: None)
DB_PORT=5432  # Port for default connection to postgres or mysql(mariadb)
DB_ADAPTER=postgresql  # Select default connection dialect (from postgresql, mysql and sqlite)
DB_USERNAME=postgres  # Username for default connection postgres or mysql(mariadb)
DB_PASSWORD=  # Username for default connection postgres or mysql(mariadb) (default: None)
DB_NAME=postgres  # Database for postgres or mysql(mariadb), filepath for sqlite
DB_POOL_TIMEOUT=1  # Global pool timeout for creating new session to DB
DB_ECHO: bool = False  # Log all sql statements (for debug purposes)

These variables can be overridden:

from database.settings import settings

settings.DB_ECHO = False

!! Attention !! After creating a default connection, changing the settings variables for it is ignored.

To open a connection, the Database and AsyncDatabase context managers are used:

from database import Database, AsyncDatabase, AsyncSession

with Database() as db:
    db.execute(...)

async with AsyncDatabase() as db:
    await db.execute(...)


# For FastAPI:

async def db_dependency() -> AsyncSession:
    async with AsyncDatabase() as db:
        yield await db.execute(...)

The default Base can be used to create models:

from database import Base
from sqlalchemy.orm import Mapped


class Model(Base):
    id: Mapped[int]

To initialize ORM models via Base for default connection:

from database import init_default_base, async_init_default_base
from database import Base

init_default_base(Base.metadata)

await async_init_default_base(Base.metadata)

License


ConnectKit Database is MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

connectkit_database-1.3.4.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

connectkit_database-1.3.4-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file connectkit_database-1.3.4.tar.gz.

File metadata

  • Download URL: connectkit_database-1.3.4.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.19.2 CPython/3.10.11 Windows/10

File hashes

Hashes for connectkit_database-1.3.4.tar.gz
Algorithm Hash digest
SHA256 5280867f348d02b458f114952037d1b264a7272c6ee20e12190783ff5b32ab65
MD5 14288d051d3869d6581975b10e1c513e
BLAKE2b-256 40c53017f6fdca303932857f8c026c67b8331aef556f736517d6c50fc2dd0c74

See more details on using hashes here.

File details

Details for the file connectkit_database-1.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for connectkit_database-1.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ee4b232c2c48da98b49608a057256e1534d6730f6d76d390eaad04cd85b5f9fa
MD5 0ee83f87329931a424dc15d3dab003e8
BLAKE2b-256 082ae0ec807f9358175463dec3256bfdabeb0e4ca2929879641ae48892832740

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page