Skip to main content

YugabyteDB dialect for SQLAlchemy

Project description

YugabyteDB dialect for SQLAlchemy

Prerequisites

For psycopg2 support you must install either:

(The binary package is a practical choice for development and testing but in production it is advised to use the package built from sources.)

Install and usage

Use pip to install the latest version. Clone the repository and run the following command:

pip install .

Use a Yugabytedb connection string when creating the Engine. For example, to connect to a local YugabyteDB cluster using psycopg2:

from sqlalchemy import create_engine
engine = create_engine('yugabytedb://yugabyte@localhost:5433/yugabyte')

or

from sqlalchemy import create_engine
engine = create_engine('yugabytedb+psycopg2://yugabyte@localhost:5433/yugabyte')

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

sqlalchemy-yugabytedb-1.0.0.1.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

sqlalchemy_yugabytedb-1.0.0.1-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

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