provider

Backup provider classes

Classes:

• BackupProviderBase –

  Base BackupProvider class

• MySQLBackupProvider –
• MariaDbBackupProvider –
• PostgresBackupProvider –

  Postgres backup provider

• RedisBackupProvider –

Attributes

BACKUP_PROVIDERS module-attribute

BACKUP_PROVIDERS = [
    MariaDbBackupProvider,
    MySQLBackupProvider,
    PostgresBackupProvider,
    RedisBackupProvider,
]

Classes

BackupProviderBase

BackupProviderBase(
    container: Container,
    compression: CompressionAlgorithm | None = None,
)

Base BackupProvider class

Backup provider constructor

Parameters:

• container

  (Container) –

  Container object

• compression

  (CompressionAlgorithm | None, default: None ) –

  Compression algorithm

Methods:

• dump –

  Dump database

• restore –

  Restore database

• is_backup_provider –

  Checks if container supports a backup provider

• validate_file –

  Validate the generated file

• trigger_webhook –

  Trigger webhook.

• trigger_error_webhook –

  Triggers an error on the webhook. code is appended to the address.

• trigger_success_webhook –

  Triggers an success on the webhook.

• get_dump_binary –

  Get the binary used to dump the backup.

• get_dump_args –

  Arguments for the dump binary.

• get_restore_binary –

  Get the binary used to restore the backup.

• get_restore_args –

  Arguments for the restore binary.

• get_container_env –

  Get environment variables from container.

• binary_exists_in_container –

  Check if binary exists inside the container.

• get_container_label –

  Get labels for container.

• get_service_name –

  Get service name (only if started with docker compose).

Attributes:

• name (str) –

  Backup provider name (e.g. postgres)

• default_dump_binary (str | None) –

  Default dump binary

• default_dump_args (str | None) –

  Default dump binary arguments

• default_restore_binary (str | None) –

  Default restore binary

• default_restore_args (str | None) –

  Default restore binary arguments

• min_file_size (int) –

  Maximum file size, used to validate the generated file

• pattern (str | None) –

  Pattern which is checked in the dumped file

• plain_file_extension (str) –

  File extenstion used for the dumped file

• compression (CompressionAlgorithm | None) –

  Compression algorithm

• container (Container) –

  Container object

Attributes

name class-attribute instance-attribute

name: str = None

Backup provider name (e.g. postgres)

default_dump_binary class-attribute instance-attribute

default_dump_binary: str | None = None

Default dump binary

default_dump_args class-attribute instance-attribute

default_dump_args: str | None = None

Default dump binary arguments

default_restore_binary class-attribute instance-attribute

default_restore_binary: str | None = 'RESTORE_COMMAND'

Default restore binary

default_restore_args class-attribute instance-attribute

default_restore_args: str | None = ''

Default restore binary arguments

min_file_size class-attribute instance-attribute

min_file_size: int = 200

Maximum file size, used to validate the generated file

pattern class-attribute instance-attribute

pattern: str | None = None

Pattern which is checked in the dumped file

plain_file_extension class-attribute instance-attribute

plain_file_extension: str = '.sql'

File extenstion used for the dumped file

compression instance-attribute

compression: CompressionAlgorithm | None = compression

Compression algorithm

container instance-attribute

container: Container = container

Container object

Functions

dump

dump() -> str

Dump database

restore

restore(backup_file: Path) -> None

Restore database

is_backup_provider

is_backup_provider() -> bool

Checks if container supports a backup provider

validate_file

validate_file(file_path: Path) -> bool

Validate the generated file

trigger_webhook

trigger_webhook(
    message: str,
    address: str,
    code: int = 0,
    append: str = "",
) -> None

Trigger webhook.

Parameters:

• message

  (str) –

  Message send to the webhook

• address

  (str) –

  If not set taken from the label

• code

  (int, default: 0 ) –

  Code which is sent to the webhook

• append

  (str, default: '' ) –

  Path appended to address (can be used for fails)

trigger_error_webhook

trigger_error_webhook(
    message: str, address: str, code: int = 1
) -> None

Triggers an error on the webhook. code is appended to the address.

trigger_success_webhook

trigger_success_webhook(
    message: str, address: str, code: int = 0
) -> None

Triggers an success on the webhook.

get_dump_binary

get_dump_binary() -> str

Get the binary used to dump the backup.

