API Reference
seekdb allows you to use seekdb through APIs.
APIs
The following APIs are supported.
Database
info
You can use this API only when you connect to seekdb by using the AdminClient. For more information about the AdminClient, see Admin Client.
| API | Description | Documentation |
|---|---|---|
create_database() | Creates a database. | Documentation |
get_database() | Retrieves a specified database. | Documentation |
list_databases() | Retrieves a list of databases in an instance. | Documentation |
delete_database() | Deletes a specified database. | Documentation |
Collection
info
You can use this API only when you connect to seekdb by using the Client. For more information about the Client, see Client.
| API | Description | Documentation |
|---|---|---|
create_collection() | Creates a collection. | Documentation |
get_collection() | Retrieves a specified collection. | Documentation |
get_or_create_collection() | Creates or queries a collection. If the collection does not exist in the database, it is created. If the collection exists, the corresponding result is obtained. | Documentation |
list_collections() | Retrieves the collection list in a database. | Documentation |
count_collection() | Counts the number of collections in a database. | Documentation |
delete_collection() | Deletes a specified collection. | Documentation |
DML
info
You can use this API only when you connect to seekdb by using the Client. For more information about the Client, see Client.
| API | Description | Documentation |
|---|---|---|
add() | Inserts a new record into a collection. | Documentation |
update() | Updates an existing record in a collection. | Documentation |
upsert() | Inserts a new record or updates an existing record. | Documentation |
delete() | Deletes a record from a collection. | Documentation |
DQL
info
You can use this API only when you connect to seekdb by using the Client. For more information about the Client, see Client.
| API | Description | Documentation |
|---|---|---|
query() | Performs vector similarity search. | Documentation |
get() | Queries specific data from a table by using the ID, document, and metadata (non-vector). | Documentation |
hybrid_search() | Performs full-text search and vector similarity search by using ranking. | Documentation |