db_sync_tool.database.process.prepare_origin_database_dump() - Code Metrics - jackd248/db-sync-tool - Measure and Improve Code Quality continuously with Scrutinizer

prepare_origin_database_dump() A
last analyzed 2025-04-09 15:26 UTC

↳ Parent: db_sync_tool.database.process

Complexity

Conditions

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	12
dl	0
loc	17
rs	9.8
c	0
b	0
f	0
cc	1
nop	0

#!/usr/bin/env python3
# -*- coding: future_fstrings -*-

"""
Process script
"""
import semantic_version

from db_sync_tool.utility import parser, mode, system, helper, output
from db_sync_tool.database import utility as database_utility


def create_origin_database_dump():
    """
    Creating the origin database dump file
    :return:
    """
    if not mode.is_import():
        parser.get_database_configuration(mode.Client.ORIGIN)
        database_utility.generate_database_dump_filename()
        helper.check_and_create_dump_dir(mode.Client.ORIGIN,
                                         helper.get_dump_dir(mode.Client.ORIGIN))

        _dump_file_path = helper.get_dump_dir(
            mode.Client.ORIGIN) + database_utility.database_dump_file_name

        _database_version = database_utility.get_database_version(mode.Client.ORIGIN)
        output.message(
            output.Subject.ORIGIN,
            f'Creating database dump {output.CliFormat.BLACK}{_dump_file_path}{output.CliFormat.ENDC}',

            True
        )

        _mysqldump_options = '--no-tablespaces '
        # Remove --no-tablespaces option for mysql < 5.6
        # @ToDo: Better option handling
        if not _database_version is None:
            if _database_version[0] == database_utility.DatabaseSystem.MYSQL and \
                    semantic_version.Version(_database_version[1]) < semantic_version.Version('5.6.0'):

                _mysqldump_options = ''

        # Adding additional where clause to sync only selected rows
        if system.config['where'] != '':
            _where = system.config['where']
            _mysqldump_options = _mysqldump_options + f'--where=\'{_where}\' '

        # Adding additional mysqldump options
        # see https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html#mysqldump-option-summary
        if system.config['additional_mysqldump_options'] != '':
            _additional = system.config['additional_mysqldump_options']
            _mysqldump_options = _mysqldump_options + f'{_additional} '

        # Run mysql dump command, e.g.
        # mysqldump --no-tablespaces -u'db' -p'db' -h'db1' -P'3306' 'db'  > /tmp/_db_08-10-2021_07-00.sql

        mode.run_command(
            helper.get_command(mode.Client.ORIGIN, 'mysqldump') + ' ' + _mysqldump_options +
            database_utility.generate_mysql_credentials(mode.Client.ORIGIN) + ' \'' +
            system.config[mode.Client.ORIGIN]['db']['name'] + '\' ' +
            database_utility.generate_ignore_database_tables() +
            database_utility.get_database_tables() +
            ' > ' + _dump_file_path,
            mode.Client.ORIGIN,
            skip_dry_run=True
        )

        database_utility.check_database_dump(mode.Client.ORIGIN, _dump_file_path)
        database_utility.count_tables(mode.Client.ORIGIN, _dump_file_path)
        prepare_origin_database_dump()


def import_database_dump():
    """
    Importing the selected database dump file
    :return:
    """
    if not system.config['is_same_client'] and not mode.is_import():
        prepare_target_database_dump()

    if system.config['clear_database']:
        output.message(
            output.Subject.TARGET,
            'Clearing database before import',
            True
        )
        clear_database(mode.Client.TARGET)

    database_utility.truncate_tables()

    if not system.config['keep_dump'] and not mode.is_dump():

        database_utility.get_database_version(mode.Client.TARGET)

        output.message(
            output.Subject.TARGET,
            'Importing database dump',
            True
        )

        if not mode.is_import():
            _dump_path = helper.get_dump_dir(
                mode.Client.TARGET) + database_utility.database_dump_file_name
        else:
            _dump_path = system.config['import']

        if not system.config['yes']:
            _host_name = helper.get_ssh_host_name(mode.Client.TARGET, True) if mode.is_remote(
                mode.Client.TARGET) else 'local'

            _input = helper.confirm(
                output.message(
                    output.Subject.TARGET,
                    f'Are you sure, you want to import the dump file into {_host_name} database?',
                    False
                ),
                True
            )

            if not _input: return


        database_utility.check_database_dump(mode.Client.TARGET, _dump_path)

        import_database_dump_file(mode.Client.TARGET, _dump_path)

    if 'after_dump' in system.config['target']:
        _after_dump = system.config['target']['after_dump']
        output.message(
            output.Subject.TARGET,
            f'Importing after_dump file {output.CliFormat.BLACK}{_after_dump}{output.CliFormat.ENDC}',

            True
        )
        import_database_dump_file(mode.Client.TARGET, _after_dump)

    if 'post_sql' in system.config['target']:
        output.message(
            output.Subject.TARGET,
            f'Running addition post sql commands',

            True
        )
        for _sql_command in system.config['target']['post_sql']:
            database_utility.run_database_command(mode.Client.TARGET, _sql_command, True)


