Simba SQL Server ODBC Install and Configuration Guide
Simba SQL Server ODBC Install and Configuration Guide
Version 1.3.13
September 27, 2017
Installation and Configuration Guide
www.simba.com 2
Installation and Configuration Guide
Purpose
The Simba SQL Server ODBC Driver Installation and Configuration Guide explains
how to install and configure the Simba SQL Server ODBC Driver. The guide also
provides details related to features of the driver.
Audience
The guide is intended for end users of the Simba SQL Server ODBC Driver, as well as
administrators and developers integrating the driver.
Knowledge Prerequisites
To use the Simba SQL Server ODBC Driver, the following knowledge is helpful:
l Familiarity with the platform on which you are using the Simba SQL Server
ODBC Driver
l Ability to use the data source to which the Simba SQL Server ODBC Driver is
connecting
l An understanding of the role of ODBC technologies and driver managers in
connecting to a data source
l Experience creating and configuring ODBC connections
l Exposure to SQL
Document Conventions
Italics are used when referring to book and document titles.
Bold is used in procedures for graphical user interface elements that a user clicks and
text that a user types.
Monospace font indicates commands, source code, or contents of text files.
Note:
A text box with a pencil icon indicates a short note appended to a paragraph.
www.simba.com 3
Installation and Configuration Guide
Important:
A text box with an exclamation mark indicates an important comment related to the
preceding paragraph.
www.simba.com 4
Installation and Configuration Guide
Table of Contents
Windows Driver 8
Windows System Requirements 8
Installing the Driver on Windows 8
Creating a Data Source Name on Windows 9
Configuring Logging Options on Windows 11
Verifying the Driver Version Number on Windows 15
macOS Driver 16
macOS System Requirements 16
Installing the Driver on macOS 16
Verifying the Driver Version Number on macOS 17
Linux Driver 18
Linux System Requirements 18
Installing the Driver Using the Tarball Package 18
Features 38
Data Types 38
Security and Authentication 40
www.simba.com 5
Installation and Configuration Guide
Third-Party Trademarks 53
Third-Party Licenses 54
www.simba.com 6
Installation and Configuration Guide About the Simba SQL Server ODBC Driver
Note:
For information about how to use the driver in various BI tools, see the Simba
ODBC Drivers Quick Start Guide for Windows: http://cdn.simba.com/docs/ODBC_
QuickstartGuide/content/quick_start/intro.htm.
www.simba.com 7
Installation and Configuration Guide Windows Driver
Windows Driver
www.simba.com 8
Installation and Configuration Guide Windows Driver
Note:
Make sure to select the ODBC Data Source Administrator that has the same
bitness as the client application that you are using to connect to SQL Server.
2. In the ODBC Data Source Administrator, click the Drivers tab, and then scroll
down as needed to confirm that the Simba SQL Server ODBC Driver appears in
the alphabetical list of ODBC drivers that are installed on your system.
3. Choose one:
l To create a DSN that only the user currently logged into Windows can use,
Note:
It is recommended that you create a System DSN instead of a User DSN.
Some applications load the data using a different user account, and might
not be able to detect User DSNs that are created under another user
account.
4. Click Add.
www.simba.com 9
Installation and Configuration Guide Windows Driver
5. In the Create New Data Source dialog box, select Simba SQL Server ODBC
Driver and then click Finish. The Simba SQL Server ODBC Driver DSN Setup
dialog box opens.
6. In the Data Source Name field, type a name for your DSN.
7. Optionally, in the Description field, type relevant details about the DSN.
8. In the Server field, type the name or IP address of the host where your SQL
Server instance is running.
Note:
You can specify the name of the SQL Server instance by using the syntax
[ServerInfo]\[Instance], where [ServerInfo] is the IP address or host name of
the server and [Instance] is the name of the instance.
9. In the Port field, type the number of the TCP port that the server uses to listen for
client connections.
Note:
The default port used by SQL Server is 1433.
10. In the Database field, type the name of the database that you want to access.
11. To use TLS to encrypt all communication with the SQL Server instance before
sending it over the network, select the Encrypt check box and then do one of the
following:
l To enable one-way authentication so that the driver verifies the server
Connection check box. Optionally, in the Server SPN field, type the
service principal name of your SQL Server instance. If you leave the field
empty, then the driver uses MSSQLSvc/[HostName]:[Port] as the service
principal name, where [HostName] is the IP address or host name of the
server and [Port] is the number of the port that you are connecting to.
13. To return certain SQL Server-specific data types as ODBC data types instead of
SQL Server data types, select the Return SQL Server-Specific Types as
ODBC Types check box. For a complete list of the data types that this setting
applies to, see Return SQL Server-Specific Types as ODBC Types on page 47.
www.simba.com 10
Installation and Configuration Guide Windows Driver
14. To include temporary tables in the results when calling SQLTables, select the
Enable Table Types check box.
15. To configure logging behavior for the driver, click Logging Options. For more
information, see Configuring Logging Options on Windows on page 11.
16. To test the connection, click Test. Review the results as needed, and then click
OK.
Note:
If the connection fails, then confirm that the settings in the Simba SQL Server
ODBC Driver DSN Setup dialog box are correct. Contact your SQL Server
administrator as needed.
17. To save your settings and close the Simba SQL Server ODBC Driver DSN Setup
dialog box, click OK.
18. To close the ODBC Data Source Administrator, click OK.
Important:
Only enable logging or tracing long enough to capture an issue. Logging or tracing
decreases performance and can consume a large quantity of disk space.
Driver Logging
Use driver logging to track the activity in the Simba SQL Server ODBC Driver. You can
specify the amount of detail included in the log files. The table below lists the logging
levels that are available, in order from least verbose to most verbose.
FATAL Logs severe error events that lead the driver to abort.
ERROR Logs error events that might allow the driver to continue
running.
www.simba.com 11
Installation and Configuration Guide Windows Driver
WARNING Logs events that might result in an error if action is not taken.
Note:
After the maximum number of log files is reached, each time an additional
file is created, the driver deletes the oldest log file.
6. In the Max File Size field, type the maximum size of each log file in megabytes
(MB).
Note:
After the maximum file size is reached, the driver creates a new file and
continues logging.
7. Click OK.
8. Restart your ODBC application to make sure that the new settings take effect.
The Simba SQL Server ODBC Driver produces a log file named
SqlServerODBC.log at the location you specify using the Log Path field.
www.simba.com 12
Installation and Configuration Guide Windows Driver
If you enable the UseLogPrefix connection property, the driver prefixes the log file
name with the user name associated with the connection and the process ID of the
application through which the connection is made. For more information, see
UseLogPrefix on page 51.
www.simba.com 13
Installation and Configuration Guide Windows Driver
l Or, if you are using Windows 8 or later, on the Start screen, right-click This
PC and then click Properties.
2. Click Advanced System Settings.
3. In the System Properties dialog box, click the Advanced tab and then click
Environment Variables.
4. Choose one:
l If the TDSTRACE variable already exists in the System Variables list,
click New and then in the Variable Name field type TDSTRACE.
5. In the Variable Value field, type [LoggingLevel]:[LogFilePath], where
[LoggingLevel] is the logging level indicating the amount of detail to include in
the log file and [LogFilePath] is the full path of the log file.
For example, the value 3:C:\Logs\MyWireLog.log configures the wire protocol
component to log debugging information in a file named MyWireLog.log
located in the C:\Logs folder.
6. To save your changes and close the Edit System Variable dialog box, click OK
7. Click OK to close the Environment Variables dialog box, and then click OK to
close the System Properties dialog box.
ODBC Tracing
You can use the ODBC Data Source Administrator to trace connection activity in the
ODBC layer.
www.simba.com 14
Installation and Configuration Guide Windows Driver
Note:
Make sure to select the ODBC Data Source Administrator that has the same
bitness as the client application that you are using to connect to SQL Server.
2. Click the Drivers tab and then find the Simba SQL Server ODBC Driver in the list
of ODBC drivers that are installed on your system. The version number is
displayed in the Version column.
www.simba.com 15
Installation and Configuration Guide macOS Driver
macOS Driver
Note:
By default, the driver files are installed in the
/Library/simba/sqlserver directory.
6. To accept the installation location and begin the installation, click Install.
7. When the installation completes, click Close.
8. If you received a license file through email, then copy the license file into the
/lib subfolder in the driver installation directory. You must have root privileges
when changing the contents of this folder.
For example, if you installed the driver to the default location, you would copy the
license file into the/Library/simba/sqlserver/lib folder.
www.simba.com 16
Installation and Configuration Guide macOS Driver
Next, configure the environment variables on your machine to make sure that the
ODBC driver manager can work with the driver. For more information, see Configuring
the ODBC Driver Manager on Non-Windows Machines on page 20.
The command returns information about the Simba SQL Server ODBC Driver that is
installed on your machine, including the version number.
www.simba.com 17
Installation and Configuration Guide Linux Driver
Linux Driver
o CentOS 6 or 7
o Debian 7 or 8
To install the driver, you must have root access on the machine.
To install the Simba SQL Server ODBC Driver using the tarball package:
1. Log in as the root user, and then navigate to the folder containing the tarball
package.
2. Run the following command to extract the package and install the driver:
www.simba.com 18
Installation and Configuration Guide Linux Driver
www.simba.com 19
Installation and Configuration Guide Configuring the ODBC Driver Manager on
Non-Windows Machines
macOS
If you are using a macOS machine, then set the DYLD_LIBRARY_PATH environment
variable to include the paths to the ODBC driver manager libraries. For example, if the
libraries are installed in /usr/local/lib, then run the following command to set
DYLD_LIBRARY_PATH for the current user session:
export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:/usr/local/lib
For information about setting an environment variable permanently, refer to the macOS
shell documentation.
Linux
If you are using a Linux machine, then set the LD_LIBRARY_PATH environment
variable to include the paths to the ODBC driver manager libraries. For example, if the
libraries are installed in /usr/local/lib, then run the following command to set
LD_LIBRARY_PATH for the current user session:
www.simba.com 20
Installation and Configuration Guide Configuring the ODBC Driver Manager on
Non-Windows Machines
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib
For information about setting an environment variable permanently, refer to the Linux
shell documentation.
export ODBCINI=/usr/local/odbc/odbc.ini
export ODBCINSTINI=/usr/local/odbc/odbcinst.ini
export SIMBASQLSERVERINI=/etc/simba.sqlserverodbc.ini
For unixODBC:
export ODBCINI=/usr/local/odbc/odbc.ini
export ODBCSYSINI=/usr/local/odbc
www.simba.com 21
Installation and Configuration Guide Configuring the ODBC Driver Manager on
Non-Windows Machines
export SIMBASQLSERVERINI=/etc/simba.sqlserverodbc.ini
To locate the simba.sqlserverodbc.ini file, the driver uses the following search
order:
1. If the SIMBASQLSERVERINI environment variable is defined, then the driver
searches for the file specified by the environment variable.
2. The driver searches the directory that contains the driver library files for a file
named simba.sqlserverodbc.ini.
3. The driver searches the current working directory of the application for a file
named simba.sqlserverodbc.ini.
4. The driver searches the home directory for a hidden file named
.simba.sqlserverodbc.ini (prefixed with a period).
5. The driver searches the /etc directory for a file named
simba.sqlserverodbc.ini.
www.simba.com 22
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Note:
If you are using a hidden copy of the odbc.ini file, you can remove the
period (.) from the start of the file name to make the file visible while you are
editing it.
2. In the [ODBC Data Sources] section, add a new entry by typing a name for
the DSN, an equal sign (=), and then the name of the driver.
For example, on a macOS machine:
www.simba.com 23
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Driver=/Library/simba/sqlserver/lib/libsqlserverodb
c_sbu.dylib
Driver=/opt/simba/sqlserver/lib/32/libsqlserverodbc_
sb32.so
b. set the Server property to the IP address or host name of the server, and
then set the Port property to the number of the TCP port that the server
uses to listen for client connections.
For example:
Server=192.168.222.160
Port=1500
c. Configure authentication by specifying the authentication mechanism and
your credentials. For more information, see Configuring Authentication on a
Non-Windows Machine on page 28.
d. Optionally, encrypt your connection with TLS and configure whether the
driver verifies the identity of the server. For more information, see
Configuring TLS Verification on a Non-Windows Machine on page 29.
e. Optionally, set additional key-value pairs as needed to specify other
optional connection settings. For detailed information about all the
configuration options supported by the Simba SQL Server ODBC Driver,
see Driver Configuration Options on page 42.
4. Save the odbc.ini configuration file.
www.simba.com 24
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Note:
If you are storing this file in its default location in the home directory, then
prefix the file name with a period (.) so that the file becomes hidden. If you
are storing this file in another location, then save it as a non-hidden file
(without the prefix), and make sure that the ODBCINI environment variable
specifies the location. For more information, see Specifying the Locations of
the Driver Configuration Files on page 21.
For example, the following is an odbc.ini configuration file for macOS containing a
DSN that connects to SQL Server using a user account:
As another example, the following is an odbc.ini configuration file for a 32-bit driver
on a Linux machine, containing a DSN that connects to SQL Server using a user
account:
You can now use the DSN in an application to connect to the data store.
www.simba.com 25
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Note:
If you are using a hidden copy of the odbcinst.ini file, you can remove
the period (.) from the start of the file name to make the file visible while you
are editing it.
2. In the [ODBC Drivers] section, add a new entry by typing a name for the
driver, an equal sign (=), and then Installed.
For example:
[ODBC Drivers]
Simba SQL Server ODBC Driver=Installed
3. Create a section that has the same name as the driver (as specified in the
previous step), and then specify the following configuration options as key-value
pairs in the section:
a. Set the Driver property to the full path of the driver library file that
matches the bitness of the application.
For example, on a macOS machine:
Driver=/Library/simba/sqlserver/lib/libsqlserverodb
c_sbu.dylib
Driver=/opt/simba/sqlserver/lib/32/libsqlserverodbc_
sb32.so
www.simba.com 26
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Note:
If you are storing this file in its default location in the home directory, then
prefix the file name with a period (.) so that the file becomes hidden. If you
are storing this file in another location, then save it as a non-hidden file
(without the prefix), and make sure that the ODBCINSTINI or ODBCSYSINI
environment variable specifies the location. For more information, see
Specifying the Locations of the Driver Configuration Files on page 21.
[ODBC Drivers]
Simba SQL Server ODBC Driver=Installed
[Simba SQL Server ODBC Driver]
Description=Simba SQL Server ODBC Driver
Driver=/Library/simba/sqlserver/lib/libsqlserverodbc_
sbu.dylib
As another example, the following is an odbcinst.ini configuration file for both the
32- and 64-bit drivers on Linux:
[ODBC Drivers]
Simba SQL Server ODBC Driver 32-bit=Installed
Simba SQL Server ODBC Driver 64-bit=Installed
[Simba SQL Server ODBC Driver 32-bit]
Description=Simba SQL Server ODBC Driver (32-bit)
Driver=/opt/simba/sqlserver/lib/32/libsqlserverodbc_sb32.so
[Simba SQL Server ODBC Driver 64-bit]
Description=Simba SQL Server ODBC Driver (64-bit)
Driver=/opt/simba/sqlserver/lib/64/libsqlserverodbc_sb64.so
You can now connect to your data store by providing your application with a
connection string where the Driver property is set to the driver name specified in the
odbcinst.ini file, and all the other necessary connection properties are also set.
For more information, see "DSN-less Connection String Examples" in Using a
Connection String on page 35.
www.simba.com 27
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
For instructions about configuring specific connection features, see the following:
l Configuring Authentication on a Non-Windows Machine on page 28
l Configuring TLS Verification on a Non-Windows Machine on page 29
For detailed information about all the connection properties that the driver supports,
see Driver Configuration Options on page 42.
Using Kerberos
You can authenticate the connection by using the Kerberos protocol.
www.simba.com 28
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Note:
If you do not set the ServerSPN proprety, the driver uses MSSQLSvc/
[HostName]:[Port] as the service principal name, where [HostName] is
the IP address or host name of the server and [Port] is the number of the port
that you are connecting to.
Using NTLM
If you are using the driver on a macOS machine, you can authenticate the connection
by using the NTLM protocol.
www.simba.com 29
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Important:
Only enable logging long enough to capture an issue. Logging decreases
performance and can consume a large quantity of disk space.
Driver Logging
Use driver logging to track the activity in the Simba SQL Server ODBC Driver.
www.simba.com 30
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
3. Set the LogPath key to the full path to the folder where you want to save log
files. For example:
4. Set the LogFileCount key to the maximum number of log files to keep.
Note:
After the maximum number of log files is reached, each time an additional
file is created, the driver deletes the oldest log file.
5. Set the LogFileSize key to the maximum size of each log file in megabytes
(MB).
Note:
After the maximum file size is reached, the driver creates a new file and
continues logging.
6. Optionally, to prefix the log file name with the user name and process ID
associated with the connection, set the UseLogPrefix property to 1.
7. Save the simba.sqlserverodbc.ini configuration file.
8. Restart your ODBC application to make sure that the new settings take effect.
The Simba SQL Server ODBC Driver produces a log file named
SqlServerODBC.log at the location you specify using the LogPath key.
If you set the UseLogPrefix property to 1, then each file name is prefixed with
[UserName]_[ProcessID]_, where [UserName] is the user name associated with
the connection and [ProcessID] is the process ID of the application through which the
connection is made.
www.simba.com 31
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
For example, the following setting configures the wire protocol component to log
debugging information in a file named MyWireLog.log located in the
C:\Logs folder:
TDSTRACE=3:/localhome/employee/Documents/MyWireLog.log
www.simba.com 32
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Note:
There are 32-bit and 64-bit installations of the iODBC driver manager available. If
you have only one or the other installed, then the appropriate version of iodbctest
(or iodbctestw) is available. However, if you have both 32- and 64-bit versions
installed, then you need to make sure that you are running the version from the
correct installation directory.
For more information about using the iODBC driver manager, see http://www.iodbc.org.
www.simba.com 33
Installation and Configuration Guide Configuring ODBC Connections on a Non-
Windows Machine
Note:
There are 32-bit and 64-bit installations of the unixODBC driver manager
available. If you have only one or the other installed, then the appropriate version
of isql (or iusql) is available. However, if you have both 32- and 64-bit versions
installed, then you need to make sure that you are running the version from the
correct installation directory.
For more information about using the unixODBC driver manager, see
http://www.unixodbc.org.
[DataSourceName] is the DSN that you are using for the connection.
If the connection is successful, then the SQL> prompt appears.
Note:
For information about the available options, run isql or iusql without providing a
DSN.
www.simba.com 34
Installation and Configuration Guide Using a Connection String
DSN=[DataSourceName]
[DataSourceName] is the DSN that you are using for the connection.
You can set additional configuration options by appending key-value pairs to the
connection string. Configuration options that are passed in using a connection string
take precedence over configuration options that are set in the DSN.
www.simba.com 35
Installation and Configuration Guide Using a Connection String
l [YourUserName] is the user name that you use to access the SQL Server
instance.
For example:
For example:
www.simba.com 36
Installation and Configuration Guide Using a Connection String
Integrated Security=NTLM;UID=[YourUserName];
PWD=[YourPassword];
For example:
www.simba.com 37
Installation and Configuration Guide Features
Features
For more information on the features of the Simba SQL Server ODBC Driver, see the
following:
l Data Types on page 38
l Security and Authentication on page 40
Data Types
The Simba SQL Server ODBC Driver supports many common data formats, converting
between SQL Server data types and SQL data types.
The table below lists the supported data type mappings.
BigInt SQL_BIGINT
Binary SQL_BINARY
Bit SQL_BIT
Char SQL_CHAR
Date SQL_TYPE_DATE
DateTime SQL_TYPE_TIMESTAMP
DateTime2 SQL_TYPE_TIMESTAMP
DateTimeOffset SQL_SS_TIMESTAMPOFFSET
Decimal SQL_DECIMAL
Float SQL_FLOAT
www.simba.com 38
Installation and Configuration Guide Features
GUID SQL_GUID
Image SQL_LONGVARBINARY
Int SQL_INTEGER
Money SQL_DECIMAL
NChar SQL_WCHAR
NText SQL_WLONGVARCHAR
Numeric SQL_NUMERIC
NVarChar SQL_WVARCHAR
NVarChar(Max) SQL_WVARCHAR
Real SQL_REAL
RowVersion SQL_BINARY
Note:
Before SQL Server 2008, this data
type was called Timestamp.
SmallDateTime SQL_TYPE_TIMESTAMP
SmallInt SQL_SMALLINT
SmallMoney SQL_DECIMAL
SysName SQL_WVARCHAR
www.simba.com 39
Installation and Configuration Guide Features
Text SQL_LONGVARCHAR
Time SQL_SS_TIME2
Timestamp SQL_BINARY
Note:
In SQL Server 2008 and later, this
data type is called RowVersion.
TinyInt SQL_TINYINT
VarBinary SQL_VARBINARY
VarBinary(Max) SQL_VARBINARY
VarChar SQL_VARCHAR
VarChar(Max) SQL_VARCHAR
In addition, certain SQL Server data types are exposed via custom type identifiers, as
in the native SQL Server driver:
l Geometry, Geography, and HierarchyID use custom type -151.
l XML uses custom type -152.
www.simba.com 40
Installation and Configuration Guide Features
www.simba.com 41
Installation and Configuration Guide Driver Configuration Options
www.simba.com 42
Installation and Configuration Guide Driver Configuration Options
CA Certificate
Description
The full path and file name of the CA certificate that you want to use to verify the server
certificate when TLS encryption is enabled.
For information about how to trust the server certificate instead of verifying it, see Trust
Server Certificate on page 48.
Database
Database None No
Description
The name of the SQL Server database that you want to access.
Description
This option specifies whether the driver includes temporary tables in the results when
calling SQLTables.
l Enabled (yes, true, or 1): The driver includes temporary tables.
l Disabled (no, false, or 0): The driver does not include temporary tables.
www.simba.com 43
Installation and Configuration Guide Driver Configuration Options
Encrypt
Description
This option specifies whether the driver uses TLS to encrypt communication with the
SQL Server instance before sending it over the network. The driver supports TLS 1.0 to
1.2. It will automatically detect the highest version the server supports and use that
when negotiating the connection.
l Enabled (yes, true, or 1): The driver encrypts all communication with the SQL
Server instance.
l Enabled (yes, true, or 1): The driver does not encrypt communication with the
SQL Server instance.
For information about configuring identity verification between the driver and the
server, see CA Certificate on page 43 and Trust Server Certificate on page 48.
Log Level
Description
Use this property to enable or disable logging in the driver and to specify the amount of
detail included in log files.
Important:
l Only enable logging long enough to capture an issue. Logging decreases
performance and can consume a large quantity of disk space.
l This option is not supported in connection strings. To configure logging for
the Windows driver, you must use the Logging Options dialog box. To
configure logging for a non-Windows driver, you must use the
simba.sqlserverodbc.ini file.
www.simba.com 44
Installation and Configuration Guide Driver Configuration Options
Log Path
Description
The full path to the folder where the driver saves log files when logging is enabled.
Important:
This option is not supported in connection strings. To configure logging for the
Windows driver, you must use the Logging Options dialog box. To configure
logging for a non-Windows driver, you must use the
simba.sqlserverodbc.ini file.
LogFileSize 20 No
www.simba.com 45
Installation and Configuration Guide Driver Configuration Options
Description
The maximum size of each log file in megabytes (MB). After the maximum file size is
reached, the driver creates a new file and continues logging.
Important:
This option is not supported in connection strings. To configure logging for the
Windows driver, you must use the Logging Options dialog box. To configure
logging for a non-Windows driver, you must use the
simba.sqlserverodbc.ini file.
LogFileCount 50 No
Description
The maximum number of log files to keep. After the maximum number of log files is
reached, each time an additional file is created, the driver deletes the oldest log file.
Important:
This option is not supported in connection strings. To configure logging for the
Windows driver, you must use the Logging Options dialog box. To configure
logging for a non-Windows driver, you must use the
simba.sqlserverodbc.ini file.
Password
Description
The password corresponding to the user name that you provided in the User field (the
UID key).
www.simba.com 46
Installation and Configuration Guide Driver Configuration Options
Port
Description
The TCP port that the SQL Server instance uses to listen for client connections.
Description
This option specifies whether the driver returns the SQL Server-specific data types that
are listed in the table below as ODBC data types, or as than as SQL Server data types.
l Enabled (yes, true, or 1): The driver returns the data types listed below as
ODBC data types.
l Disabled (no, false, or 0): The driver returns the data types listed below as
SQL Server data types.
TDS_SQL_SS_TIME SQL_TYPE_TIME
TDS_SQL_SS_ SQL_WVARCHAR
DATETIMEOFFSET
Server
www.simba.com 47
Installation and Configuration Guide Driver Configuration Options
Description
The host name or IP address of the SQL Server instance.
Server SPN
ServerSPN MSSQLSvc/ No
[HostName]:[Port],
where [HostName] is the
server name or IP
address specified in the
Server option and [Port]
is the port number
specified in the Port
option.
Description
The service principal name of the SQL Server instance.
Description
This option specifies whether the driver trusts the server certificate when connecting to
the server using TLS.
l Enabled (yes, true, or 1): The driver trusts the server certificate.
l Disabled (no, false, or 0): The driver does not trust the server certificate, and
instead uses a CA certificate to verify the server certificate.
For information about how to specify a CA certificate, see CA Certificate on page 43.
www.simba.com 48
Installation and Configuration Guide Driver Configuration Options
Description
This option specifies the protocol that the driver uses to authenticate connections to the
SQL Server instance.
l Enabled (Trusted_Connection is set to yes, true, or 1; or Integrated
Security is set to SSPI): The driver uses the Kerberos protocol to authenticate
connections.
l Disabled (Trusted_Connection is set to no, false, or 0; or Integrated
Security is not set): The driver uses user login to authenticate connections.
When using the macOS version of the driver, you can set the Trusted_Connection
key or the Integrated Security key to NTLM to authenticate connections using
the NTLM protocol.
User
Description
The user name that you use to access the SQL Server instance.
www.simba.com 49
Installation and Configuration Guide Driver Configuration Options
l Driver on page 50
l LongColumnLength on page 50
l UseLogPrefix on page 51
Additionally, the TDSTRACE option is available only as an environment variable.
l TDSTRACE on page 50
Driver
Description
On Windows, the name of the installed driver (Simba SQL Server ODBC Driver).
On other platforms, the name of the installed driver as specified in odbcinst.ini, or
the absolute path of the driver shared object file.
LongColumnLength
LongColumnLength 8000 No
Description
The maximum size of BLOB and CLOB columns.
TDSTRACE
Key Name Default Value Required
TDSTRACE None No
www.simba.com 50
Installation and Configuration Guide Driver Configuration Options
Description
Use this property to enable or disable logging in the wire protocol component and to
specify the amount of detail included in log files.
Important:
l Only enable logging long enough to capture an issue. Logging decreases
performance and can consume a large quantity of disk space.
l This option is not supported in DSNs or connection strings. To configure wire
protocol logging for the Windows driver, you must set TDSTRACE as an
environment variable. To configure wire protocol logging for a non-Windows
driver, you must set TDSTRACE in the simba.sqlserverodbc.ini file.
UseLogPrefix
UseLogPrefix 0 No
www.simba.com 51
Installation and Configuration Guide Driver Configuration Options
Description
This option specifies whether the driver includes a prefix in the names of log files so
that the files can be distinguished by user and application.
l 1: The driver prefixes log file names with the user name and process ID
associated with the connection that is being logged. For example, if you are
connecting as a user named "jdoe" and using the driver in an application with
process ID 7836, the generated log file would be named jdoe_7836_
SqlServerODBC.log.
l 0: The driver does not include the prefix in log file names.
www.simba.com 52
Installation and Configuration Guide Third-Party Trademarks
Third-Party Trademarks
Debian is a trademark or registered trademark of Software in the Public Interest, Inc. or
its subsidiaries in Canada, United States and/or other countries.
Linux is the registered trademark of Linus Torvalds in Canada, United States and/or
other countries.
Mac, macOS, Mac OS, and OS X are trademarks or registered trademarks of Apple,
Inc. or its subsidiaries in Canada, United States and/or other countries.
Microsoft SQL Server, SQL Server, Microsoft, MSDN, Windows, Windows Server,
Windows Vista, and the Windows start button are trademarks or registered trademarks
of Microsoft Corporation or its subsidiaries in Canada, United States and/or other
countries.
Red Hat, Red Hat Enterprise Linux, and CentOS are trademarks or registered
trademarks of Red Hat, Inc. or its subsidiaries in Canada, United States and/or other
countries.
SUSE is a trademark or registered trademark of SUSE LLC or its subsidiaries in
Canada, United States and/or other countries.
Ubuntu is a trademark or registered trademark of Canonical Ltd. or its subsidiaries in
Canada, United States and/or other countries.
All other trademarks are trademarks of their respective owners.
www.simba.com 53
Installation and Configuration Guide Third-Party Licenses
Third-Party Licenses
The licenses for the third-party libraries that are included in this product are listed
below.
CityHash License
Copyright (c) 2011 Google, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies
or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
CityHash, by Geoff Pike and Jyrki Alakuijala
http://code.google.com/p/cityhash/
dtoa License
The author of this software is David M. Gay.
Copyright (c) 1991, 2000, 2001 by Lucent Technologies.
Permission to use, copy, modify, and distribute this software for any purpose without
fee is hereby granted, provided that this entire notice is included in all copies of any
software which is or includes a copy or modification of this software and in all copies of
the supporting documentation for such software.
THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
IMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT
MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING
www.simba.com 54
Installation and Configuration Guide Third-Party Licenses
www.simba.com 55
Installation and Configuration Guide Third-Party Licenses
www.simba.com 56
Installation and Configuration Guide Third-Party Licenses
THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT "AS IS" AND ANY
EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL
PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This product includes cryptographic software written by Eric Young
([email protected]). This product includes software written by Tim Hudson
([email protected]).
Original SSLeay License
Copyright (C) 1995-1998 Eric Young ([email protected])
All rights reserved.
This package is an SSL implementation written by Eric Young ([email protected]).
The implementation was written so as to conform with Netscapes SSL.
This library is free for commercial and non-commercial use as long as the following
conditions are aheared to. The following conditions apply to all code found in this
distribution, be it the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The
SSL documentation included with this distribution is covered by the same copyright
terms except that the holder is Tim Hudson ([email protected]).
Copyright remains Eric Young's, and as such any Copyright notices in the code are not
to be removed. If this package is used in a product, Eric Young should be given
attribution as the author of the parts of the library used. This can be in the form of a
textual message at program startup or in documentation (online or textual) provided
with the package.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
1. Redistributions of source code must retain the copyright notice, this list of
conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list
of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
www.simba.com 57
Installation and Configuration Guide Third-Party Licenses
3. All advertising materials mentioning features or use of this software must display
the following acknowledgement:
"This product includes cryptographic software written by Eric Young
([email protected])"
The word 'cryptographic' can be left out if the rouines from the library being used
are not cryptographic related :-).
4. If you include any Windows specific code (or a derivative thereof) from the apps
directory (application code) you must include an acknowledgement:
"This product includes software written by Tim Hudson ([email protected])"
THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The licence and distribution terms for any publically available version or derivative of
this code cannot be changed. i.e. this code cannot simply be copied and put under
another distribution licence [including the GNU Public Licence.]
Stringencoders License
Copyright 2005, 2006, 2007
Nick Galbreath -- nickg [at] modp [dot] com
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list
of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
www.simba.com 58
Installation and Configuration Guide Third-Party Licenses
Neither the name of the modp.com nor the names of its contributors may be used
to endorse or promote products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This is the standard "new" BSD license:
http://www.opensource.org/licenses/bsd-license.php
www.simba.com 59