vector_database_credentials
Creates, updates, deletes, gets or lists a vector_database_credentials resource.
Overview
| Name | vector_database_credentials |
| Type | Resource |
| Id | digitalocean.databases.vector_database_credentials |
Fields
The following fields are returned by SELECT queries:
- vector_databases_get_credentials
A successful response.
| Name | Datatype | Description |
|---|---|---|
user_id | string | Database user id from the cluster secret (opaque; matches what was provisioned). (example: 123e4567-e89b-12d3-a456-426614174000) |
api_token | string | API token for that user. (example: example string) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
vector_databases_get_credentials | select | id | To retrieve the admin credentials for a vector database, send a GET request to /v2/vector-databases/{id}/credentials. The response body contains the user_id and api_token for the admin user provisioned on the cluster. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the vector database. (example: "example string") |
SELECT examples
- vector_databases_get_credentials
To retrieve the admin credentials for a vector database, send a GET request to /v2/vector-databases/{id}/credentials. The response body contains the user_id and api_token for the admin user provisioned on the cluster.
SELECT
user_id,
api_token
FROM digitalocean.databases.vector_database_credentials
WHERE id = '{{ id }}' -- required
;