API reference
You can use the API to programmatically access seekdb.
API
The following APIs are supported.
Database
info
You can use the following APIs only when you connect to the database by using the SeekdbAdminClient. For more information about the SeekdbAdminClient, see SeekdbAdminClient.
| API | Description | Related document link |
|---|---|---|
createDatabase() | Creates a database. | Documentation |
getDatabase() | Gets a specified database. | Documentation |
listDatabases() | Gets the list of databases in the instance. | Documentation |
deleteDatabase() | Deletes a specified database. | Documentation |
Collection
info
You can use the following APIs only when you connect to the database by using the SeekdbClient. For more information about the SeekdbClient, see SeekdbClient.
| API | Description | Related document link |
|---|---|---|
createCollection() | Creates a collection. | Documentation |
getCollection() | Gets a specified collection. | Documentation |
getOrCreateCollection() | Creates or queries a collection. If the collection does not exist in the database, it is created. If it exists, the corresponding result is obtained. | Documentation |
fork() | Forks a specified collection to create a new collection with the same data. | Documentation |
listCollections() | Gets the list of collections in the database. | Documentation |
countCollection() | Counts the number of collections in the database. | Documentation |
hasCollection() | Checks whether a specified collection exists in the database. | Documentation |
deleteCollection() | Deletes a specified collection. | Documentation |
DML
info
You can use the following APIs only when you connect to seekdb by using the SeekdbClient. For more information about the SeekdbClient, see SeekdbClient.
| API | Description | Related document link |
|---|---|---|
add() | Inserts a new record into the collection. | Documentation |
update() | Updates an existing record in the collection. | Documentation |
upsert() | Inserts a new record or updates an existing record. | Documentation |
delete() | Deletes a record from the collection. | Documentation |
DQL
info
You can use the following APIs only when you connect to seekdb by using the SeekdbClient. For more information about the SeekdbClient, see SeekdbClient.
| API | Description | Related document link |
|---|---|---|
query() | A vector similarity search method. | Documentation |
get() | Queries specific data from the table by using the ID, document, and metadata (non-vector). | Documentation |
hybridSearch() | A hybrid search method that combines full-text search and vector similarity search. | Documentation |