How To Install and Configure the Multi-Tier Edition JDBC Drivers for PostgreSQL (macOS)

Server Components

Installation (Request Broker and Database Agent)


There are no Server Components to Install

Non-Advanced Users should proceed to the Client Components installation and configuration guides
  1. To configure an ODBC DSN, run the OpenLink iODBC Administrator located in the /Applications/iODBC folder:
  2. Click the System DSN tab.
  3. Click the Add button.
  4. Then, select the OpenLink PostgreSQL Lite Driver from the list of available drivers.
  5. 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.
  6. Click Finish.
  7. The Data Source tab prompts for information that identifies the PostgreSQL database server and listen port. It also requests a name for your Data Source. You may also supply an optional description for your Data Source Name.
    • DSN: A brief and meaningful title for your Data Source Name
    • Description: An optional description for your Data Source Name
    • Hostname: The hostname or IP of the server on which PostgreSQL runs
    • Port number: The TCP port on which PostgreSQL listens
  8. Press Continue once your data source details have been added.
  9. The Connection Tab takes a combination of required and optional parameters to make a connection to the target database:
    • Username: A PostgreSQL username
    • 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: Suppresses the ODBC "Username" and "Password" login dialog boxes when interacting with your ODBC DSN from within an ODBC compliant application.
    • Read Only connection: Specifies whether the connection is "Read-only." Make sure the checkbox is unchecked to request a "Read/Write" connection.
    • Database: A valid PostgreSQL database
    • 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 return value should be "SQL Server".
  10. Click Continue once your connection parameters have been set.
  11. Click Continue to view additional preferences that can be set for the connection.
    • Initialization SQL: Lets you specify a file containing SQL statements that will be run automatically against the database upon connection.
    • Cursor Sensitivity: Enables or disables the row version cache used with dynamic cursors.
    • Max Rows Override: 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.
    • Show remarks: Affects output from the SQLColumns() ODBC API call.
    • Disable autocommit: Changes the default commit behavior of the OpenLink driver. The default mode is AutoCommit (box unchecked).
    • Disable rowset size limit: Removes OpenLink's default 100 rowset restriction.
    • Defer fetching of long data: Defers fetching of LONG (BINARY, BLOB, etc.) data unless explicitly requested in a query. This provides significant performance increases when fields in the query do not include LONG data fields.
    • Always include VIEWS in table list:
    • Always include all types in table list:
    • Custom Catalogue Views: Dictates whether custom OpenLink views are used to return metadata for certain ODBC catalog functions: SQLForeignKeys(), SQLPrimaryKeys(), SQLProcedureColumns(), SQLProcedures(), and SQLSpecialColumns(). These custom views provide more metadata than is normally provided by the standard Oracle data dictionary views.
    • User's own tables first in SQLTables: This option is specific to OpenLink's Oracle drivers. It prompts the SQLTables() ODBC API call to display the connected user's tables first in table lists. The default ordering is alphabetical.
    • Count stored procedure parameters in SQL Procedures: This parameter is specific to the Oracle data source. It affects the output from SQLProcedures() when "Custom Catalog Views" is enabled.
  12. Click the Finish button to save your new Data Source Name.

Client Components

Installation

  1. Download the OpenLink Generic JDBC Driver for macOS, which comes in a .dmg file.
  2. Double-click the .dmg file to start the installation process.
  3. Confirm the warning message to proceed with the installation.
  4. Read and accept the License Agreement for the OpenLink Generic JDBC Driver.
  5. Choose the destination volume for the installation (typically your macOS boot volume).
  6. Select the installation type:
    • Easy Install (recommended).
    • Custom Install (for experienced users who want to choose specific components).
      • If you have installed OpenLink or iODBC components in the past, select "Upgrade" to continue. Otherwise, click "Install."
  7. If you chose the custom installation option, select the desired components to install.
    • Click Next.
    • Enter your macOS Username and Password when prompted to complete the installation.
  8. After installation, your database driver is ready for use.
  9. For configuring the OpenLink Generic JDBC Driver, use the following parameters in the Connection URL:
    • Driver Name: opljdbc3.jar, megathin3.jar
    • Driver Class Name: openlink.jdbc3.Driver
    • Connection URL: jdbc:openlink://<Hostname>:[portnumber] [/UID] [/PWD] [/READONLY] [/SVT] [/APPLICATION] [/FBS|FETCHBUFFERSIZE] [/ENCRYPTED] [/CHARSET] [/UNICODE] [/DLF] [/DATABASE] [/OPTIONS] [/DRIVER]
      • Description of Parameters:
      • Hostname: Network Alias or IP address of the machine running the OpenLink Request Broker instance.
      • Port Number: TCP port on which the Request Broker listens.
      • /UID: Database username.
      • /PWD: Database password.
      • /READONLY: Read-write or read-only session mode.
      • /SVT: A valid domain alias from the [Domain Aliases] section of the OpenLink server component's oplrqb.ini file. Default domain aliases represent the type of database agent to which the application intends to connect.
      • /APPLICATION: The Application name to enable connectivity when restrictive server-side rules screen by application name.
      • /FBS (or /FETCHBUFFERSIZE): The Fetch Buffer Size representing the number of rows to return during one fetch operation.
      • /ENCRYPTED: Sets the Encrypted flag for outgoing packets. ('1', '0', 'Y', 'N', 'y', or 'n'. Disabled by default.)
      • /CHARSET: Specifies the charset of remote databases. Default value is read from System.getProperty("file.encoding").
      • /UNICODE: Instantiates unicode. The unicode connection isn't used by default. ('1', '0', 'Y', 'N', 'y', or 'n'. Disabled by default.)
      • /DLF: Pushes large, binary objects to the end of the resultset. Smaller data types are retrieved first, enhancing performance. ('1', '0', 'Y', 'N', 'y', or 'n'. Disabled by default.)
      • /DATABASE: Actual database name within a particular database environment.
      • /OPTIONS: Optional parameter to pass specialized database native client connection parameters.
      • /DRIVER: The Driver name contained in curly brackets ({}). Used for DSN-Less connections to remote ODBC Drivers.
  10. Examples of Connection URLs:
    • jdbc:openlink://localhost:5000/SVT=Ingres II/DATABASE=iidbdb/UID=ingres/PWD=ingres
    • jdbc:openlink://192.128.13.119:5000/SVT=Oracle 8.1.x/DATABASE=ORCL/UID=scott/PWD=tiger
    • jdbc:openlink://saturn:5000/SVT=Progress 91D/DATABASE=isports/OPTIONS=-S isports -N tcp -H saturn
    • jdbc:openlink://localhost:5000/SVT=SQLServer 2000/DATABASE=Northwind/UID=sa/OPTIONS=-S SATURN

