twindb_backup.modifiers package

Submodules

twindb_backup.modifiers.base module

Module defines Modifier() base class and its errors.

class twindb_backup.modifiers.base.Modifier(input_stream)

Bases: object

Base Modifier class

callback(**kwargs)

Method that will be called after the stream ends

get_stream()

Compress the input stream and return it as the output stream

Returns

output stream handle

property input

Returns

Input stream to be modified

revert_stream()

Un-Apply modifier and return output stream. The Base modifier does nothing, so it will return the input stream without modifications

Returns

output stream handle

twindb_backup.modifiers.bzip2 module

Module defines modifier that compresses a stream with bzip2

class twindb_backup.modifiers.bzip2.Bzip2(input_stream, level=9)

Bases: twindb_backup.modifiers.base.Modifier

Modifier that compresses the input_stream with bzip2.

suffix = '.bz'

twindb_backup.modifiers.exceptions module

Modifier exceptions.

exception twindb_backup.modifiers.exceptions.ModifierException

Bases: twindb_backup.exceptions.TwinDBBackupError

Base Exception for Modifier error

twindb_backup.modifiers.gpg module

Module defines modifier that implements asymmetric encryption with gpg

class twindb_backup.modifiers.gpg.Gpg(input_stream, recipient, keyring, secret_keyring=None)

Bases: twindb_backup.modifiers.base.Modifier

Asymmetric encryption

twindb_backup.modifiers.gzip module

Module defines modifier that compresses a stream with gzip

class twindb_backup.modifiers.gzip.Gzip(input_stream, level=9)

Bases: twindb_backup.modifiers.base.Modifier

Modifier that compresses the input_stream with gzip.

suffix = '.gz'

twindb_backup.modifiers.keeplocal module

Module defines modifier that save a stream on the local file system

class twindb_backup.modifiers.keeplocal.KeepLocal(input_stream, local_path)

Bases: twindb_backup.modifiers.base.Modifier

KeepLocal() class saves a copy of the stream on the local file system. It doesn’t alter the stream.

callback(**kwargs)

Method that will be called after the stream ends

twindb_backup.modifiers.lbzip2 module

Module defines modifier that compresses a stream with lbzip2

class twindb_backup.modifiers.lbzip2.Lbzip2(input_stream, threads=1, level=9)

Bases: twindb_backup.modifiers.parallel_compressor.ParallelCompressor

Modifier that compresses the input_stream with lbzip2.

twindb_backup.modifiers.parallel_compressor module

Module defines modifier that compresses a stream with pigz

class twindb_backup.modifiers.parallel_compressor.ParallelCompressor(input_stream, program='pigz', threads=1, level=9, suffix='.gz')

Bases: twindb_backup.modifiers.base.Modifier

Modifier that compresses the input_stream with pigz.

property suffix

File name suffix, specific for the compression tool

twindb_backup.modifiers.pigz module

Module defines modifier that compresses a stream with pigz

class twindb_backup.modifiers.pigz.Pigz(input_stream, threads=1, level=9)

Bases: twindb_backup.modifiers.parallel_compressor.ParallelCompressor

Modifier that compresses the input_stream with pigz.

Module contents

Modifiers module.

Modifier take a stream as input, do something with it (compress, encrypt, etc) and return the modified stream for a next modifier or backup destination.

Modifiers also do reverse operation - i.e. decompress, decrypt.