sqlalchemy-iris
An InterSystems IRIS dialect for SQLAlchemy.
Pre-requisites
This dialect requires SQLAlchemy, InterSystems DB-API driver, and iris-embedded-python-wrapper. They are
specified as requirements so pip will install them if they are not already in place. To install, just:
pip install sqlalchemy-iris
Or to use InterSystems official driver support
pip install sqlalchemy-iris[intersystems]
Usage
In your Python app, you can connect to the database via:
from sqlalchemy import create_engine
engine = create_engine("iris://_SYSTEM:SYS@localhost:1972/USER")
To use with Python Embedded mode through iris-embedded-python-wrapper, when run next to IRIS
from sqlalchemy import create_engine
engine = create_engine("iris+emb://USER")
The legacy path form iris+emb:///USER is also supported.
To use with InterSystems official driver, does not work in Python Embedded mode
from sqlalchemy import create_engine
engine = create_engine("iris+intersystems://_SYSTEM:SYS@localhost:1972/USER")
IRIS Cloud SQL requires SSLContext
url = engine.URL.create(
drivername="iris",
host=host,
port=443,
username='SQLAdmin',
password=password,
database='USER',
)
sslcontext = ssl.create_default_context(cafile="certificateSQLaaS.pem")
engine = create_engine(url, connect_args={"sslcontext": sslcontext})
InterSystems IRIS
You can run your instance of InterSystems IRIS Community Edition with Docker
docker run -d --name iris \
-p 1972:1972 \
-p 52773:52773 \
-e IRIS_USERNAME=_SYSTEM \
-e IRIS_PASSWORD=SYS \
intersystemsdc/iris-community:preview
Examples
IRISVector
from sqlalchemy import Column, MetaData, Table, select
from sqlalchemy.sql.sqltypes import Integer, UUID
from sqlalchemy_iris import IRISVector
from sqlalchemy import create_engine
from sqlalchemy.orm import DeclarativeBase
import uuid
DATABASE_URL = "iris://_SYSTEM:SYS@localhost:1972/USER"
engine = create_engine(DATABASE_URL, echo=False)
# Create a table metadata
metadata = MetaData()
def main():
demo_table = Table(
"demo_table",
metadata,
Column("id", Integer, primary_key=True, autoincrement=True),
Column("uuid", UUID),
Column("embedding", IRISVector(item_type=float, max_items=3)),
)
demo_table.drop(engine, checkfirst=True)
demo_table.create(engine, checkfirst=True)
with engine.connect() as conn:
conn.execute(
demo_table.insert(),
[
{"uuid": uuid.uuid4(), "embedding": [1, 2, 3]},
{"uuid": uuid.uuid4(), "embedding": [2, 3, 4]},
],
)
conn.commit()
result = conn.execute(
demo_table.select()
).fetchall()
print("result", result)
main()
Port 1972 is used for binary communication (this driver, xDBC and so on), and 52773 is for web (Management Portal, IRIS based web-applications and API's).
The System Management Portal is available by URL: http://localhost:52773/csp/sys/UtilHome.csp
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sqlalchemy_iris-0.20.0.tar.gz.
File metadata
- Download URL: sqlalchemy_iris-0.20.0.tar.gz
- Upload date:
- Size: 41.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d12f4e3f9f72ebbd271e8f2ce7be68d24fa8e519e3d00369ab206ebd91196aee
|
|
| MD5 |
0224b55d4346d49956d2755aff89ea07
|
|
| BLAKE2b-256 |
53afcc51e2adb81630ae9099370c3466789afa65ad40ffbee16d72a054675b1e
|
Provenance
The following attestation bundles were made for sqlalchemy_iris-0.20.0.tar.gz:
Publisher:
python-publish.yml on caretdev/sqlalchemy-iris
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sqlalchemy_iris-0.20.0.tar.gz -
Subject digest:
d12f4e3f9f72ebbd271e8f2ce7be68d24fa8e519e3d00369ab206ebd91196aee - Sigstore transparency entry: 1778701467
- Sigstore integration time:
-
Permalink:
caretdev/sqlalchemy-iris@10bc81ed02795823164fbcb85c306d89dca1dfeb -
Branch / Tag:
refs/tags/v0.20.0 - Owner: https://github.com/caretdev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@10bc81ed02795823164fbcb85c306d89dca1dfeb -
Trigger Event:
release
-
Statement type:
File details
Details for the file sqlalchemy_iris-0.20.0-py3-none-any.whl.
File metadata
- Download URL: sqlalchemy_iris-0.20.0-py3-none-any.whl
- Upload date:
- Size: 36.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8697f5ccdf2a52c0a6731cc2633a4c2286a4cb3dd74429226e0e66de107e7e68
|
|
| MD5 |
2444f2ad12cc74d035d50c6064249915
|
|
| BLAKE2b-256 |
b9510df817269cc8a1a78e66def5fb697ec8d48bdd43d324bce6c861aeca2ed6
|
Provenance
The following attestation bundles were made for sqlalchemy_iris-0.20.0-py3-none-any.whl:
Publisher:
python-publish.yml on caretdev/sqlalchemy-iris
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sqlalchemy_iris-0.20.0-py3-none-any.whl -
Subject digest:
8697f5ccdf2a52c0a6731cc2633a4c2286a4cb3dd74429226e0e66de107e7e68 - Sigstore transparency entry: 1778701682
- Sigstore integration time:
-
Permalink:
caretdev/sqlalchemy-iris@10bc81ed02795823164fbcb85c306d89dca1dfeb -
Branch / Tag:
refs/tags/v0.20.0 - Owner: https://github.com/caretdev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@10bc81ed02795823164fbcb85c306d89dca1dfeb -
Trigger Event:
release
-
Statement type:
