Skip to main content

YDB Dialect for SQLAlchemy


License Functional tests Style checks

This repository contains YQL dialect for SqlAlchemy 2.0.

Note: Dialect also works with SqlAlchemy 1.4, but it is not fully tested.

Installation

To work with current ydb-sqlalchemy version clone this repo and run from source root:

$ pip install -U .

Getting started

Connect to local YDB using SqlAlchemy:

import sqlalchemy as sa


engine = sa.create_engine("yql+ydb://localhost:2136/local")

with engine.connect() as conn:
  rs = conn.execute(sa.text("SELECT 1 AS value"))
  print(rs.fetchone())

Development

Run Tests:

Run the command from the root directory of the repository to start YDB in a local docker container.

$ docker-compose up

To run all tests execute the command from the root directory of the repository:

$ tox -e test-all

Run specific test:

$ tox -e test -- test/test_core.py

Check code style:

$ tox -e style

Reformat code:

$ tox -e isort
$ tox -e black-format

Run example (needs running local YDB):

$ python -m pip install virtualenv
$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ python examples/example.py

Metadata

Release files for ydb-sqlalchemy 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ydb-sqlalchemy 0.1.2
File Size Uploaded
ydb_sqlalchemy-0.1.2.tar.gz 30.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ydb-sqlalchemy 0.1.2
File Interpreter ABI Platform
ydb_sqlalchemy-0.1.2-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 66.2 kB

Release files / ydb_sqlalchemy-0.1.2.tar.gz

Download URL ydb_sqlalchemy-0.1.2.tar.gz
Size 30.9 kB
Tags Source
SHA-256 checksum
How to use checksums
276879fbf2a3d0e44a611e66c7223ed25aae402ed187ccb02ec8fdd87b575115
BLAKE2b-256 checksum
How to use checksums
57da4f28ad56105a6681841683202ebb3cc424d553afcf560043c841401f975e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.7

Release files / ydb_sqlalchemy-0.1.2-py2.py3-none-any.whl

Download URL ydb_sqlalchemy-0.1.2-py2.py3-none-any.whl
Size 35.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
207523faf08692b20acabc7515891837949bc5576260c019d379dd321fc1d4f9
BLAKE2b-256 checksum
How to use checksums
46678370800d5e4f9bcf69d7c0e903370584e29f110bee3f3538e951d3f4ac4b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.7

Release history Release notifications | RSS feed

0.1.24

2 release files

0.1.20

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

This release

0.1.2 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page