Prerequisites
SQream => 4.5.6
Python == 3.9
SQLAlchemy == 2.0.27
SQream DB-API Connector == 3.2.5
SQLite
Cython (optional - improves performance)
Installing SQream SQLAlchemy
pip3.9 install pysqream-sqlalchemy -UVerifying Installation
import sqlalchemy as sa
import pandas as pd
from sqlalchemy import text, orm
conn_str = "sqream://sqream:sqream@localhost:3108/master"
engine = sa.create_engine(conn_str, connect_args={"clustered": True})
session = orm.sessionmaker(bind=engine)()
session.execute(text('create or replace table test (ints int)'))
session.execute(text('insert into test values (5), (6)'))
df = pd.read_sql('select * from test', engine)
print(df)Connection String
sqream://<user_login_name>:<password>@<host>:<port>/<db_name>Parameters
Parameter |
Description |
|---|---|
username |
Username of a role to use for connection |
password |
Specifies the password of the selected role |
host |
Specifies the hostname |
port |
Specifies the port number |
port_ssl |
An optional parameter |
database |
Specifies the database name |
clustered |
Establishing a multi-clustered connection. Input values: True, False. Default is False |
service |
Specifies service queue to use |
Example
Pulling a Table into Pandas
The following example shows how to pull a table in Pandas. This example uses the URL method to create the connection string:
import sqlalchemy as sa
import pandas as pd
from sqlalchemy.engine.url import URL
engine_url = sa.engine.url.URL(
'sqream',
username='sqream',
password='12345',
host='127.0.0.1',
port=3108,
database='master')
engine = sa.create_engine(engine_url,connect_args={"clustered": True, "service": "admin"})
table_df = pd.read_sql("select * from nba", con=engine)Limitations
Arrays
SQream SQLAlchemy doesn’t suppport ARRAY type for columns.
Parameterized Queries
SQream SQLAlchemy supports only the BULK INSERT statement.
2 maintainers
Metadata
2 maintainers
Release files for pysqream-sqlalchemy 1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pysqream_sqlalchemy-1.4.tar.gz | 11.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pysqream_sqlalchemy-1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.8 kB
Release files / pysqream_sqlalchemy-1.4.tar.gz
| Download URL | pysqream_sqlalchemy-1.4.tar.gz |
|---|---|
| Size | 11.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c9f8a1a2e552470dbb9ae84335fbe5c8f551ac13945d44cf97ecd32c3c5532a9
|
|
BLAKE2b-256 checksum How to use checksums |
868bd4e0c64ab6e25a4d52833dec13105c28906b42d60dce2783faea05ce71c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 31, 2025.
Transparency logRelease files / pysqream_sqlalchemy-1.4-py3-none-any.whl
| Download URL | pysqream_sqlalchemy-1.4-py3-none-any.whl |
|---|---|
| Size | 10.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
65654edbb8ccd362b7b5036ccf9d34550da088bd564b6a8def74bd3c23cad3a2
|
|
BLAKE2b-256 checksum How to use checksums |
868aa3f850be630ce63ebdd6cc7676b54c8df2893e6c1b73a21af886bf553b5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 31, 2025.
Transparency log
