Skip to content

libsql/sqlalchemy-libsql

Repository files navigation

sqlalchemy-libsql

A libSQL dialect for SQLAlchemy.

Pre-requisites

You must have a running instance of sqld, which is the libSQL server mode. There are several supported options:

Co-requisites

This dialect requires the python packages SQLAlchemy (version 2.0 or later) and libsql_client. They are specified as requirements so pip will install them if they are not already in place. To install, just:

pip install sqlalchemy-libsql

Getting Started

You must construct a special URL that SQLAlchemy can use to locate your database. This will be different than the usual HTTP or websocket URLs that you normally use with the libSQL client SDKs.

If you are running an instance of sqld on your own machine, normally listening at 127.0.0.1 port 8080, the SQLAlchemy URL looks like this:

sqlite+libsql://127.0.0.1:8080

If your sqld instance is configured to use SSL with some hostname, and requires authentication with a database token (including Turso databases), you must provide two additional configurations in the query string of the URL:

sqlite+libsql://your-database-hostname/?authToken=your-auth-token&secure=true

your-database-hostname and your-auth-token above are unique to your database. secure=true specifies the use of SSL.

You can then pass this URL to SQLAlchemy:

from sqlalchemy import create_engine
engine = create_engine(url)

Development

This project uses poetry, can be tested with pytest and should be checked with pre-commit. A pure-python test server is used as a submodule:

git clone https://github.com/libsql/sqlalchemy-libsql.git
cd sqlalchemy-libsql
git submodule init && git submodule update  # hrana-test-server

pre-commit install         # install git-hooks
poetry install --with dev  # pytest

pre-commit run -a          # check all files in the project, runs pytest

poetry run pytest
poetry run pytest --log-debug=libsql_client  # debug libsql_client usage
# run against WSS server:
poetry run pytest --dburi "sqlite+libsql://server.com?secure=true&authToken=JWT_HERE"

The SQLAlchemy Project

SQLAlchemy-libsql is part of the SQLAlchemy Project and adheres to the same standards and conventions as the core project.

Development / Bug reporting / Pull requests

Please refer to the SQLAlchemy Community Guide for guidelines on coding and participating in this project.

Code of Conduct

Above all, SQLAlchemy places great emphasis on polite, thoughtful, and constructive communication between users and developers. Please see our current Code of Conduct at Code of Conduct.

Credits

This project structure is based on https://github.com/gordthompson/sqlalchemy-access, a project cited at README.dialects.rst.

License

SQLAlchemy-libsql is distributed under the MIT license.