:py:mod:`alembic_pg_autogen.canonicalize`
=========================================

.. py:module:: alembic_pg_autogen.canonicalize

.. autodoc2-docstring:: alembic_pg_autogen.canonicalize
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`CanonicalState <alembic_pg_autogen.canonicalize.CanonicalState>`
     - .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.CanonicalState
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`canonicalize <alembic_pg_autogen.canonicalize.canonicalize>`
     - .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.canonicalize
          :summary:
   * - :py:obj:`canonicalize_functions <alembic_pg_autogen.canonicalize.canonicalize_functions>`
     - .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.canonicalize_functions
          :summary:
   * - :py:obj:`canonicalize_triggers <alembic_pg_autogen.canonicalize.canonicalize_triggers>`
     - .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.canonicalize_triggers
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`log <alembic_pg_autogen.canonicalize.log>`
     - .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.log
          :summary:

API
~~~

.. py:data:: log
   :canonical: alembic_pg_autogen.canonicalize.log
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.log

.. py:class:: CanonicalState
   :canonical: alembic_pg_autogen.canonicalize.CanonicalState

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.CanonicalState

   .. py:attribute:: functions
      :canonical: alembic_pg_autogen.canonicalize.CanonicalState.functions
      :type: collections.abc.Sequence[alembic_pg_autogen.inspect.FunctionInfo]
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.CanonicalState.functions

   .. py:attribute:: triggers
      :canonical: alembic_pg_autogen.canonicalize.CanonicalState.triggers
      :type: collections.abc.Sequence[alembic_pg_autogen.inspect.TriggerInfo]
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.CanonicalState.triggers

.. py:function:: canonicalize(conn: sqlalchemy.Connection, *, function_ddl: collections.abc.Sequence[str] = (), trigger_ddl: collections.abc.Sequence[str] = (), schemas: collections.abc.Sequence[str] | None = None) -> alembic_pg_autogen.canonicalize.CanonicalState
   :canonical: alembic_pg_autogen.canonicalize.canonicalize

   .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.canonicalize

.. py:function:: canonicalize_functions(conn: sqlalchemy.Connection, ddl: collections.abc.Sequence[str], schemas: collections.abc.Sequence[str] | None = None) -> collections.abc.Sequence[alembic_pg_autogen.inspect.FunctionInfo]
   :canonical: alembic_pg_autogen.canonicalize.canonicalize_functions

   .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.canonicalize_functions

.. py:function:: canonicalize_triggers(conn: sqlalchemy.Connection, ddl: collections.abc.Sequence[str], schemas: collections.abc.Sequence[str] | None = None) -> collections.abc.Sequence[alembic_pg_autogen.inspect.TriggerInfo]
   :canonical: alembic_pg_autogen.canonicalize.canonicalize_triggers

   .. autodoc2-docstring:: alembic_pg_autogen.canonicalize.canonicalize_triggers