InstallFirebirdExpressWin32 Installation and Configuration of the Single-Tier "Express" Edition ODBC Driver for Firebird Data Sources, for Windows Installation and Configuration of the Single-Tier "Express" Edition ODBC Driver for Firebird Data Sources, for Windows Review Preinstallation Documentation: Pre-Installation Requirements Installation The OpenLink ODBC Driver for Firebird (Express Edition) is distributed as a Windows MSI installer. Double click on the installer 'ntl6efrb.msi' to commence the installation:
This is the Welcome dialog for the OpenLink ODBC Driver for Firebird (Express Edition):
Read the Software License Agreement and accept before continuing your installation:
Before installation, you will be prompted for a license file. If a license file already exists on the machine, then select the 'use existing file' option. A trial (try) or full (buy) license can be obtained by selecting the 'try and buy' option which loads our online try and buy web page:
To obtain the trial license, you must be a registered user on the OpenLink Web site and login with the username (e-mail address) and password for that user. Click on the 'Shop' link to visit our online shop cart to purchase a full license if required. Click on the 'download license' button to obtain an immediate license file and save it to your desktop. Alternatively, mail can be sent to your e-mail address with a link to your OpenLink Data Space (ODS). Here, all trial and full license files will be stored in a specialized Briefcase for download at a later date.
Select the license file to be used for the installation:
Choose to perform a custom, typical, or complete installation of the driver:
Select the features to be installed:
Click the install button to begin the installation:
Installation in progress:
The installation is complete and ready for use:
Configuration Launch the ODBC Administrator appropriate to the bitness (32-bit or 64-bit) of your client application and driver.
Click on the Drivers tab to confirm that the driver has been successfully installed:
From either the User or System DSN tab, click on the Add button and select the Express Edition Driver from the list. 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:
On the Data Source tab, provide a suitable DSN name and optional description for the Data Source to be created:
The Connection tab requests the minimum parameters required to make a connection to the target database:
Host: This is the fully qualified host name or IP address of the machine hosting the DBMS you wish to access, e.g., or Any host name which can be resolved by your local DNS is acceptable. Port: This is the port on which Firebird listens. DatabasePath: This is the path and filename of the database file (.fdb) to which you want to connect. 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 user for the Firebird database. Password: This is a valid password for the Firebird database.
The advanced button displays additional, optional parameters that can be configured:
<tgroup><thead /><tbody> <row><entry><emphasis>Name</emphasis></entry><entry><emphasis>Description</emphasis> </entry></row> <row><entry><emphasis>BlobBufferLength</emphasis> </entry><entry> Sets BLOB buffer length. This value influences performance when working with BLOB fields. </entry></row> <row><entry> <emphasis>BlobBufferSize</emphasis> </entry><entry> Size of the BLOB buffer in bytes. </entry></row> <row><entry> <emphasis>BuffersNumber</emphasis> </entry><entry> Number of cache buffers that should be allocated for this connection. It should be specified for ClassicServer instances. SuperServer has a server-wide configuration parameter. </entry></row> <row><entry> <emphasis>DefaultIsolation</emphasis> </entry><entry> Sets the default transaction isolation level as string. The following strings are allowed: 'TRANSACTION_READ_COMMITTED', 'TRANSACTION_REPEATABLE_READ', 'TRANSACTION_SERIALIZABLE' </entry></row> <row><entry> <emphasis>Encoding</emphasis> </entry><entry> Sets encoding for connections produced by this data source. </entry></row> <row><entry> <emphasis>LoginTimeout</emphasis> </entry><entry> Sets login timeout for this datasource in seconds. </entry></row> <row><entry> <emphasis>RoleName</emphasis> </entry><entry> SQL role to use. </entry></row> <row><entry> <emphasis>SocketBufferSize</emphasis> </entry><entry> Socket buffer size in bytes. </entry></row> <row><entry> <emphasis>SqlDialect</emphasis> </entry><entry> SQL dialect of the client. </entry></row> <row><entry> <emphasis>TimestampUsesLocalTimezone</emphasis> </entry><entry> Set to 'true' if the JayBird 1.0 handling of the calendar in corresponding setters. This is also compatible with the MySQL calendar treatment. </entry></row> <row><entry> <emphasis>UseStandardUdf</emphasis> </entry><entry> Set to 'true,' if driver should assume that standard UDF are installed. </entry></row> <row><entry> <emphasis>UseStreamBlobs</emphasis> </entry><entry> Set to 'true,' if stream blobs should be created. Otherwise, set to 'false.' </entry></row> <row><entry> <emphasis>UseTranslation</emphasis> </entry><entry> Path to the character translation table. </entry></row> <row><entry> <emphasis>CharSet</emphasis> </entry><entry> Character set for the connection. Similar to encoding property, but accepts Java names instead of Firebird ones. </entry></row> </tbody></tgroup></table> </listitem> <listitem> Click continue to proceed to the Options dialog. This dialog contains optional parameters that are not required for basic ODBC connectivity: <figure><graphic fileref="InstallFirebirdExpressWin32/frbconf07.png" /></figure> <itemizedlist mark="bullet" spacing="compact"><listitem> <emphasis>Drop Catalog from Meta calls</emphasis> - Enable this option to have the catalog name not appear for tables, views, and procedures when requesting database meta-data. </listitem> <listitem> <emphasis>Drop Schema from Meta calls</emphasis> - Enable this option to have the schema-name not appear for tables, views, and procedures when requesting database meta-data. </listitem> <listitem> <emphasis>Return and empty ResultSet for SQLStatistics</emphasis> - 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). </listitem> <listitem> <emphasis>Disable support of quoted identifier</emphasis> - If set, the call SQLGetInfo for 'SQL_IDENTIFIER_QUOTE_CHAR' will return a space (" "). It can be used if the DBMS doesn't support quoted SQL like select * from "account." </listitem> <listitem> <emphasis>Disable support of search string escape</emphasis> - If set, the call SQLGetInfo for 'SQL_LIKE_ESCAPE_CLAUSE' will return a space (" "). It can be used if the DBMS doesn't support SQL escape patterns. </listitem> <listitem> <emphasis>Patch NULL size of SQL_CHAR</emphasis> - If set, this option overrides the size of SQL_CHAR column type returned by the database with the value set in the text box (in bytes). With a default value of 0, the driver uses the size returned by the database. </listitem> </itemizedlist></listitem> <listitem> Click continue to proceed to the Preferences dialog. This dialog contains optional parameters that are not required for basic ODBC connectivity: <figure><graphic fileref="InstallFirebirdExpressWin32/frbconf08.png" /></figure> <itemizedlist mark="bullet" spacing="compact"><listitem> <emphasis>Read Only connection</emphasis> - Specifies whether the connection is "Read-only." Make sure the checkbox is unchecked to request a "Read/Write" connection. </listitem> <listitem> <emphasis>Defer fetching of long data</emphasis> - Defers fetching of LONG (BINARY, BLOB etc.) data unless explicitly requested in a query. This provides significant performance increases when fields in query do not include LONG data fields. </listitem> <listitem> <emphasis>Disable interactive login</emphasis> - Suppresses the ODBC "Username" and "Password" login dialog boxes when interacting with your ODBC DSN from within an ODBC compliant application. </listitem> <listitem> <emphasis>Row Buffer Size</emphasis> - This attribute specifies the number of records to be transported over the network in a single network hop. Values can range from 1 to 99. </listitem> <listitem> <emphasis>Max Rows Override</emphasis> - Allows you to define a limit on the maximum number of rows to be returned from a query. The default value of 0 means no limit. </listitem> <listitem> <emphasis>Initial SQL</emphasis> - Lets you specify a file containing SQL statements that will be run automatically against the database upon connection. </listitem> <listitem> <emphasis>Dynamic cursor sensitivity</emphasis> - 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. </listitem> <listitem> <emphasis>Enable logging to the log file</emphasis> - Pass a full path to an arbitrary log file that will be used to log ODBC API and SQL related errors. </listitem> </itemizedlist></listitem> <listitem> Click Next to continue to the Compatibility dialog . The Compatibility dialog enables you to set additional parameters to enhance compatibility with applications: <figure><graphic fileref="InstallFirebirdExpressWin32/frbconf09.png" /></figure> <itemizedlist mark="bullet" spacing="compact"><listitem> <emphasis>Disable Autocommit</emphasis> - Change the default commit behaviour of the OpenLink Lite Driver. The default mode is AutoCommit mode (box unchecked). </listitem> <listitem> <emphasis>Disable Rowset Size Limit</emphasis> - Disable the limitation enforced by the cursor library. The limitation is enforced by default to prevent the Driver claiming all available memory in the event that a resultset is generated from an erroneous query is very large. The limit is normally never reached. </listitem> <listitem> <emphasis>Multiple Active Statements Emulation</emphasis> - Enables use of Multiple Active statements in an ODBC application even if the underlying database does not allow this, as it is emulated in the driver. </listitem> <listitem> <emphasis>SQL_DBMS Name</emphasis> - Manually overrides the SQLGetInfo(SQL_DBMS_NAME) response returned by the driver. This is required for products like Microsoft InfoPath for which the return the value should be "SQL Server." </listitem> </itemizedlist></listitem> <listitem> Click on the <emphasis>Test Data Source</emphasis> button to verify that a successful connection can be made to the database. <figure><graphic fileref="InstallFirebirdExpressWin32/frbconf10.png" /></figure></listitem> </orderedlist><bridgehead class="">Next...</bridgehead> <itemizedlist mark="bullet" spacing="compact"><listitem> <ulink url="TestingWindowsODBCDSNs">Test your DSNs with our sample program</ulink>. </listitem> <listitem> If anything isn't working as you expect, including errors resulting from the test above, <ulink url="UDATroubleshootingResources">see our Troubleshooting Resources</ulink>. </listitem> <listitem> 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 <emphasis>OpenLink License Manager</emphasis> technology: <ulink url="UDALicenseApplication">License Technology & Application</ulink>.</listitem> </itemizedlist></section></docbook>