API 参考
seekdb 支持通过 API 以编程的方式来使用 seekdb。
API 接口
目前支持以下 API 接口。
Database
信息
仅支持在使用 AdminClient 连接时，才能使用该接口。关于 AdminClient 的详细介绍，参见 Admin Client。
| API 接口 | 描述 | 相关文档链接 |
|---|---|---|
create_database() | 创建数据库。 | 文档 |
get_database() | 获取指定数据库。 | 文档 |
list_databases() | 获取实例中数据库列表。 | 文档 |
delete_database() | 删除指定数据库。 | 文档 |
Collection
信息
仅支持在使用 Client 连接时，才能使用该接口。关于 Client 的详细介绍，参见 Client。
| API 接口 | 描述 | 相关文档链接 |
|---|---|---|
create_collection() | 创建 collection。 | 文档 |
get_collection() | 获取指定 collection。 | 文档 |
get_or_create_collection() | 创建或者查询 Collection，如果数据库中 Collection 不存在，则创建；如果存在 Collection，则获取相应的结果。 | 文档 |
list_collections() | 获取数据库 collection 列表。 | 文档 |
count_collection() | 统计数据库中的 Collection 数量 | 文档 |
delete_collection() | 删除指定 collection。 | 文档 |
DML
信息
仅支持在使用 Client 连接时，才能使用该接口。关于 Client 的详细介绍，参见 Client。
| API 接口 | 描述 | 相关文档链接 |
|---|---|---|
add() | 将新记录插入到 collection 中。 | 文档 |
update() | 更新 collection 中的现有记录。 | 文档 |
upsert() | 插入新记录或更新现有记录。 | 文档 |
delete() | 从 collection 中删除记录。 | 文档 |
DQL
信息
仅支持在使用 Client 连接时，才能使用该接口。关于 Client 的详细介绍，参见 Client。