Using the iODBC Driver Manager
Connecting through a Driver Manager
On macOS, the CData ODBC Driver for SQL Server is preconfigured for use with the iODBC driver manager, as are many other products like Filemaker Pro, Microsoft Excel, and Tableau. You can find the latest version of iODBC on the iODBC site.
The driver installation registers the driver with iODBC and creates a system DSN, which you can use in any tools or applications that support ODBC connectivity.
The driver manager loads the driver and passes function calls from the application to the driver. The driver must be registered with the driver manager and DSNs are defined in the driver manager's configuration files.
To configure a DSN, you can use the iODBC Administrator 64-bit, the GUI installed with iODBC. Note that the ODBC Manager must match the bitness of the ODBC driver. The most recent version of the CData ODBC Driver for SQL Server is 64-bit only. Alternatively, you can edit the iODBC configuration files.
You can configure User or System DSNs. User data sources are restricted to a user account. System data sources can be accessed by all users.
Configuring a DSN with the iODBC Administrator
You can create user DSNs by opening the iODBC Administrator 64-bit from Launchpad.
To modify the system DSN installed by the driver or create a system DSN, open the iODBC Administrator 64-bit with elevated permissions. To do so, enter the following command into a terminal:
sudo /Applications/iODBC/iODBC\ Administrator64.app/Contents/MacOS/iODBC\ Administrator64After opening the iODBC Administrator 64-bit, you will see the CData SQL Source listed under the System tab. Select the DSN and click the Configure button to set connection properties as name-value pairs.
To create your own DSN, instead click Add on the User or System tab and then select the CData ODBC Driver for SQL Server option.
Configuring a DSN in the iODBC INI Files
Configure DSNs in odbc.ini. Register ODBC drivers in odbcinst.ini.
Define ODBC data sources in sections in the odbc.ini file. User data sources can only be accessed by the user account whose home folder the odbc.ini is located in. System data sources can be accessed by all users.
Modifying iODBC's system-wide settings requires elevated permissions; to do so, you can use the sudo command to open a text editor from the terminal. For example:
sudo nano /Library/ODBC/odbc.ini
In addition to the connection properties required to connect to your data source, the Driver property specifies either a driver definition in the odbcinst.ini file or the path to the driver library.
[CData SQL Source] Driver = CData ODBC Driver for SQL Server user=myuser password=mypassword Server=localhost Database=Northwind
Additionally, in the ODBC Data Sources section, the DSN must be set to a driver defined in the odbcinst.ini file. For example, below is the entry for the DSN created during the driver install:
[ODBC Data Sources] CData SQL Source = CData ODBC Driver for SQL Server
You may need to modify the installed driver definition if you change the path to the driver library.
To register an ODBC driver, modify the odbcinst.ini file. With iODBC, drivers can be available to only one user account or drivers can be available system wide.
Drivers are defined in sections in the odbcinst.ini file. The section name specifies the name of the driver. In this section, the Driver property specifies the path to the driver library. The driver library is the .dylib file located in the lib subfolder of the installation directory, by default in /Applications/CData ODBC Driver for SQL Server.
[CData ODBC Driver for SQL Server] Driver = /Applications/CData ODBC Driver for SQL Server/lib/libsqlodbc.dylib
The ODBC Drivers section must also contain a property with the driver name, set to "Installed". For example:
[ODBC Drivers] CData ODBC Driver for SQL Server = Installed
Testing the Connection
You can use the iODBC Demo, available in most iODBC installations, to connect to SQL Server and execute SQL queries.
Complete the following steps to connect from the iODBC Demo:
- Open Launchpad and search for "iODBC".
- If you need to connect to SQL Server from an application that can use only the ANSI ODBC API, click iODBC Demo Ansi. Otherwise, click iODBC Demo Unicode.
- In the Environment menu, click Open Connection.
- Select the DSN on the corresponding tab and test the connection.
Set the Driver Encoding
The ODBC drivers need to specify which encoding to use with the ODBC Driver Manager. By default, the CData ODBC Drivers for Mac are configured to use UTF-32 which is compatible with iODBC, but other Driver Managers may require alternative encoding.
Alternatively, if you are using the ODBC driver from an application that uses the ANSI ODBC API it may be necessary to set the ANSI code page. For example, to import Japanese characters in an ANSI application, you can specify the code page in the config file '/Applications/CData ODBC Driver for SQL Server/lib/cdata.odbc.sql.ini':
[Driver] AnsiCodePage = 932