get_dump_args

get_dump_args() -> str

Arguments for the dump binary.

get_restore_binary

get_restore_binary() -> str

Get the binary used to restore the backup.

get_restore_args

get_restore_args() -> str

Arguments for the restore binary.

get_container_env

get_container_env() -> dict[str, str | None]

Get environment variables from container.

binary_exists_in_container

binary_exists_in_container(binary_name: str) -> bool

Check if binary exists inside the container.

get_container_label

get_container_label(
    label: str, default: str | None = None
) -> str | None

Get labels for container.

get_service_name

get_service_name() -> str

Get service name (only if started with docker compose).

MySQLBackupProvider

MySQLBackupProvider(
    container: Container,
    compression: CompressionAlgorithm | None = None,
)

Backup provider constructor

Parameters:

• container

  (Container) –

  Container object

• compression

  (CompressionAlgorithm | None, default: None ) –

  Compression algorithm

Methods:

• dump –
• restore –
• is_backup_provider –

  Checks if container supports a backup provider

• validate_file –

  Validate the generated file

• trigger_webhook –

  Trigger webhook.

• trigger_error_webhook –

  Triggers an error on the webhook. code is appended to the address.

• trigger_success_webhook –

  Triggers an success on the webhook.

• get_dump_binary –

  Get the binary used to dump the backup.

• get_dump_args –

  Arguments for the dump binary.

• get_restore_binary –

  Get the binary used to restore the backup.

• get_restore_args –

  Arguments for the restore binary.

• get_container_env –

  Get environment variables from container.

• binary_exists_in_container –

  Check if binary exists inside the container.

• get_container_label –

  Get labels for container.

• get_service_name –

  Get service name (only if started with docker compose).

Attributes:

• default_dump_args –
• default_restore_binary (str | None) –

  Default restore binary

• default_restore_args (str | None) –

  Default restore binary arguments

• min_file_size (int) –

  Maximum file size, used to validate the generated file

• pattern (str | None) –

  Pattern which is checked in the dumped file

• plain_file_extension (str) –

  File extenstion used for the dumped file

• compression (CompressionAlgorithm | None) –

  Compression algorithm

• container (Container) –

  Container object

• name –
• default_dump_binary –

Attributes

default_dump_args class-attribute instance-attribute

default_dump_args = '--all-databases'

default_restore_binary class-attribute instance-attribute

default_restore_binary: str | None = 'RESTORE_COMMAND'

Default restore binary

default_restore_args class-attribute instance-attribute

default_restore_args: str | None = ''

Default restore binary arguments

min_file_size class-attribute instance-attribute

min_file_size: int = 200

Maximum file size, used to validate the generated file

pattern class-attribute instance-attribute

pattern: str | None = None

Pattern which is checked in the dumped file

plain_file_extension class-attribute instance-attribute

plain_file_extension: str = '.sql'

File extenstion used for the dumped file

compression instance-attribute

compression: CompressionAlgorithm | None = compression

Compression algorithm

container instance-attribute

container: Container = container

Container object

name class-attribute instance-attribute

name = 'mysql'

default_dump_binary class-attribute instance-attribute

default_dump_binary = 'mysqldump'

Functions

dump

dump() -> str

restore

restore(backup_file: Path) -> None

is_backup_provider

is_backup_provider() -> bool

Checks if container supports a backup provider

validate_file

validate_file(file_path: Path) -> bool

Validate the generated file

trigger_webhook

trigger_webhook(
    message: str,
    address: str,
    code: int = 0,
    append: str = "",
) -> None

Trigger webhook.

Parameters:

• message

  (str) –

  Message send to the webhook

• address

  (str) –

  If not set taken from the label

• code

  (int, default: 0 ) –

  Code which is sent to the webhook

• append

  (str, default: '' ) –

  Path appended to address (can be used for fails)

trigger_error_webhook

trigger_error_webhook(
    message: str, address: str, code: int = 1
) -> None

Triggers an error on the webhook. code is appended to the address.

trigger_success_webhook

trigger_success_webhook(
    message: str, address: str, code: int = 0
) -> None

Triggers an success on the webhook.

get_dump_binary

get_dump_binary() -> str

Get the binary used to dump the backup.

get_dump_args

get_dump_args() -> str

Arguments for the dump binary.

get_restore_binary

get_restore_binary() -> str

