7.1. OpenLink ODBC Driver for MySQL (Express Edition) for Mac OS X

7.1.1.  Installation Guide

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

Figure 7.1. ee-mys-00.png

ee-mys-00.png

Double-click on the mpkg file to run the installer. Follow the on-screen instructions as indicated below to complete the installation:

Figure 7.2. ee-mys-01.png

ee-mys-01.png

When prompted, permit the verification script to run. This simply checks to see that you are running a version of Mac OS X later than 10.3.0:

Figure 7.3. ee-mys-02.png

ee-mys-02.png

Review the Welcome message to confirm you're installing the right driver:

Figure 7.4. ee-mys-03.png

ee-mys-03.png

Review the ReadMe for installation requirements and any known issues:

Figure 7.5. ee-mys-04.png

ee-mys-04.png

Please read and agree to the Software License Agreement before continuing your installation:

Figure 7.6. ee-mys-05.png

ee-mys-05.png

Figure 7.7. ee-mys-06.png

ee-mys-06.png

Select the destination volume for driver installation:

Figure 7.8. ee-mys-07.png

ee-mys-07.png

Accept the default installation of the driver, or click Customize to select specific components for installation:

Figure 7.9. ee-mys-08.png

ee-mys-08.png

Select the components to be installed, or click Easy Install to return to the default:

Figure 7.10. ee-mys-09.png

ee-mys-09.png

The Software must be installed as a user with Administrative privileges on the machine. When prompted, provide a relevant username and password:

Figure 7.11. ee-mys-10.png

ee-mys-10.png

Installation will proceed.

Figure 7.12. ee-mys-11.png

ee-mys-11.png

During installation, you will be prompted to select a license file for the driver. If such a license file already exists on the machine, then select the 'use existing file' option.

Figure 7.13. ee-mys-15.png

ee-mys-15.png

If you accidentally clicked this option, you can cancel out of the selection dialog. As the following alert will explain, you can manually apply the license file at any point in the future:

Figure 7.14. ee-mys-16.png

ee-mys-16.png

A trial or permanent license may be obtained by selecting the Try and Buy option which loads our online try and buy web page:

Figure 7.15. ee-mys-12.png

ee-mys-12.png

A permanent license may be obtained by clicking on the 'Shop' link to visit our online store, or you may obtain a trial license by registering with and logging in to the OpenLink Web site:

Figure 7.16. ee-mys-13.png

ee-mys-13.png

Click on the 'Download License' button to immediately obtain an evaluation license file; it will be saved to your Browser's download folder (which typically defaults to your desktop). A message will also be sent to your email address with a link to your OpenLink Data Space (ODS) Briefcase, where all non-expired trial and full license files will be stored for download at your convenience.

Figure 7.17. ee-mys-14.png

ee-mys-14.png

Close the browser, and proceed as if you had selected the option to use existing file. Select the license file to be used for the installation:

Figure 7.18. ee-mys-15.png

ee-mys-15.png

Installation is now complete, and you can exit the Installer and proceed to configure a DSN:

Figure 7.19. ee-mys-17.png

ee-mys-17.png

7.1.2.  Configuration

To configure an ODBC DSN, double-click the OpenLink ODBC Administrator.app located in /Applications/Utilities/, or the iODBC Administrator.app located in /Applications/iODBC/:

Figure 7.20. ee-mys-18.png

ee-mys-18.png

Figure 7.21. ee-mys-19.png

ee-mys-19.png

Click on the Add button, to create a new DSN (Data Source Name):

Figure 7.22. ee-mys-20.png

ee-mys-20.png

Choose the OpenLink MySQL Driver (Express Edition) v6.0 from the list of available drivers. Choose the OpenLink MySQL Driver (Express Edition)(Unicode) v6.0 if and only if you are working with multi-byte character sets, as unnecessary translations can significantly ODBC performance:

Figure 7.23. ee-mys-21.png

ee-mys-21.png

In the Data Source tab, enter a suitable name and optional description for the DSN being created:

Figure 7.24. ee-mys-22.png

ee-mys-22.png

The Connection tab requests the minimum parameters required to make a connection to the target database:

  • Host - the name of the server on which the target MySQL instance is running

  • Port - the port at which the target MySQL instance is listening (default 3306)

  • Database - the name of a valid database on the target MySQL instance

  • Username - a valid MySQL username

Figure 7.25. ee-mys-23.png

ee-mys-23.png

If desired, click the Advanced button to set additional parameters relevant to the MySQL connection. None of these need be changed for a basic connection:

Table 7.1. 

SocketFactoryClassName The name of the class that the driver should use for creating socket connections to the server. This class must implement the interface 'com.mysql.jdbc.SocketFactory' and have public no-args constructor.
ConnectTimeout Timeout for socket connect (in milliseconds), with 0 being no timeout.
SocketTimeout Timeout on network socket operations (0, the default means no timeout).
IsInteractiveClient Set the CLIENT_INTERACTIVE flag, which tells MySQL to timeout connections based on INTERACTIVE_TIMEOUT instead of WAIT_TIMEOUT
UseCompression Use zlib compression when communicating with the server (true/false)?
AllowMultiQueries Allow the use of ';' to delimit multiple queries during one statement (true/false).
UseSSL Use SSL when communicating with the server (true/false); defaults to 'false'.
RequireSSL Require SSL connection if useSSL=true?
AllowUrlInLocalInfile Should the driver allow URLs in 'LOAD DATA LOCAL INFILE' statements?
Paranoid Take measures to prevent exposure sensitive information in error messages and clear data structures holding sensitive data when possible?
MetadataCacheSize The number of queries to cacheResultSetMetadata for if cacheResultSetMetaData is set to 'true'
BlobSendChunkSize Chunk to use when sending BLOB/CLOBs via ServerPreparedStatements
CacheServerConfiguration Should the driver cache the results of 'SHOW VARIABLES' and 'SHOW COLLATION' on a per-URL basis?
ElideSetAutoCommits If using MySQL-4.1 or newer, should the driver only issue 'set autocommit=n' queries when the server's state doesn't match the requested state by Connection.setAutoCommit(boolean)?
UseReadAheadInput Use newer, optimized non-blocking, buffered input stream when reading from the server?
UseUnicode Should the driver use Unicode character encodings when handling strings? Should only be used when the driver can't determine the character set mapping, or you are trying to 'force' the driver to use a character set that MySQL either doesn't natively support (such as UTF-8), true/false.
CharacterEncoding If 'useUnicode' is set to true, what character encoding should the driver use when dealing with strings? (defaults is to 'autodetect')
CharacterSetResults Character set to tell the server to return results as.
ConnectionCollation If set, tells the server to use this collation via 'set collation_connection'
SessionVariables A comma-separated list of name/value pairs to be sent as SET SESSION ... to the server when the driver connects.

Figure 7.26. ee-mys-24.png

ee-mys-24.png

As suggested above, the parameters of the Options and Preferences tabs need not be changed for a basic connection:

Figure 7.27. ee-mys-25.png

ee-mys-25.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 such as 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 7.28. ee-mys-26.png

    ee-mys-26.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 Express Edition 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 7.29. ee-mys-27.png

ee-mys-27.png

Enter a valid username and password for the target database:

Figure 7.30. ee-mys-28.png

ee-mys-28.png

A successful connection to the database has been made:

Figure 7.31. ee-mys-29.png

ee-mys-29.png