forked from borgmatic-collective/borgmatic
126 lines
4.7 KiB
Python
126 lines
4.7 KiB
Python
import logging
|
|
import os
|
|
|
|
from borgmatic.execute import execute_command, execute_command_with_processes
|
|
from borgmatic.hooks import dump
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def make_dump_path(location_config): # pragma: no cover
|
|
'''
|
|
Make the dump path from the given location configuration and the name of this hook.
|
|
'''
|
|
return dump.make_database_dump_path(
|
|
location_config.get('borgmatic_source_directory'), 'sqlite_databases'
|
|
)
|
|
|
|
|
|
def dump_databases(databases, log_prefix, location_config, dry_run):
|
|
'''
|
|
Dump the given SQLite3 databases to a file. The databases are supplied as a sequence of
|
|
configuration dicts, as per the configuration schema. Use the given log prefix in any log
|
|
entries. Use the given location configuration dict to construct the destination path. If this
|
|
is a dry run, then don't actually dump anything.
|
|
'''
|
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
|
processes = []
|
|
|
|
logger.info('{}: Dumping SQLite databases{}'.format(log_prefix, dry_run_label))
|
|
|
|
for database in databases:
|
|
database_path = database['path']
|
|
|
|
if database['name'] == 'all':
|
|
logger.warning('The "all" database name has no meaning for SQLite3 databases')
|
|
if not os.path.exists(database_path):
|
|
logger.warning(
|
|
f'{log_prefix}: No SQLite database at {database_path}; An empty database will be created and dumped'
|
|
)
|
|
|
|
dump_path = make_dump_path(location_config)
|
|
dump_filename = dump.make_database_dump_filename(dump_path, database['name'])
|
|
if os.path.exists(dump_filename):
|
|
logger.warning(
|
|
f'{log_prefix}: Skipping duplicate dump of SQLite database at {database_path} to {dump_filename}'
|
|
)
|
|
continue
|
|
|
|
command = (
|
|
'sqlite3',
|
|
database_path,
|
|
'.dump',
|
|
'>',
|
|
dump_filename,
|
|
)
|
|
logger.debug(
|
|
f'{log_prefix}: Dumping SQLite database at {database_path} to {dump_filename}{dry_run_label}'
|
|
)
|
|
if dry_run:
|
|
continue
|
|
|
|
dump.create_parent_directory_for_dump(dump_filename)
|
|
processes.append(execute_command(command, shell=True, run_to_completion=False))
|
|
|
|
return processes
|
|
|
|
|
|
def remove_database_dumps(databases, log_prefix, location_config, dry_run): # pragma: no cover
|
|
'''
|
|
Remove the given SQLite3 database dumps from the filesystem. The databases are supplied as a
|
|
sequence of configuration dicts, as per the configuration schema. Use the given log prefix in
|
|
any log entries. Use the given location configuration dict to construct the destination path.
|
|
If this is a dry run, then don't actually remove anything.
|
|
'''
|
|
dump.remove_database_dumps(make_dump_path(location_config), 'SQLite', log_prefix, dry_run)
|
|
|
|
|
|
def make_database_dump_pattern(
|
|
databases, log_prefix, location_config, name=None
|
|
): # pragma: no cover
|
|
'''
|
|
Make a pattern that matches the given SQLite3 databases. The databases are supplied as a
|
|
sequence of configuration dicts, as per the configuration schema.
|
|
'''
|
|
return dump.make_database_dump_filename(make_dump_path(location_config), name)
|
|
|
|
|
|
def restore_database_dump(database_config, log_prefix, location_config, dry_run, extract_process):
|
|
'''
|
|
Restore the given SQLite3 database from an extract stream. The database is supplied as a
|
|
one-element sequence containing a dict describing the database, as per the configuration schema.
|
|
Use the given log prefix in any log entries. If this is a dry run, then don't actually restore
|
|
anything. Trigger the given active extract process (an instance of subprocess.Popen) to produce
|
|
output to consume.
|
|
'''
|
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
|
|
|
if len(database_config) != 1:
|
|
raise ValueError('The database configuration value is invalid')
|
|
|
|
database_path = database_config[0]['path']
|
|
|
|
logger.debug(f'{log_prefix}: Restoring SQLite database at {database_path}{dry_run_label}')
|
|
if dry_run:
|
|
return
|
|
|
|
try:
|
|
os.remove(database_path)
|
|
logger.warning(f'{log_prefix}: Removed existing SQLite database at {database_path}')
|
|
except FileNotFoundError: # pragma: no cover
|
|
pass
|
|
|
|
restore_command = (
|
|
'sqlite3',
|
|
database_path,
|
|
)
|
|
|
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
|
# if the restore paths don't exist in the archive.
|
|
execute_command_with_processes(
|
|
restore_command,
|
|
[extract_process],
|
|
output_log_level=logging.DEBUG,
|
|
input_file=extract_process.stdout,
|
|
)
|