Installation and Configuration of Single-Tier "Lite" Edition ODBC Driver for Microsoft SQL Server for Unix
Review Pre-installation Documentation: Pre-Installation Requirements for Microsoft SQL Server Single-Tier Drivers (Unix)
Installation
- Log in to your Unix or Linux client machine.
- cd into the installation directory.
- The installation files ship as an installation shell script, a driver and admin .taz file, and a license .lic file.
The installation shell script should be ftp'd in ascii.
The rest of the files should be ftp'd in binary, where applicable.
- Run the following command to start the installation
sh install.sh
- If you have a pre-existing installation running on the machine, you will be presented with the following options.
- You must choose a TCP port on which to run your HTTP-based iODBC Data Sources Administrator.
The default is 8000.
You will need to know this port number and your local machine's IP address or hostname to access your Admistrator in a Web browser.
This is how you call it
http://hostname.or.ip.address:portnumber/
- This enables you to name your administrator's log file.
It is best to go with the default.
- You can choose to log all requests.
This is not diagnostic-level odbc tracing or connection logging.
The default is no.
- You can change the iODBC Data Source Administrator's default username from "admin." This is the name that you will need to login to
OpenLink's HTTP-based iODBC Data Sources Administrator.
- You can change the iODBC Data Source Administrator's default password from "admin."
- The installation is complete.
Configuration
Jump to manual configuration docs: Manually Configure SQL Server Connectivity
- Execute the bash command to open a bash shell.
If you do not have have the bash shell, substitute the sh command for the bash command.
This will open the bourne shell.
- Run the following command to set your ODBC environment variables.
This should also automatically start the OpenLink License Manager.
. ./openlink.sh
- cd into the bin sub-directory of your
OpenLink installation.
- Use the ls command to display your files.
- Run the following command to start your HTTP-based iODBC Data Sources Administrator
./iodbc-admin-httpd.sh start
- Open a Web browser on any computer and type the URL for your administrator in the address bar.
- Click the Client Components Administration link in the left hand side navigation bar.
- Click the Configure ODBC Data Sources link in the left hand side navigation bar.
- Then, login with your username and password.
- Click the Add button.
- Click the
OpenLink SQL Server Lite Driver (multi-threaded). Then, click Create DSN.
- Provide a descriptive name and optional description for your DSN.
Then, click Next.
- Pass the following values in the next dialog:
- Database Name - A valid SQL Server database name
- Username - SQL Server login
- Connection Options - The following Connection Options can be passed to the driver
- -H <FQDN> - Fully-qualified domain name (i.e., DNS-resolvable hostname) or IP address of the SQL Server host machine.
Overrides TDSHOST in $OPENLINKINI.
- -P <port number> - TCP Port at which the target SQL Server instance is listening.
Overrides TDSPORT in $OPENLINKINI.
- -V <version> - The TDS version appropriate to the target SQL Server.
Overrides TDSVER in $OPENLINKINI.
- -I <instance> - SQL Server instance name on the specified host machine (-H).
This flag should be used in preference to the "-S" flag above when connecting to a SQL Server named instance.
Overrides DSQUERY in $OPENLINKINI.
- -S <server-name> - Not recommended.
-H and -I are preferred. Specifies a target SQL Server instance by combining the host and instance names as "<FQDN>\\<instance>", e.g., "sql-host.example.com\\demo-instance".
Note the double backslash (\\) between the
SQLServerName and InstanceName.
- -F <fail-over server name> - Specify Failover server name for Database Mirroring
- -N <size> - Network Packet size, which is a value that determines the number of bytes per network packet transferred from the database server to the client.
The correct setting of this attribute can improve performance.
When set to 0, the initial default, the driver uses the default packet size as specified in the Sybase server configuration.
When set to -1, the driver computes the maximum allowable packet size on the first connect to the data source and saves the value in the system information.
- -O <value> Prepared Method, which is a value that determines whether stored procedures are created on the server for every call to SQLPrepare.
When set to Full (2), stored procedures are created for every call to SQLPrepare, which can decrease performance when processing static statements.
When set to Partial(1), the initial default, the driver creates stored procedures only if the statement contains parameters.
Otherwise, the statement is cached and executed directly at SQLExecute time.
When set to None (0), the driver never creates stored procedures.
- -L <language> - The name of a Microsoft SQL Server supported national language.
The default language is English.
- -C <character set> - The name of an installed character set on the server.
By default it is the setting on the Microsoft SQL Server.
- -A - Turn Off ANSI NULL handling
- -E - Turn On SSL Strong Data Encryption
- -R - Turn On SSL Server Certificate Verification
- -D <filename> - Specify Name of Certificate Authority file to be used for SSL Certificate Verification
- -Z - Turn On Snapshot Serializable Isolation
- -M - Turn On Multiple Active Result Sets (MARS)
- -H <FQDN> - Fully-qualified domain name (i.e., DNS-resolvable hostname) or IP address of the SQL Server host machine.
Overrides TDSHOST in $OPENLINKINI.
- Database Name - A valid SQL Server database name
- Click Next.
- Set the following variables on the next dialog:
- Existing Environment - This arbitrary heading for a collection of DBMS-related environment variables usually corresponds with the DBMS version
- New Environment - You can choose a new heading.
- FREETDSCONF - The full path to the fallback freetds.conf file installed with our drivers.
- DSQUERY - SQL Server instance name.
Overridden by -I flag value in DSN Options.
- TDSHOST - SQL Server database server hostname or IP address.
Overridden by -H or -S flag value in DSN Options.
- TDSPORT - SQL Server listen port.
Overridden by -P flag value in DSN Options.
- TDSVER - The TDS version appropriate to the target SQL Server.
Overridden by -V flag value in DSN Options.
- SQLSERVER_CATALOG -
- 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.
- Existing Environment - This arbitrary heading for a collection of DBMS-related environment variables usually corresponds with the DBMS version
- Click Next.
- You can set the following, optional values on the fourth dialog:
- Read-only connection - Specifies whether the connection is "Read-only." Make sure the checkbox is unchecked to request a "Read/Write" connection.
- 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 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.
- Jet fix - This option facilitates translation of certain datatypes by the Microsoft Jet Engine.
If you utilize MS applications, and you notice that money and other datatypes are mishandled, test with Jet fix enabled.
- No
AutoCommit - Changes the default commit behaviour of the OpenLink driver. The default mode is AutoCommit (box unchecked).
- No
RowSetSize limit - Disables a limitation enforced by the cursor library. This limitation is enforced by default. It prevents the driver from claiming all available memory in the event that a resultset generated from an erroneous query is very large. The limit is normally never reached.
- Read-only connection - Specifies whether the connection is "Read-only." Make sure the checkbox is unchecked to request a "Read/Write" connection.
- Click Next.
- Additional, optional parameters appear on the fifth, and final dialog:
- 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.
- Max Rows - 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.
- 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 the value should be "SQL Server".
- Initial SQL - Lets you specify a file containing SQL statements that will be run automatically against the database upon connection.
- 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.
- Click Next.
- Your new DSN is highlighted and persisted on the the Data Sources tab.
Click the Test tab.
- Type your password in the password field and click test.
- You have established a connection.
Proceed to Commercial Licensing Documentation
If you 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
Referenced by...