Skip to main content

SQLAlchemy support for Db2 on IBM i

Project description

Latest version released on PyPi Supported Python Version Badge GitHub Actions status | sdras/awesome-actions Documentation Status

SQLAlchemy adapter for IBM i

The IBM i SQLAlchemy adapter provides a SQLAlchemy interface to Db2 for IBM i.

Please note that this project is still under active development. Please report any bugs in the issue tracker :rotating_light:

import sqlalchemy as sa

# see documentation for available connection options
# pass connection options in url query string, eg.
# engine = sa.create_engine("ibmi://user:pass@host?autocommit=true&timeout=10"
# find usage of create_engine database urls here
# https://docs.sqlalchemy.org/en/13/core/engines.html#database-urls
# this is the base connection which connects to *LOCAL on the host

engine = sa.create_engine("ibmi://user:pass@host")

cnxn = engine.connect()
metadata = sa.MetaData()
table = sa.Table('table_name', metadata, autoload=True, autoload_with=engine)

query = sa.select([table])

result = cnxn.execute(query)
result = result.fetchall()

# print first entry
print(result[0])

Installation

pip install sqlalchemy-ibmi

Feature Support

  • SQLAlchemy ORM - Python object based automatically constructed SQL
  • SQLAlchemy Core - schema-centric SQL Expression Language

Documentation

The documentation for the SQLAlchemy adapter for IBM i can be found at: https://sqlalchemy-ibmi.readthedocs.io/en/latest/

Known Limitations

  1. Non-standard SQL queries are not supported. e.g. "SELECT ? FROM TAB1"
  2. For updations involving primary/foreign key references, the entries should be made in correct order. Integrity check is always on and thus the primary keys referenced by the foreign keys in the referencing tables should always exist in the parent table.
  3. Unique key which contains nullable column not supported
  4. UPDATE CASCADE for foreign keys not supported
  5. DEFERRABLE INITIALLY deferred not supported
  6. Subquery in ON clause of LEFT OUTER JOIN not supported

Contributing to the IBM i SQLAlchemy adapter

Please read the contribution guidelines.

The developer sign-off should include the reference to the DCO in remarks(example below):
DCO 1.1 Signed-off-by: Random J Developer <random@developer.org>

Releasing a New Version

# checkout and pull the latest code from master
git checkout master
git pull

# bump to a release version (a tag and commit are made)
bumpversion release

# To skip a release candidate
bumpversion --no-tag --no-commit release
bumpversion --allow-dirty release

# bump to the new dev version (a commit is made)
bumpversion --no-tag patch

# push the new tag and commits
git push origin master --tags

License

Apache 2.0

Credits

  • ibm_db_sa for SQLAlchemy was first produced by IBM Inc., targeting version 0.4.
  • The library was ported for version 0.6 and 0.7 by Jaimy Azle.
  • Port for version 0.8 and modernization of test suite by Mike Bayer.
  • Port for sqlalchemy-ibmi by Naveen Ram/Kevin Adler.

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

crazy_ibmi-0.10.0.tar.gz (29.3 kB view details)

Uploaded Source

Built Distribution

crazy_ibmi-0.10.0-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file crazy_ibmi-0.10.0.tar.gz.

File metadata

  • Download URL: crazy_ibmi-0.10.0.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.10.102.1-microsoft-standard-WSL2

File hashes

Hashes for crazy_ibmi-0.10.0.tar.gz
Algorithm Hash digest
SHA256 169fc8da3e71b961d7c4bffe76422cea1963af403b12f6fd3ac8c8356f64f559
MD5 dc542bed3d25da0b64856c149c1bb644
BLAKE2b-256 215815a29a537ca92433e736fcc491a11068cde99f410cefb6fa52dba8731a43

See more details on using hashes here.

File details

Details for the file crazy_ibmi-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: crazy_ibmi-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.10.102.1-microsoft-standard-WSL2

File hashes

Hashes for crazy_ibmi-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68061ae4bff7adfd50d4dfeebb99e87e71056af3f2da30573acc3c08ec255d4e
MD5 31707700b617beca4306c21f28c692d5
BLAKE2b-256 955697c3f9bce113b90d6947a47a46a4ba8d6f409cb059482b546bcb81782797

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page