Configuration

  1. The OpenLink installer should set your CLASSPATH. You should have a pre-existing JAVA_HOME directory that points to the root of your JAVA installation. No further configuration should be needed.
  2. Driver Name: opljdbc3.jar, megathin3.jar
  3. Driver Class Name: openlink.jdbc3.Driver
  4. Connection URL: jdbc:openlink://<Hostname>:[portnumber] [/UID] [/PWD] [/READONLY] [/SVT] [/APPLICATION] [/FBS|FETCHBUFFERSIZE] [/ENCRYPTED] [/CHARSET] [/UNICODE] [/DLF] [/DATABASE] [/OPTIONS] [/DRIVER]
    • Hostname - Network Alias or IP address of the machine that runs an OpenLink Request Broker instance.
    • Port Number - TCP port on which the Request Broker listens.
    • /UID - Database username.
    • /PWD - Database password.
    • /READONLY - Read-write or read-only session mode.
    • /SVT - A valid domain alias from the [Domain Aliases] section of the OpenLink server component's oplrqb.ini file. Default domain aliases represent the type of database agent to which the application intends to connect, e.g., DB2, Informix 2000, Oracle 8.1.x. Custom aliases may take any form.
    • /APPLICATION - The Application name. Enables connectivity when restrictive server-side rules screen by application name.
    • /FBS (or /FETCHBUFFERSIZE) - The Fetch Buffer Size. The Fetch Buffer Size is an integer that represents the number of rows to return during one fetch operation.
    • /ENCRYPTED - Sets the Encrypted flag for outgoing packets. /ENCRYPTED may pass '1', '0', 'Y', 'N', 'y', or 'n'. (This feature is disabled by default.)
    • /CHARSET - Specifies the charset of remote databases. The default value is read from System.getProperty("file.encoding").
    • /UNICODE - Instantiates unicode. The unicode connection isn't used by default. The value may be '1', '0', 'Y', 'N', 'y', 'n' (This feature is disabled by default.)
    • /DLF - Pushes large, binary objects to the end of the result set. Smaller data types are retrieved first. This enhances performance. /DLF may be set to '1', '0', 'Y', 'N', 'y', or 'n'. (This feature is disabled by default.)
    • /DATABASE - Actual database name within a particular database environment.
    • /OPTIONS - Optional parameter that passes specialized database native client connection parameters. Do not use this parameter unless you need to pass Progress socket parameters or database native client parameters that enable a local OpenLink database agent to locate a remote database. Example parameters would be Oracle Net10 Service Names, Ingres vnodes, remote Informix instance names, or DB2 remote database aliases.
    • /DRIVER - The Driver name contained in curly brackets ({}). Used for DSN-Less connections to remote ODBC Drivers.
  5. Examples of Connection URLs:
    • jdbc:openlink://localhost:5000/SVT=Ingres II/DATABASE=iidbdb/UID=ingres/PWD=ingres
    • jdbc:openlink://192.128.13.119:5000/SVT=Oracle 8.1.x/DATABASE=ORCL/UID=scott/PWD=tiger
    • jdbc:openlink://saturn:5000/SVT=Progress 91D/DATABASE=isports/OPTIONS=-S isports -N tcp -H saturn
    • jdbc:openlink://localhost:5000/SVT=SQLServer 2000/DATABASE=Northwind/UID=sa/OPTIONS=-S SATURN