JAVA 驱动

推荐使用 OceanBase 数据库的 JDBC 驱动：oceanbase-client。

连接 MySQL 租户也可以使用 MySQL 官方 JDBC 驱动：mysql-connector-Java。推荐使用 5.1.30 和 5.1.40 版本，其他版本可能存在兼容问题。

注意

• oceanbase-client 完全兼容 MySQL JDBC 的使用方式并且可以自动识别 OceanBase 的运行模式是 MySQL 还是 Oracle，因为其在协议层还兼容 2 种模式，且兼容 OB 2.0 协议。

• mysql-connector-Java 只支持 MySQL 运行模式。

oceanbase-client 使用说明

连接串的前缀需要设置为 jdbc:oceanbase ，其他部分的使用方式与原生的 MySQL 使用方式保持一致。

注意

1.0.9 版本的 oceanbase-client 的驱动类名为：com.alipay.oceanbase.obproxy.mysql.jdbc.Driver。

后续版本驱动类名改为：com.alipay.oceanbase.jdbc.Driver。

代码示例如下所示：

  String url = "jdbc:oceanbase://xxx.xxx.xxx.xxx:2883/SYS?useUnicode=true&characterEncoding=utf-8";              //IP地址:OBProxy端口号/数据库名
  String username = "SYS@test1#obtest";                                                                          //用户名@租户名#集群名称
  String password = "test";                                                                                      //密码
  Connection conn = null;                                                                                         
  try {                                                                                                           
      Class.forName("com.alipay.oceanbase.obproxy.mysql.jdbc.Driver");                                             //驱动类名
      conn = DriverManager.getConnection(url, username, password);
      PreparedStatement ps = conn.prepareStatement("select to_char(sysdate,'yyyy-MM-dd HH24:mi:ss') from dual;");
      ResultSet rs = ps.executeQuery();
      rs.next();
      System.out.println("sysdate is:" + rs.getString(1));
      rs.close();
      ps.close();
  } catch (Exception e) {
      e.printStackTrace();
  } finally {
      if (null != conn) {
          conn.close();
      }
  }

mysql-connector-Java 使用说明

连接串的前缀需要设置为 jdbc:mysql，驱动类名为：com.mysql.jdbc.Driver。

代码示例如下所示：

String url = "jdbc:mysql://xxx.xxx.xxx.xxx:2883/hr?useUnicode=true&characterEncoding=utf-8";                    //IP地址:OBProxy端口号/数据库名
String username = "root@test2#obtest";                                                                          //用户名@租户名#集群名称
String password = "test";                                                                                       //密码
Connection conn = null;
try {
    Class.forName("com.mysql.jdbc.Driver");                                                                       //驱动类名
    conn = DriverManager.getConnection(url, username, password);
    PreparedStatement ps = conn.prepareStatement("select date_format(now(),'%Y-%m-%d %H:%i:%s');");
    ResultSet rs = ps.executeQuery();
    rs.next();
    System.out.println("sysdate is:" + rs.getString(1));
    rs.close();
    ps.close();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    if (null != conn) {
        conn.close();
    }
}

JDBC 驱动实践

下述表格中展示了 JDBC 中几个必须要设置的重要参数。均可以设置到连接池的 ConnectionProperties 中，或者 JdbcURL 上：

应用连接池配置

将应用和数据库连接进行业务操作，建议使用连接池。如果是 Java 程序，推荐使用 Druid 连接池。配置示例如下所示：

