Connect with MariaDB Connector/ODBC

Configuring a Data Source on Linux

1. Configure unixODBC to recognize the driver by creating a file called MariaDB_odbc_driver_template.ini with the relevant driver definition.

   For example, on CentOS / RHEL / Rocky Linux:

   [MariaDB ODBC 3.1 Driver]
   Description = MariaDB Connector/ODBC v.3.1
   Driver      = /usr/lib64/libmaodbc.so
   

   On Debian / Ubuntu:

   [MariaDB ODBC 3.1 Driver]
   Description = MariaDB Connector/ODBC v.3.1
   Driver      = /usr/lib/libmaodbc.so
   

2. Install the driver using the odbcinst command.

   For example:

   $ sudo odbcinst -i -d -f MariaDB_odbc_driver_template.ini
   odbcinst: Driver installed. Usage count increased to 1.
   Target directory is /etc
   

3. Determine the connection parameters for your database.

4. Configure unixODBC to connect to the data source by creating a file called MariaDB_odbc_data_source_template.ini with the relevant data source parameters.

   For example:

   # Data Source for unixODBC
   [My-Test-Server]
   Description = Describe your database setup here
   Driver      = MariaDB ODBC 3.1 Driver
   Trace       = Yes
   TraceFile   = /tmp/trace.log
   SERVER      = localhost
   SOCKET      = /var/run/mysqld/mysqld.sock
   USER        = db_user
   PASSWORD    = db_user_password
   DATABASE    = test
   

   # Data Source for unixODBC
   [My-Test-Server]
   Description = Describe your database setup here
   Driver      = MariaDB ODBC 3.1 Driver
   Trace       = Yes
   TraceFile   = /tmp/trace.log
   SERVER      = example.skysql.net
   PORT        = 5001
   SSLCA       = /path/to/skysql_chain.pem
   USER        = db_user
   PASSWORD    = db_user_password
   DATABASE    = test
   

   • Customize the values of the parameters with the relevant information for your environment.

5. Install the unixODBC data source template file:

   $ sudo odbcinst -i -s -h -f MariaDB_odbc_data_source_template.ini
   

6. Test the data source My-Test-Server configured in the MariaDB_odbc_data_source_template.ini file using the isql command:

   $ isql My-Test-Server
   +-------------------------+
   | Connected!              |
   | sql-statement           |
   | help[tablename]         |
   | quit                    |
   +-------------------------+
   SQL>
   

7. To select your new data source in your application, select the data source with the name that you configured, which is My-Test-Server in the above example.

Configuring a Data Source on macOS

1. Confirm that MariaDB Connector/ODBC has been registered with iODBC by confirming that the following options are set in the iODBC configuration file at /Library/ODBC/odbcinst.ini:

   [ODBC]
   Trace     = no
   TraceFile = /tmp/iodbc_trace.log
   
   [ODBC Drivers]
   MariaDB ODBC 3.1 Unicode Driver = Installed
   
   [MariaDB ODBC 3.1 Unicode Driver]
   Driver      = /Library/MariaDB/MariaDB-Connector-ODBC/libmaodbc.dylib
   Description = MariaDB Connector/ODBC(Unicode) 3.1 64bit
   Threading   = 0
   

2. Determine the connection parameters for your database.

3. Add a data source for your database to iODBC by adding the following options to the iODBC configuration file at /Library/ODBC/odbc.ini:

   [ODBC Data Sources]
   My-Test-Server = MariaDB ODBC 3.1 Unicode Driver
   
   [My-Test-Server]
   Driver   = /Library/MariaDB/MariaDB-Connector-ODBC/libmaodbc.dylib
   SERVER   = 192.0.2.1
   DATABASE = test
   USER     = db_user
   PASSWORD = db_user_password
   

   • Substitute the values of the SERVER, SOCKET, DATABASE, PORT, USER, and PASSWORD parameters with the relevant value for your environment.

4. Test the data source using the iodbctest command:

   $ iodbctest "DSN=My-Test-Server"
   

5. To select your new data source in your application, select the data source with the name that you configured, which is My-Test-Server in the above example.

Configuring a Data Source on Windows

MariaDB Connector/ODBC requires at least Windows 8.

Windows 10 was used to prepare these instructions. When using other versions of Windows, these instructions may require adjustment.

1. In the start menu, search for "ODBC Data Sources".

2. In the search results, open the application called "ODBC Data Sources (32-bit)" or "ODBC Data Sources (64-bit)", depending on whether you need a data source for a 32-bit or 64-bit application.

3. In the ODBC Data Source Administrator, click the "Add" button on the right side.

4. In the "Create New Data Source" window:

   • Click on "MariaDB ODBC 3.1 Driver" in the list.

   • Click the "Finish" button.

5. In the "Create a new Data Source to MariaDB" window:

   • In the "Name" text box, enter a name for the data source.

   • In the "Description" test box, enter a description for the data source.

   • Click the "Next" button.

6. In the next window, provide the connection credentials:

   • In the "Server Name" field, provide the IP address or domain name for the Server.

   • In the "User name" field, provide the username for the database user account.

   • In the "Password" field, provide the password for that user.

   • In the "Database" field, provide the the default database to use.

   • Then, click the "Next" button.

7. Continue configuring the data source using the wizard:

   • The wizard provides a series of windows for configuring various aspects of the connection, such as enabling TLS encryption. Enable settings you want to use.

   • Click the "Next" button to move onto the next window in the wizard.

   • Click the "Finish" on the last window to exit the wizard and save your data source.

8. To select your new data source in your application, select the data source with the name that you configured for the "Name" field.

Failover

MariaDB Connector/ODBC supports failover in case one or more hosts are not available.

The failover feature requires using MariaDB Connector/ODBC 3.1.16 or greater with MariaDB Connector/C 3.3 or greater.

MariaDB Connector/ODBC 3.1.16 and greater is statically linked for Windows and macOS with MariaDB Connector/C 3.3.1. MariaDB Connector/ODBC 3.1.16 and greater is dynamically linked for Linux with MariaDB Connector/C.

The failover feature is enabled by providing a comma separated list of hosts as a server name.

The following syntax is required:

• IPv6 addresses must be enclosed within square brackets "[]"

• hostname and port must be separated by a colon ":"

• hostname:port pairs must be be separated by a comma ","

• If only one hostname:port is specified, the host string must end with a comma

• If no port is specified, the default port will be used

An example of a failover host string:

[::1]:3306,192.168.0.1:3307,test.example.com

Connection Parameters

OPTIONS Bitmask

The OPTIONS bitmask contains the following bits: