weaviate.backup

Module for backup/restore operations.

class weaviate.backup.BackupStorage(*values)[source]

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)[source]

Bases: _BackupExecutor[ConnectionAsync]

Parameters:: connection (ConnectionSync | ConnectionAsync)

class weaviate.backup._Backup(connection)[source]

Bases: _BackupExecutor[ConnectionSync]

Parameters:: connection (ConnectionSync | ConnectionAsync)

weaviate.backup.backup

class weaviate.backup.backup.BackupCompressionLevel(*values)[source]

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)[source]

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)[source]

Bases: str, Enum

The status of a backup.

STARTED = 'STARTED'

TRANSFERRING = 'TRANSFERRING'

TRANSFERRED = 'TRANSFERRED'

CANCELLING = 'CANCELLING'

FINALIZING = 'FINALIZING'

SUCCESS = 'SUCCESS'

FAILED = 'FAILED'

CANCELED = 'CANCELED'

class weaviate.backup.backup._BackupConfigBase(*, cpu_percentage=None)[source]

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.

Parameters:: cpu_percentage (int | None)

CPUPercentage: int | None

_to_dict()[source]

Return type:: Dict[str, Any]

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup.BackupConfigCreate(*, cpu_percentage=None, chunk_size=None, compression_level=None)[source]

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.

Parameters:

cpu_percentage (int | None)
chunk_size (int | None)
compression_level (BackupCompressionLevel | None)

ChunkSize: int | None

CompressionLevel: BackupCompressionLevel | None

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup.BackupConfigRestore(*, cpu_percentage=None)[source]

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.

Parameters:: cpu_percentage (int | None)

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup.BackupStatusReturn(*, error=None, status, path, id, size=0)[source]

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.

Parameters:

error (str | None)
status (BackupStatus)
path (str)
id (str)
size (float)

error: str | None

status: BackupStatus

path: str

backup_id: str

size: float

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup.BackupReturn(*, error=None, status, path, id, size=0, classes=<factory>)[source]

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.

Parameters:

error (str | None)
status (BackupStatus)
path (str)
id (str)
size (float)
classes (List[str])

collections: List[str]

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup.BackupListReturn(*, classes=<factory>, status, id, startedAt=None, completedAt=None, size=0)[source]

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.

Parameters:

classes (List[str])
status (BackupStatus)
id (str)
startedAt (datetime | None)
completedAt (datetime | None)
size (float)

collections: List[str]

status: BackupStatus

backup_id: str

started_at: datetime | None

completed_at: datetime | None

size: float

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

weaviate.backup.backup_location

class weaviate.backup.backup_location._BackupLocationConfig[source]

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()[source]

Return type:: Dict[str, Any]

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup_location._BackupLocationFilesystem(*, path)[source]

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.

Parameters:: path (str)

path: str

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup_location._BackupLocationS3(*, path, bucket)[source]

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.

Parameters:

path (str)
bucket (str)

path: str

bucket: str

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup_location._BackupLocationGCP(*, path, bucket)[source]

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.

Parameters:

path (str)
bucket (str)

path: str

bucket: str

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup_location._BackupLocationAzure(*, path, bucket)[source]

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.

Parameters:

path (str)
bucket (str)

path: str

bucket: str

_abc_impl = <_abc._abc_data object>

model_config = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.backup.backup_location.BackupLocation[source]

Bases: object

The dynamic path of a backup.

FileSystem: alias of _BackupLocationFilesystem

S3: alias of _BackupLocationS3

GCP: alias of _BackupLocationGCP

Azure: alias of _BackupLocationAzure