<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
    <property name="driverClassName" value="com.mysql.jdbc.Driver" />
    <!-- 基本属性 URL、user、password -->
    <property name="url" value="jdbc:mysql://ip:port/db?socketTimeout=30000&amp;connectTimeout=3000" />
    <property name="username" value="{user}" />
    <property name="password" value="{password}" />
    <!-- 配置初始化大小、最小、最大 -->
    <property name="maxActive" value="4" />                                                                       //initialSize/minIdle/maxActive视业务规模设置
    <property name="initialSize" value="2" />
    <property name="minIdle" value="2" />
    <!-- 获取连接等待超时的时间，单位是毫秒 -->
    <property name="maxWait" value="1000" />
    <!-- 间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 -->
    <property name="timeBetweenEvictionRunsMillis" value="60000" />
    <!-- 一个连接在池中最小空闲的时间，单位是毫秒-->
    <property name="minEvictableIdleTimeMillis" value="300000" />
    <!-- 检测连接是否可用的 SQL -->
    <property name="validationQuery" value="SELECT foo FROM bar" />                                               //找真实的、记录少的业务表用作查询探测语句
    <!-- 是否开启空闲连接检查 -->
    <property name="testWhileIdle" value="true" />
    <!-- 是否在获取连接前检查连接状态 -->
    <property name="testOnBorrow" value="false" />
    <!-- 是否在归还连接时检查连接状态 -->
    <property name="testOnReturn" value="false" />
</bean>

ODBC 驱动

开放数据库互连（ODBC）是微软公司开放服务结构（WOSA，Windows Open Services Architecture）中有关数据库的一个组成部分，基本思想是为用户提供简单、标准、透明的数据库连接的公共编程接口，开发厂商根据 ODBC 的标准去实现底层的驱动程序，这个驱动对用户是透明的，并允许根据不同的 DBMS 采用不同的技术加以优化实现。

ODBC 主要由驱动程序和驱动程序管理器组成。驱动程序是一个用以支持 ODBC 函数调用的模块，每个驱动程序对应于相应的数据库，当应用程序从基于一个数据库系统移植到另一个时，只需更改应用程序中由 ODBC 管理程序设定的与相应数据库系统对应的别名即可。

连接 OceanBase 数据库的驱动程序管理器和驱动程序 OB-ODBC 均是定制开发，通过该驱动可以连接访问 OceanBase 数据库的 MySQL 及 Oracle 租户。

Linux 下 OB-ODBC 连接 OceanBase 数据库的架构图如下所示。

连接环境配置

连接数据库前，需要配置连接环境，配置方法如下：