def import_database_dump_file(client, filepath):
    """
    Import a database dump file
    :param client: String
    :param filepath: String
    :return:
    """
    if helper.check_file_exists(client, filepath):
        mode.run_command(
            helper.get_command(client, 'mysql') + ' ' +
            database_utility.generate_mysql_credentials(client) + ' \'' +
            system.config[client]['db']['name'] + '\' < ' + filepath,
            client,
            skip_dry_run=True
        )


def prepare_origin_database_dump():
    """
    Preparing the origin database dump file by compressing them as .tar.gz
    :return:
    """
    output.message(
        output.Subject.ORIGIN,
        'Compressing database dump',
        True
    )
    mode.run_command(
        helper.get_command(mode.Client.ORIGIN, 'tar') + ' cfvz ' + helper.get_dump_dir(
            mode.Client.ORIGIN) + database_utility.database_dump_file_name + '.tar.gz -C ' +
        helper.get_dump_dir(mode.Client.ORIGIN) + ' ' +
        database_utility.database_dump_file_name + ' > /dev/null',
        mode.Client.ORIGIN,
        skip_dry_run=True
    )


def prepare_target_database_dump():
    """
    Preparing the target database dump by the unpacked .tar.gz file
    :return:
    """
    output.message(output.Subject.TARGET, 'Extracting database dump', True)
    mode.run_command(
        helper.get_command('target', 'tar') + ' xzf ' + helper.get_dump_dir(mode.Client.TARGET) +
        database_utility.database_dump_file_name + '.tar.gz -C ' +
        helper.get_dump_dir(mode.Client.TARGET) + ' > /dev/null',
        mode.Client.TARGET,
        skip_dry_run=True
    )


def clear_database(client):
    """

    Clearing the database by dropping all tables
    https://www.techawaken.com/drop-tables-mysql-database/

    { mysql -hHOSTNAME -uUSERNAME -pPASSWORD -Nse 'show tables' DB_NAME; } |
    ( while read table; do if [ -z ${i+x} ]; then echo 'SET FOREIGN_KEY_CHECKS = 0;'; fi; i=1;
    echo "drop table \`$table\`;"; done;
    echo 'SET FOREIGN_KEY_CHECKS = 1;' ) |
    awk '{print}' ORS=' ' | mysql -hHOSTNAME -uUSERNAME -pPASSWORD DB_NAME;

    :param client: String
    :return:
    """
    mode.run_command(
        '{ ' + helper.get_command(client, 'mysql') + ' ' +
        database_utility.generate_mysql_credentials(client) +
        ' -Nse \'show tables\' \'' +
        system.config[client]['db']['name'] + '\'; }' +
        ' | ( while read table; do if [ -z ${i+x} ]; then echo \'SET FOREIGN_KEY_CHECKS = 0;\'; fi; i=1; ' +

        'echo "drop table \\`$table\\`;"; done; echo \'SET FOREIGN_KEY_CHECKS = 1;\' ) | awk \'{print}\' ORS=' ' | ' +

        ' ' +
        helper.get_command(client, 'mysql') + ' ' +
        database_utility.generate_mysql_credentials(client) + ' ' +
        system.config[client]['db']['name'],
        client,
        skip_dry_run=True
    )


