Trino dialect for SQLAlchemy
Project description
sqlalchemy-trino
⚠️ Deprecation and Archive Notice
sqlalchemy-trino
was developed as Trino (f.k.a PrestoSQL) dialect for SQLAlchemy.
Since trinodb/trino-python-client#81, all code of sqlalchemy-trino
is donated and merged into upstream project.
So now, this project is no longer active and consider as deprecated.
Supported Trino version
Trino version 352 and higher
Installation
The driver can either be installed through PyPi or from the source code.
Through Python Package Index
pip install sqlalchemy-trino
Latest from Source Code
pip install git+https://github.com/dungdm93/sqlalchemy-trino
Usage
To connect from SQLAlchemy to Trino, use connection string (URL) following this pattern:
trino://<username>:<password>@<host>:<port>/catalog/[schema]
JWT authentication
You can pass the JWT token via either connect_args
or the query string
parameter accessToken
:
from sqlalchemy.engine import create_engine
from trino.auth import JWTAuthentication
# pass access token via connect_args
engine = create_engine(
'trino://<username>@<host>:<port>/',
connect_args={'auth': JWTAuthentication('a-jwt-token')},
)
# pass access token via the query string param accessToken
engine = create_engine(
'trino://<username>@<host>:<port>/?accessToken=a-jwt-token',
)
Notice: When using username and password, it will connect to Trino over TLS connection automatically.
User impersonation
It supports user impersonation with username and password based authentication only.
You can pass the session user (a.k.a., the user that will be impersonated) via
either connect_args
or the query string parameter sessionUser
:
from sqlalchemy.engine import create_engine
# pass session user via connect_args
engine = create_engine(
'trino://<username>:<password>@<host>:<port>/',
connect_args={'user': 'user-to-be-impersonated'},
)
# pass session user via a query string parameter
engine = create_engine(
'trino://<username>:<password>@<host>:<port>/?sessionUser=user-to-be-impersonated',
)
Pandas support
import pandas as pd
from pandas import DataFrame
import sqlalchemy_trino
from sqlalchemy.engine import Engine, Connection
def trino_pandas_write(engine: Engine):
df: DataFrame = pd.read_csv("tests/data/population.csv")
df.to_sql(con=engine, schema="default", name="abcxyz", method="multi", index=False)
print(df)
def trino_pandas_read(engine: Engine):
connection: Connection = engine.connect()
df = pd.read_sql("SELECT * FROM public.foobar", connection)
print(df)
Note: in df.to_sql
following params is required:
index=False
because index is not supported in Trino.method="multi"
: currentlymethod=None
(default) is not working because Trino dbapi is not supportexecutemany
yet
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
Built Distributions
Hashes for sqlalchemy_trino-0.5.0-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0ed0b28aeced7d7ffaf526d8d018ebd25f65bab41ddee6cad7f5825f56fd6e3 |
|
MD5 | 9030da2dfc860d2632790c12c532304a |
|
BLAKE2b-256 | ad019b3a2318d3906765794e173de151c89ca145b692a1244bdbbd3fb2db1c57 |
Hashes for sqlalchemy_trino-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06e54562f5d326592b8254449686215a8e38e46b8c1d5534169271ce143f61af |
|
MD5 | 74469a254556ae7e70c7491cc89241c0 |
|
BLAKE2b-256 | 0dfb0ae57e8f2ddb803e5cc39c5266cd619cf9dd6e03868d469e83b197e9d65d |