Noizu.Weaviate.Api.Backups (Noizu Weaviate v0.1.1)
Functions for working with backups in Weaviate.
Summary
Functions
Create a backup in Weaviate.
Get the status of a restore operation in Weaviate.
Get the status of a backup in Weaviate.
Restore a backup in Weaviate.
Functions
create_backup(backend, backup_id, options \\ [], opts \\ %{})
@spec create_backup(String.t(), String.t(), Keyword.t(), map()) :: {:ok, Noizu.Weaviate.Struct.RespObj} | {:error, any()}
Create a backup in Weaviate.
Parameters
backend(required) - The name of the backup provider module.backup_id(required) - The ID of the backup.include(optional) - An optional list of class names to be included in the backup.exclude(optional) - An optional list of class names to be excluded from the backup.options(optional) - Additional options for the API call.
Returns
A tuple {:ok, response} on successful API call, where response is of type Noizu.Weaviate.Struct.RespObj.
Returns {:error, term} on failure, where term contains error details.
Examples
{:ok, response} = Noizu.Weaviate.Api.Backups.create_backup("s3", "my-backup", include: ["Product"], exclude: ["User"])get_restore_status(backend, backup_id, opts \\ [])
@spec get_restore_status(String.t(), String.t(), map()) :: {:ok, Noizu.Weaviate.Struct.RespObj} | {:error, any()}
Get the status of a restore operation in Weaviate.
Parameters
backend(required) - The name of the backup provider module.backup_id(required) - The ID of the backup.options(optional) - Additional options for the API call.
Returns
A tuple {:ok, response} on successful API call, where response is of type Noizu.Weaviate.Struct.RespObj.
Returns {:error, term} on failure, where term contains error details.
Examples
{:ok, response} = Noizu.Weaviate.Api.Backups.get_restore_status("s3", "my-backup")get_status(backend, backup_id, opts \\ %{})
@spec get_status(String.t(), String.t(), map()) :: {:ok, Noizu.Weaviate.Struct.RespObj} | {:error, any()}
Get the status of a backup in Weaviate.
Parameters
backend(required) - The name of the backup provider module.backup_id(required) - The ID of the backup.options(optional) - Additional options for the API call.
Returns
A tuple {:ok, response} on successful API call, where response is of type Noizu.Weaviate.Struct.RespObj.
Returns {:error, term} on failure, where term contains error details.
Examples
{:ok, response} = Noizu.Weaviate.Api.Backups.get_status("s3", "my-backup")restore_backup(backend, backup_id, options \\ [], opts \\ %{})
@spec restore_backup(String.t(), String.t(), Keyword.t(), map()) :: {:ok, Noizu.Weaviate.Struct.RespObj} | {:error, any()}
Restore a backup in Weaviate.
Parameters
backend(required) - The name of the backup provider module.backup_id(required) - The ID of the backup.include(optional) - An optional list of class names to be included in the restore.exclude(optional) - An optional list of class names to be excluded from the restore.options(optional) - Additional options for the API call.
Returns
A tuple {:ok, response} on successful API call, where response is of type Noizu.Weaviate.Struct.RespObj.
Returns {:error, term} on failure, where term contains error details.
Examples
{:ok, response} = Noizu.Weaviate.Api.Backups.restore_backup("s3", "my-backup", include: ["Product"], exclude: ["User"])