1			#!/usr/bin/env python3
2			# -- coding: future_fstrings --
3
4			"""
5			Process script
6			"""
7			import semantic_version
8
9			from db_sync_tool.utility import parser, mode, system, helper, output
10			from db_sync_tool.database import utility as database_utility
11
12
13			def create_origin_database_dump():
14			"""
15			Creating the origin database dump file
16			:return:
17			"""
18			if not mode.is_import():
19			parser.get_database_configuration(mode.Client.ORIGIN)
20			database_utility.generate_database_dump_filename()
21			helper.check_and_create_dump_dir(mode.Client.ORIGIN,
22			helper.get_dump_dir(mode.Client.ORIGIN))
23
24			_dump_file_path = helper.get_dump_dir(
25			mode.Client.ORIGIN) + database_utility.database_dump_file_name
26
27			_database_version = database_utility.get_database_version(mode.Client.ORIGIN)
28			output.message(
29			output.Subject.ORIGIN,
30			f'Creating database dump {output.CliFormat.BLACK}{_dump_file_path}{output.CliFormat.ENDC}',
			0 ignored issues – show Coding Style introduced 2020-11-21 18:36 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (103/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
31			True
32			)
33
34			_mysqldump_options = '--no-tablespaces '
35			# Remove --no-tablespaces option for mysql < 5.6
36			# @ToDo: Better option handling
37			if not _database_version is None:
38			if _database_version[0] == database_utility.DatabaseSystem.MYSQL and \
39			semantic_version.Version(_database_version[1]) < semantic_version.Version('5.6.0'):
			0 ignored issues – show Coding Style introduced 2020-12-23 09:57 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (103/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
40			_mysqldump_options = ''
41
42			# Adding additional where clause to sync only selected rows
43			if system.config['where'] != '':
44			_where = system.config['where']
45			_mysqldump_options = _mysqldump_options + f'--where=\'{_where}\' '
46
47			# Adding additional mysqldump options
48			# see https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html#mysqldump-option-summary
49			if system.config['additional_mysqldump_options'] != '':
50			_additional = system.config['additional_mysqldump_options']
51			_mysqldump_options = _mysqldump_options + f'{_additional} '
52
53			# Run mysql dump command, e.g.
54			# mysqldump --no-tablespaces -u'db' -p'db' -h'db1' -P'3306' 'db' > /tmp/_db_08-10-2021_07-00.sql
			0 ignored issues – show Coding Style introduced 2020-12-06 17:30 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (105/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
55			mode.run_command(
56			helper.get_command(mode.Client.ORIGIN, 'mysqldump') + ' ' + _mysqldump_options +
57			database_utility.generate_mysql_credentials(mode.Client.ORIGIN) + ' \'' +
58			system.config[mode.Client.ORIGIN]['db']['name'] + '\' ' +
59			database_utility.generate_ignore_database_tables() +
60			database_utility.get_database_tables() +
61			' > ' + _dump_file_path,
62			mode.Client.ORIGIN,
63			skip_dry_run=True
64			)
65
66			database_utility.check_database_dump(mode.Client.ORIGIN, _dump_file_path)
67			database_utility.count_tables(mode.Client.ORIGIN, _dump_file_path)
68			prepare_origin_database_dump()
69
70
71			def import_database_dump():
72			"""
73			Importing the selected database dump file
74			:return:
75			"""
76			if not system.config['is_same_client'] and not mode.is_import():
77			prepare_target_database_dump()
78
79			if system.config['clear_database']:
80			output.message(
81			output.Subject.TARGET,
82			'Clearing database before import',
83			True
84			)
85			clear_database(mode.Client.TARGET)
86
87			database_utility.truncate_tables()
88
89			if not system.config['keep_dump'] and not mode.is_dump():
90
91			database_utility.get_database_version(mode.Client.TARGET)
92
93			output.message(
94			output.Subject.TARGET,
95			'Importing database dump',
96			True
97			)
98
99			if not mode.is_import():
100			_dump_path = helper.get_dump_dir(
101			mode.Client.TARGET) + database_utility.database_dump_file_name
102			else:
103			_dump_path = system.config['import']
104
105			if not system.config['yes']:
106			_host_name = helper.get_ssh_host_name(mode.Client.TARGET, True) if mode.is_remote(
107			mode.Client.TARGET) else 'local'
108
109			_input = helper.confirm(
110			output.message(
111			output.Subject.TARGET,
112			f'Are you sure, you want to import the dump file into {_host_name} database?',
113			False
114			),
115			True
116			)
117
118			if not _input: return
			0 ignored issues – show Coding Style introduced 2022-07-28 12:57 UTC by Report Bug Copy Issue Report More than one statement on a single line Loading history...
119
120			database_utility.check_database_dump(mode.Client.TARGET, _dump_path)
121
122			import_database_dump_file(mode.Client.TARGET, _dump_path)
123
124			if 'after_dump' in system.config['target']:
125			_after_dump = system.config['target']['after_dump']
126			output.message(
127			output.Subject.TARGET,
128			f'Importing after_dump file {output.CliFormat.BLACK}{_after_dump}{output.CliFormat.ENDC}',
			0 ignored issues – show Coding Style introduced 2020-12-23 09:57 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (102/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
129			True
130			)
131			import_database_dump_file(mode.Client.TARGET, _after_dump)
132
133			if 'post_sql' in system.config['target']:
134			output.message(
135			output.Subject.TARGET,
136			f'Running addition post sql commands',
			0 ignored issues – show introduced 2022-04-01 16:16 UTC by Report Bug Copy Issue Report Using an f-string that does not have any interpolated variables Loading history...
137			True
138			)
139			for _sql_command in system.config['target']['post_sql']:
140			database_utility.run_database_command(mode.Client.TARGET, _sql_command, True)
141
142
143			def import_database_dump_file(client, filepath):
144			"""
145			Import a database dump file
146			:param client: String
147			:param filepath: String
148			:return:
149			"""
150			if helper.check_file_exists(client, filepath):
151			mode.run_command(
152			helper.get_command(client, 'mysql') + ' ' +
153			database_utility.generate_mysql_credentials(client) + ' \'' +
154			system.config[client]['db']['name'] + '\' < ' + filepath,
155			client,
156			skip_dry_run=True
157			)
158
159
160			def prepare_origin_database_dump():
161			"""
162			Preparing the origin database dump file by compressing them as .tar.gz
163			:return:
164			"""
165			output.message(
166			output.Subject.ORIGIN,
167			'Compressing database dump',
168			True
169			)
170			mode.run_command(
171			helper.get_command(mode.Client.ORIGIN, 'tar') + ' cfvz ' + helper.get_dump_dir(
172			mode.Client.ORIGIN) + database_utility.database_dump_file_name + '.tar.gz -C ' +
173			helper.get_dump_dir(mode.Client.ORIGIN) + ' ' +
174			database_utility.database_dump_file_name + ' > /dev/null',
175			mode.Client.ORIGIN,
176			skip_dry_run=True
177			)
178
179
180			def prepare_target_database_dump():
181			"""
182			Preparing the target database dump by the unpacked .tar.gz file
183			:return:
184			"""
185			output.message(output.Subject.TARGET, 'Extracting database dump', True)
186			mode.run_command(
187			helper.get_command('target', 'tar') + ' xzf ' + helper.get_dump_dir(mode.Client.TARGET) +
188			database_utility.database_dump_file_name + '.tar.gz -C ' +
189			helper.get_dump_dir(mode.Client.TARGET) + ' > /dev/null',
190			mode.Client.TARGET,
191			skip_dry_run=True
192			)
193
194
195			def clear_database(client):
196			"""
			0 ignored issues – show Bug introduced 2021-02-19 18:09 UTC by Report Bug Copy Issue Report A suspicious escape sequence \` was found. Did you maybe forget to add an `r` prefix? Escape sequences in Python are generally interpreted according to rules similar to standard C. Only if strings are prefixed with `r` or `R` are they interpreted as regular expressions. The escape sequence that was used indicates that you might have intended to write a regular expression. Learn more about the available escape sequences. in the Python documentation. Loading history...
197			Clearing the database by dropping all tables
198			https://www.techawaken.com/drop-tables-mysql-database/
199
200			{ mysql -hHOSTNAME -uUSERNAME -pPASSWORD -Nse 'show tables' DB_NAME; } \|
201			( while read table; do if [ -z ${i+x} ]; then echo 'SET FOREIGN_KEY_CHECKS = 0;'; fi; i=1;
202			echo "drop table \`$table\`;"; done;
203			echo 'SET FOREIGN_KEY_CHECKS = 1;' ) \|
204			awk '{print}' ORS=' ' \| mysql -hHOSTNAME -uUSERNAME -pPASSWORD DB_NAME;
205
206			:param client: String
207			:return:
208			"""
209			mode.run_command(
210			'{ ' + helper.get_command(client, 'mysql') + ' ' +
211			database_utility.generate_mysql_credentials(client) +
212			' -Nse \'show tables\' \'' +
213			system.config[client]['db']['name'] + '\'; }' +
214			' \| ( while read table; do if [ -z ${i+x} ]; then echo \'SET FOREIGN_KEY_CHECKS = 0;\'; fi; i=1; ' +
			0 ignored issues – show Coding Style introduced 2021-02-19 18:09 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (108/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
215			'echo "drop table \\`$table\\`;"; done; echo \'SET FOREIGN_KEY_CHECKS = 1;\' ) \| awk \'{print}\' ORS=' ' \| ' +
			0 ignored issues – show Coding Style introduced 2021-02-19 18:09 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (118/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
216			' ' +
217			helper.get_command(client, 'mysql') + ' ' +
218			database_utility.generate_mysql_credentials(client) + ' ' +
219			system.config[client]['db']['name'],
220			client,
221			skip_dry_run=True
222			)
223

jackd248 / db-sync-tool

prepare_origin_database_dump() A last analyzed 2025-04-09 15:26 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

prepare_origin_database_dump() A
last analyzed 2025-04-09 15:26 UTC