vector_database_backups

Creates, updates, deletes, gets or lists a vector_database_backups resource.

Overview

Name	vector_database_backups
Type	Resource
Id	digitalocean.databases.vector_database_backups

Fields

The following fields are returned by SELECT queries:

vector_databases_get_restore_status

A successful response.

Name	Datatype	Description
backup_id	string	The backup ID being restored. (example: 123e4567-e89b-12d3-a456-426614174000)
error	string	Error message if the restore failed. (example: example string)
status	string	Current status: STARTED, TRANSFERRING, TRANSFERRED, FINALIZING, SUCCESS, FAILED, CANCELLING, CANCELED. (example: example string)

vector_databases_list_backups

A successful response.

Name	Datatype	Description
backup_id	string	Unique identifier for the backup (e.g., "vectordb-{uuid}-20240101-120000"). (example: 123e4567-e89b-12d3-a456-426614174000)
completed_at	string (date-time)	Timestamp when the backup process completed. (example: 2023-01-01T00:00:00Z)
started_at	string (date-time)	Timestamp when the backup process started. (example: 2023-01-01T00:00:00Z)
status	string	Status of the backup: SUCCESS. (example: example string)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
vector_databases_get_restore_status	select	id, backup_id		To check the status of a restore operation, send a GET request to /v2/vector-databases/{id}/backups/{backup_id}/restore. The response body contains the current status of the restore.
vector_databases_list_backups	select	id		To list the available backups for a vector database, send a GET request to /v2/vector-databases/{id}/backups. Only backups with a status of SUCCESS are returned.
vector_databases_post_restore_backup	exec	id, backup_id		To restore a vector database from a backup, send a POST request to /v2/vector-databases/{id}/backups/{backup_id}/restore. The restore runs asynchronously; use the restore-status endpoint to monitor its progress.

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
backup_id	string	Required. ID of the backup to restore from. (example: "example string")
id	string	Required. ID of the vector database. (example: "example string")

SELECT examples

vector_databases_get_restore_status

To check the status of a restore operation, send a GET request to /v2/vector-databases/{id}/backups/{backup_id}/restore. The response body contains the current status of the restore.

SELECT
backup_id,
error,
status
FROM digitalocean.databases.vector_database_backups
WHERE id = '{{ id }}' -- required
AND backup_id = '{{ backup_id }}' -- required
;

vector_databases_list_backups

To list the available backups for a vector database, send a GET request to /v2/vector-databases/{id}/backups. Only backups with a status of SUCCESS are returned.

SELECT
backup_id,
completed_at,
started_at,
status
FROM digitalocean.databases.vector_database_backups
WHERE id = '{{ id }}' -- required
;

Lifecycle Methods

vector_databases_post_restore_backup

To restore a vector database from a backup, send a POST request to /v2/vector-databases/{id}/backups/{backup_id}/restore. The restore runs asynchronously; use the restore-status endpoint to monitor its progress.

EXEC digitalocean.databases.vector_database_backups.vector_databases_post_restore_backup 
@id='{{ id }}' --required, 
@backup_id='{{ backup_id }}' --required 
@@json=
'{
"backup_id": "{{ backup_id }}", 
"id": "{{ id }}"
}'
;