weaviate.backup

Module for backup/restore operations.

class weaviate.backup.BackupStorage(*values)

Bases: str, Enum

Which backend should be used to write the backup to.

FILESYSTEM = 'filesystem'

S3 = 's3'

GCS = 'gcs'

AZURE = 'azure'

class weaviate.backup._BackupAsync(connection)

Bases: _BackupExecutor[ConnectionAsync]

Parameters:

connection (ConnectionSync | ConnectionAsync)

class weaviate.backup._Backup(connection)

Bases: _BackupExecutor[ConnectionSync]

Parameters:

connection (ConnectionSync | ConnectionAsync)

weaviate.backup.backup

class weaviate.backup.backup.BackupCompressionLevel(*values)

Bases: str, Enum

Which compression level should be used to compress the backup.

DEFAULT = 'DefaultCompression'

BEST_SPEED = 'BestSpeed'

BEST_COMPRESSION = 'BestCompression'

ZSTD_BEST_SPEED = 'ZstdBestSpeed'

ZSTD_DEFAULT = 'ZstdDefaultCompression'

ZSTD_BEST_COMPRESSION = 'ZstdBestCompression'

NO_COMPRESSION = 'NoCompression'

class weaviate.backup.backup.BackupStorage(*values)

Bases: str, Enum

Which backend should be used to write the backup to.

FILESYSTEM = 'filesystem'

S3 = 's3'

GCS = 'gcs'

AZURE = 'azure'

class weaviate.backup.backup.BackupStatus(*values)

Bases: str, Enum

The status of a backup.

STARTED = 'STARTED'

TRANSFERRING = 'TRANSFERRING'

TRANSFERRED = 'TRANSFERRED'

SUCCESS = 'SUCCESS'

FAILED = 'FAILED'

CANCELED = 'CANCELED'

pydantic model weaviate.backup.backup._BackupConfigBase

Bases: BaseModel

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 CPUPercentage: int | None = None (alias 'cpu_percentage')

_to_dict()

Return type:

Dict[str, Any]

_abc_impl = <_abc._abc_data object>

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')

DEPRECATED: This parameter no longer has any effect.

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

_abc_impl = <_abc._abc_data object>

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.

_abc_impl = <_abc._abc_data object>

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]

_abc_impl = <_abc._abc_data object>

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')

_abc_impl = <_abc._abc_data object>

pydantic model weaviate.backup.backup.BackupListReturn

Bases: BaseModel

Return type of the backup list method.

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 collections: List[str] [Optional] (alias 'classes')

field completed_at: datetime | None = None (alias 'completedAt')

field size: float = 0

field started_at: datetime | None = None (alias 'startedAt')

field status: BackupStatus [Required]

_abc_impl = <_abc._abc_data object>

weaviate.backup.backup_location

pydantic model weaviate.backup.backup_location._BackupLocationConfig

Bases: BaseModel

The dynamic location of 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.

_to_dict()

Return type:

Dict[str, Any]

_abc_impl = <_abc._abc_data object>

pydantic model weaviate.backup.backup_location._BackupLocationFilesystem

Bases: _BackupLocationConfig

The dynamic location of a backup for filesystem.

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 path: str [Required]

_abc_impl = <_abc._abc_data object>

pydantic model weaviate.backup.backup_location._BackupLocationS3

Bases: _BackupLocationConfig

The dynamic location of a backup for S3.

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 bucket: str [Required]

field path: str [Required]

_abc_impl = <_abc._abc_data object>

pydantic model weaviate.backup.backup_location._BackupLocationGCP

Bases: _BackupLocationConfig

The dynamic location of a backup for GCP.

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 bucket: str [Required]

field path: str [Required]

_abc_impl = <_abc._abc_data object>

pydantic model weaviate.backup.backup_location._BackupLocationAzure

Bases: _BackupLocationConfig

The dynamic location of a backup for Azure.

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 bucket: str [Required]

field path: str [Required]

_abc_impl = <_abc._abc_data object>

class weaviate.backup.backup_location.BackupLocation

Bases: object

The dynamic path of a backup.

FileSystem

alias of _BackupLocationFilesystem

S3

alias of _BackupLocationS3

GCP

alias of _BackupLocationGCP

Azure

alias of _BackupLocationAzure