Skip to content

Commit b42452d

Browse files
committed
Docs on ibm_db incompatibility - use ibm_db_dbi
1 parent 527b94a commit b42452d

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Connect To Database
200200
</details>
201201

202202
<details>
203-
<summary>IBM DB2 (ibm_db)</summary>
203+
<summary>IBM DB2 (ibm_db_dbi)</summary>
204204

205205
```RobotFramework
206206
Connect To Database
@@ -447,8 +447,8 @@ Therefore there are some modules, which are "natively" supported in the library
447447
### Teradata
448448
- [teradata](https://github.com/teradata/PyTd)
449449
### IBM DB2
450-
- [ibm_db](https://github.com/ibmdb/python-ibmdb)
451-
- [ibm_db_dbi](https://github.com/ibmdb/python-ibmdb)
450+
- The Python package to be installed is [ibm_db](https://github.com/ibmdb/python-ibmdb). It includes two modules - `ibm_db` and `ibm_db_dbi`.
451+
- *Using `ibm_db_dbi` is highly recommended* as only this module is Python DB API 2.0 compatible. See [official docs](https://www.ibm.com/docs/en/db2/12.1?topic=applications-python-sqlalchemy-django-framework).
452452
### ODBC
453453
- [pyodbc](https://github.com/mkleehammer/pyodbc)
454454
- [pypyodbc](https://github.com/pypyodbc/pypyodbc)

doc/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

src/DatabaseLibrary/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ class DatabaseLibrary(ConnectionManager, Query, Assertion):
386386
=== Oracle ===
387387
[https://oracle.github.io/python-oracledb/|oracledb]
388388
- Both thick and thin client modes are supported - you can select one using the `oracle_driver_mode` parameter.
389-
- However, due to current limitations of the oracledb module, **it's not possible to switch between thick and thin modes during a test execution session** - even in different suites.
389+
- However, due to current limitations of the oracledb module, *it's not possible to switch between thick and thin modes during a test execution session* - even in different suites.
390390
391391
[https://oracle.github.io/python-cx_Oracle/|cx_Oracle]
392392
@@ -402,8 +402,8 @@ class DatabaseLibrary(ConnectionManager, Query, Assertion):
402402
=== Teradata ===
403403
- [https://github.com/teradata/PyTd|teradata]
404404
=== IBM DB2 ===
405-
- [https://github.com/ibmdb/python-ibmdb|ibm_db]
406-
- [https://github.com/ibmdb/python-ibmdb|ibm_db_dbi]
405+
- The Python package to be installed is [https://github.com/ibmdb/python-ibmdb|ibm_db]. It includes two modules - `ibm_db` and `ibm_db_dbi`.
406+
- Using *`ibm_db_dbi` is highly recommended* as only this module is Python DB API 2.0 compatible. See [https://www.ibm.com/docs/en/db2/12.1?topic=applications-python-sqlalchemy-django-framework|official docs].
407407
=== ODBC ===
408408
- [https://github.com/mkleehammer/pyodbc|pyodbc]
409409
- [https://github.com/pypyodbc/pypyodbc|pypyodbc]

src/DatabaseLibrary/connection_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ def connect_to_database(
209209
210210
Other custom params from keyword arguments and config file are passed to the Python DB module as provided -
211211
normally as arguments for the _connect()_ function.
212-
However, when using *pyodbc* or *ibm_db*, the connection is established using a *connection string* -
212+
However, when using *pyodbc* or *ibm_db_dbi*, the connection is established using a *connection string* -
213213
so all the custom params are added into it instead of function arguments.
214214
215215
Set ``alias`` for `Handling multiple database connections`.

0 commit comments

Comments
 (0)