Get the binary used to restore the backup.

get_restore_args

get_restore_args() -> str

Arguments for the restore binary.

get_container_env

get_container_env() -> dict[str, str | None]

Get environment variables from container.

binary_exists_in_container

binary_exists_in_container(binary_name: str) -> bool

Check if binary exists inside the container.

get_container_label

get_container_label(
    label: str, default: str | None = None
) -> str | None

Get labels for container.

get_service_name

get_service_name() -> str

Get service name (only if started with docker compose).

MariaDbBackupProvider

MariaDbBackupProvider(
    container: Container,
    compression: CompressionAlgorithm | None = None,
)

Backup provider constructor

Parameters:

• container

  (Container) –

  Container object

• compression

  (CompressionAlgorithm | None, default: None ) –

  Compression algorithm

Methods:

• is_backup_provider –

  Checks if container supports a backup provider

• validate_file –

  Validate the generated file

• trigger_webhook –

  Trigger webhook.

• trigger_error_webhook –

  Triggers an error on the webhook. code is appended to the address.

• trigger_success_webhook –

  Triggers an success on the webhook.

• get_dump_binary –

  Get the binary used to dump the backup.

• get_dump_args –

  Arguments for the dump binary.

• get_restore_binary –

  Get the binary used to restore the backup.

• get_restore_args –

  Arguments for the restore binary.

• get_container_env –

  Get environment variables from container.

• binary_exists_in_container –

  Check if binary exists inside the container.

• get_container_label –

  Get labels for container.

• get_service_name –

  Get service name (only if started with docker compose).

• dump –
• restore –

Attributes:

• default_restore_binary (str | None) –

  Default restore binary

• default_restore_args (str | None) –

  Default restore binary arguments

• min_file_size (int) –

  Maximum file size, used to validate the generated file

• pattern (str | None) –

  Pattern which is checked in the dumped file

• plain_file_extension (str) –

  File extenstion used for the dumped file

• compression (CompressionAlgorithm | None) –

  Compression algorithm

• container (Container) –

  Container object

• name –
• default_dump_args –
• default_dump_binary –

Attributes

default_restore_binary class-attribute instance-attribute

default_restore_binary: str | None = 'RESTORE_COMMAND'

Default restore binary

default_restore_args class-attribute instance-attribute

default_restore_args: str | None = ''

Default restore binary arguments

min_file_size class-attribute instance-attribute

min_file_size: int = 200

Maximum file size, used to validate the generated file

pattern class-attribute instance-attribute

pattern: str | None = None

Pattern which is checked in the dumped file

plain_file_extension class-attribute instance-attribute

plain_file_extension: str = '.sql'

File extenstion used for the dumped file

compression instance-attribute

compression: CompressionAlgorithm | None = compression

Compression algorithm

container instance-attribute

container: Container = container

Container object

name class-attribute instance-attribute

name = 'mariadb'

default_dump_args class-attribute instance-attribute

default_dump_args = '--all-databases'

default_dump_binary class-attribute instance-attribute

default_dump_binary = 'mariadb-dump'

Functions

is_backup_provider

is_backup_provider() -> bool

Checks if container supports a backup provider

validate_file

validate_file(file_path: Path) -> bool

Validate the generated file

trigger_webhook

trigger_webhook(
    message: str,
    address: str,
    code: int = 0,
    append: str = "",
) -> None

Trigger webhook.

Parameters:

• message

  (str) –

  Message send to the webhook

• address

  (str) –

  If not set taken from the label

• code

  (int, default: 0 ) –

  Code which is sent to the webhook

• append

  (str, default: '' ) –

  Path appended to address (can be used for fails)

trigger_error_webhook

trigger_error_webhook(
    message: str, address: str, code: int = 1
) -> None

Triggers an error on the webhook. code is appended to the address.

trigger_success_webhook

trigger_success_webhook(
    message: str, address: str, code: int = 0
) -> None

Triggers an success on the webhook.

get_dump_binary

get_dump_binary() -> str

Get the binary used to dump the backup.

get_dump_args

get_dump_args() -> str

Arguments for the dump binary.

get_restore_binary

get_restore_binary() -> str

Get the binary used to restore the backup.

get_restore_args

get_restore_args() -> str

Arguments for the restore binary.

get_container_env

get_container_env() -> dict[str, str | None]

