magpie.cli.run_db_migration
===========================

.. py:module:: magpie.cli.run_db_migration

.. autoapi-nested-parse::

   Magpie helpers for database migration.



Functions
---------

.. autoapisummary::

   magpie.cli.run_db_migration.get_constant
   magpie.cli.run_db_migration.run_database_migration
   magpie.cli.run_db_migration.make_parser
   magpie.cli.run_db_migration.main


Module Contents
---------------

.. py:function:: get_constant(constant_name: magpie.typedefs.Str, settings_container: Optional[magpie.typedefs.AnySettingsContainer] = None, settings_name: Optional[magpie.typedefs.Str] = None, default_value: Optional[magpie.typedefs.SettingValue] = None, raise_not_set: bool = True, raise_missing: bool = True, print_missing: bool = False, empty_missing: bool = False) -> magpie.typedefs.SettingValue

   Search in order for matched value of :paramref:`constant_name`:
     1. search in :py:data:`MAGPIE_CONSTANTS`
     2. search in settings if specified
     3. search alternative setting names (see below)
     4. search in :mod:`magpie.constants` definitions
     5. search in environment variables

   Parameter :paramref:`constant_name` is expected to have the format ``MAGPIE_[VARIABLE_NAME]`` although any value can
   be passed to retrieve generic settings from all above-mentioned search locations.

   If :paramref:`settings_name` is provided as alternative name, it is used as is to search for results if
   :paramref:`constant_name` was not found. Otherwise, ``magpie.[variable_name]`` is used for additional search when
   the format ``MAGPIE_[VARIABLE_NAME]`` was used for :paramref:`constant_name`
   (i.e.: ``MAGPIE_ADMIN_USER`` will also search for ``magpie.admin_user`` and so on for corresponding constants).

   :param constant_name: key to search for a value
   :param settings_container: WSGI application settings container (if not provided, uses found one in current thread)
   :param settings_name: alternative name for `settings` if specified
   :param default_value: default value to be returned if not found anywhere, and exception raises are disabled.
   :param raise_not_set: raise an exception if the found key is ``None``, search until last case if others are ``None``
   :param raise_missing: raise exception if key is not found anywhere
   :param print_missing: print message if key is not found anywhere, return ``None``
   :param empty_missing: consider an empty value for an existing key as if it was missing (i.e.: as if not set).
   :returns: found value or `default_value`
   :raises ValueError: if resulting value is invalid based on options (by default raise missing/empty/``None`` value)
   :raises LookupError: if no appropriate value could be found from all search locations (according to options)


.. py:function:: run_database_migration(container: Optional[magpie.typedefs.AnySettingsContainer] = None, db_session: Optional[sqlalchemy.orm.session.Session] = None) -> None

   Runs database migration operations with :mod:`alembic`, using the provided session or a new engine connection.


.. py:function:: make_parser() -> argparse.ArgumentParser

.. py:function:: main(args: Optional[Sequence[magpie.typedefs.Str]] = None, parser: Optional[argparse.ArgumentParser] = None, namespace: Optional[argparse.Namespace] = None) -> Any