{"author":"IBM Application Development Team","author_email":"earamma.kanasavi@ibm.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: MacOS","Operating System :: MacOS :: MacOS X","Operating System :: Microsoft :: Windows :: Windows 10","Operating System :: Microsoft :: Windows :: Windows 11","Operating System :: POSIX :: AIX","Operating System :: POSIX :: Linux","Operating System :: Unix","Programming Language :: Python","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Database :: Front-Ends"],"description":"# Python support for IBM Db2 for LUW and IBM Db2 for z/OS\n\n## Python, DB-API components for IBM Db2 for LUW and IBM Db2 for z/OS\n\nProvides Python interface for connecting to IBM Db2 for LUW and IBM Db2 for z/OS\n\n\n\n## Components\n\n1. The **ibm_db** contains:\n - **ibm_db** driver: Python driver for IBM Db2 for LUW and IBM Db2 for z/OS databases. Uses the IBM Data Server Driver for ODBC and CLI APIs to connect to IBM Db2 for LUW.\n - **ibm_db_dbi**: Python driver for IBM Db2 for LUW that complies to the DB-API 2.0 specification.\n\n## API Documentation\n\nFor more information on the APIs supported by ibm_db, please refer to below link:\n\nhttps://github.com/ibmdb/python-ibmdb/wiki/APIs\n\n\n\n## Pre-requisites\n\nInstall Python 3.7 <= 3.13. The minimum python version supported by driver is python 3.7 and the latest version supported is python 3.13.\nMacOS arm64 is supported Python 3.9 onwards.\n\n### To install ibm_db on z/OS system\n\nPlease follow detailed installation instructions as documented here: [ibm_db Installation on z/OS](INSTALL.md#inszos)\n\n- **SQL1598N Error** - It is expected in absence of valid db2connect license. Please click [here](#Licenserequirements) and read instructions.\n- **SQL0805N Error** - You need to rebind CLI packages to fix this error. Please read detailed instructions [here](#SQL0805NError).\n\n### For MacOS M1/M2/ Apple Silicon chip system\n\n**MacOS with Silicon Chip** - Supported from v3.2.5 onwards using v12.x clidriver.\n**MacOS with Intel Chip** - Supported using v11.x clidriver only. By default v11.5.9 clidriver will get downloaded.\n\n### Linux/Unix:\n\nIf you face problems due to missing python header files while installing the driver, you would need to install python developer package and retry install. e.g:\n\n```\n zypper install python-devel\n or\n yum install python-devel\n```\n\n### Windows:\n\n- If a db2 client or server or dsdriver or clidriver is already installed in the system and user has already set installed path to `PATH` environment variable, then user need to set [environment variable](#envvar) `IBM_DB_HOME` manaully to the installed path before installing `ibm_db`.\n\n- To verify it, just execute `db2level` command before installation of `ibm_db`. If it works, note down the install directory path and set system level environment variable `IBM_DB_HOME` as install path shown in output of `db2level` command.\n\n- If user has installed clidriver in `F:\\DSDRIVER` and if the \"PATH\" environment variable has `F:\\DSDRIVER\\bin`, then user should also set `IBM_DB_HOME` to `F:\\DSDRIVER`.\n\n### Docker Linux containers:\n\n- You may need to install **gcc, python, pip, python-devel, libxml2 and pam** if not already installed. Refer to [Installation](#docker) for more details.\n\n### Manual Installation\n\nTo install ibm_db from source code after clone from git, or to know the detialed installation steps for various platforms, please check [INSTALL document](https://github.com/ibmdb/python-ibmdb/blob/master/INSTALL.md#inslnx).\n\n\n\n## Installation\n\n- Python **Wheels** are built for Linux, MacOS and Windows operating systems for multiple python versions (from python version 3.7 to 3.13). For other platforms, package gets installed from source distribution. For MaxOS arm64, python wheels are available from version 3.9 onwards.\n\nYou can install the driver using pip as:\n\n```\npip install ibm_db\n```\n\nThis will install ibm_db and ibm_db_dbi module.\n\n- When we install ibm_db package on Linux, MacOS and Windows, `pip install ibm_db` command install\n prebuilt Wheel package that includes clidriver too and ignores `IBM_DB_HOME` or `IBM_DB_INSTALLER_URL`\n or `CLIDRIVER_VERSION` environment variables if set. Also, auto downloading of clidriver does not happen\n as clidriver is already present inside wheel package.\n\n- For platforms not supported by python-wheel, ibm_db will get installed from souce distribution.\n GCC compiler is required on non-windows platform and VC++ compiler on Windows platform to\n install `ibm_db` from souce distribution.\n\n- If `db2cli validate` command works in your system and installed db2 client/server\n has `include` directory, ibm_db installation from souce distribution will not download clidriver, but\n it will use the existing client/server from the system.\n\n- To inforce auto downloading of clidriver _OR_ to make setting of environment variable `IBM_DB_HOME` or\n `IBM_DB_INSTALLER_URL` or `CLIDRIVER_VERSION` effective; install ibm_db from source distribution\n using below command:\n\n```\npip install ibm_db --no-binary :all: --no-cache-dir\n```\n\n- If you want to use your own URL for clidriver.tar.gz/.zip please set below environment variable:\n\n```\nexport IBM_DB_INSTALLER_URL=full_path_of_clidriver.tar.gz/.zip\npip install ibm_db --no-binary :all: --no-cache-dir\n```\n\n- To install using specific version of clidriver from https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli/:\n\n```\nexport CLIDRIVER_VERSION=v11.5.9\npip install ibm_db --no-binary :all: --no-cache-dir\n```\n\n- ibm_db will override value of CLIDRIVER_VERSION to v12.1.0 for MacARM64 and to v11.5.9 for Macx64 platform.\n\n- When ibm_db get installed from wheel package, you can find clidriver under site_packages directory\n of Python. You need to copy license file under `site_packages/clidriver/license` to be effective, if any.\n\n**Note:** For windows after installing ibm_db, recieves the below error when we try to import ibm_db :\n\n```>python\nPython 3.11.4 (tags/v3.11.4:d2340ef, Jun 7 2023, 05:45:37) [MSC v.1934 64 bit (AMD64)] on win32\nType \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n>>> import ibm_db\nTraceback (most recent call last):\n File \"\", line 1, in \nImportError: DLL load failed while importing ibm_db: The specified module could not be found.\n>>>\n```\n\nWe need to make sure to set dll path of dependent library of clidriver before importing the module as:\n\n```\nimport os\nos.add_dll_directory('path to clidriver installation until bin')\nimport ibm_db\n\ne.g:\nos.add_dll_directory('C:\\\\Program Files\\\\IBM\\\\CLIDRIVER\\\\bin')\nimport ibm_db\n```\n\nRefer https://bugs.python.org/issue36085 for more details.\n\n- For installing ibm_db on docker Linux container, you can refer as below:\n\n```\nyum install python gcc pam wget python-devel.x86_64 libxml2\nuse, `yum install python3` to install python 3.x\n\nif pip or pip3 does not exist, install it as:\nwget https://bootstrap.pypa.io/get-pip.py\ndocker cp get-pip.py /root:\ncd root\npython3 get-pip.py\n\nInstall python ibm_db as:\npip install ibm_db\nor\npip3 install ibm_db\n\n```\n\n- Uninstalling the ibm_db driver :\n\n```python\npip uninstall ibm_db\n```\n\n> The ODBC and CLI Driver(clidriver) is automatically downloaded at the time of installation and it is recommended to use this driver. However, if you wish to use an existing installation of clidriver or install the clidriver manually and use it, you can set IBM_DB_HOME environment variable as documented below:\n\n- Environment Variables:\n `IBM_DB_HOME :`\n\n Set this environment variable to avoid automatic downloading of the clidriver during installation. You could set this to the installation path of ODBC and CLI driver in your environment.
\n e.g:\n\n ```\n Windows :\n set IBM_DB_HOME=C:/Users/userid/clidriver\n\n Other platforms:\n export IBM_DB_HOME=/home/userid/clidriver\n ```\n\n **Note:** You must need to install ibm_db using command `pip install ibm_db --no-binary :all: --no-cache-dir`\n on Linux, Windows and MacOS to make setting of `IBM_DB_HOME` effective.\n\n You are required to set the library path to the clidriver under IBM_DB_HOME to pick this version of the ODBC and CLI Driver.
\n e.g:\n\n ```\n Windows:\n set LIB=%IBM_DB_HOME%/lib;%LIB%\n\n AIX:\n export LIBPATH=$IBM_DB_HOME/lib:$LIBPATH\n\n MAC:\n export DYLD_LIBRARY_PATH=$IBM_DB_HOME/lib:$DYLD_LIBRARY_PATH\n\n Other platforms:\n export LD_LIBRARY_PATH=$IBM_DB_HOME/lib:$LD_LIBRARY_PATH\n ```\n\n The ODBC and CLI driver is available for download at [Db2 LUW ODBC and CLI Driver](https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli/).\n Refer to ([License requirements](#Licenserequirements)) for more details on the CLI driver for manual download and installation.\n\n- Installing using Anaconda distribution of python\n\n```\nconda install -c conda-forge ibm_db\n```\n\n- Supported Platform for Anaconda Installation\n\n| Platform | Architecture | Supported | Version |\n| :------: | :------------: | :-------: | :-----: |\n| Linux | amd64 (x86_64) | Yes | Latest |\n| Linux | ppc64le | Yes | Latest |\n| Darwin | Mac OS x64 | Yes | Latest |\n| Darwin | Mac OS arm64 | Yes | Latest |\n| Windows | x64 | Yes | Latest |\n| Windows | x32 | Yes | Latest |\n\n## Quick Example\n\n```python\n$ python\nPython 3.13.0 (main, Oct 7 2024, 05:02:14) [Clang 16.0.0 (clang-1600.0.26.4)] on darwin\nType \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n>>> import ibm_db\n>>> #For connecting to local database named pydev for user db2inst1 and password secret, use below example\n>>> #ibm_db_conn = ibm_db.connect('pydev', 'db2inst1', 'secret')\n>>> #For connecting to remote database named pydev for uid db2inst and pwd secret on host host.test.com, use below example\n>>> # Connect using ibm_db\n>>> conn_str='database=pydev;hostname=host.test.com;port=portno;protocol=tcpip;uid=db2inst1;pwd=secret'\n>>> ibm_db_conn = ibm_db.connect(conn_str,'','')\n>>>\n>>> # Connect using ibm_db_dbi\n>>> import ibm_db_dbi\n>>> conn = ibm_db_dbi.Connection(ibm_db_conn)\n>>> # create table using ibm_db\n>>> create=\"create table mytable(id int, name varchar(50))\"\n>>> ibm_db.exec_immediate(ibm_db_conn, create)\n\n>>>\n>>> # Execute tables API\n>>> conn.tables('DB2INST1', '%')\n[{'TABLE_CAT': None, 'TABLE_SCHEM': 'DB2INST1', 'TABLE_NAME': 'MYTABLE', 'TABLE_TYPE': 'TABLE', 'REMARKS': None}]\n>>>\n>>> # Insert 3 rows into the table\n>>> insert = \"insert into mytable values(?,?)\"\n>>> params=((1,'Sanders'),(2,'Pernal'),(3,'OBrien'))\n>>> stmt_insert = ibm_db.prepare(ibm_db_conn, insert)\n>>> ibm_db.execute_many(stmt_insert,params)\n3\n>>> # Fetch data using ibm_db_dbi\n>>> select=\"select id, name from mytable\"\n>>> cur = conn.cursor()\n>>> cur.execute(select)\nTrue\n>>> row=cur.fetchall()\n>>> print(\"{} \\t {} \\t {}\".format(row[0],row[1],row[2]),end=\"\\n\")\n(1, 'Sanders') (2, 'Pernal') (3, 'OBrien')\n>>> row=cur.fetchall()\n>>> print(row)\n[]\n>>>\n>>> # Fetch data using ibm_db\n>>> stmt_select = ibm_db.exec_immediate(ibm_db_conn, select)\n>>> cols = ibm_db.fetch_tuple( stmt_select )\n>>> print(\"%s, %s\" % (cols[0], cols[1]))\n1, Sanders\n>>> cols = ibm_db.fetch_tuple( stmt_select )\n>>> print(\"%s, %s\" % (cols[0], cols[1]))\n2, Pernal\n>>> cols = ibm_db.fetch_tuple( stmt_select )\n>>> print(\"%s, %s\" % (cols[0], cols[1]))\n3, OBrien\n>>> cols = ibm_db.fetch_tuple( stmt_select )\n>>> print(cols)\nFalse\n>>>\n>>> # Close connections\n>>> cur.close()\nTrue\n>>> # Dropping the table created\n>>> drop = \"drop table mytable\"\n>>> stmt_delete = ibm_db.exec_immediate(ibm_db_conn,drop)\n>>> conn1.tables('DB2INST1','MY%')\n[]\n>>>\n>>> ibm_db.close(ibm_db_conn)\nTrue\n```\n\n## Logging\n\n### Logging in ibm_db Module\n\nYou can enable logging in the ibm_db module to debug and trace activities.\nLogging can be directed to the console or a specified file.\n\nTo enable logging:\n\n```\nimport ibm_db\n\n# Log to console\nibm_db.debug(True)\n\n# Log to a file (e.g., log.txt)\nibm_db.debug(\"log.txt\")\n\n# stop logging\nibm_db.debug(False)\n```\n\nCalling ibm_db.debug(True) with boolean True argument will output logs to the console.\n\nCalling ibm_db.debug(\"log.txt\") will log messages to the specified file (log.txt in this example).\n\nCalling ibm_db.debug(False) with boolean False argument will stop logging.\n\n### Logging in ibm_db_dbi Module\n\nYou can enable logging in the ibm_db_dbi module to debug and trace activities.\nLogging can be directed to the console or a specified file.\n\nTo enable logging:\n\n```\nimport ibm_db_dbi as dbi\n\n# Log to console\ndbi.debug(True)\n\n# Log to a file (e.g., log.txt)\ndbi.debug(\"log.txt\")\n\n# stop logging\ndbi.debug(False)\n```\n\nCalling dbi.debug(True) with boolean True argument will output logs to the console.\n\nCalling dbi.debug(\"log.txt\") will log messages to the specified file (log.txt in this example).\n\nCalling dbi.debug(False) with boolean False argument will stop logging.\n\n## Example of SSL Connection String\n\n- **Secure Database Connection using SSL/TSL** - ibm_db supports secure connection to Database Server over SSL same as ODBC/CLI driver. If you have SSL Certificate from server or an CA signed certificate, just use it in connection string as below:\n\n```\nUsing SSLServerCertificate keyword\n\nconnStr = \"DATABASE=;HOSTNAME=;PORT=;UID=;PWD=;\" +\n \"SECURITY=SSL;SSLServerCertificate=;\"\nconn = ibm_db.connect(connStr,'','')\n```\n\n> Note the two extra keywords **Security** and **SSLServerCertificate** used in connection string. `SSLServerCertificate` should point to the SSL Certificate from server or an CA signed certificate. Also, `PORT` must be `SSL` port and not the TCPI/IP port. Make sure Db2 server is configured to accept connection on SSL port else `ibm_db` will throw SQL30081N error.\n\n> Value of `SSLServerCertificate` keyword must be full path of a certificate file generated for client authentication.\n> It normally has `*.arm` or `*.cert` or `*.pem` extension. `ibm_db` do not support `*.jks` format file as it is not a\n> certificate file but a Java KeyStore file, extract certificate from it using keytool and then use the \\*.cert file.\n\n> `ibm_db` uses IBM ODBC/CLI Driver for connectivity and it do not support a `*.jks` file as keystoredb as `keystore.jks` is meant for Java applications.\n> Note that `*.jks` file is a `Java Key Store` file and it is not an SSL Certificate file. You can extract SSL certificate from JKS file using below `keytool` command:\n\n```\nkeytool -exportcert -alias your_certificate_alias -file client_cert.cert -keystore keystore.jks\n```\n\nNow, you can use the generated `client_cert.cert` as the value of `SSLServerCertificate` in connection string.\n\n> Do not use keyworkds like `sslConnection=true` in connection string as it is a JDBC connection keyword and ibm_db\n> ignores it. Corresponding ibm_db connection keyword for `sslConnection` is `Security` hence, use `Security=SSL;` in\n> connection string instead.\n\n> `ibm_db` supports only ODBC/CLI Driver keywords in connection string: https://www.ibm.com/docs/en/db2/11.5?topic=odbc-cliodbc-configuration-keywords\n\n- To connect to dashDB in IBM Cloud, use below connection string:\n\n```\nconnStr = \"DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=passwd;Security=SSL\";\n```\n\n> We just need to add **Security=SSL** in connection string to have a secure connection against Db2 server in IBM Cloud.\n\n**Note:** You can also create a KeyStore DB using GSKit command line tool and use it in connection string along with other keywords as documented in [DB2 Infocenter](http://www.ibm.com/support/knowledgecenter/en/SSEPGG_11.5.0/com.ibm.db2.luw.admin.sec.doc/doc/t0053518.html).\n\n- If you have created a KeyStore DB using GSKit using password or you have got _.kdb file with _.sth file:\n\n```\nUsing SSLClientKeyStoreDB and SSLClientKeyStoreDBPassword keyword\n\nconnStr = \"DATABASE=;HOSTNAME=;PORT=;UID=;PWD=;\" +\n \"SECURITY=SSL;SSLClientKeyStoreDB=;SSLClientKeyStoreDBPassword=;\"\nconn = ibm_db.connect(connStr,'','')\n```\n\n```\nUsing SSLClientKeyStoreDB and SSLClientKeyStash keyword\n\nconnStr = \"DATABASE=;HOSTNAME=;PORT=;UID=;PWD=;\" +\n \"SECURITY=SSL;SSLClientKeyStoreDB=;\" +\n \"SSLClientKeyStash=;\"\nconn = ibm_db.connect(connStr,'','')\n```\n\n> If you have downloaded `IBMCertTrustStore` from IBM site, ibm*db will not work with it; you need to\n> download `Secure Connection Certificates.zip` file that comes for IBM DB2 Command line tool(CLP).\n> `Secure Connection Certificates.zip` has *.kdb and \\_.sth files that should be used as the value of\n> `SSLClientKeystoreDB` and `SSLClientKeystash` in connection string.\n\n- More examples can be found under ['ibm_db_tests'](https://github.com/ibmdb/python-ibmdb/tree/master/IBM_DB/ibm_db/ibm_db_tests) folder.\n\n- [API Documentation](https://github.com/ibmdb/python-ibmdb/wiki/APIs) has examples for each API.\n\n- **Jupyter Notebook** examples can be found here -> [Other Examples](https://github.com/IBM/db2-python/tree/master/Jupyter_Notebooks)\n\n## SQL0805N Error - Rebind packages\n\n- Connecting first time to `Db2 for z/OS` from distributed platforms will result in error **SQL0805N** Package \"_location_.NULLID.SYSSH200.\\_\\_\\_\" or variation of package name.\n- To solve it, the bind packages are available within the `ibm_db` python install. Do the following:\n\n ```\n # Change directory to where your pip package was installed locally, e.g.:\n cd .local/lib/python3.10/site-packages/clidriver/bin\n # Run the bind command using db2cli utility from there, e.g:\n ./db2cli bind ../bnd/@db2cli.lst -database _dbname_ : _hostname_ : _port_ -user _userid_ -passwd _password_ -options \"grant public action replace blocking no\"\n ```\n\n## For z/OS and iSeries Connectivity and SQL1598N error\n\n- Connection to `Db2 for z/OS` or `Db2 for i`(AS400) Server using `ibm_db` driver from distributed platforms (Linux, Unix, Windows and MacOS) is not free. It requires either client side or server side license. See note below about license activation.\n\n- Connection to `Db2 for LUW` Server using `ibm_db` driver is free.\n\n- `ibm_db` returns SQL1598N error in absence of a valid db2connect license. SQL1598N error is returned by the Db2 Server to client.\n To suppress this error, Db2 server must be activated with db2connectactivate utility OR a client side db2connect license file must exist.\n\n- Db2connect license can be applied on database server or client side. A **db2connect license of version 11.5** is required for ibm_db.\n\n- For MacOS M1/M2/M3 Chip System (ARM64 processor), **db2connect license of version 12.1** is required.\n\n- For activating server side license, you can purchase either `Db2 Connect Unlimited Edition for System z®` or `Db2 Connect Unlimited Edition for System i®` license from IBM.\n\n- Ask your DBA to run db2connectactivate utility on Server to activate db2connect license.\n\n- If database Server is enabled for db2connect, no need to apply client side db2connect license.\n\n- If Db2 Server is not db2connectactivated to accept unlimited number of client connection, you must need to apply client side db2connect license.\n\n- db2connectactivate utility and client side db2connect license both comes together from IBM in a single zip file.\n\n- Client side db2connect license is a `db2con*.lic` file that must be copied under `clidriver\\license` directory.\n\n- If you have a `db2jcc_license_cisuz.jar` file, it will not work for ibm_db. `db2jcc_license_cisuz.jar` is a db2connect license file for Java Driver. For non-Java Driver, client side db2connect license comes as a file name `db2con*.lic`.\n\n- If environment variable `IBM_DB_HOME` or `IBM_DB_INSTALLER_URL` is not set, `ibm_db` automatically downloads open source driver specific clidriver from https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli and save as `site_packages\\clidriver`. Ignores any other installation.\n\n- If `IBM_DB_HOME` or `IBM_DB_INSTALLER_URL` is set, you need to have same version of db2connect license as installed db2 client. Check db2 client version using `db2level` command to know version of required db2connect license. The license file should get copied under `$IBM_DB_HOME\\license` directory.\n\n- If you do not have db2connect license, contact [IBM Customer Support](https://www.ibm.com/mysupport/s/?language=en_US) to buy db2connect license. Find the `db2con*.lic` file in the db2connect license shared by IBM and copy it under `.../site_packages/clidriver/license` directory or `$IBM_DB_HOME\\license` directory (if IBM_DB_HOME is set), to be effective.\n\n- To know more about license and purchasing cost, please contact [IBM Customer Support](https://www.ibm.com/mysupport/s/?language=en_US).\n\n- To know more about server based licensing viz db2connectactivate, follow below links:\n\n* [Activating the license certificate file for Db2 Connect Unlimited Edition](https://www.ibm.com/docs/en/db2/11.5?topic=li-activating-license-certificate-file-db2-connect-unlimited-edition).\n* [Unlimited licensing using db2connectactivate utility](https://www.ibm.com/docs/en/db2/11.1?topic=edition-db2connectactivate-server-license-activation-utility).\n\n#### Troubleshooting SQL1598N Error:\n\nIf you have copied db2con\\*.lic file under clidriver/license directory, but still getting SQL1598N Error; try below options:\n\n- `cd clidriver/bin` directory and run `./db2level` command. Make sure you have the db2connect license of same major and minor version as of clidriver.\n\n- Make sure the user running python program has read permission for license file.\n\n- Make sure the user running python program has read-write permission for `clidriver/license` and `clidriver/cfgcache` directories as license check utility need to create some cache files under `cfgcache` and `license` directories.\n\n- Validate your license file and connectivity using below db2cli command:\n\n```\n db2cli validate -connstring \"connection string as used in python program\" -displaylic\n\n OR\n\n db2cli validate -database \"dbname:hostname:port\" -user dbuser -passwd dbpasswd -connect -displaylic\n```\n\nIf you intend to install the clidriver manually, Following are the details of the client driver versions that you can download from [CLIDRIVER](https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli/) to be able to connect to databases on non-LUW servers. You would need the client side license file as per Version for corresponding installation.:\n\n#### CLIDriver and Client license versions for Specific Platform and Architecture\n\n| Platform | Architecture | Cli Driver | Supported | Version |\n| :------: | :----------: | :-----------------------: | :-------: | :----------: |\n| AIX | ppc | aix32_odbc_cli.tar.gz | Yes | V11.5.9 |\n| | others | aix64_odbc_cli.tar.gz | Yes | V11.5.9 |\n| Darwin | x64 | macos64_odbc_cli.tar.gz | Yes | Till V11.5.9 |\n| | arm64 | macarm64_odbc_cli.tar.gz | Yes | From V12.1.0 |\n| Linux | x64 | linuxx64_odbc_cli.tar.gz | Yes | V11.5.9 |\n| | s390x | s390x64_odbc_cli.tar.gz | Yes | V11.5.9 |\n| | s390 | s390_odbc_cli.tar.gz | Yes | V11.1 |\n| | ppc64 (LE) | ppc64le_odbc_cli.tar.gz | Yes | V11.5.9 |\n| | ppc64 | ppc64_odbc_cli.tar.gz | Yes | V10.5 |\n| | ppc32 | ppc32_odbc_cli.tar.gz | Yes | V10.5 |\n| | others | linuxia32_odbc_cli.tar.gz | Yes | V11.5.9 |\n| Windows | x64 | ntx64_odbc_cli.zip | Yes | V11.5.9 |\n| | x32 | nt32_odbc_cli.zip | Yes | V11.5.9 |\n| Sun | i86pc | sunamd64_odbc_cli.tar.gz | Yes | V10.5 |\n| | | sunamd32_odbc_cli.tar.gz | Yes | V10.5 |\n| | sparc | sun64_odbc_cli.tar.gz | Yes | V11.1 |\n| | sparc | sun32_odbc_cli.tar.gz | Yes | V11.1 |\n\nYou can refer to [ODBC and CLI Driver installation](http://www-01.ibm.com/support/docview.wss?uid=swg21418043) for details on how to install the driver manually.\n\n\n\n## Downloads\n\nUse following pypi web location for downloading source code and binaries\n**ibm_db**: https://pypi.python.org/pypi/ibm_db .\nYou can also get the source code by cloning the ibm_db github repository as :\n\n```\ngit clone git@github.com:ibmdb/python-ibmdb.git\n```\n\n\n\n## Support & feedback\n\n**Your feedback is very much appreciated and expected through project ibm-db:**\n\n- ibm-db issues reports: **https://github.com/ibmdb/python-ibmdb/issues**\n- ibm_db discuss: **http://groups.google.com/group/ibm_db**\n\n\n\n## Contributing to the ibm_db python project\n\nSee [CONTRIBUTING](https://github.com/ibmdb/python-ibmdb/blob/master/contributing/CONTRIBUTING.md)\n\n```\nThe developer sign-off should include the reference to the DCO in remarks(example below):\nDCO 1.1 Signed-off-by: Random J Developer \n```\n\n\n\n## Some common issues\n\n## 1. Installation Issues for missing python.h file\n\n### Always use the latest pip\n\n`python3 -m pip install --upgrade pip`\n\n### Install the package python3-devel that delivers the python.h header file\n\n```\nFor RHEL use\nsudo yum install python3-devel\n```\n\n```\nFor Ubuntu use\nsudo apt-get install python3-devel\n```\n\n- Once the above steps works fine, try re-installing ibm_db.\n\n## 2. SQL30081N Error\n\nIf connection fails with SQL30081N error - means `ibm_db` installation is correct and there is some issue with connection string. Please check database connection info and use correct connection string. If you are using SSL connection, port must be SSL port and connection string must have `Security=SSL;` and `SSLServerCertificate=;`.\n\n## 3. Issues with MAC OS X\n\n- If `import ibm_db` fails with `Symbol not found: ___cxa_throw_bad_array_new_length` error or `malloc` error: Please follow instructions as documented [here](INSTALL.md#symbolerror).\n\n- If you run into errors for libdb2.dylib as below:\n\n```python\n>>> import ibm_db\nTraceback (most recent call last):\n File \"\", line 1, in \nImportError: dlopen(/usr/local/lib/python3.5/site-packages/ibm_db.cpython-35m-darwin.so, 2): Library not loaded: libdb2.dylib\n Referenced from: /usr/local/lib/python3.5/site-packages/ibm_db.cpython-35m-darwin.so\n Reason: image not found\n\n```\n\nYou would need to set DYLD_LIBRARY_PATH to point to lib folder as per the installation location of clidriver in your environment. Assuming the driver is installed at /usr/local/lib/python3.5/site-packages/clidriver, you can set the path as:\n\n```\nexport DYLD_LIBRARY_PATH=/usr/local/lib/python3.5/site-packages/clidriver/lib:$DYLD_LIBRARY_PATH\n\n```\n\nIf the issue is not resolved even after setting DYLD_LIBRARY_PATH, you could refer:\n[MAC OS Hints and Tips](https://medium.com/@sudhanvalp/overcome-ibm-db-import-error-image-not-found-on-macos-578f07b70762)\n\n### Resolving SQL1042C error\n\nIf you hit following error while attempting to connect to a database:\n\n```python\n>>> import ibm_db\n>>> ibm_db.connect(\"my_connection_string\", \"\", \"\")\n Traceback (most recent call last):\n File \"\", line 1, in \n Exception: [IBM][CLI Driver] SQL1042C An unexpected system error occurred. SQLSTATE=58004 SQLCODE=-1042\n```\n\nSet DYLD_LIBRARY_PATH to point to icc folder as per the installation location of clidriver in your environment.\n\n```\nexport DYLD_LIBRARY_PATH=/usr/local/lib/python3.5/site-packages/clidriver/lib/icc:$DYLD_LIBRARY_PATH\n```\n\nIn case of similar issue in windows platform\n\n```\nset PATH=\\bin\\amd64.VC12.CRT;%PATH%\n```\n\n## 4. ERROR: Failed building wheel for ibm_db\n\nIn case of the error seen while building wheel use the following flag along with ibm_db for installation\n\n```\nTo install the package ibm_db it is necessary at first to install the build dependency package - wheel:\npip3 install wheel\nInstall ibm_db with the pip flag --no-build-isolation:\npip3 install ibm_db --no-build-isolation\n```\n\n## 5. For Issues on IBM iSeries System (AS400)\n\n- If you have installed `ibm_db` on IBM i and need help, please open an issue [here](https://github.com/kadler/python-ibmdb/issues).\n\n- If you have installed `ibm_db` on distributed platform and want to connect to AS400 server, you must have to use db2connect license. `ibm_db` do not work with `IBM i Access` driver.\n\n\n\n# Testing\n\nTests displaying Python ibm_db driver code examples are located in the ibm_db_tests\ndirectory. A valid config.py will need to be created to configure your Db2\nsettings. A config.py.sample exists that can be copied and modified for your\nenvironment.\n\n- Set Environment Variables DB2_USER, DB2_PASSWD accordingly.\n\n```\nFor example, by sourcing the following ENV variables:\nFor Linux\nexport DB2_USER=\nexport DB2_PASSWD=\n\nFor windows\nset DB2_USER=\nset DB2_PASSWD=\n\n```\n\n- OR\n\n```\nIf not using environment variables, update user and password information in\nconfig.json file.\n\n```\n\nThe config.py should look like this:\n\n```python\ntest_dir = 'ibm_db_tests' # Location of testsuite file (relative to current directory)\nfile_path = 'config.json'\n\nwith open(file_path, 'r') as file:\n data = json.load(file)\n\ndatabase = data['database'] # Database to connect to\nhostname = data['hostname'] # Hostname\nport = data['port'] # Port Number\n\nenv_not_set = False\nif 'DB2_USER' in os.environ:\n user = os.getenv('DB2_USER') # User ID to connect with\nelse:\n user = data['user']\n env_not_set = True\nif 'DB2_PASSWD' in os.environ:\n password = os.getenv('DB2_PASSWD') # Password for given User ID\nelse:\n password = data['password']\n env_not_set = True\n\nif env_not_set == True:\n warnings.warn(\"Warning: Environment variable DB2_USER or DB2_PASSWD is not set.\")\n print(\"Please set it before running test file and avoid\")\n print(\"hardcoded password in config.json file.\" )\n```\n\nPoint the database to mydatabase as created by the following command.\n\nThe tests that ibm_db driver uses depends on a UTF-8 database. This can be\ncreated by running:\n\n```\n CREATE DATABASE mydatabase USING CODESET UTF-8 TERRITORY US\n```\n\nSome of the tests utilize XML functionality only available in version 9 or\nlater of Db2. While Db2 v8.x is fully supported, two of the tests\n(test_195.py and test_52949.py) utilize XML functionality. These tests will\nfail on version 8.x of Db2.\n\n## Running the driver testsuite on Linux\n\nIn order to run the entire python driver testsuite on Linux, run this\ncommand at the command prompt:\n\n```\n python ibmdb_tests.py\n```\n\nTo run a single test, set the environment variable, **SINGLE_PYTHON_TEST**, to\nthe test filename you would like to run, followed by the previous command.\n\n## Running the driver testsuite on Windows\n\nIn order to run the entire python driver testsuite on Windows, run this\ncommand at the command prompt:\n\n```\n python ibmdb_tests.py\n```\n\nTo run a single test, set the environment variable, **SINGLE_PYTHON_TEST**, to\nthe test filename you would like to run, followed by the previous command.\n\n## Known Limitations for the Python driver\n\nIf trusted context is not set up, there will be two failures related to trusted context. When thick client has been used then additional three failures related to create, recreate DB.\n\n## Known Limitations for the Python wrapper\n\n1. The rowcount for select statements can not be generated.\n2. Some warnings from the drivers are not caught by the wrapper.\n As such these might go unnoticed.\n\nHappy coding!\n","description_content_type":"text/markdown","docs_url":null,"download_url":"http://code.google.com/p/ibm-db/downloads/list","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["Author","Author-Email","Classifier","Description","Description-Content-Type","Download-Url","Home-Page","Keywords","License","Platform","Summary"],"home_page":"http://pypi.python.org/pypi/ibm_db/","keywords":"database DB-API interface IBM Data Servers Db2","license":"Apache License 2.0","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"ibm-db","package_url":"https://pypi.org/project/ibm-db/","platform":"Linux32/64","project_url":"https://pypi.org/project/ibm-db/","project_urls":{"Download":"http://code.google.com/p/ibm-db/downloads/list","Homepage":"http://pypi.python.org/pypi/ibm_db/"},"provides_extra":null,"release_url":"https://pypi.org/project/ibm-db/3.2.6/","requires_dist":null,"requires_python":null,"summary":"Python DBI driver for DB2 (LUW, zOS, i5)","version":"3.2.6","yanked":false,"yanked_reason":null}

Package search

ibm-db

project_urls

Dependencies

All package metadata

Releases