4.1. OpenLink ODBC Driver for Firebird (Express Edition) for Mac OS X

4.1.1. Installation Guide

The OpenLink ODBC Driver for Firebird (Express Edition) is distributed as a Disk image (DMG) file. Simply double click on the disk image 'mul6efrb.dmg' to extract the installer mpkg file:

Figure 4.1. ee-frb-00.png

ee-frb-00.png

Double click on the mpkg file to run the installer and following the on screen instriuction as indicated below to complete the installation:

Figure 4.2. ee-frb-01.png

ee-frb-01.png

Installer Welcome Dialog for the OpenLink ODBC Driver for Firebird (Express Edition):

Figure 4.3. ee-frb-02.png

ee-frb-02.png

Please review the readme file for installation requirements and known issues:

Figure 4.4. ee-frb-03.png

ee-frb-03.png

Please read the software license agreement before continuing your installation:

Figure 4.5. ee-frb-04.png

ee-frb-04.png

Select destination volume for driver installation:

Figure 4.6. ee-frb-05.png

ee-frb-05.png

Choose to perform a custome or default installation of the driver:

Figure 4.7. ee-frb-06.png

ee-frb-06.png

If you chose the custom option select which of the components below are to be installed:

Figure 4.8. ee-frb-07.png

ee-frb-07.png

The Software must be installed as a user with Administrative privileges on the machine:

Figure 4.9. ee-frb-08.png

ee-frb-08.png

After the driver has been installed you will be prompted for a license file. If a license file already exists on the machine then select the 'use exisiting file' option. A trial (try) or full (buy) license can be obtain by selecting the 'try and buy' option which loads our online try and buy web page:

Figure 4.10. ee-frb-09.png

ee-frb-09.png

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 purchases a full license if required:

Figure 4.11. ee-frb-10.png

ee-frb-10.png

Click on the 'download license' button to obtain the license file immediately and save to your desktop. Alternatively an auto e-mail will be sent to the registered users e-mail address with a link to their OpenLink Data Space (ODS) where all trial and full license files will be stored in the Briefcase for download at a later date.

Figure 4.12. ee-frb-11.png

ee-frb-11.png

Select the license file to be used for the installation:

Figure 4.13. ee-frb-12.png

ee-frb-12.png

Installation is complete:

Figure 4.14. ee-frb-13.png

ee-frb-13.png

4.1.2. Configuration

To configure an ODBC DSN, run the OpenLink iODBC Administrator located in the /Applications/iODBC folder:

Figure 4.15. ee-frb-14.png

ee-frb-14.png

Click on the add button to Choose the ODBC Driver the DSN should be created for:

Figure 4.16. ee-frb-15.png

ee-frb-15.png

Choose the OpenLink Firebird Driver (Express Edition) v6.0 from the list of available drivers:

Figure 4.17. ee-frb-16.png

ee-frb-16.png

In the Data Source tab, select a suitable DSN name and optional description for the Data Source to be created:

Figure 4.18. ee-frb-17.png

ee-frb-17.png

The Connection Tab request the minimum paramters required to make a connection to the target database:

Figure 4.19. ee-frb-18.png

ee-frb-18.png

  • Hostname - the hostname of the server on which Firebird is running

  • PortName - the port on whcih the Firebird instance listens

  • Database - the name of a valid database

  • Username - the name of a valid Firebird user

  • Advanced - additional optional configuration parameters:

Table 4.1. 

BlobBufferLength Set BLOB buffer length. This value influences the performance when working with BLOB fields.
BlobBufferSize Size of the BLOB buffer in bytes.
BuffersNumber Number of cache buffers that should be allocated for this connection, should be specified for ClassicServer instances; SuperServer has a server-wide configuration parameter.
DefaultIsolation Set the default transaction isolation level as string. Following strings are allowed: 'TRANSACTION_READ_COMMITTED', 'TRANSACTION_REPEATABLE_READ', 'TRANSACTION_SERIALIZABLE'
Encoding Set encoding for connections produced by this data source.
LoginTimeout Set login timeout for this datasource in seconds.
RoleName SQL role to use.
SocketBufferSize The socket buffer-size in bytes.
SqlDialect SQL dialect of the client.
TimestampUsesLocalTimezone 'true' if the JayBird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
UseStandardUdf 'true' if driver should assume that standard UDFs are installed.
UseStreamBlobs 'true' if stream blobs should be created, otherwise 'false'
UseTranslation Path to the character translation table.
CharSet Character set for the connection. Similar to encoding property, but accepts Java names instead of Firebird ones.

As indiacted above the paramters of the options and preferences tabs are not required for a basic connection:

Figure 4.20. ee-frb-19.png

ee-frb-19.png

  • Row Buffer Size - 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.

  • Hide Login Dialog - Suppress the ODBC "Username" and "Password" login dialog box when interacting with your ODBC DSN from within an ODBC compliant application.

  • Read Only connection - Specify whether the connection is to be read-only. Make sure the checkbox is unchecked to request a read/write connection.

  • Drop Catalog from meta-calls - Enable this option to have the catalog name not appear for tables, views and procedures when requesting database meta-data.

  • Drop Schema from meta calls - Enable this option to have the schema-name not appear for tables, views and procedures when requesting database meta-data.

  • SQLStatistics disabled - Check this box to have SQLStatistics() return an empty resultset. Use this if the underlying database does not support retrieving statistics about a table (e.g. what indexes there are on it).

  • No support of quoted identifier - If it is set, the call SQLGetInfo for 'SQL_IDENTIFIER_QUOTE_CHAR' will return the space (" "). It can be used if DBMS doesn't support quoted SQL like select * from "account"

  • No support of search string escape - If it is set, the call SQLGetInfo for 'SQL_LIKE_ESCAPE_CLAUSE' will return the space (" "). It can be used if DBMS doesn't support SQL escape patterns

  • Patch of NULL size of SQL_CHAR - 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 the default value of 0 the driver uses the size returned by the database.

  • SQL_DBMS Name - Manually override the SQLGetInfo(SQL_DBMS_NAME) response returned by the driver. This is know to be required for products like Microsoft InfoPath for which the return the value should be "SQL Server".

Figure 4.21. ee-frb-20.png

ee-frb-20.png

  • Initialization SQL - Lets you specify a file containing SQL statements that will be run against the database upon connection, automatically.

  • 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.

  • MaxRows Override - Allows you to define a limit on the maximum number of rows to returned from a query. The default value of 0 means no limit.

  • Disable AutoCommit - Change the default commit behaviour of the OpenLink Lite Driver. The default mode is AutoCommit mode (box unchecked).

  • Disable Rowset Size Limit - 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.

  • Defer fetching of long data - Defer fetching of LONG (BINARY, BLOB etc.) data unless explicitly requested in query. This provides significant performance increase when fields in query does not include LONG data fields.

  • Multiple Active Statements Emulation - 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.

Click on the 'Test Data Source' button to make a connection to the database to verify connectivity:

Figure 4.22. ee-frb-21.png

ee-frb-21.png

Enter a vaild username and pasword for the database:

Figure 4.23. ee-frb-22.png

ee-frb-22.png

A successful connection to the database has been made:

Figure 4.24. ee-frb-23.png

ee-frb-23.png