:py:mod:`alembic_pg_autogen.inspect`
====================================

.. py:module:: alembic_pg_autogen.inspect

.. autodoc2-docstring:: alembic_pg_autogen.inspect
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`FunctionInfo <alembic_pg_autogen.inspect.FunctionInfo>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect.FunctionInfo
          :summary:
   * - :py:obj:`TriggerInfo <alembic_pg_autogen.inspect.TriggerInfo>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect.TriggerInfo
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`inspect_functions <alembic_pg_autogen.inspect.inspect_functions>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect.inspect_functions
          :summary:
   * - :py:obj:`inspect_triggers <alembic_pg_autogen.inspect.inspect_triggers>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect.inspect_triggers
          :summary:
   * - :py:obj:`_build_schema_filter <alembic_pg_autogen.inspect._build_schema_filter>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect._build_schema_filter
          :summary:

Data
~~~~

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

   * - :py:obj:`log <alembic_pg_autogen.inspect.log>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect.log
          :summary:
   * - :py:obj:`_EXCLUDED_SCHEMAS <alembic_pg_autogen.inspect._EXCLUDED_SCHEMAS>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect._EXCLUDED_SCHEMAS
          :summary:
   * - :py:obj:`_FUNCTIONS_QUERY <alembic_pg_autogen.inspect._FUNCTIONS_QUERY>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect._FUNCTIONS_QUERY
          :summary:
   * - :py:obj:`_TRIGGERS_QUERY <alembic_pg_autogen.inspect._TRIGGERS_QUERY>`
     - .. autodoc2-docstring:: alembic_pg_autogen.inspect._TRIGGERS_QUERY
          :summary:

API
~~~

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

   .. autodoc2-docstring:: alembic_pg_autogen.inspect.log

.. py:class:: FunctionInfo
   :canonical: alembic_pg_autogen.inspect.FunctionInfo

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

   .. autodoc2-docstring:: alembic_pg_autogen.inspect.FunctionInfo

   .. py:attribute:: schema
      :canonical: alembic_pg_autogen.inspect.FunctionInfo.schema
      :type: str
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.inspect.FunctionInfo.schema

   .. py:attribute:: name
      :canonical: alembic_pg_autogen.inspect.FunctionInfo.name
      :type: str
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.inspect.FunctionInfo.name

   .. py:attribute:: identity_args
      :canonical: alembic_pg_autogen.inspect.FunctionInfo.identity_args
      :type: str
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.inspect.FunctionInfo.identity_args

   .. py:attribute:: definition
      :canonical: alembic_pg_autogen.inspect.FunctionInfo.definition
      :type: str
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.inspect.FunctionInfo.definition

.. py:class:: TriggerInfo
   :canonical: alembic_pg_autogen.inspect.TriggerInfo

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

   .. autodoc2-docstring:: alembic_pg_autogen.inspect.TriggerInfo

   .. py:attribute:: schema
      :canonical: alembic_pg_autogen.inspect.TriggerInfo.schema
      :type: str
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.inspect.TriggerInfo.schema

   .. py:attribute:: table_name
      :canonical: alembic_pg_autogen.inspect.TriggerInfo.table_name
      :type: str
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.inspect.TriggerInfo.table_name

   .. py:attribute:: trigger_name
      :canonical: alembic_pg_autogen.inspect.TriggerInfo.trigger_name
      :type: str
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.inspect.TriggerInfo.trigger_name

   .. py:attribute:: definition
      :canonical: alembic_pg_autogen.inspect.TriggerInfo.definition
      :type: str
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.inspect.TriggerInfo.definition

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

   .. autodoc2-docstring:: alembic_pg_autogen.inspect.inspect_functions

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

   .. autodoc2-docstring:: alembic_pg_autogen.inspect.inspect_triggers

.. py:data:: _EXCLUDED_SCHEMAS
   :canonical: alembic_pg_autogen.inspect._EXCLUDED_SCHEMAS
   :value: ('pg_catalog', 'information_schema')

   .. autodoc2-docstring:: alembic_pg_autogen.inspect._EXCLUDED_SCHEMAS

.. py:data:: _FUNCTIONS_QUERY
   :canonical: alembic_pg_autogen.inspect._FUNCTIONS_QUERY
   :value: <Multiline-String>

   .. autodoc2-docstring:: alembic_pg_autogen.inspect._FUNCTIONS_QUERY

.. py:data:: _TRIGGERS_QUERY
   :canonical: alembic_pg_autogen.inspect._TRIGGERS_QUERY
   :value: <Multiline-String>

   .. autodoc2-docstring:: alembic_pg_autogen.inspect._TRIGGERS_QUERY

.. py:function:: _build_schema_filter(schemas: collections.abc.Sequence[str] | None) -> tuple[str, dict[str, object]]
   :canonical: alembic_pg_autogen.inspect._build_schema_filter

   .. autodoc2-docstring:: alembic_pg_autogen.inspect._build_schema_filter