Easysoft ODBC-DB2 Driver User's Guide - Installation

Installing the Easysoft ODBC-DB2 Driver

This chapter explains how to install, license and remove the Easysoft ODBC-DB2 Driver on supported Windows and Unix platforms.

The Windows installation can be carried out by anyone with local administrator privileges for the target machine.

The Unix installation instructions assume you are, or are able to consult with, a system administrator.

Chapter Guide

Obtaining the Easysoft ODBC-DB2 Driver

There are three ways to obtain the Easysoft ODBC-DB2 Driver:

Choose Download from the Easysoft ODBC-DB2 Driver section of the web site and then choose the platform release that you require.

If you have not already done so, you will need to register at the web site to download Easysoft software.

Change to the pub/db2 subdirectory and then choose the platform release that you require.

What to Install

The name of the Easysoft ODBC-DB2 Driver distribution file varies from platform to platform. The file name format is:

¯ OR ¯

where x is the major version number, y is the minor version number and z is the build index, which is incremented when minor changes are made.

platform depends on the operating system distribution you require. File names may have this format:


Select the highest release available for your platform within your licensed major version number (installing software with a different major version number requires a new Easysoft license).


On Unix, as long as you stop all Easysoft software first (or software that uses the Easysoft drivers under Unix), it is safe to reinstall or upgrade the Easysoft ODBC-DB2 Driver without uninstalling.

If you do uninstall, you should first back up any configuration data that you still need, as uninstalling some Easysoft products will result in this information being deleted (license details remain in place).

To continue, refer to the installation instructions for your platform:

Installing the Easysoft ODBC-DB2 Driver on Unix

These instructions show how to install the Easysoft ODBC-DB2 Driver on Unix platforms. Please read this section carefully before installing the Easysoft ODBC-DB2 Driver.

Before you Install


To install the Easysoft ODBC-DB2 Driver on Unix you need:

grep, awk, test, cut, ps, sed, cat, wc, uname, tr, find, echo, sum, head, tee, id

If you do not have any of these commands, they can usually be obtained from the Free Software Foundation. As the tee command does not work correctly on some systems, the distribution includes a tee replacement.

The installation will do this automatically for you so long as you run the installation as someone with permission to create /usr/local/easysoft.

For more information about setting the EASYSOFT_ROOT environment variable, see Post installation.

1.  Register the Easysoft ODBC-DB2 Driver with unixODBC.

2.  Create the example data source in the SYSTEM odbc.ini file.

3.  Update the dynamic linker entries (some platforms only).

If you are not root, these tasks will have to be done manually later.

Easysoft recommend you install all components as the root user.

What you can Install

This distribution contains:

You will need an ODBC Driver Manager to use the Easysoft ODBC-DB2 Driver from your applications. The distribution therefore contains the unixODBC Driver Manager. Most (if not all) Unix applications and interfaces support the unixODBC Driver Manager. For example, Perl DBD::ODBC, PHP, Python and so on.

You do not have to install the unixODBC Driver Manager included with this distribution. You can use an existing copy of unixODBC. For example, a version of unixODBC installed by another Easysoft product, a version obtained from your operating system vendor or one that you built yourself. However, as Easysoft ensure that the unixODBC distributed with the Easysoft ODBC-DB2 Driver has been tested with that driver, we recommend you use it.

If you choose to use an existing unixODBC Driver Manager, the installation script will attempt to locate it. The installation script looks for the Driver Manager in the standard places. If you have installed it in a non-standard location, the installation script will prompt you for the location. The installation primarily needs unixODBC's odbcinst command to install drivers and data sources.

Where to Install

This installation needs a location for the installed files. The default location is /usr/local.

At the start of the installation, you will be prompted for an installation path. All files are installed in a subdirectory of your specified path called easysoft. For example, if you accept the default location /usr/local, the product will be installed in /usr/local/easysoft and below.

If you choose a different installation path, the installation script will try to symbolically link /usr/local/easysoft to the easysoft subdirectory in your chosen location. This allows us to distribute binaries with built in dynamic linker run paths. If you are not root or the path /usr/local/easysoft already exists and is not a symbolic link, the installation will be unable to create the symbolic link.

Note that you cannot license Easysoft products until either of the following is true:

Changes Made to Your System

This installation script installs files in subdirectories of the path requested at the start of the installation, Depending on what is installed, a few changes may be made to your system:

1.  If you choose to install the Easysoft ODBC-DB2 Driver into unixODBC, unixODBC's odbcinst command will be run to add an entry to your odbcinst.ini file. You can locate this file with odbcinst -j. (odbcinst is in installation_path/easysoft/unixODBC/bin, if you are using the unixODBC included with this distribution.)

 The odbcinst.ini entry for the Easysoft ODBC-DB2 Driver will look similar to this:

 [Easysoft ODBC-DB2]

 Description = Easysoft ODBC-DB2 Driver

 Driver = /usr/local/easysoft/db2/lib/libesdb2.so

 Setup =

 DontDLClose = 1

 FileUsage = 1

 UsageCount = 1

For information about removing these entries, see Uninstalling the Easysoft ODBC-DB2 Driver on Unix.

2.  The installation script installs example data sources into unixODBC. The data sources will be added to your SYSTEM odbc.ini file. You can locate your SYSTEM odbc.ini file by using odbcinst -j. The data source for the standard driver will look similar to this:

For information about removing these data sources, see Uninstalling the Easysoft ODBC-DB2 Driver on Unix.

3.  Dynamic Linker.

 On operating systems where the dynamic linker has a file listing locations for shared objects (Linux), the installation script will attempt to add paths under the path you provided at the start of the installation to the end of this list. On Linux, this is usually the file /etc/ld.so.conf.

Reinstalling or Installing When You Already Have Other Easysoft Products Installed

Each Easysoft distribution contains common files shared between Easysoft products. These shared objects are placed in installation_path/easysoft/lib. When you run the installation script, the dates and versions of these files will be compared with the same files in the distribution. The files are only updated if the files being installed are newer or have a later version number.

You should ensure that nothing on your system is using Easysoft software before starting an installation. This is because on some platforms, files in use cannot be replaced. If a file cannot be updated, you will see a warning during the installation. All warnings are written to a file called warnings in the directory you unpacked the distribution into.

If the installer detects you are upgrading a product, the installer will suggest you delete the product directory to avoid having problems with files in use. An alternative is to rename the specified directory.

If you are upgrading, you will need a new license from Easysoft to use the new driver.

Gathering Information Required During the Installation

During the installation, you will be prompted for various pieces of information. Before installing, you need to find out whether you have unixODBC already installed and where it is installed. The installation script searches standard places like /usr and /usr/local. However, if you installed the Driver Manager in a non-standard place and you do not install the included unixODBC, you will need to know the location.


Unpacking the Distribution

The distribution for Unix platforms is a tar file (.tar). To extract the installation files from the tar file, use:

tar -xvf odbc-db2-x.y.z-platform.tar

This will create a directory with the same name as the tar file (without the .tar postfix) containing further archives, checksum files, an installation script and various other installation files.

Change directory into the directory created by unpacking the tar file.

License to Use

The End-User License Agreement is contained in the file license.txt. Be sure to understand the terms of the agreement before continuing, as you will be required to accept the license terms at the start of the installation.

Answering Questions During the Installation

Throughout the installation, you will be asked to answer some questions. In each case, the default choice will be displayed in square brackets and you need only press Enter to accept the default. If there are alternative responses, these will be shown in round brackets; to choose one of these, type the response and press Enter.

For example:

Do you want to continue? (y/n) [n]:

The possible answers to this question are y or n. The default answer when you type nothing and press Enter is n.

Running the Installer

Before you run the installer, make sure you have read Installation. If you are considering running the installation as a non root user, we suggest you review this carefully as you will have to get a root user to manually complete some parts of the installation afterwards. Easysoft recommend installing as the root user. (If you are concerned about the changes that will be made to your system, see Changes Made to Your System.)

To start the installation, run:


You will need to:

For more information about the license agreement, see License to Use.

For more information, see Where to Install.


If you are upgrading, you will need a new license from Easysoft.

Locating or Installing unixODBC

Easysoft strongly recommend you use the unixODBC Driver Manager because:

The installation starts by searching for unixODBC. There are two possible outcomes here:

1.  If the installation script finds unixODBC, the following message will be output:

 Found unixODBC under /unixODBC_path

  and it is version n.n.n

2.  If the installation script cannot find unixODBC in the standard places, you will be asked whether you have it installed.

 If unixODBC is installed, you need to provide the unixODBC installation path. Usually, the path required is the directory above where odbcinst is installed. For example, if odbcinst is in /opt/unixODBC/bin/odbcinst, the required path is /opt/unixODBC.

