Source code for PyFunceble.cli.migrators.mariadb.base

"""
The tool to check the availability or syntax of domain, IP or URL.

::


    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides the base of all mariadb related migrations.

Author:
    Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks:
    https://pyfunceble.github.io/#/special-thanks

Contributors:
    https://pyfunceble.github.io/#/contributors

Project link:
    https://github.com/funilrys/PyFunceble

Project documentation:
    https://pyfunceble.readthedocs.io/en/dev/

Project homepage:
    https://pyfunceble.github.io/

License:
::


    Copyright 2017, 2018, 2019, 2020, 2022 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
"""

import functools
from typing import Any, Generator, Tuple

import PyFunceble.cli.facility
import PyFunceble.cli.factory
import PyFunceble.sessions
from PyFunceble.cli.migrators.base import MigratorBase


[docs]class MariaDBMigratorBase(MigratorBase): """ Provides the base of all our mariadb migration. """
[docs] def execute_if_authorized(default: Any = None): # pylint: disable=no-self-argument """ Executes the decorated method only if we are authorized to process. Otherwise, apply the given :code:`default`. """ def inner_metdhod(func): @functools.wraps(func) def wrapper(self, *args, **kwargs): if self.authorized: return func(self, *args, **kwargs) # pylint: disable=not-callable return self if default is None else default return wrapper return inner_metdhod
[docs] def does_table_exists(self, name: str) -> bool: """ Checks if the given table name exists. """ statement = ( "SELECT COUNT(*) " "FROM information_schema.tables " "WHERE table_schema = :database_name " "AND table_name = :table_name " ) result = self.db_session.execute( statement, { "database_name": PyFunceble.cli.factory.DBSession.credential.name, "table_name": name, }, ).fetchone() return result["COUNT(*)"] == 1
[docs] def get_rows( self, statement: str, limit: int = 20 ) -> Generator[Tuple[str, int], dict, None]: """ Run the given statement with a defined limit, and yield each row. .. warning:: If you don't delete the given rows, this method will be infinite. """ statement += f" LIMIT {limit}" while True: db_result = list(self.db_session.execute(statement).fetchall()) if not db_result: break for result in db_result: yield dict(result)
@property def authorized(self) -> bool: """ Provides the authorization to process. """ return PyFunceble.cli.facility.CredentialLoader.is_already_loaded()
[docs] @execute_if_authorized(None) def migrate(self) -> "MariaDBMigratorBase": """ Provides the migration (itself). """ raise NotImplementedError()
[docs] @execute_if_authorized(None) def start(self) -> "MariaDBMigratorBase": """ Starts the migration if wanted. """ PyFunceble.facility.Logger.info("Started migration.") self.migrate() PyFunceble.facility.Logger.info("Finished migration.") return self