list_databases - 获取数据库列表
list_databases() 用于获取实例中的数据库列表。
信息
仅支持在使用 AdminClient 连接时，才能使用该接口。关于 AdminClient 的详细介绍，参见 Admin Client。
前提条件
-
您已经安装了 pyseekdb，有关安装 pyseekdb 的详细信息，参见 快速开始。
-
您已经连接到数据库。有关连接的详细操作参见 Admin Client。
请求参数
list_databases(limit=None, offset=None, tenant=DEFAULT_TENANT)
| 参数 | 取值类型 | 是否必选 | 描述 | 取值示例 |
|---|---|---|---|---|
limit | int | 可选 | 返回数据库的最大数量。 | 2 |
offset | int | 可选 | 从前往后跳过的数据库个数。 | 3 |
tenant | string | 可选
| 指定所查询的数据库归属的租户。 | test_tenant |
请求示例
# List all databases
import pyseekdb
# Embedded mode
admin = pyseekdb.AdminClient(path="./seekdb")
# list database
databases = admin.list_databases(2,3)
for db in databases:
print(f"Database: {db.name}, Charset: {db.charset}, collation:{db.collation}, metadata:{db.metadata}")
返回参数
| 参数 | 返回类型 | 是否必选 | 描述 | 返回示例 |
|---|---|---|---|---|
name | string | 必选 | 所查询的数据库的名称。 | my_database |
tenant | string | 可选 当使用嵌入式 seekdb 和服务器模式 SeekDB 时，没有该参数。 | 所查询的数据库归属的租户。 | test_tenant |
charset | string | 可选 | 所查询的数据库使用的字符集。 | utf8mb4 |
collation | string | 可选 | 所查询的数据库使用的的排序方式。 | utf8mb4_general_ci |
metadata | dict | 可选 | 预留字段，暂无数据 |
返回示例
Database: test, Charset: utf8mb4, collation:utf8mb4_general_ci, metadata:{}
Database: my_database, Charset: utf8mb4, collation:utf8mb4_general_ci, metadata:{}