If unixODBC is not installed, you should install the unixODBC included with this distribution.

If you already have unixODBC installed, you do not have to install the unixODBC included with the distribution, but you might consider doing so if your version is older than the one included.

The unixODBC in the Easysoft ODBC-DB2 Driver distribution is not built with the default options in unixODBC's configure line.

Option Description


This means the default SYSTEM odbc.ini file where SYSTEM data sources are located will be /etc/odbc.ini.


This means other ODBC drivers that come with unixODBC are not installed.


This means unixODBC will not look for a libiconv. Warnings about not finding an iconv library were confusing our customers.


Disables unixODBC statistics, which use system semaphores to keep track of used handles. Many systems do not have sufficient semaphore resources to keep track of used handles. In addition, the statistics are only available in the GUI ODBC Administrator.


This disables readline support in isql.

We disabled this because it ties isql to the version of libreadline on the system we build on. We build on as old a version of the operating system as we can for forward compatibility. Many newer Linux systems no longer include the older readline libraries and so enabling readline support makes isql unusable on these systems.


This installs unixODBC into /usr/local/easysoft/unixODBC.

Figure 1: Easysoft unixODBC configure line options.
Installing the Easysoft ODBC-DB2 Driver

The Easysoft ODBC-DB2 Driver installation script:

If the Easysoft ODBC-DB2 Driver is already registered with unixODBC, a warning will be displayed that lists the drivers unixODBC knows about. If you are installing the Easysoft ODBC-DB2 Driver into a different directory than it was installed before, you will need to edit your odbcinst.ini file after the installation and correct the Driver and Setup paths. unixODBC's odbcinst will not update these paths if a driver is already registered.

If unixODBC is installed and you registered the Easysoft ODBC-DB2 Driver with unixODBC, an example data source will be added to your odbc.ini file.

If a data source called "DB2_SAMPLE", the existing data source will be displayed and you have the option to replace it.


The installation_path/easysoft/license/licshell program lets you obtain or list licenses.

Licenses are stored in the installation_path/easysoft/license/licenses file. After obtaining a license, you should make a backup copy of this file.

The installation script asks you if you want to request an Easysoft ODBC-DB2 Driver license:

Would you like to request a Easysoft ODBC-DB2 Driver license now (y/n) [y]:

You do not need to obtain a license during the installation, you can run licshell after the installation to obtain or view licenses.

If you answer yes, the installation runs the licshell script. The process of obtaining a license is best described in the Licensing Guide.

To obtain a license automatically, you will need to be connected to the Internet and allow outgoing connections to license.easysoft.com on port 8884. If you are not connected to the Internet or do not allow outgoing connections on port 8884, the License Client can create a license request file that you can mail or fax to Easysoft. You can also supply the details to us by telephone.

Start the License Client. The following menu is displayed:

[0] exit

[1] view existing license

[n] obtain a license for the desired product.

To obtain a license, select one of the options from [2] onwards for the product you are installing. The License Client will then run a program that generates a key that is used to identify the product and operating system (we need this key to license you).

After you have chosen the product to license (Easysoft ODBC-DB2 Driver), you need to supply:

You will then be asked to specify how you want to obtain the license. The choices are:

[1] Automatically by contacting the Easysoft License Daemon

This requires a connection to the Internet and the ability to support an outgoing TCP/IP connection to license.easysoft.com on port 8884.

[2] Write information to file so you can fax, telephone it

The license request is output to license_request.txt.

[3] Cancel this operation

If you choose to obtain the license automatically, the License Client will start a TCP/IP connection to license.easysoft.com on port 8884 and send the details you supplied and your machine number. No other data is sent. The data sent is transmitted as plain text, so if you want to avoid the possibility of this information being intercepted by someone else on the Internet, you should choose [2] and telephone or fax the request to us. The License daemon will return the license key, print it to the screen and make it available to the installation script in the file licenses.out.

If you choose option [2], the license request is written to the file license_request.txt. You should then exit the License Client by choosing option [0] and complete the installation. After you have mailed, faxed or telephoned the license request to us, we will return a license key. Add this to the end of the file installation_path/easysoft/license/licenses.

If any warnings or errors are output during this process, please mail the output to support@easysoft.com and we will correct the problem.

Post installation

Supplied Documents and Examples

The last part of the installation runs a post install script that lists the resources available to you.

installation_path/easysoft/db2/doc/CHANGES.txt lists all the changes in each version of the Easysoft ODBC-DB2 Driver.

There are also many resources at the Easysoft web site.

Setting Dynamic Linker Search Paths

Your applications will be linked against an ODBC Driver Manager, which will load the ODBC Driver you require. The dynamic linker needs to know where to find the ODBC Driver Manager shared object. The ODBC Driver Manager will load the Easysoft ODBC-DB2 Driver, which is dependent on further common Easysoft shared objects; the dynamic linker needs to locate these too.

On operating systems where the dynamic linker has a file specifying locations for shared objects (Linux, for example), the installation will attempt to add paths under the path you provided at the start of the installation to the end of this list; no further action should be required. For more information, see Dynamic Linker..

On other Unix platforms, there are two methods of telling the dynamic linker where to look for shared objects:

1.  You add the search paths to an environment variable and export it.

 This method always works and overrides the second method, described below.

2.  At build time, a run path is inserted into the executable or shared objects. On most System V systems, Easysoft distribute Easysoft ODBC-DB2 Driver shared objects with an embedded run path. The dynamic linker uses the run path to locate Easysoft ODBC-DB2 Driver shared object dependencies.

For the first method, the environment variable you need to set depends on the platform (refer to the platform documentation for ld(1), dlopen or ld.so(8)) .

Environment Variable Platform


System V based operating systems and Solaris.






Many platforms use this in addition to those listed above.

Figure 2: Dynamic linker search path environment variables.

To use the Easysoft ODBC-DB2 Driver, you need to add:


where installationdir is the directory in which you chose to install the Easysoft ODBC-DB2 Driver. If you accepted the default location, this is /usr/local.

An example of setting the environment path in the Bourne shell on Solaris is:




The exact command you need to set and export an environment variable depends on your shell.

If you installed the unixODBC Driver Manager included in the Easysoft ODBC-DB2 Driver distribution, you also need to add installationdir/easysoft/unixODBC/lib to the dynamic linker search path.

Uninstalling the Easysoft ODBC-DB2 Driver on Unix

There is no automated way to remove the Easysoft ODBC-DB2 Driver in this release. However, removal is quite simple. To do this, follow these instructions.

To uninstall the Easysoft ODBC-DB2 Driver

1.  Change directory to installation_path/easysoft and delete the db2 directory. installation_path is the Easysoft ODBC-DB2 Driver installation directory, by default /usr/local.

2.  If you had to add this path to the dynamic linker search paths (for example, /etc/ld.so.conf on Linux), remove it. You may have to run a linker command such as /sbin/ldconfig to get the dynamic linker to reread its configuration file. Usually, this step can only be done by the root user.

3.  If you were using unixODBC, the Easysoft ODBC-DB2 Driver entry needs to be removed from the odbcinst.ini file. To check whether the Easysoft ODBC-DB2 Driver is configured under unixODBC, use odbcinst -q -d. If the command output contains [Easysoft ODBC-DB2 Driver], uninstall the drivers from unixODBC by using:

odbcinst -u -d -n 'Easysoft ODBC-DB2'

Installing the Easysoft ODBC-DB2 Driver on Windows

Installing the Easysoft ODBC-DB2 Driver

Follow the on screen instructions.

Updating Files That are in Use

To avoid rebooting your computer, the Easysoft ODBC-DB2 Driver installer prompts you when files that it needs to update are in use by another application or service. This frees the locked files and allows the installation to complete without a system restart.

On Windows Vista and later, the Easysoft ODBC-DB2 Driver installer uses the Restart Manager to locate the applications that are using files that need updating. These applications are displayed in the Files in Use dialog box. To avoid a system restart, choose Automatically close applications and attempt to restart them after setup is complete. The Easysoft ODBC-DB2 Driver installer then uses the Restart Manager to try to stop and restart each application or service in the list. If possible, the Restart Manager restores applications to the same state and with the same data that they were in before it shut them down.

On earlier versions of Windows, when the Files in Use dialog is displayed, manually shut down each application in the list and then click Retry to avoid a system restart.

Licensing on Windows

 The install program starts the Easysoft License Manager (documented in the Licensing Guide), because you cannot use the Easysoft ODBC-DB2 Driver until a license is obtained.

 The following types of license are available:

4.  Enter your contact details.

 You MUST enter the Name, E-Mail Address and Company fields.

 The Telephone and Facsimile fields are important if you require Easysoft to contact you by those methods.

 The E-Mail Address MUST be the same as the address used to register and download from the Easysoft web site or you will be unable to obtain trial licenses.