1. 修改配置文件 odbc.ini，路径为 /etc/odbc.ini，配置文件 odbc.ini 也可以放在除了 /etc 以外的其他目录，通过设置环境变量到相应的目录即可。

   [ODBC Data Sources]
   data_source_name = Name
   [Name]
   Driver=Oceanbase
   Description = MyODBC 5 Driver DSN
   SERVER      = [OBProxy IP地址]
   PORT        = [OBProxy 端口]
   USER        = [用户名@租户名#集群名称]
   Password    = [用户密码]
   Database    = [数据库名]
   OPTION      = 3
   charset=UTF8

2. 配置 /etc/odbcinst.ini。

   [Oceanbase]
   Driver=/u01/mysql-odbc/lib/libmyodbc5a.so

3. 设置环境变量。

   export ODBCSYSINI=/etc
   export ODBCINI=/etc/odbc.ini
   export LD_LIBRARY_PATH=/u01/mysql/lib:/usr/lib64:$LD_LIBRARY_PATH
   export PATH=$PATH:/u01/unix-odbc/bin

4. 配置完成后使用 odbcinst -j命令查看配置是否正确。

   返回结果如下所示。

   unixODBC 2.3.7
   DRIVERS............: /etc/odbcinst.ini
   SYSTEM DATA SOURCES: /etc/odbc.ini
   FILE DATA SOURCES..: /etc/ODBCDataSources
   USER DATA SOURCES..: /etc/odbc.ini
   SQLULEN Size.......: 8
   SQLLEN Size........: 8
   SQLSETPOSIROW Size.: 8

示例：

1. 以 OceanBase 数据库的 Oracle 租户为测试环境，运行下述语句在数据库中创建一张示例表 TEST。

   CREATE TABLE "TEST" (
     "ID" NUMBER(38) NOT NULL,
     "NAME" VARCHAR2(32),
     CONSTRAINT "TEST_PK" PRIMARY KEY ("ID")
   ) COMPRESS FOR ARCHIVE REPLICA_NUM = 3 BLOCK_SIZE = 16384 USE_BLOOM_FILTER = FALSE TABLET_SIZE = 134217728 PCTFREE = 10

2. 编写连接数据库的驱动程序。

   驱动程序的代码示例如下：

   #include <stdio.h>
   #include <stdlib.h>
   #include <string.h>
   #include "sql.h"
   #include "sqlext.h"
   typedef struct tagODBCHandler {
       SQLHENV henv;
       SQLHDBC hdbc;
       SQLHSTMT hstmt;
   }ODBCHandler;
   int IS_SUCC(SQLRETURN retcode) {
       if  (retcode == SQL_SUCCESS || retcode == SQL_SUCCESS_WITH_INFO) return 1;
       return 0;
   }
   void checkError(SQLRETURN retcode, const char* msg, ODBCHandler* handler) {
       SQLCHAR message[SQL_MAX_MESSAGE_LENGTH + 1];
       SQLCHAR sqlstate[SQL_SQLSTATE_SIZE + 1];
       SQLINTEGER error;
       SQLSMALLINT len;
       SQLRETURN tmpcode;
       switch (retcode){
       case SQL_SUCCESS:
           printf("%s retcode is SQLRETURN\n", msg);
           break;
       case SQL_SUCCESS_WITH_INFO:
           printf("%s retcode is SQL_SUCCESS_WITH_INFO\n", msg);
           break;
       case SQL_ERROR:
           printf("%s retcode is SQL_ERROR\n", msg);
           tmpcode = SQLError(handler->henv, handler->hdbc, handler->hstmt, sqlstate, &error, message, sizeof(message), &len);
           if (tmpcode != SQL_SUCCESS && tmpcode != SQL_SUCCESS_WITH_INFO) {
               printf("get sqlerror failed %d", tmpcode);
           } else {
               printf("error is %d, meeesage is %s, sqlstate is %s, len is %d\n", error, message, sqlstate, len);
           }
           break;
       case SQL_INVALID_HANDLE:
           printf("%s retcode is SQL_INVALID_HANDLE\n", msg);
           break;
       case SQL_STILL_EXECUTING:
           printf("%s retcode is SQL_STILL_EXECUTING\n", msg);
           break;
       case SQL_NO_DATA:
           printf("%s retcode is SQL_NO_DATA\n", msg);
           break;
       default:
           printf("%s retcode is UNKNOWN retcode\n", msg);
           break;
       }
   }
   int main(int argc, char** argv) {
       ODBCHandler handler;
       SQLRETURN retcode;
   #define MAX_NAME_LEN 255
       SQLCHAR   connOut[MAX_NAME_LEN+1];
       SQLSMALLINT len;
       //Allocate environment handle 
       retcode = SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, &handler.henv);
       // Set the ODBC version environment attribute  
       if (!IS_SUCC(retcode)) {
           checkError(retcode, "SQLAllocHandle", &handler);
           return -1;
       }
       retcode = SQLSetEnvAttr(handler.henv, SQL_ATTR_ODBC_VERSION, (SQLPOINTER)SQL_OV_ODBC3_80, 0);
       // Allocate connection handle  
       if (!IS_SUCC(retcode)) {  
           checkError(retcode, "SQLSetEnvAttr", &handler);
           return -1;
       }
       retcode = SQLAllocHandle(SQL_HANDLE_DBC, handler.henv, &handler.hdbc);  
       if (!IS_SUCC(retcode)) {  
           checkError(retcode, "SQLAllocHandle", &handler);
           return -1;
       }
     // Set login timeout to 5 seconds  
     SQLSetConnectAttr(handler.hdbc, SQL_LOGIN_TIMEOUT, (SQLPOINTER)5, 0);  
     // Connect to data source  
     retcode = SQLDriverConnect(handler.hdbc, NULL, (SQLCHAR*)"DSN=odbctest", SQL_NTS, connOut, MAX_NAME_LEN, &len,SQL_DRIVER_NOPROMPT);
     if (!IS_SUCC(retcode)) {  
           checkError(retcode, "SQLDriverConnect", &handler);
           return -1;
       }
     retcode = SQLAllocHandle(SQL_HANDLE_STMT, handler.hdbc, &handler.hstmt);
     if (!IS_SUCC(retcode)) {  
           checkError(retcode, "SQLAllocHandle", &handler);
           return -1;
       }
       {
           //insert 
           retcode = SQLPrepare(handler.hstmt, (SQLCHAR*)"INSERT INTO test VALUES(?,'robin')", SQL_NTS);
           if (!IS_SUCC(retcode)) {  
               checkError(retcode, "SQLPrepare", &handler);
               return -1;
           }
           SQLINTEGER id = 2;
           retcode = SQLBindParameter(handler.hstmt, 1, SQL_PARAM_INPUT, SQL_C_LONG, SQL_INTEGER, 0, 0, &id, 0, NULL);
           if (!IS_SUCC(retcode)) {  
               checkError(retcode, "SQLBindParameter", &handler);
               return -1;
           }
           retcode = SQLExecute(handler.hstmt);
           if (!IS_SUCC(retcode)) {  
               checkError(retcode, "SQLExecute", &handler);
               return -1;
           }
           //ORACLE mode will need this section
           retcode = SQLEndTran(SQL_HANDLE_DBC, handler.hdbc, SQL_COMMIT);
           if (!IS_SUCC(retcode)) {
               checkError(retcode, "SQLCommit", &handler);
               return -1;
           }
       }
       // clean handle
       SQLFreeHandle(SQL_HANDLE_STMT, handler.hstmt);
       SQLDisconnect(handler.hdbc);
       SQLFreeHandle(SQL_HANDLE_DBC, handler.hdbc);
       SQLFreeHandle(SQL_HANDLE_ENV, handler.henv);
       return 0;
   }

   注意

   Oracle 租户同 MySQL 租户最大的区别在于不会自动提交，因此代码中增加了 ORACLE mode will need this section片段，如果是操作 MySQL 租户则无需这段代码。

