Skip to content

Commit

Permalink
Initial source code release to Google Code repository:
Browse files Browse the repository at this point in the history
 - Python Driver:  ibm_db-0.2.5      - DB2 CLI based C extension 
 - DB-DBI-2.0:     ibm_db_dbi-0.2.5  - DB-API compliant wrapper
 - SQLAlchemy-0.4: ibm_db_sa-0.1.0   - adapter support for DB2

git-svn-id: https://ibm-db.googlecode.com/svn/trunk@2 1b047d87-d943-0410-8e89-5b5f2422cd04
  • Loading branch information
[email protected] committed Feb 9, 2008
1 parent 7eccd0f commit 4be0331
Show file tree
Hide file tree
Showing 161 changed files with 39,072 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .project
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>ibm-db.googlecode</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
</buildSpec>
<natures>
</natures>
</projectDescription>
9 changes: 9 additions & 0 deletions IBM_DB/ibm_db/CHANGES
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Change Log
=============

2007/12/04 (setup.py 0.2.0):
- added the ability to create Python Eggs by running:
$ python setup.py bdist_egg

2008/02/08 (setup.py 0.2.5, ibm_db-0.2.5, ibm_db_dbi-0.2.5):
- added support for ibm_db_sa-0.1.0 SQLAlchemy-0.4 adapter release
55 changes: 55 additions & 0 deletions IBM_DB/ibm_db/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

1. You must give any other recipients of the Work or Derivative Works a copy of this License; and

2. You must cause any modified files to carry prominent notices stating that You changed the files; and

3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
155 changes: 155 additions & 0 deletions IBM_DB/ibm_db/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
Python Driver and DBI Wrapper for IBM Databases
-----------------------------------------------
The ibm_db driver and ibm_db_dbi wrapper provide a Python interface for IBM
databases. The wrapper conforms to the DBI specification located here:
http://www.python.org/dev/peps/pep-0249/

The driver and wrapper have been developed and will be supported by IBM.


Python ibm_db Driver Build and Installation
-------------------------------------------
1. Linux

Preparations (specific commands dependent on shell):
If you are compiling against a DB2 instance, do the following
(paths depend on system):
. <path_to_sqllib>/db2profile
export IBM_DB_DIR=<path_to_sqllib>
export IBM_DB_LIB=<path_to_sqllib>/lib

Installation Commands for Linux:
python setup.py build
python setup.py install

2. Windows

Preparations:
Install Python from:
http://python.org
Install Visual C++ 2003, Platform SDK (latest), .NET SDK Version
1.1 from:
http://wiki.tcl.tk/11431
Set envrionment:
CALL "C:\Program Files\Microsoft Platform SDK for Windows
Server 2003 R2\SetEnv.Cmd"
CALL "C:\Program Files\Microsoft Visual C++ Toolkit
2003\vcvars32.bat"
SET LIB=%LIB%;C:\Program Files\Microsoft Visual Studio .NET
2003\Vc7\lib
(Use notepad to edit config.py to your DB2 settings)
set IBM_DB_DIR=<path_to_sqllib>
set IBM_DB_LIB=<path_to_sqllib>\lib

Installation Commands for Windows:
setup.py build
setup.yp install


Python ibm_db_dbi Wrapper Build and Installation
------------------------------------------------
There is no special build required to use the ibm_db_wrapper. However, the
wrapper internally uses the driver. So the driver needs to be built and
installed before you use the wrapper.


Setup to use ibm_db or ibm_db_dbi
---------------------------------
For Unix based systems:
Depending on your shell, source the db2profile or db2chsrc. Be sure to source
the profile for the DB2 instance and not the profile under the DB2 product
installation. For example:
. <path_to_sqllib>/db2profile
or
source <path_to_sqllib>/db2chsrc

Import ibm_db or ibm_db_dbi inside your Python application to use the driver or
wrapper functionality
import ibm_db
or
import ibm_db_dbi

Note: Please make sure that the directory containing the ibm_db_dbi.py file is
added to the PYTHONPATH variable. This will ensure that the DBI wrapper can be
accessed in your python applications.


List of Operating Systems tested
--------------------------------
SuSE Linux Server 9 32 bit
Ubuntu Linux 7.04 32 bit
Windows 32 bit


Supported Databases
-------------------
IBM DB2 Database on Linux, Unix and Windows 8.2 and beyond


Future Supported Databases
--------------------------
IBM Cloudscape
Apache Derby
Remote connections to i5/OS (iSeries)
Remote connections to z/OS (DB2 UDB for zOS)
Informix (IDS)
Native DB2 for i5/OS (iSeries)
Native DB2 UDB for zOS


Testing
-------
Tests displaying Python ibm_db driver code examples are located in the tests
directory. These tests can be run by using 'python tests.py' on Unix based
systems, and 'tests.py' on Windows based systems. Use vi to edit config.py to
your DB2 settings.

The tests that ibm_db driver uses depends on a UTF-8 database. This can be
created by running:
CREATE DATABASE mydatabase USING CODESET UTF-8 TERRITORY US
Some of the tests utilize XML functionality only available in version 9 or
later of DB2. While DB2 v8.x is fully supported, two of the tests
(test_195.py and test_52949.py) utilize XML functionality. These tests will
fail on version 8.x of DB2.

Running the driver testsuite on Linux
In order to run the entire python driver testsuite on Linux, run this
command at the command prompt:
python tests.py
To run a single test, set the environment variable, SINGLE_PYTHON_TEST, to
the test filename you would like to run, followed by the previous command.

Running the driver testsuite on Windows
In order to run the entire python driver testsuite on Windows, run this
command at the command prompt:
tests.py
To run a single test, set the environment variable, SINGLE_PYTHON_TEST, to
the test filename you would like to run, followed by the previous command.


Known Limitations for the Python driver
---------------------------------------
1. The following tests are expected to fail:
test_03a.py:
Fails due to an exception being thrown by the driver and not
being caught by the test.
test_133.py:
Fails due to the None object not being returned by the
ibm_db.execute() statement on line 48.
test_146.py:
Fails due to issues with procedures being called with
parameters that have a parameter-type of SQL_PARAM_OUTPUT.
test_148.py:
Same issue as test_146.py.
tests_53494.py:
Same issue as test_52949.py.


Known Limitations for the Python wrapper
----------------------------------------
1. An error is thrown when selecting a row which has a BLOB type
column with a null value.
2. The rowcount for complex select statements can not be generated.
The wrapper might throw errors with complex select statement.
3. Some warnings from the drivers are not caught by the wrapper.
As such these might go unnoticed.
7 changes: 7 additions & 0 deletions IBM_DB/ibm_db/config.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
test_dir = 'tests' # Location of testsuite file (relative to current directory)

database = 'sample' # Database to connect to
user = 'db2inst1' # User ID to connect with
password = 'password' # Password for given User ID
hostname = 'localhost' # Hostname
port = 60000 # Port Number
Loading

0 comments on commit 4be0331

Please sign in to comment.