semvec/pypi-packages huggingface dataset:
sqlalchemy-cockroachdb 1.4.6
CockroachDB dialect for SQLAlchemy
License: http://www.apache.org/licenses/LICENSE-2.0
Keywords: SQLAlchemy CockroachDB

# CockroachDB dialect for SQLAlchemy

## Prerequisites

For psycopg2 support you must install either:

* [psycopg2](https://pypi.org/project/psycopg2/), which has some
  [prerequisites](https://www.psycopg.org/docs/install.html#prerequisites) of
  its own.

* [psycopg2-binary](https://pypi.org/project/psycopg2-binary/)

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

Or, for asyncpg support (⚠️ experimental 🏗) you must install

* [asyncpg](https://pypi.org/project/asyncpg/)
 
## Install and usage

Use `pip` to install the latest version.

`pip install sqlalchemy-cockroachdb`

Use a `cockroachdb` connection string when creating the `Engine`. For example,
to connect to an insecure, local CockroachDB cluster using psycopg2:

```
from sqlalchemy import create_engine
engine = create_engine('cockroachdb://root@localhost:26257/defaultdb?sslmode=disable')
```

or

```
from sqlalchemy import create_engine
engine = create_engine('cockroachdb+psycopg2://root@localhost:26257/defaultdb?sslmode=disable')
```

To connect using asyncpg (⚠️ experimental 🏗):

```
from sqlalchemy import create_async_engine
engine = create_async_engine('cockroachdb+asyncpg://root@localhost:26257/defaultdb')
```

## Changelog

See [CHANGES.md](https://github.com/cockroachdb/sqlalchemy-cockroachdb/blob/master/CHANGES.md)