weaviate.backup package

Module for backup/restore operations

class weaviate.backup.BackupStorage(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Which backend should be used to write the backup to.

AZURE = 'azure'

FILESYSTEM = 'filesystem'

GCS = 'gcs'

S3 = 's3'

Submodules

weaviate.backup.backup module

Backup class definition.

class weaviate.backup.backup.BackupCompressionLevel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Which compression level should be used to compress the backup.

BEST_COMPRESSION = 'BestCompression'

BEST_SPEED = 'BestSpeed'

DEFAULT = 'DefaultCompression'

pydantic model weaviate.backup.backup.BackupConfigCreate

Bases: _BackupConfigBase

Options to configure the backup when creating a backup.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field ChunkSize: int | None = None (alias 'chunk_size')

field CompressionLevel: BackupCompressionLevel | None = None (alias 'compression_level')

pydantic model weaviate.backup.backup.BackupConfigRestore

Bases: _BackupConfigBase

Options to configure the backup when restoring a backup.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

pydantic model weaviate.backup.backup.BackupReturn

Bases: BackupStatusReturn

Return type of the backup creation and restore methods.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field collections: List[str] [Optional] (alias 'classes')

class weaviate.backup.backup.BackupStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The status of a backup.

CANCELED = 'CANCELED'

FAILED = 'FAILED'

STARTED = 'STARTED'

SUCCESS = 'SUCCESS'

TRANSFERRED = 'TRANSFERRED'

TRANSFERRING = 'TRANSFERRING'

pydantic model weaviate.backup.backup.BackupStatusReturn

Bases: BaseModel

Return type of the backup status methods.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field backup_id: str [Required] (alias 'id')

field error: str | None = None

field path: str [Required]

field status: BackupStatus [Required]

class weaviate.backup.backup.BackupStorage(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Which backend should be used to write the backup to.

AZURE = 'azure'

FILESYSTEM = 'filesystem'

GCS = 'gcs'

S3 = 's3'