跳到主要内容

Client

Client 用于连接不同模式的数据库，嵌入式模式和服务器模式，会根据提供的参数自动选择合适的连接模式。

提示

OceanBase 数据库是 OceanBase 提供的一款完全自研的企业级原生分布式数据库，在普通硬件上实现金融级高可用，首创“三地五中心”城市级故障自动无损容灾新标准，刷新 TPC-C 标准测试，单集群规模超过 1500 节点，具有云原生、强一致性、高度兼容 Oracle/MySQL 等特性。有关 OceanBase 数据库的更多信息，参见 OceanBase 数据库。

连接嵌入式 seekdb​

通过 Client 连接到本地嵌入式 seekdb 实例。

import pyseekdb

# Create embedded client
client = pyseekdb.Client(
    #path="./seekdb",      # Path to SeekDB data directory
    #database="test"        # Database name
)

参数说明：

参数取值类型是否必选描述取值示例
pathstring可选seekdb 数据目录的路径。seekdb 会在该路径下存储数据库文件并在启动时加载。./seekdb
databasestring可选数据库名称。test

连接远程服务器​

通过 Client 连接到远程服务器，支持连接到 seekdb 和 OceanBase 数据库。

提示

连接之前，请确保您已经部署了服务器模式的 seekdb 或者 OceanBase 数据库。
有关服务器模式 seekdb 的部署方法，参见 部署概述。
有关 OceanBase 数据库的部署方法，参见 部署概述。

示例：连接到服务器模式的 seekdb

import pyseekdb

# Create remote server client (SeekDB Server)
client = pyseekdb.Client(
    host="127.0.0.1",      # Server host
    port=2881,              # Server port
    database="test",        # Database name
    user="root",            # Username
    password=""             # Password (can be retrieved from SEEKDB_PASSWORD environment variable)
)

参数说明：

参数取值类型是否必选描述取值示例
hoststring必选实例所在服务器 IP。127.0.0.1
protstring必选实例端口。默认为 2881。2881
databasestring必选数据库名。test
userstring必选用户名。默认为 root。root
passwordstring必选用户所对应的密码。如果未提供 password 或者填写了空字符串，系统会通过 SEEKDB_PASSWORD 环境变量获取。

示例：连接到 OceanBase 数据库

import pyseekdb

# Create remote server client (OceanBase Server)
client = pyseekdb.Client(
    host="127.0.0.1",      # Server host
    port=2881,              # Server port (default: 2881)
    tenant="test",         # Tenant name
    database="test",       # Database name
    user="root",           # Username (default: "root")
    password=""             # Password (can be retrieved from SEEKDB_PASSWORD environment variable)
)

参数说明：

参数取值类型是否必选描述取值示例
hoststring必选数据库所在服务器 IP。127.0.0.1
protstring必选OceanBase 数据库端口。默认为 2881。2881
tenantstring可选租户名。seekdb 是不需要写这个参数的，只有 oceanbase 数据库的时候需要，默认是 sys。test
databasestring必选数据库名。test
userstring必选租户对应的用户名。默认为 root。root
passwordstring必选用户所对应的密码。如果未提供 password 或者填写了空字符串，系统会通过 SEEKDB_PASSWORD 环境变量获取。

使用 Client 进行连接所支持的接口​

当使用 Client 连接数据库时，支持使用以下 API 接口。

API 接口描述相关文档链接
create_collection()创建一个新的 collection。文档
get_collection()查询指定的 collection。文档
delete_collection()删除指定的 collection。文档
list_collections()列出当前数据库中全部的 collections。文档
get_or_create_collection()查询指定的 collection，如果该 collection 不存在则会创建该 collection。文档
count_collection()查询当前数据库中所有 collection 的数量。文档

Contents

编辑此页