ODBC

Install the driver

1. Download the .msi package that matches your Windows architecture. See Download the driver.

2. Right-click the polardb2_odbc_*_*.msi file and select Run as administrator to install the driver.

Connect to PolarDB

1. Open Control Panel > Administrative Tools > ODBC Data Sources.

2. In the ODBC Data Source Administrator dialog box, click Add.

3. Select PolarDB Unicode(x64) and click Finish.

4. Fill in the connection details:

   

   Parameter	Description	Default
   Data Source	A name for this data source.	—
   Description	An optional description of the data source.	—
   Database	The name of the destination database.	—
   SSL Mode	The SSL encryption mode.	—
   Server	The cluster endpoint. To find it, see View or request an endpoint.	—
   Port	The database port.	1521
   User Name	The database account.	—
   Password	The password for the database account.	—

5. Click Test to verify the connection. A success message confirms that the connection string is correctly configured.

   

6. Click Save.

Install the driver

1. Download the driver package that matches your operating system and architecture. See Download the driver.

2. Extract the package. The PolarDB ODBC driver does not require installation — it's ready to use after extraction.

   tar -zxvf polardb-odbc-*-*-*.tar.gz

   Replace polardb-odbc-*-*-*.tar.gz with the actual package name.

3. Set the LD_LIBRARY_PATH environment variable to point to the driver library:

   export LD_LIBRARY_PATH=<PolarDB-ODBC/lib>:$LD_LIBRARY_PATH

   Replace <PolarDB-ODBC/lib> with the actual path to the extracted lib folder.

4. Set the ODBCINI environment variable to point to your odbc.ini file:

   export ODBCINI=</your/odbc.ini/file/path>

Connect to PolarDB

1. Install Libtool (1.5.1 or later) on the Linux server:

   yum install -y libtool

2. Install unixODBC-devel:

   yum install -y unixODBC-devel

3. Open the odbc.ini file configured in ODBCINI:

   vim $ODBCINI

4. Add the following data source definition:

   Field	Description	Default
   [POLARDB]	The data source name. Use any name you like.	—
   Description	An optional description of this data source.	—
   Driver / Driver64	The path to psqlodbcw.so in the extracted lib folder.	—
   Database	The name of the destination database.	—
   Servername	The cluster endpoint. To find it, see View or request an endpoint.	—
   Password	The password for the database account.	—
   Port	The database port.	—
   Username	The database account.	—
   Trace	Set to yes to enable unixODBC tracing, which logs all ODBC calls. Useful for troubleshooting; disable in production to avoid performance overhead.	yes
   TraceFile	The file where trace output is written.	/tmp/odbc.log
   FileUsage	Set to 1 to indicate this is a file-based data source.	1

   [POLARDB]
   Description = ODBC for POLARDB
   Driver      = <PolarDB-ODBC/lib/psqlodbcw.so>
   Driver64    = <PolarDB-ODBC/lib/psqlodbcw.so>
   Database    = <database_name>
   Servername  = <database_endpoint>
   Password    = <password>
   Port        = <port>
   Username    = <username>
   Trace       = yes
   TraceFile   = /tmp/odbc.log
   FileUsage   = 1

   Replace <PolarDB-ODBC/lib/> with the actual path to the extracted lib folder.

5. Connect to PolarDB:

   $isql -v POLARDB

   Expected output:

   +---------------------------------------+
   | Connected!                            |
   |                                       |
   | sql-statement                         |
   | help [tablename]                      |
   | quit                                  |
   |                                       |
   +---------------------------------------+
   SQL>

13.02.0000.1 (February 10, 2025)

• Type compatibility

  • The DATE type is now compatible with Oracle and supports time information, including hours, minutes, and seconds.

  • The INTERVAL type is now compatible with Oracle. To query an INTERVAL column, convert it to a string first.

• API adaptation

  • PGAPI_Columns and related APIs are updated for ROWID and DTS. System columns and system indexes are no longer displayed.

  • PGAPI_Columns now supports using SQL reserved keywords as column names.