5.  Click Request License.

 You are asked for a license type.

6.  For a trial license click Time Limited Trial and then click Next.

 The License Manager asks what software you are licensing:

 Select your required version of the Easysoft ODBC-DB2 Driver (Standard or Remote, for example) from the drop-down list and then click Next.

¯ OR ¯

 If you have obtained an authorization code for a purchased license, select Non-expiring License and then click Next.

 The License Manager requests your authorization code.

 Enter the authorization code and then click Next.

7.  The License Manager displays a summary of the information you entered and allows you to choose the method of applying for your license.

8.  Choose On-line Request if your machine is connected to the internet and can make outgoing connections to port 8884.

 The License Manager then sends a request to the Easysoft license server to activate your license key automatically. This is the quickest method and results in your details being entered immediately into our support database. You can now go to step 9.


Only your license request identifier and contact details as they are displayed in the main License Manager screen are sent to Easysoft.

 The remaining three options (Email Request, Print Request and View Request) are all ways to obtain a license if your machine is off-line (i.e. does not have a connection to the internet).

 Each of these methods involves providing Easysoft with information including your machine number (a number unique to your machine) and then waiting to receive your license key.

 Instead of emailing your details to Easysoft, you can enter them directly at the Easysoft web site and your license key will be emailed to you automatically.

 To use this method, click View Request, and then visit:

(trial licenses)

(purchased licenses)

 In the Licensing page, enter your machine number (and authorization code for purchased license), click Submit and your license key will be emailed to you


You can copy your machine number from the View Request dialog box using CTRL-C and then paste it into the License Generator by using CTRL-V.


 When you receive the license key, you can activate it either by double-clicking the email attachment or by clicking Enter License on the License Manager main screen and pasting the license key into the dialog box.

9.  A message tells you how many licenses have been added.


If you use the Email Request option, the license key is emailed to the email address as displayed on the License Manager screen, not the from: address of your email.

For more information about the licensing procedure refer to the Licensing Guide.

10.  Click Finish in the License Manager.

 The installation is complete.

Repairing the Easysoft ODBC-DB2 Driver Installation

The installer can repair a broken Easysoft ODBC-DB2 Driver installation. For example, you can use the installer to restore missing Easysoft ODBC-DB2 Driver files or registry keys.

In Windows Vista and later versions of Windows:

1.  In Control Panel, open Programs and Features.

2.  Right-click Easysoft ODBC-DB2 Driver, and then click Repair.

In earlier versions of Windows:

1.  In Control Panel, open Add or Remove Programs.

2.  Select Easysoft ODBC-DB2 Driver and click Change/Remove.

Uninstalling the Easysoft ODBC-DB2 Driver on Windows

This section explains how to remove the Easysoft ODBC-DB2 Driver from your system.

Removing Easysoft ODBC-DB2 Driver Data Sources

 Easysoft ODBC-DB2 Driver data sources are not removed when you uninstall. You therefore do not need to recreate your Easysoft ODBC-DB2 Driver data sources if you reinstall or upgrade. If you do not want to keep your Easysoft ODBC-DB2 Driver data sources, use ODBC Administrator to remove them, before uninstalling the Easysoft ODBC-DB2 Driver.

1.  In Control Panel, double-click Administrative Tools and then Data Sources (ODBC).

2.  Select the data source in the ODBC Administrator and click the Remove button.

64-bit Windows

There is both a 32-bit and a 64-bit version of ODBC Administrator. The 64-bit ODBC Administrator is located in Control Panel under Administrative tools. To access the 32-bit ODBC Administrator, in the Windows Run dialog box, type:


If you do not see the data source in the 64-bit ODBC Administrator, look for it in the 32-bit ODBC Administrator.

Removing the Easysoft ODBC-DB2 Driver

In Windows Vista and later versions of Windows:

1.  In Control Panel, open Programs and Features.

2.  Double-click Easysoft ODBC-DB2 Driver.

In earlier versions of Windows:

1.  In Control Panel, open Add or Remove Programs.

2.  Select Easysoft ODBC-DB2 Driver and click Change/Remove.

The uninstall process is complete.

 Any licenses you obtained for the Easysoft ODBC-DB2 Driver and other Easysoft products are held in the Windows registry.

 When you uninstall, your licenses are not removed so you do not need to relicense the product if you reinstall or upgrade.