sqlalchemy-intersystems-iris 1.0.0

An InterSystems IRIS dialect for SQLAlchemy

sqlalchemy-intersystems-iris

This package provides an InterSystems IRIS dialect for SQLAlchemy, built for use with the InterSystems Python DB-API driver.

Installation

Install sqlalchemy-intersystems-iris with pip:

pip install sqlalchemy-intersystems-iris

The InterSystems Python DB-API driver is a dependency and will be automatically installed or upgraded to a compatible version.

Usage

You can connect your Python application to an InterSystems IRIS database by passing a connection URL to create_engine(). The URL can be a string or a SQLAlchemy URL object.

A connection string for InterSystems IRIS has the format iris://{username}:{password}@{host}:{port}/{namespace}. For example:

from sqlalchemy import create_engine

url = "iris://SQLUser:password@localhost:1972/USER"

engine = create_engine(url)

You can construct a SQLAlchemy URL with URL.create(). Note that the database field corresponds to an InterSystems IRIS namespace:

from sqlalchemy import create_engine
from sqlalchemy import URL

url = URL.create(
    drivername='iris',
    username='SQLUser',
    password='password',
    host='localhost',
    port=1972,
    database='USER',
)

engine = create_engine(url)

As these examples demonstrate, you do not need to import the dialect package directly—the SQLAlchemy engine will automatically load the correct dialect based on the connection URL.

For details on the features supported by InterSystems IRIS SQL, see the InterSystems IRIS SQL documentation.

Documentation

SQLAlchemy documentation is available at https://docs.sqlalchemy.org/.

Help

For any issues you can contact InterSystems Worldwide Response Center (WRC).

License

This project is licensed under the terms detailed at https://www.intersystems.com/IERTU/.

Release Notes

Version 1.0.0

Initial release.