Get environment variables from container.

binary_exists_in_container

binary_exists_in_container(binary_name: str) -> bool

Check if binary exists inside the container.

get_container_label

get_container_label(
    label: str, default: str | None = None
) -> str | None

Get labels for container.

get_service_name

get_service_name() -> str

Get service name (only if started with docker compose).

dump

dump() -> str

restore

restore(backup_file: Path) -> None

PostgresBackupProvider

PostgresBackupProvider(
    container: Container,
    compression: CompressionAlgorithm | None = None,
)

Postgres backup provider

Backup provider constructor

Parameters:

• container

  (Container) –

  Container object

• compression

  (CompressionAlgorithm | None, default: None ) –

  Compression algorithm

Methods:

• restore –

  Restore database

• is_backup_provider –

  Checks if container supports a backup provider

• validate_file –

  Validate the generated file

• trigger_webhook –

  Trigger webhook.

• trigger_error_webhook –

  Triggers an error on the webhook. code is appended to the address.

• trigger_success_webhook –

  Triggers an success on the webhook.

• get_dump_binary –

  Get the binary used to dump the backup.

• get_dump_args –

  Arguments for the dump binary.

• get_restore_binary –

  Get the binary used to restore the backup.

• get_container_env –

  Get environment variables from container.

• binary_exists_in_container –

  Check if binary exists inside the container.

• get_container_label –

  Get labels for container.

• get_service_name –

  Get service name (only if started with docker compose).

• dump –

  Overwrite dump method with custom postgres dump

• get_restore_args –

  Overwrite restore args with custom postgres arguments

Attributes:

• min_file_size (int) –

  Maximum file size, used to validate the generated file

• pattern (str | None) –

  Pattern which is checked in the dumped file

• compression (CompressionAlgorithm | None) –

  Compression algorithm

• container (Container) –

  Container object

• name –
• default_dump_binary –
• default_dump_args –
• default_restore_binary –
• default_restore_args –
• plain_file_extension –

Attributes

min_file_size class-attribute instance-attribute

min_file_size: int = 200

Maximum file size, used to validate the generated file

pattern class-attribute instance-attribute

pattern: str | None = None

Pattern which is checked in the dumped file

compression instance-attribute

compression: CompressionAlgorithm | None = compression

Compression algorithm

container instance-attribute

container: Container = container

Container object

name class-attribute instance-attribute

name = 'postgres'

default_dump_binary class-attribute instance-attribute

default_dump_binary = 'pg_dump'

default_dump_args class-attribute instance-attribute

default_dump_args = '-Fc -U USER'

default_restore_binary class-attribute instance-attribute

default_restore_binary = 'pg_restore'

default_restore_args class-attribute instance-attribute

default_restore_args = '-Fc -U USER -d DATABASE'

plain_file_extension class-attribute instance-attribute

plain_file_extension = '.dump'

Functions

restore

restore(backup_file: Path) -> None

Restore database

is_backup_provider

is_backup_provider() -> bool

Checks if container supports a backup provider

validate_file

validate_file(file_path: Path) -> bool

Validate the generated file

trigger_webhook

trigger_webhook(
    message: str,
    address: str,
    code: int = 0,
    append: str = "",
) -> None

Trigger webhook.

Parameters:

• message

  (str) –

  Message send to the webhook

• address

  (str) –

  If not set taken from the label

• code

  (int, default: 0 ) –

  Code which is sent to the webhook

• append

  (str, default: '' ) –

  Path appended to address (can be used for fails)

trigger_error_webhook

trigger_error_webhook(
    message: str, address: str, code: int = 1
) -> None

Triggers an error on the webhook. code is appended to the address.

trigger_success_webhook

trigger_success_webhook(
    message: str, address: str, code: int = 0
) -> None

Triggers an success on the webhook.

get_dump_binary

get_dump_binary() -> str

Get the binary used to dump the backup.

get_dump_args

get_dump_args() -> str

Arguments for the dump binary.

get_restore_binary

get_restore_binary() -> str

Get the binary used to restore the backup.

get_container_env

get_container_env() -> dict[str, str | None]

Get environment variables from container.

binary_exists_in_container

binary_exists_in_container(binary_name: str) -> bool

Check if binary exists inside the container.

get_container_label

get_container_label(
    label: str, default: str | None = None
) -> str | None

Get labels for container.

