连接方式概述

本节主要介绍 MySQL 模式下连接和访问 OceanBase 数据库的方法。当前主要支持通过客户端、GUI、驱动、ORM 框架或连接池连接到 OceanBase 数据库。

选择客户端连接 OceanBase 数据库

在连接 OceanBase 数据库的 MySQL 租户时，支持的客户端如下：

• MySQL 客户端（mysql）

  mysql 是 MySQL 数据库的命令行客户端，需要单独安装。OceanBase 数据库租户包括 MySQL 兼容租户和 Oracle 兼容租户。当访问 MySQL 兼容租户时，可以通过 mysql 连接。

  连接 OceanBase 数据库后，在 mysql 的命令行环境里，可以运行 mysql 运维命令和 SQL 语句来执行以下任务：

  • 计算、存储和打印查询结果。

  • 创建数据库对象、检查和修改对象定义。

  • 执行数据库管理和修改参数等。

  使用 MySQL 客户端连接 OceanBase 数据库的 MySQL 租户的具体操作示例请参见 通过 MySQL 客户端连接 OceanBase 租户。

• OceanBase 客户端（OBClient）

  OBClient 是一个交互式和批处理查询工具，需要单独安装。它是一个命令行用户界面，在连接到数据库时充当客户端，支持 OceanBase 数据库的 MySQL 租户 和 Oracle 租户。

  OBClient 在运行时需要指定 OceanBase 数据库租户的连接信息。连接上 OceanBase 数据库后，通过 OBClient 可以运行一些数据库命令（包含常用的 MySQL 命令）、SQL 语句和 PL 语句，可以实现以下任务：

  • 计算、存储和打印查询结果。

  • 创建数据库对象、检查和修改对象定义。

  • 开发和运行批处理脚本。

  • 执行数据库管理和修改参数等。

  使用 OceanBase 客户端连接 OceanBase 租户的具体操作示例请参见 通过 OBClient 连接 OceanBase 租户。

• OceanBase 开发者中心（ODC）

  OceanBase 开发者中心（OceanBase Developer Center，ODC）是为 OceanBase 数据库量身打造的企业级数据库开发平台。

  ODC 支持连接 OceanBase 数据库的 MySQL 租户和 Oracle 租户，同时为数据库开发者提供了数据库日常开发操作、WebSQL、SQL 诊断、会话管理和数据导入导出等功能。

  使用 OceanBase 开发者中心连接 OceanBase 租户的具体操作示例请参见 通过 ODC 连接 OceanBase 数据库。

选择 GUI 连接 OceanBase 数据库

• DBeaver

  DBeaver 是通用的数据库客户端工具，其原理是使用各个数据库提供的 JDBC 驱动连接数据库，支持常见的关系型数据库、非关系型数据库、分布式数据库等等。

  更多内容参见通过 DBeaver 连接数据库。

• Navicat

  同 DBeaver 一样，Navicat 也是一款通用的数据库客户端工具，其原理是使用各个数据库提供的 JDBC 驱动连接数据库，支持常见的关系型数据库、非关系型数据库、分布式数据库等等。

  更多内容参见通过 Navicat 连接数据库。

选择驱动或 ORM 框架连接 OceanBase 数据库

C

• C 驱动（OceanBase Connector/C）

  OceanBase Connector/C 是一个基于 C/C++ 的 OceanBase 客户端开发组件，支持 C API Lib 库。

  OceanBase Connector/C 允许 C/C++ 程序以一种较为底层的方式访问 OceanBase 分布式数据库集群，以进行数据库连接、数据访问、错误处理和 Prepared Statement 处理等操作。

  OceanBase Connector/C 也称为 LibOBClient，用于应用程序作为独立的服务器进程通过网络连接与数据库服务器 OBServer 节点进行通信。客户端程序在编译时会引用 C API 头文件，同时可以连接到 C API 库文件。

  说明

  LibOBClient 生成的 so 文件为 libobclient.so（对应 MySQL 的 libmysqlclient.so），OceanBase 数据库安装后的命令行工具是 OBClient（对应 MySQL 的命令行工具）。

  使用 C 应用程序连接 OceanBase 数据库的具体操作示例请参见 创建 C 示例应用程序。

Golang

• Golang 驱动

  • Go-SQL-Driver/MySQL

    Go-SQL-Driver/MySQL 是一个用 Go 语言实现的 MySQL 驱动程序，它遵循 Go 的数据库/sql 标准接口，可以方便地与 Go 应用程序进行集成。使用 Go-SQL-Driver/MySQL 应用程序连接 OceanBase 数据库的具体操作示例请参见 创建 Go 示例应用程序。