3. 编译并执行驱动程序。

   GCC 编译时，使用 -I 选项指定头文件， -L 指定库文件目录， -l指定库名。

   示例语句如下所示：

   gcc test.c -L/u01/unix-odbc/lib -lodbc -I/u01/unix-odbc/include -otest
   ./test

   检查结果：

   obclient -hobproxy.oceanbase.abc.com -uhr@test0_5#obtest -p'hr' -P2883
   obclient> select * from test;
   +----+-------+
   | ID | NAME  |
   +----+-------+
   |  1 | jason |
   |  2 | robin |
   +----+-------+

MySQL C API

C APIs 包含在 mysqlclient库文件当中，GCC 编译时使用 -I选项指定头文件， -L指定库文件目录， -l指定库名。示例语句如下所示：

gcc test.c -I/usr/include/mysql/ -L/usr/lib64/mysql -lmysqlclient

注意

把库文件名开头的 lib 和结尾的 .so 去掉即为库名。

代码示例：

#include <mysql.h>
#include <stdio.h>
#include <string.h>
void main(void) {
    MYSQL conn;
    char server = "xxx.xxx.xxx.xxx";
    char user = "root@test#obtest";                                                //用户名@租户名#集群名称
    char password = "test";                                                        //密码
    char *database = "test";                                                       //数据库名
    char str_sqls;
    int status;
    int result;
    int i;
    conn = mysql_init(NULL); / Connect to database /
    / connect to server with the CLIENT_MULTI_STATEMENTS option /
    if (mysql_real_connect (conn, server, user, password,
            database, 3306, NULL, CLIENT_MULTI_STATEMENTS) == NULL)
    {
        printf("mysql_real_connect() failed\n");
        mysql_close(conn);
        exit(1);
    }
    / execute multiple statements /
    strcat(str_sqls, "DROP TABLE IF EXISTS test_table;");
    strcat(str_sqls, "CREATE TABLE test_table(id BIGINT);");
    strcat(str_sqls, "INSERT INTO test_table VALUES(10);");
    status = mysql_query(conn, str_sqls);
    if (status)
    {
        printf("Could not execute statement(s)");
        mysql_close(conn);
        exit(0);
    }
    mysql_close(conn);
}