--- title: "How to Install and Configure the Lite Edition JDBC Driver for ODBC, on Windows" description: "A guide for installing the Lite Edition JDBC Driver for ODBC data sources, on Windows." url: urn:osdi:this dateModified: 2026-10-30T15:45:34Z language: en --- The page for one UDA how-to guide, MERGED by build_uda_howtos.py from this template and the guide data (fixture/data/uda-howtos-qa.ttl and uda-howto-page-notes.ttl). Do not edit the generated file: change this template or the data and rebuild. The guide text is the data's own HTML, passed through the generator's allow-list; nothing here needs script except the Copy buttons on code blocks (js/howto.js). [Home](urn:osdi:site)/[UDA](urn:osdi:siteuda/)/[JDBC-to-ODBC Bridge](urn:osdi:sitedrivers/bridges/jdbc-to-odbc/)/Lite Edition (Single-Tier)/How to Install and Configure the Lite Edition JDBC Driver for ODBC, on Windows # How to Install and Configure the Lite Edition JDBC Driver for ODBC, on Windows [Get the JDBC-to-ODBC Bridge](urn:osdi:sitedrivers/bridges/jdbc-to-odbc/) A guide for installing the Lite Edition JDBC Driver for ODBC data sources, on Windows. [Pre-installation Guide](#guide-1) [Installation Guide](#guide-2) [Data Source Name Configuration Guide](#guide-3) [Walkthrough with screenshots](#group-walk) [Configuration and upgrades](#group-more) [· Upgrades and existing installations](#wiki-upgrades) ## Pre-installation Guide Pre-Installation Requirements for the Lite Edition (Single-Tier) JDBC Driver for ODBC Data Sources (a/k/a JDBC-to-ODBC Bridge), for Windows 1. You must have a working ODBC Environment (comprising an ODBC Administrator and Driver Manager) that is compatible with the Single-Tier (Lite Edition) JDBC to ODBC Bridge Driver for ODBC Data Sources. 2. You must be able to establish an ODBC connection to one or more target databases using third-party or native ODBC drivers that have already been installed. 3. You must have a Java Runtime Environment (JRE) that is compatible with the Single-Tier (Lite Edition) ODBC Driver for JDBC Data Sources. - Generally, the latest JVM from [http://java.com/](http://java.com/) is the best choice. - If using a 64-bit ODBC Driver, you must have a 64-bit JVM. 4. You must possess third-party or native JDBC drivers that connect to your target database. ## Installation Guide Installation of the Lite Edition (Single-Tier) JDBC Driver for ODBC Data Sources (the JDBC-to-ODBC Bridge), for Windows 1. Download the Lite Edition (Single-Tier) JDBC Driver for ODBC Data Sources (.msi) file. 2. Double-click on the downloaded .msi file to start the installation process. 3. Make sure you have a license file for the driver. Know the location of this file before proceeding with the installation. 4. During the installation process, you may be prompted to click the "Try & Buy" button to obtain a commercial or free evaluation license. 5. You can choose to skip the license file selection process by checking the "I don't want to install a license file right now" checkbox. However, note that you won't be able to use the software until a commercial or evaluation license key is registered. 6. Click "Next" and continue through the dialog until the installation is complete. 7. Click the "Finish" button to finish the installation process. ## Data Source Name Configuration Guide Lite Edition (Single-Tier) JDBC Driver for ODBC Data Sources (JDBC to ODBC Bridge Driver) Data Source Name (DSN) Configuration for Windows 1. The fourth dialog enables you to set optional ODBC connection parameters. - **Read-only connection** — Specifies whether the connection is "Read-only." Must be unchecked to INSERT, UPDATE, or DELETE records, and to run some Stored Procedures including some built-in functions. - **Defer fetching of long data** — Defers fetching of LONG (BINARY, BLOB, etc.) fields in wildcard queries. This provides significant performance increases when fields in query do not include LONG data fields. - **Disable interactive login** — Suppresses the ODBC "Username" and "Password" login dialog boxes when interacting with your ODBC DSN from within an ODBC compliant application. - **Row Buffer Size** — This attribute specifies the number of records to be delivered from the driver to the client application in a single batch. Values can range from 1 to 999. - **Max Rows Override** — Allows you to set a limit for the maximum number of rows to be returned from a query. The default value of 0 means no limit. - **Initial SQL** — Lets you specify a file containing SQL statements that will be run automatically against the database upon connection. - **Dynamic Cursor Sensitivity** — Enables or disables the row version cache used with dynamic cursors. When dynamic cursor sensitivity is set high, the Cursor Library calculates checksums for each row in the current rowset and compares these with the checksums (if any) already stored in the row version cache for the same rows when fetched previously. If the checksums differ for a row, the row has been updated since it was last fetched and the row status flag is set to SQL_ROW_UPDATED. The row version cache is then updated with the latest checksums for the rowset. From the user's point of view, the only visible difference between the two sensitivity settings is that a row status flag can never be set to SQL_ROW_UPDATED when the cursor sensitivity is low. (The row status is instead displayed as SQL_ROW_SUCCESS.) In all other respects, performance aside, the two settings are the same. Deleted rows don't appear in the rowset. Updates to the row since the row was last fetched are reflected in the row data, and inserted rows appear in the rowset, if their keys fall within the span of the rowset. If your application does not need to detect the row status SQL_ROW_UPDATED, you should leave the High Cursor Sensitivity checkbox unchecked, as performance is improved. The calculation and comparison of checksums for each row fetched carries an overhead. If this option is enabled, the table oplrvc must have been created beforehand using the appropriate script for the target database. - **Enable logging to the log file** — Check the checkbox and use the associated textbox to provide the full path to a file in which to log diagnostic information. 2. Click Next to continue. Start a JDBC-compliant application e.g., the JDBC Demo Application bundled with the OpenLink JDBC-ODBC Bridge Driver Installer Using the following JDBC URL template: URL`jdbc:openlink://ODBC[/DSN=dsn][/UID=uid][/PWD=pwd][/READONLY=x]` Construct a JDBC URL comprising the following connection attribute name and values pairings: - **/DSN** = Data Source Name (DSN) used to successfully connect to your target database in the prior step - **/UID** = database username - **/PWD** = password - **/READONLY** = Y or N, subject to your preferred Read or Write session mode ## Walkthrough with screenshots ## Installation walkthrough with screenshots The same installation, step by step, with the screens you will see. Installation and Configuration of the Lite Edition (Single-Tier) ODBC Driver for JDBC Data Sources (the ODBC-to-JDBC Bridge), for Windows **Review Preinstallation Documentation:** Pre-Installation Requirements ### Installation 1. The **Lite Edition (Single-Tier) ODBC Driver for JDBC Data Sources** (also known as the ODBC-to-JDBC Bridge) is distributed in a single `.msi` file. 2. Click the **Open** link that appears in your Downloads dialog. 3. The installer will display a **Welcome** message. Click "Next." 4. The next screen will display the **License Agreement** for the OpenLink Lite Driver. Please read and check the "I accept the license agreement" checkbox. Then, click **Next.** 5. The driver needs a license file to operate. Click the Browse button to locate a commercial or evaluation license that you have previously downloaded onto your local hard drive. Alternatively, click the **Try & Buy** button to obtain a commercial or evaluation license. You can also tick the "I don't want to install a license file right now" check box. This option will permit you to install the product; however, you will not be able to use the product until you obtain a commercial or evaluation license key. 6. Click **Next.** 7. Choose from the **Typical**, **Complete**, and **Custom** installation types. 8. Click **Next.** 9. Click the **Install** button. 10. Installation is complete. Click the **Finish** button. 11. You may be prompted to restart your computer, if you have a pre-existing OpenLink License Manager running on your computer. This reboot not always necessary, but is generally recommended. ### Configuration 1. Launch the **ODBC Administrator** appropriate to the bitness (32-bit or 64-bit) of your client application and driver. 2. Click the **System DSN** tab. 3. Click the **Add** button. Then, select the OpenLink "Lite" Driver for JDBC Data Sources from the list of available drivers. *Select the Unicode version of the driver if and only if you are working with multi-byte character sets, as unnecessary translations can significantly affect ODBC performance.* 4. Click **Finish**. 5. The first dialog prompts for a **Data Source Name** and optional description. 6. Click **Next**. 7. The second dialog prompts for a third-party JDBC driver name, JDBC connection URL, and authentication parameters associated with that JDBC URL. - **JDBC driver**- This is the class name of the target JDBC driver - **URL string**- This is the JDBC connection URL for the target JDBC driver - **Connect now to verify that all settings are correct**- Will attempt to connect to the database, once you click Continue. - **Login ID**- This is a valid username for your JDBC database - **Password**- This is a valid password for your JDBC database 8. Click **Next** to continue. 9. The third dialog takes a combination of database specific and optional parameters. - **Drop Catalog name from DatabaseMetaData calls** - Enable this option to have the catalog name not appear for tables, views, and procedures when requesting database meta-data. - **Drop Schema name from DatabaseMetaData calls** - Enable this option to have the schema-name not appear for tables, views, and procedures when requesting database meta-data. - **Return an empty ResultSet for SQLStatistics** - Check this box to have `SQLStatistics()` return an empty resultset. Use this if the underlying database does not support retrieval of statistics about a table (e.g., what indexes it has). - **Disable support of quoted identifier** - If set, the call `SQLGetInfo(SQL_IDENTIFIER_QUOTE_CHAR)` will return a space (`" "`). It can be used if the DBMS doesn't support quoted SQL like `SELECT * FROM "account"` - **Disable support of search pattern escape** - If set, the call `SQLGetInfo(SQL_LIKE_ESCAPE_CLAUSE)` will return a space (`" "`). It can be used if the DBMS doesn't support SQL escape patterns. - **Enable logging of JDBC calls to the log file** - 10. Click **Next** to continue. 11. The fourth dialog enables you to set optional ODBC connection parameters. - **Read-only connection** — Specifies whether the connection is "Read-only." Must be unchecked to `INSERT`, `UPDATE`, or `DELETE` records, and to run some Stored Procedures including some built-in functions. - **Defer fetching of long data** — Defers fetching of `LONG` (`BINARY`, `BLOB`, etc.) fields in wildcard queries. This provides significant performance increases when fields in query do not include LONG data fields. - **Disable interactive login** — Suppresses the ODBC "Username" and "Password" login dialog boxes when interacting with your ODBC DSN from within an ODBC compliant application. - **Row Buffer Size** — This attribute specifies the number of records to be delivered from the driver to the client application in a single batch. Values can range from 1 to 999. - **Max Rows Override** — Allows you to set a limit for the maximum number of rows to be returned from a query. The default value of 0 means no limit. - **Initial SQL** — Lets you specify a file containing SQL statements that will be run automatically against the database upon connection. - **Dynamic Cursor Sensitivity** — Enables or disables the row version cache used with dynamic cursors. When dynamic cursor sensitivity is set **high**, the Cursor Library calculates checksums for each row in the current rowset and compares these with the checksums (if any) already stored in the row version cache for the same rows when fetched previously. If the checksums differ for a row, the row has been updated since it was last fetched and the row status flag is set to `SQL_ROW_UPDATED`. The row version cache is then updated with the latest checksums for the rowset. From the user's point of view, the only visible difference between the two sensitivity settings is that a row status flag can never be set to `SQL_ROW_UPDATED` when the cursor sensitivity is low. (The row status is instead displayed as `SQL_ROW_SUCCESS`.) In all other respects, performance aside, the two settings are the same. Deleted rows don't appear in the rowset. Updates to the row since the row was last fetched are reflected in the row data, and inserted rows appear in the rowset, if their keys fall within the span of the rowset. If your application does not need to detect the row status `SQL_ROW_UPDATED`, you should leave the **High Cursor Sensitivity** checkbox unchecked, as performance is improved. The calculation and comparison of checksums for each row fetched carries an overhead. If this option is enabled, the table `oplrvc` must have been created beforehand using the appropriate script for the target database. - **Enable logging to the log file** — Check the checkbox and use the associated textbox to provide the full path to a file in which to log diagnostic information. 12. Click **Next** to continue. 13. The fifth dialog enables you to set additional parameters to enhance compatibility with applications. - **Enable Microsoft Jet engine options** — Facilitates translation of certain data types for the Microsoft Jet Engine. If you notice that money and other datatypes are mishandled with Microsoft or other applications, test with Jet fix enabled. - **Disable Autocommit — Changes the commit behavior of the OpenLink driver. The default mode is AutoCommit (box unchecked).** - **Disable rowset size limit** — Disables a limitation enforced by the cursor library. This limitation is enforced by default. It prevents the driver from claiming all available memory when a resultset (typically generated by an accidental query) is very large. The limit is not normally reached. - **Multiple Active Statements Emulation** — Enables use of Multiple Active statements in an ODBC application even if the underlying database does not allow this,, by emulation within the driver. - **SQL_DBMS Name** — Manually overrides the `SQLGetInfo(SQL_DBMS_NAME)` response returned by the driver. This is required for products like Microsoft InfoPath for which the value should be "**`SQL Server`**". 14. Click **Next** to continue. 15. The final dialog enables you to test your Data Source. Click the **Test Data Source** button. ### Next... - Test your DSNs with our sample program. - If anything isn't working as you expect, including errors resulting from the test above, see our Troubleshooting Resources. - Should you decide to purchase a commercial license at the end of your evaluation period, be sure to consult our documentation which explains the placement and uptake of commercial license files and the use of our **OpenLink License Manager** technology: [License Technology & Application](http://wiki.usnet.private/dataspace/dav/wiki/UdaWikiWeb/UDALicenseApplication). ## Configuration and upgrades ## Upgrades and existing installations Finding out what is installed, and moving to a newer release. Upgrades & Pre-Existing Installations ### Upgrades & Pre-Existing Installations #### Identifying Pre-existing Installations Use the following instructions to search for pre-existing OpenLink components on partner-supplied machines and other hardware: 1. Open Windows ODBC Data Sources Administrators or Mac iODBC Data Sources Administrators. Click on the Drivers tab. Look for OpenLink driver entries. 2. Open Windows registries. Expand the HKEY_ LOCAL_ MACHINE\SOFTWARE\ODBC\ODBCINST.INI tree structure. Look for OpenLink driver entries. 3. Use the Windows explorer to search for oplrqb.exe, olod*.dll, or lite32. 4. Open the Windows Services utility and look for an OpenLink Request Broker or License Manager service. 5. Log in to Mac OS X machines and open the Applications folder. Look for an OpenLink`=>`Universal Data Access Drivers folder structure. 6. Log in to Unix machines and use the *find / -name file -print* command to search for the following files: oplrqb, oplodbc.s*, openlink.ini Discovery of one or more of these files confirms the presence of OpenLink's Multi-Tier, Single-Tier or Express Edition drivers. If you want to install new software, you have two options: 7. Remove the old software and start fresh. 8. Obtain version information from the existing software and obtain new components from the same build. Upgrades & Pre-Existing Installations ### Upgrades & Pre-Existing Installations #### Mixing & Matching Components from Different Versions OpenLink Software does not support mixed-version installations. Mismatched client and server software may not hinder your ability to connect and query. However, version incompatibility issues will arise over time. In fact, if you mix OpenLink 3.x and OpenLink 4.x software, you can expect specific problems with stability, transactions, and threading. These problems may only be resolved by upgrading the older component. Be advised: Under rare circumstances, you may be forced to deploy a mixed installation. As stated previously, 3.x and 4.x components tend to generate problems. However, 4.x client components appear to work well with 5.x server components. Upgrades & Pre-Existing Installations ### Upgrades & Pre-Existing Installations #### Detecting Sofware Versions You may employ a variety of methods to obtain your product version information. Windows and Mac Single-Tier users should open their ODBC Administrator. The Single-Tier driver version appears on the Drivers tab of this Administrator. Users simple scroll through the Driver list box, locate their driver, and record the version string, which appears to the right of the driver name. **Windows & Mac Client Drivers (Express Edition/Single-Tier/Multi-Tier)** 1. Open your ODBC Data Sources Administrator or iODBC Data Sources Administrator. 2. Click the Drivers tab. 3. Scroll through the list box until you locate the OpenLink driver. 4. View the driver version information that appears to the right of the driver name. **Unix Client Drivers (Single-Tier/Multi-Tier)** 1. Login to the client machine. 2. cd into the root of the OpenLink installation. 3. Execute the openlink.sh or openlink.csh shell script. 4. cd into the /samples/ODBC (MT) or /bin (ST) sub-directory of the installation. 5. Use odbctest or iodbctest to connect to your Data Source. 6. View the driver version information that appears above the SQL> prompt. 7. Alternatively, run one of the following commands from the /lib sub-directory: | HP-UX | strings *.sl | grep "Driver" | sort -u | | --- | --- | --- | --- | | All Other Unix | strings *.so | grep "Driver" | sort -u | **Multi-Tier Server Components (All Platforms)** 1. Open a DOS Command Prompt, Unix console terminal, or similar command line utility. 2. cd into the /bin sub-directory of the OpenLink server components installation. 3. Type the broker or agent name and append -? or ?v to the end of the name. For example: oplrqb -? ingii_mv -? sql_mv -? 4. Record the version information that is returned by the broker or agent. Upgrades & Pre-Existing Installations ### Upgrades & Pre-Existing Installations #### Running Multiple Versions Simultaneously You can run multiple driver versions for comparative and diagnostic purposes. Take the following action to proceed: **Single-Tier & Express Edition Drivers** 1. Shutdown your License Manager, if you have OpenLink 6.0 drivers installed. 2. Install your new drivers in a separate directory. 3. Place your new license files in the /bin sub-directory of the new installation. 4. Restart your License Manager, if you have OpenLink 6.0 drivers installed. **Multi-Tier Drivers** 1. Shutdown your License Manager, if you have OpenLink 6.0 drivers installed. 2. Install your new drivers in a separate directory. 3. Place your new license files in the /bin sub-directory of the new installation. 4. Restart your License Manager, if you have OpenLink 6.0 drivers installed. 5. Use a text editor to open the oplrqb.ini files that appear in the /bin sub-directories of both Multi-Tier server component installations. 6. Locate the [Protocol TCP] section. For example: INI ``` [Protocol TCP] PingWatchdog = No PingInterval = 600 Listen = 5000 PortLow = 5000 PortHigh = 5025 ;IPAddress = 127.0.0.1 ``` 7. Insure that each Listen port references a different, unused TCP/IP port. (Use PortLow for OpenLink 1.x-3.x.) 8. Save any changes to the oplrqb.ini files. 9. Start your Request Brokers. BE ADVISED: The above instructions may not bring success in all scenarios. The following issues could present challenges that warrant attention from OpenLink Product Support: 1. Differing Windows driver versions may share the same .dll name. This could provide configuration challenges. 2. Some Windows installers may force you to remove an older installation. 3. OpenLink's 1.x and 3.x use UDP ports to broadcast license information. You need to contact Product Support for specialized configuration in this instance. Upgrades & Pre-Existing Installations ### Upgrades & Pre-Existing Installations #### Installing New Software on Top of Old Software You can install new software on top of existing software. However, this is not the preferred course of action, in many circumstances. You should install new software to new directories, if you are attempting to compare software performance or troubleshoot problems. Uninstalling Our Components Removing installations of our components takes different steps for different platforms. ### Windows You may use the uninstall utility to remove existing Windows software. You may also use the **Add/Remove Programs** utility, which appears in the **Control Panel**. ### Mac OS X The following sequence will cleanly remove all iODBC and Data Access components added by our installers. 1. Double-click the **`Uninstall.command`** script (`/Applications/OpenLink/Universal Data Access Drivers (* Tier Edition)`). If the script is not present, skip ahead to #3. 2. Answer the questions posed by the script. Please note that you must answer with the mixed-case, full-word answers. Anything other than `**`Yes`**`, `**`All`**`, or `**`Quit`**`, will be interpreted as `**`No`**`, including `**`y`**`, `**`Y`**`, and `**`yes`**`. 3. Verify that all of the following directories (including contents), and specified individual files, have been removed -- Example`/Applications/iODBC /Applications/OpenLink* /Library/Application Support/iodbc /Library/Application Support/openlink /Library/Frameworks/iODBC* /Library/Java/Extensions/libopljodbc*.jnilib /Library/Java/Extensions/opljdbc*.jar /Library/Java/Extensions/virtjdbc*.jar /Library/LaunchDaemons/com.openlinksw.* /Library/ODBC/OpenLink* /Library/Receipts/iODBC* /Library/Receipts/Opl* /Library/Receipts/UDA* /Library/Receipts/VIRT* /Library/Receipts/Virt* /Library/StartupItems/Oplmgr /Users/*/Library/Preferences/com.openlinksw* /Users/*/Library/Saved Application State/com.openlinksw* /private/var/db/receipts/com.openlinksw.*` 4. You can copy and paste the following command into Terminal.app to remove all of the above -- Shell`sudo rm -rf /Applications/iODBC /Applications/OpenLink* "/Library/Application Support/iodbc" "/Library/Application Support/openlink" /Library/Frameworks/iODBC* /Library/LaunchDaemons/com.openlinksw.* /Library/ODBC/OpenLink* /Library/Receipts/iODBC* /Library/Receipts/Opl* /Library/Receipts/UDA* /Library/Receipts/VIRT* /Library/Receipts/Virt* /Library/StartupItems/Oplmgr /Library/Java/Extensions/libopljodbc* /Library/Java/Extensions/opljdbc* /Library/Java/Extensions/virtjdbc* /Users/*/Library/Preferences/com.openlinksw* /Users/*/Library/Saved\ Application\ State/com.openlinksw* /private/var/db/receipts/com.openlinksw.*` ### Unix-like OS -- AIX, HP-UX, Linux, Solaris, etc. We do not provide an uninstall utility for Unix-like platforms. **`rm`** and **`rmdir`** should be used to remove existing deployments. Upgrades & Pre-Existing Installations ### Upgrades & Pre-Existing Installations #### Performing Upgrades Express Edition Upgrades 1. Terminate active ODBC connections. 2. Back up your license file. 3. Make sure you have the appropriate version JDK/JRE installed. 4. Perform your upgrade. **Single-Tier Upgrades** 1. Terminate active ODBC connections, which use OpenLink's drivers. 2. Back up license files. 3. Back-up existing odbc.ini and openlink.ini files. (Unix Only) 4. Terminate the License Manager service if you use OpenLink 6.0 or newer drivers. 5. Proceed with the upgrade. **Multi-Tier Upgrades** 1. Terminate active ODBC connections, which use OpenLink's drivers. 2. Stop your Request Broker and License Manager services. (License Managers are an OpenLink 6.0 and higher feature.) 3. Back-up your license and oplrqb.ini files. 4. Back-up odbc.ini files. (Unix Client Installs Only.) 5. Proceed with their upgrades. BE ADVISED: Some installers present two options: 1) Upgrade Driver Name, 2) Install New Driver. The first option should overwrite older drivers. DSNs that use those drivers will be affected. They should be migrated to the new driver. However, to insure the integrity of existing DSNs, choose the second option. This option installs the new driver alongside the old driver. Pre-existing DSNs should not be affected in any way. Upgrades & Pre-Existing Installations ### Upgrades & Pre-Existing Installations #### Reasons to Upgrade Consultants should encourage end-users to upgrade to the latest software version. The latest software contains desirable new features and fixes for bugs. Additionally, support options are limited, when legacy software is involved. Development does not back-patch legacy bugs, and Support staff may have difficulties recreating legacy problems. The following table lists new features for recent software builds: | [Build](#t-UDAReasonsToUpgrade) | [Features](#t-UDAReasonsToUpgrade) | | --- | --- | | 4.x | ODBC 3.5 compliancy. Multi-Threaded client & server components. Substantially-revised communications layer. | | 5.x | Unicode support. Zero Config. Best communications layer. | This guide for another platform: [macOS](urn:osdi:sitehowto/lite/jdbc/odbc/macos/) Windows The same guide for the other edition: [Enterprise Edition (Multi-Tier)](urn:osdi:sitehowto/mt/jdbc/odbc/windows/) [← JDBC-to-ODBC Bridge](urn:osdi:sitedrivers/bridges/jdbc-to-odbc/)