Skip to content

# Db base

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

::

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

Provides the base of all our database migration.

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://docs.pyfunceble.com

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

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 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

        https://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.

## `DBMigratorBase`

Bases: `MigratorBase`

Provides the base of all our database migration.

Source code in `PyFunceble/cli/migrators/db_base.py`

     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112

    class DBMigratorBase(MigratorBase):
        """
        Provides the base of all our database migration.
        """

        def __init__(self, print_action_to_stdout: bool = False) -> None:
            super().__init__(print_action_to_stdout=print_action_to_stdout)

        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_method(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_method

        @property
        def authorized(self):
            """
            Provides the authorization to run.
            """

            return PyFunceble.cli.facility.CredentialLoader.is_already_loaded()

        def does_table_exists(self, table_name: str) -> bool:
            """
            Checks if the table exists.

            :param table_name:
                The name of the table to check.
            """

            return sqlalchemy.inspect(PyFunceble.sessions.DB_ENGINE).has_table(table_name)

        def start(self) -> "MigratorBase":
            """
            Starts the migration.
            """

            raise NotImplementedError()

### `authorized` `property`

Provides the authorization to run.

### `does_table_exists(table_name)`

Checks if the table exists.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`table_name` | `str` | The name of the table to check. | required

Source code in `PyFunceble/cli/migrators/db_base.py`

     97
     98
     99
    100
    101
    102
    103
    104
    105

    def does_table_exists(self, table_name: str) -> bool:
        """
        Checks if the table exists.

        :param table_name:
            The name of the table to check.
        """

        return sqlalchemy.inspect(PyFunceble.sessions.DB_ENGINE).has_table(table_name)

### `execute_if_authorized(default=None)`

Executes the decorated method only if we are authorized to process. Otherwise, apply the given :code:`default`.

Source code in `PyFunceble/cli/migrators/db_base.py`

    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87

    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_method(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_method

### `start()`

Starts the migration.

Source code in `PyFunceble/cli/migrators/db_base.py`

    107
    108
    109
    110
    111
    112

    def start(self) -> "MigratorBase":
        """
        Starts the migration.
        """

        raise NotImplementedError()