get_service_name

get_service_name() -> str

Get service name (only if started with docker compose).

dump

dump() -> str

Overwrite dump method with custom postgres dump

get_restore_args

get_restore_args() -> str

Overwrite restore args with custom postgres arguments

RedisBackupProvider

RedisBackupProvider(
    container: Container,
    compression: CompressionAlgorithm | None = None,
)

Backup provider constructor

Parameters:

• container

  (Container) –

  Container object

• compression

  (CompressionAlgorithm | None, default: None ) –

  Compression algorithm

Methods:

• is_backup_provider –

  Checks if container supports a backup provider

• validate_file –

  Validate the generated file

• trigger_webhook –

  Trigger webhook.

• trigger_error_webhook –

  Triggers an error on the webhook. code is appended to the address.

• trigger_success_webhook –

  Triggers an success on the webhook.

• get_dump_binary –

  Get the binary used to dump the backup.

• get_dump_args –

  Arguments for the dump binary.

• get_restore_binary –

  Get the binary used to restore the backup.

• get_restore_args –

  Arguments for the restore binary.

• get_container_env –

  Get environment variables from container.

• binary_exists_in_container –

  Check if binary exists inside the container.

• get_container_label –

  Get labels for container.

• get_service_name –

  Get service name (only if started with docker compose).

• dump –
• restore –

Attributes:

• default_dump_args (str | None) –

  Default dump binary arguments

• default_restore_binary (str | None) –

  Default restore binary

• default_restore_args (str | None) –

  Default restore binary arguments

• pattern (str | None) –

  Pattern which is checked in the dumped file

• compression (CompressionAlgorithm | None) –

  Compression algorithm

• container (Container) –

  Container object

• name –
• min_file_size (int) –
• default_dump_binary –
• plain_file_extension –

Attributes

default_dump_args class-attribute instance-attribute

default_dump_args: str | None = None

Default dump binary arguments

default_restore_binary class-attribute instance-attribute

default_restore_binary: str | None = 'RESTORE_COMMAND'

Default restore binary

default_restore_args class-attribute instance-attribute

default_restore_args: str | None = ''

Default restore binary arguments

pattern class-attribute instance-attribute

pattern: str | None = None

Pattern which is checked in the dumped file

compression instance-attribute

compression: CompressionAlgorithm | None = compression

Compression algorithm

container instance-attribute

container: Container = container

Container object

name class-attribute instance-attribute

name = 'redis'

min_file_size class-attribute instance-attribute

min_file_size: int = 50

default_dump_binary class-attribute instance-attribute

default_dump_binary = 'redis-cli'

plain_file_extension class-attribute instance-attribute

plain_file_extension = '.rdb'

Functions

is_backup_provider

is_backup_provider() -> bool

Checks if container supports a backup provider

validate_file

validate_file(file_path: Path) -> bool

Validate the generated file

trigger_webhook

trigger_webhook(
    message: str,
    address: str,
    code: int = 0,
    append: str = "",
) -> None

Trigger webhook.

Parameters:

• message

  (str) –

  Message send to the webhook

• address

  (str) –

  If not set taken from the label

• code

  (int, default: 0 ) –

  Code which is sent to the webhook

• append

  (str, default: '' ) –

  Path appended to address (can be used for fails)

trigger_error_webhook

trigger_error_webhook(
    message: str, address: str, code: int = 1
) -> None

Triggers an error on the webhook. code is appended to the address.

trigger_success_webhook

trigger_success_webhook(
    message: str, address: str, code: int = 0
) -> None

Triggers an success on the webhook.

get_dump_binary

get_dump_binary() -> str

Get the binary used to dump the backup.

get_dump_args

get_dump_args() -> str

Arguments for the dump binary.

get_restore_binary

get_restore_binary() -> str

Get the binary used to restore the backup.

get_restore_args

get_restore_args() -> str

Arguments for the restore binary.

get_container_env

get_container_env() -> dict[str, str | None]

Get environment variables from container.

binary_exists_in_container

binary_exists_in_container(binary_name: str) -> bool

Check if binary exists inside the container.

get_container_label

get_container_label(
    label: str, default: str | None = None
) -> str | None

Get labels for container.

get_service_name

get_service_name() -> str

Get service name (only if started with docker compose).

dump

dump() -> str

restore

restore(backup_file: Path) -> None