• Golang ORM

  • GORM

    GORM 是一个用于 Go 语言的优秀 ORM（对象关系映射）库，它提供了丰富的功能，帮助开发者更轻松地与数据库进行交互。使用 GORM 连接 OceanBase 数据库的具体操作示例请参见 GORM 连接 OceanBase 数据库示例程序。

Java

• Java 驱动（MySQL Connector/J）

  • MySQL Connector/J 是 MySQL 官方提供的 JDBC 驱动程序。

    使用 Java 驱动程序连接 OceanBase 数据库的具体操作示例请参见 创建 Java 示例应用程序。

  • SpringJDBC

    SpringJDBC 连接 OceanBase 数据库的具体操作示例请参见 SpringJDBC 连接 OceanBase 数据库。

• Java ORM 框架

  • SpringBoot

    SpringBoot 连接 OceanBase 数据库的具体操作示例请参见 SpringBoot 连接 OceanBase 数据库。

  • SpringBatch

    SpringBatch 连接 OceanBase 数据库的具体操作示例请参见 SpringBatch 连接 OceanBase 数据库。

  • SpringJPA

    SpringJPA 连接 OceanBase 数据库的具体操作示例请参见 SpringJPA 连接 OceanBase 数据库。

  • Hibernate

    Hibernate 连接 OceanBase 数据库的具体操作示例请参见 Hibernate 连接 OceanBase 数据库。

  • MyBatis

    MyBatis 连接 OceanBase 数据库的具体操作示例请参见 MyBatis 连接 OceanBase 数据库。

• Java 库测试工具

  • TestContainers

    TestContainers 是开源的 Java 库测试工具，主要用于提供轻量级的容器化测试环境。它提供容器化的依赖环境，允许开发者在测试中快速启动和管理 Docker 容器，以便于进行集成测试。使用 TestContainers 连接 OceanBase 数据库的具体操作示例请参见 TestContainers Java 连接 OceanBase 数据库示例程序。

PHP

• PHP 驱动

  • EXT

    EXT（PHP Extension）是 PHP 的一个扩展，用于与不同的数据库进行连接和交互。它提供了多种功能，以便开发人员可以更好地操作数据库和处理数据。使用 EXT 连接 OceanBase 数据库的具体操作示例请参见 EXT 驱动连接 OceanBase 数据库示例程序。

  • MySQLi

    MySQLi（MySQL Improved）是 PHP 官方提供的一个扩展，用于与 MySQL 数据库进行交互。它支持面向对象和过程化编程，提供了准备好的语句、事务支持和多查询等功能，旨在提高性能和安全性。使用 MySQLi 连接 OceanBase 数据库的具体操作示例请参见 使用 MySQLi 驱动连接 OceanBase 数据库。

  • PDO

    PDO（PHP Data Objects）是一个数据库访问抽象层，允许开发者以统一的方式与多种数据库进行交互。PDO 支持预处理语句，有助于提高安全性，并使得代码在不同数据库之间的迁移变得更加简便。使用 PDO 连接 OceanBase 数据库的具体操作示例请参见 使用 PDO 驱动连接 OceanBase 数据库。

Python

• Python 驱动（PyMySQL）

  • PyMySQL

    PyMySQL是在 Python3.x 版本中用于连接 MySQL 服务器的一个库。遵循 Python 数据库 API v2.0 规范，并包含了 pure-Python MySQL 客户端库。在 OceanBase 数据库的 MySQL 模式下，用户可以使用 PyMySQL 驱动为 Python 应用程序提供与 OceanBase 数据库的连接。使用 Python 应用程序连接 OceanBase 数据库的具体操作示例请参见 创建 Python 示例应用程序。

  • mysqlclient

    mysqlclient 是一个 MySQL 数据库的 Python 客户端库，它是对 MySQL 官方 C API 的一个封装。使用 mysqlclient 应用程序连接 OceanBase 数据库的具体操作示例请参见 mysqlclient 连接 OceanBase 数据库示例程序。

  • MySQL-connector-python

    MySQL-connector-python 是由 Oracle 官方提供的 MySQL 数据库驱动程序，专门为 Python 设计。它遵循 Python 数据库 API v2.0 规范，提供了一组完整的功能，可以方便地通过 Python 代码与 MySQL 数据库交互。该库是跨平台的，支持 Python 2 和 3，并且是纯 Python 实现，无需依赖任何外部库。在 OceanBase 数据库的 MySQL 模式下，MySQL-connector-python 也可用于建立与 OceanBase 数据库的连接，执行查询和管理数据。使用 MySQL-connector-python 应用程序连接 OceanBase 数据库的具体操作示例请参见 创建 MySQL-connector-python 连接 OceanBase 数据库示例程序。

连接池

OceanBase 数据库支持多种连接池连接，您可以根据业务特点自行选择连接池实现。

• Tomcat
• C3P0
• Proxool
• HikariCP
• DBCP
• Commons Pool
• Druid