:py:mod:`alembic_pg_autogen.compare`
====================================

.. py:module:: alembic_pg_autogen.compare

.. autodoc2-docstring:: alembic_pg_autogen.compare
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`_HasText <alembic_pg_autogen.compare._HasText>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._HasText
          :summary:
   * - :py:obj:`SQLCreatable <alembic_pg_autogen.compare.SQLCreatable>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare.SQLCreatable
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`setup <alembic_pg_autogen.compare.setup>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare.setup
          :summary:
   * - :py:obj:`_compare_pg_objects <alembic_pg_autogen.compare._compare_pg_objects>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._compare_pg_objects
          :summary:
   * - :py:obj:`_resolve_ddl <alembic_pg_autogen.compare._resolve_ddl>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._resolve_ddl
          :summary:
   * - :py:obj:`_filter_to_declared <alembic_pg_autogen.compare._filter_to_declared>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._filter_to_declared
          :summary:
   * - :py:obj:`_parse_function_names <alembic_pg_autogen.compare._parse_function_names>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._parse_function_names
          :summary:
   * - :py:obj:`_parse_trigger_identities <alembic_pg_autogen.compare._parse_trigger_identities>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._parse_trigger_identities
          :summary:
   * - :py:obj:`_get_default_schema <alembic_pg_autogen.compare._get_default_schema>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._get_default_schema
          :summary:
   * - :py:obj:`_resolve_schemas <alembic_pg_autogen.compare._resolve_schemas>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._resolve_schemas
          :summary:
   * - :py:obj:`_filter_to_schemas <alembic_pg_autogen.compare._filter_to_schemas>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._filter_to_schemas
          :summary:
   * - :py:obj:`_order_ops <alembic_pg_autogen.compare._order_ops>`
     - .. autodoc2-docstring:: alembic_pg_autogen.compare._order_ops
          :summary:

Data
~~~~

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

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

API
~~~

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

   .. autodoc2-docstring:: alembic_pg_autogen.compare.log

.. py:class:: _HasText
   :canonical: alembic_pg_autogen.compare._HasText

   Bases: :py:obj:`typing.Protocol`

   .. autodoc2-docstring:: alembic_pg_autogen.compare._HasText

   .. py:property:: text
      :canonical: alembic_pg_autogen.compare._HasText.text
      :type: str

      .. autodoc2-docstring:: alembic_pg_autogen.compare._HasText.text

.. py:class:: SQLCreatable
   :canonical: alembic_pg_autogen.compare.SQLCreatable

   Bases: :py:obj:`typing.Protocol`

   .. autodoc2-docstring:: alembic_pg_autogen.compare.SQLCreatable

   .. py:method:: to_sql_statement_create() -> alembic_pg_autogen.compare._HasText
      :canonical: alembic_pg_autogen.compare.SQLCreatable.to_sql_statement_create

      .. autodoc2-docstring:: alembic_pg_autogen.compare.SQLCreatable.to_sql_statement_create

.. py:function:: setup(plugin: alembic.runtime.plugins.Plugin) -> None
   :canonical: alembic_pg_autogen.compare.setup

   .. autodoc2-docstring:: alembic_pg_autogen.compare.setup

.. py:function:: _compare_pg_objects(autogen_context: alembic.autogenerate.api.AutogenContext, upgrade_ops: alembic.operations.ops.UpgradeOps, schemas: set[str | None]) -> alembic.util.PriorityDispatchResult
   :canonical: alembic_pg_autogen.compare._compare_pg_objects

   .. autodoc2-docstring:: alembic_pg_autogen.compare._compare_pg_objects

.. py:function:: _resolve_ddl(items: collections.abc.Sequence[str | alembic_pg_autogen.compare.SQLCreatable]) -> tuple[str, ...]
   :canonical: alembic_pg_autogen.compare._resolve_ddl

   .. autodoc2-docstring:: alembic_pg_autogen.compare._resolve_ddl

.. py:function:: _filter_to_declared(canonical: alembic_pg_autogen.canonicalize.CanonicalState, pg_functions: collections.abc.Sequence[str], pg_triggers: collections.abc.Sequence[str], conn: sqlalchemy.Connection) -> alembic_pg_autogen.canonicalize.CanonicalState
   :canonical: alembic_pg_autogen.compare._filter_to_declared

   .. autodoc2-docstring:: alembic_pg_autogen.compare._filter_to_declared

.. py:function:: _parse_function_names(ddl_list: collections.abc.Sequence[str], conn: sqlalchemy.Connection) -> set[tuple[str, str]]
   :canonical: alembic_pg_autogen.compare._parse_function_names

   .. autodoc2-docstring:: alembic_pg_autogen.compare._parse_function_names

.. py:function:: _parse_trigger_identities(ddl_list: collections.abc.Sequence[str], conn: sqlalchemy.Connection) -> set[tuple[str, str, str]]
   :canonical: alembic_pg_autogen.compare._parse_trigger_identities

   .. autodoc2-docstring:: alembic_pg_autogen.compare._parse_trigger_identities

.. py:function:: _get_default_schema(conn: sqlalchemy.Connection) -> str
   :canonical: alembic_pg_autogen.compare._get_default_schema

   .. autodoc2-docstring:: alembic_pg_autogen.compare._get_default_schema

.. py:function:: _resolve_schemas(conn: sqlalchemy.Connection, schemas: collections.abc.Iterable[str | None]) -> list[str] | None
   :canonical: alembic_pg_autogen.compare._resolve_schemas

   .. autodoc2-docstring:: alembic_pg_autogen.compare._resolve_schemas

.. py:function:: _filter_to_schemas(state: alembic_pg_autogen.canonicalize.CanonicalState, schemas: collections.abc.Iterable[str] | None) -> alembic_pg_autogen.canonicalize.CanonicalState
   :canonical: alembic_pg_autogen.compare._filter_to_schemas

   .. autodoc2-docstring:: alembic_pg_autogen.compare._filter_to_schemas

.. py:function:: _order_ops(function_ops: collections.abc.Sequence[alembic_pg_autogen.diff.FunctionOp], trigger_ops: collections.abc.Sequence[alembic_pg_autogen.diff.TriggerOp]) -> list[alembic.operations.ops.MigrateOperation]
   :canonical: alembic_pg_autogen.compare._order_ops

   .. autodoc2-docstring:: alembic_pg_autogen.compare._order_ops