Admin Client

AdminClient 提供数据库管理操作。它使用与 Client 相同的数据库连接模式，但仅支持数据库管理相关操作。

连接嵌入式 seekdb

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

import pyseekdb

# Embedded mode - Database management
admin = pyseekdb.AdminClient(path="./seekdb")

参数说明：

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

连接远程服务器

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

提示

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

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

import pyseekdb

# Remote server mode - Database management
admin = pyseekdb.AdminClient(
    host="127.0.0.1",
    port=2881,
    user="root",
    password=""  # Can be retrieved from SEEKDB_PASSWORD environment variable
)

参数说明：

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

示例：连接到 OceanBase 数据库

import pyseekdb

# Remote server mode - Database management
admin = pyseekdb.AdminClient(
    host="127.0.0.1",
    port=2881,
    tenant="test"
    user="root",
    password=""  # Can be retrieved from SEEKDB_PASSWORD environment variable
)

参数说明：

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

使用 AdminClient 进行连接所支持的接口

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

API 接口	描述	相关文档链接
create_database	创建一个新数据库。	文档
get_database	查询指定的数据库。	文档
delete_database	删除指定的数据。	文档
list_databases	列出所有数据库。	文档