Skip to content

Commit

Permalink
Updated Readme.md, Notes.md and install.md (ibmdb#880)
Browse files Browse the repository at this point in the history
doc update
  • Loading branch information
Earammak authored Aug 21, 2023
1 parent 4e7d425 commit 9972645
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 34 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Please note that on z/OS, you can only have one active connection per thread.

## Installation from source code
```shell
cd /u/pdharr/git/python-ibmdb/IBM_DB/ibm_db
cd /u/pdharr/git/python-ibmdb
export IBM_DB_HOME='DSN.VC10'
python setup.py install
```
Expand Down
52 changes: 19 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,22 @@
Python support for IBM Db2 for LUW, IBM Informix and IBM Db2 for z/OS
=========

[![Build Status](https://travis-ci.com/ibmdb/python-ibmdb.svg?branch=master)](https://travis-ci.com/ibmdb/python-ibmdb)

## Python, DB-API components for IBM Db2 for LUW, IBM Informix and IBM Db2 for z/OS

Provides Python interface for connecting to IBM Db2 for LUW, IBM Informix and IBM Db2 for z/OS

### Table of contents

[Components](#components)

[Pre-requisites](#pre-requisites)

[Installation](#inst)

[Quick Example](#eg)

[API Documentation](#api)

[Downloads](#downloads)

[Latest Updates](#latest-updates)

[Support & Feedback](#support)

[Contributing to the ibm_db python project](#contributing-to-the-ibm_db-python-project)

[Some common issues](#KnownIssues)

[Testing](#testing)

<a name='components'></a>
## Components

1. The **ibm_db** contains:
* **ibm_db** driver: Python driver for IBM Db2 for LUW, IBM Informix 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 and Informix.
* **ibm_db_dbi**: Python driver for IBM Db2 for LUW and IBM Informix databases that complies to the DB-API 2.0 specification.
Checkout the [README](https://github.com/ibmdb/python-ibmdb/tree/master/IBM_DB/ibm_db) for getting started with ibm_db and ibm_db_dbi


## <a name="api"></a> API Documentation
For more information on the APIs supported by ibm_db, please refer to below link:

https://github.com/ibmdb/python-ibmdb/wiki/APIs

<a name="prereq"></a>
## Pre-requisites
Expand Down Expand Up @@ -85,6 +64,8 @@ You might need zlib, openssl, pip installations if not already available in your
<a name="installation"></a>
## Installation
Python wheels are built for linux, macos and windows for multiple python versions (from python version 3.7 to 3.11).And for other platforms package gets installed from source distribution.
You can install the driver using pip as:
```
Expand All @@ -97,7 +78,17 @@ If you have to use your own URL for clidriver please set environment variable
IBM_DB_INSTALLER_URL
```
Note: For windows after installing ibm_db, we need to make sure to set dll path of dependent library of clidriver before importing the module as:
Note: For windows after installing ibm_db,recieves the below error when we try to import ibm_db :
```>python
Python 3.11.4 (tags/v3.11.4:d2340ef, Jun 7 2023, 05:45:37) [MSC v.1934 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import ibm_db
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ImportError: DLL load failed while importing ibm_db: The specified module could not be found.
>>>
```
We need to make sure to set dll path of dependent library of clidriver before importing the module as:
```
import os
Expand Down Expand Up @@ -283,11 +274,6 @@ More examples can be found under ['ibm_db_tests'](https://github.com/ibmdb/pytho
Jupyter Notebook examples can be found here -> [Other Examples](https://github.com/IBM/db2-python/tree/master/Jupyter_Notebooks)
## <a name="api"></a> API Documentation
For more information on the APIs supported by ibm_db, please refer to below link:
https://github.com/ibmdb/python-ibmdb/wiki/APIs
### <a name="Licenserequirements"></a> License requirements for connecting to databases
Python ibm_db driver can connect to Db2 on Linux Unix and Windows without any additional license/s, however, connecting to databases on Db2 for z/OS or Db2 for i(AS400) Servers require either client side or server side license/s. The client side license would need to be copied under `license` folder of your `clidriver` installation directory and for activating server side license, you would need to purchase Db2 Connect Unlimited for System z® and Db2 Connect Unlimited Edition for System i®.
Expand Down

0 comments on commit 9972645

Please sign in to comment.