HEX

File: //usr/local/lib/python3.10/dist-packages/sqlalchemy/sql/__pycache__/ddl.cpython-310.pyc
o

���gI��@s�dZddlmZddlZddlZddlmZddlmZddlmZddlmZddlm	Z	dd	lm
Zdd
lmZddl
mZdd
lmZddlmZddlmZddlmZddl
mZddl
mZddlmZddlmZddlmZejr�ddlmZddlmZddlmZddl m!Z!ddl m"Z"ddl m#Z#dd	l m
Z
ddl m$Z$ddl%m&Z&ddl'm(Z(dd l)m*Z*dd!l)m+Z+dd"l)m,Z,dd#l)m-Z-Gd$d%�d%e�Z.Gd&d'�d'e�Z/Gd(d)�d)ej0�Z1Gd*d+�d+ej2ee.�Z3e3Z4	Gd,d-�d-e3�Z5Gd.d/�d/e3�Z6Gd0d1�d1e6�Z7Gd2d3�d3e6�Z8Gd4d5�d5e7�Z9Gd6d7�d7e8�Z:Gd8d9�d9e7�Z;Gd:d;�d;e8�Z<Gd<d=�d=e.�Z=Gd>d?�d?e.�Z>Gd@dA�dAe8�Z?GdBdC�dCe7�Z@GdDdE�dEe8�ZAGdFdG�dGe7�ZBGdHdI�dIe8�ZCGdJdK�dKe7�ZDGdLdM�dMe8�ZEGdNdO�dOe6�ZFGdPdQ�dQe6�ZGGdRdS�dSe6�ZHGdTdU�dUe6�ZIGdVdW�dWe6�ZJGdXdY�dYe6�ZKGdZd[�d[e�ZLGd\d]�d]eL�ZMGd^d_�d_eL�ZNGd`da�daeM�ZOGdbdc�dceN�ZP		dqdrdldm�ZQ	ndsdodp�ZRdS)tzq
Provides the hierarchy of DDL-defining schema items as well as routines
to invoke them for a create/drop call.

�)�annotationsN)�Any)�Callable)�Iterable)�List)�Optional)�Sequence)�Tuple�)�roles)�_generative)�
Executable)�
SchemaVisitor)�
ClauseElement�)�exc)�util)�topological)�Protocol)�Self)�Compiled)�DDLCompiler)�
BindParameter)�
Constraint)�ForeignKeyConstraint)�
SchemaItem)�Table)�TableClause)�
Connection)�
CacheStats)�CompiledCacheType)�Dialect)�SchemaTranslateMapTypec@s0eZdZdZdZ	dd�Zddd�ddd�ZdS)�BaseDDLElementz�The root of DDL constructs, including those that are sub-elements
    within the "create table" and other processes.

    .. versionadded:: 2.0

    FcKs|j||fi|��S)zNReturn a compiler appropriate for this ClauseElement, given a
        Dialect.)�ddl_compiler)�self�dialect�kw�r(�=/usr/local/lib/python3.10/dist-packages/sqlalchemy/sql/ddl.py�	_compilerAszBaseDDLElement._compilerN)�for_executemany�schema_translate_mapr&r!�compiled_cache�Optional[CompiledCacheType]�column_keys�	List[str]r+�boolr,� Optional[SchemaTranslateMapType]r'r�return�JTuple[Compiled, Optional[typing_Sequence[BindParameter[Any]]], CacheStats]cK�t���N��NotImplementedError)r%r&r-r/r+r,r'r(r(r)�_compile_w_cacheGszBaseDDLElement._compile_w_cache)r&r!r-r.r/r0r+r1r,r2r'rr3r4)�__name__�
__module__�__qualname__�__doc__�_hierarchy_supports_cachingr*r9r(r(r(r)r#6s�r#c@s"eZdZ		ddd�ddd�ZdS)�
DDLIfCallableN.)�compiler�ddlr#�targetr�bind�Optional[Connection]�tables�Optional[List[Table]]�state�
Optional[Any]r&r!r@�Optional[DDLCompiler]�
checkfirstr1r3c	CsdSr6r()	r%rArBrCrErGr&r@rJr(r(r)�__call__WszDDLIfCallable.__call__�NN)rAr#rBrrCrDrErFrGrHr&r!r@rIrJr1r3r1)r:r;r<rKr(r(r(r)r?Vs�	�r?c@s4eZdZUded<ded<ded<	dddd�ZdS)�DDLIf�
Optional[str]r&�Optional[DDLIfCallable]�	callable_rHrGNrAr#rBrrCrDr@rIr'rr3r1cKs�|dur|j}n|dur|j}nJd��t|jt�r#|j|jkr"dSnt|jtttf�r4|j|jvr4dS|jdurK|j|||f|j||d�|��sKdSdS)NFzcompiler or dialect is required)rGr&r@T)	r&�
isinstance�str�name�tuple�list�setrPrG)r%rArBrCr@r'r&r(r(r)�_should_executejs2����	zDDLIf._should_executer6)rAr#rBrrCrDr@rIr'rr3r1)r:r;r<�__annotations__rWr(r(r(r)rMes
�rMc@sveZdZUdZdZded<dZded<dd�Zeddd
��Z	e			dd dd��Z
dd�Zdd�Zdd�Z
dd�ZdS)!�ExecutableDDLElementa�Base class for standalone executable DDL expression constructs.

    This class is the base for the general purpose :class:`.DDL` class,
    as well as the various create/drop clause constructs such as
    :class:`.CreateTable`, :class:`.DropTable`, :class:`.AddConstraint`,
    etc.

    .. versionchanged:: 2.0  :class:`.ExecutableDDLElement` is renamed from
       :class:`.DDLElement`, which still exists for backwards compatibility.

    :class:`.ExecutableDDLElement` integrates closely with SQLAlchemy events,
    introduced in :ref:`event_toplevel`.  An instance of one is
    itself an event receiving callable::

        event.listen(
            users,
            "after_create",
            AddConstraint(constraint).execute_if(dialect="postgresql"),
        )

    .. seealso::

        :class:`.DDL`

        :class:`.DDLEvents`

        :ref:`event_toplevel`

        :ref:`schema_ddl_sequences`

    NzOptional[DDLIf]�_ddl_ifzOptional[SchemaItem]rBcCs|�|||�Sr6)�_execute_ddl)r%�
connection�distilled_params�execution_optionsr(r(r)�_execute_on_connection�s�z+ExecutableDDLElement._execute_on_connectionrr3rcCs
||_|S)a�Return a copy of this :class:`_schema.ExecutableDDLElement` which
        will include the given target.

        This essentially applies the given item to the ``.target`` attribute of
        the returned :class:`_schema.ExecutableDDLElement` object. This target
        is then usable by event handlers and compilation routines in order to
        provide services such as tokenization of a DDL string in terms of a
        particular :class:`_schema.Table`.

        When a :class:`_schema.ExecutableDDLElement` object is established as
        an event handler for the :meth:`_events.DDLEvents.before_create` or
        :meth:`_events.DDLEvents.after_create` events, and the event then
        occurs for a given target such as a :class:`_schema.Constraint` or
        :class:`_schema.Table`, that target is established with a copy of the
        :class:`_schema.ExecutableDDLElement` object using this method, which
        then proceeds to the :meth:`_schema.ExecutableDDLElement.execute`
        method in order to invoke the actual DDL instruction.

        :param target: a :class:`_schema.SchemaItem` that will be the subject
         of a DDL operation.

        :return: a copy of this :class:`_schema.ExecutableDDLElement` with the
         ``.target`` attribute assigned to the given
         :class:`_schema.SchemaItem`.

        .. seealso::

            :class:`_schema.DDL` - uses tokenization against the "target" when
            processing the DDL string.

        )rB)r%rBr(r(r)�against�s!zExecutableDDLElement.againstr&rNrPrOrGrHcCst|||�|_|S)aA
Return a callable that will execute this
        :class:`_ddl.ExecutableDDLElement` conditionally within an event
        handler.

        Used to provide a wrapper for event listening::

            event.listen(
                metadata,
                "before_create",
                DDL("my_ddl").execute_if(dialect="postgresql"),
            )

        :param dialect: May be a string or tuple of strings.
          If a string, it will be compared to the name of the
          executing database dialect::

            DDL("something").execute_if(dialect="postgresql")

          If a tuple, specifies multiple dialect names::

            DDL("something").execute_if(dialect=("postgresql", "mysql"))

        :param callable\_: A callable, which will be invoked with
          three positional arguments as well as optional keyword
          arguments:

            :ddl:
              This DDL element.

            :target:
              The :class:`_schema.Table` or :class:`_schema.MetaData`
              object which is the
              target of this event. May be None if the DDL is executed
              explicitly.

            :bind:
              The :class:`_engine.Connection` being used for DDL execution.
              May be None if this construct is being created inline within
              a table, in which case ``compiler`` will be present.

            :tables:
              Optional keyword argument - a list of Table objects which are to
              be created/ dropped within a MetaData.create_all() or drop_all()
              method call.

            :dialect: keyword argument, but always present - the
              :class:`.Dialect` involved in the operation.

            :compiler: keyword argument.  Will be ``None`` for an engine
              level DDL invocation, but will refer to a :class:`.DDLCompiler`
              if this DDL element is being created inline within a table.

            :state:
              Optional keyword argument - will be the ``state`` argument
              passed to this function.

            :checkfirst:
             Keyword argument, will be True if the 'checkfirst' flag was
             set during the call to ``create()``, ``create_all()``,
             ``drop()``, ``drop_all()``.

          If the callable returns a True value, the DDL statement will be
          executed.

        :param state: any value which will be passed to the callable\_
          as the ``state`` keyword argument.

        .. seealso::

            :meth:`.SchemaItem.ddl_if`

            :class:`.DDLEvents`

            :ref:`event_toplevel`

        )rMrZ)r%r&rPrGr(r(r)�
execute_if�sSzExecutableDDLElement.execute_ifcKs&|jdurdS|jj|||fi|��S�NT)rZrW�r%rBrCr'r(r(r)rW2s
z$ExecutableDDLElement._should_executecCs|�|j|�r|�|�SdSr6)rWrB�execute)r%rCr(r(r)�_invoke_with8s
�z!ExecutableDDLElement._invoke_withcKs|�|��|�dS)z"Execute the DDL as a ddl_listener.N)r`rercr(r(r)rK<szExecutableDDLElement.__call__cCs|j�|j�}|j��|_|Sr6)�	__class__�__new__�__dict__�copy)r%�sr(r(r)�	_generateAszExecutableDDLElement._generate)rBrr3r)NNN)r&rNrPrOrGrHr3r)r:r;r<r=rZrXrBr_rr`rarWrerKrkr(r(r(r)rY�s 
 #�UrYc@s&eZdZdZdZddd�Zdd�ZdS)	�DDLaZA literal DDL statement.

    Specifies literal SQL DDL to be executed by the database.  DDL objects
    function as DDL event listeners, and can be subscribed to those events
    listed in :class:`.DDLEvents`, using either :class:`_schema.Table` or
    :class:`_schema.MetaData` objects as targets.
    Basic templating support allows
    a single DDL instance to handle repetitive tasks for multiple tables.

    Examples::

      from sqlalchemy import event, DDL

      tbl = Table("users", metadata, Column("uid", Integer))
      event.listen(tbl, "before_create", DDL("DROP TRIGGER users_trigger"))

      spow = DDL("ALTER TABLE %(table)s SET secretpowers TRUE")
      event.listen(tbl, "after_create", spow.execute_if(dialect="somedb"))

      drop_spow = DDL("ALTER TABLE users SET secretpowers FALSE")
      connection.execute(drop_spow)

    When operating on Table events, the following ``statement``
    string substitutions are available:

    .. sourcecode:: text

      %(table)s  - the Table name, with any required quoting applied
      %(schema)s - the schema name, with any required quoting applied
      %(fullname)s - the Table name including schema, quoted if needed

    The DDL's "context", if any, will be combined with the standard
    substitutions noted above.  Keys present in the context will override
    the standard substitutions.

    rANcCs,t|t�st�d|��||_|pi|_dS)a�Create a DDL statement.

        :param statement:
          A string or unicode string to be executed.  Statements will be
          processed with Python's string formatting operator using
          a fixed set of string substitutions, as well as additional
          substitutions provided by the optional :paramref:`.DDL.context`
          parameter.

          A literal '%' in a statement must be escaped as '%%'.

          SQL bind parameters are not available in DDL statements.

        :param context:
          Optional dictionary, defaults to None.  These values will be
          available for use in string substitutions on the DDL statement.

        .. seealso::

            :class:`.DDLEvents`

            :ref:`event_toplevel`

        z4Expected a string or unicode SQL statement, got '%r'N)rQrRr�
ArgumentError�	statement�context)r%rnror(r(r)�__init__ss
��zDDL.__init__cCsBt|j�g}|jr|�d|j���dt|�jt|�d�|�fS)Nzcontext=z<%s@%s; %s>�, )�reprrnro�append�typer:�id�join)r%�partsr(r(r)�__repr__�s�zDDL.__repr__r6)r:r;r<r=�__visit_name__rprxr(r(r(r)rlKs
%
#rlc@s,eZdZdZdd�Zedd��Zdd�ZdS)	�_CreateDropBasez�Base class for DDL constructs that represent CREATE and DROP or
    equivalents.

    The common theme of _CreateDropBase is a single
    ``element`` attribute which refers to the element
    to be created or dropped.

    cCs||_|_t|dd�|_dS)NrZ)�elementrB�getattrrZ�r%r{r(r(r)rp�sz_CreateDropBase.__init__cCs|jjSr6)r{�create_drop_stringify_dialect�r%r(r(r)�stringify_dialect�sz!_CreateDropBase.stringify_dialectcCsdS)z�Allow disable of _create_rule using a callable.

        Pass to _create_rule using
        util.portable_instancemethod(self._create_rule_disable)
        to retain serializability.

        Fr()r%r@r(r(r)�_create_rule_disable�sz$_CreateDropBase._create_rule_disableN)r:r;r<r=rp�propertyr�r�r(r(r(r)rz�s	
rzc�eZdZd�fdd�	Z�ZS)�_CreateBaseFc�t��|�||_dSr6)�superrp�
if_not_exists�r%r{r��rfr(r)rp��
z_CreateBase.__init__�F�r:r;r<rp�
__classcell__r(r(r�r)r���r�cr�)�	_DropBaseFcr�r6)r�rp�	if_exists�r%r{r�r�r(r)rp�r�z_DropBase.__init__r�r�r(r(r�r)r��r�r�cs.eZdZdZdZdZ	dd�fd	d
�
Z�ZS)
�CreateSchemazcRepresent a CREATE SCHEMA statement.

    The argument here is the string name of the schema.

    �
create_schema�defaultFrSrRr�r1c�t�j||d�dS)z.Create a new :class:`.CreateSchema` construct.)r{r�N�r�rp)r%rSr�r�r(r)rp�szCreateSchema.__init__r�)rSrRr�r1�r:r;r<r=ryr�rpr�r(r(r�r)r��s�r�cs0eZdZdZdZdZ		dd
�fd
d�
Z�ZS)�
DropSchemazaRepresent a DROP SCHEMA statement.

    The argument here is the string name of the schema.

    �drop_schemar�FrSrR�cascader1r�cst�j||d�||_dS)z,Create a new :class:`.DropSchema` construct.)r{r�N)r�rpr�)r%rSr�r�r�r(r)rp�s
zDropSchema.__init__�FF)rSrRr�r1r�r1r�r(r(r�r)r��s�r�cs,eZdZdZdZ		d
d�fdd�
Z�ZS)�CreateTablez#Represent a CREATE TABLE statement.�create_tableNFr{r�include_foreign_key_constraints�/Optional[typing_Sequence[ForeignKeyConstraint]]r�r1cs,t�j||d�dd�|jD�|_||_dS)a�Create a :class:`.CreateTable` construct.

        :param element: a :class:`_schema.Table` that's the subject
         of the CREATE
        :param on: See the description for 'on' in :class:`.DDL`.
        :param include_foreign_key_constraints: optional sequence of
         :class:`_schema.ForeignKeyConstraint` objects that will be included
         inline within the CREATE construct; if omitted, all foreign key
         constraints that do not specify use_alter=True are included.

        :param if_not_exists: if True, an IF NOT EXISTS operator will be
         applied to the construct.

         .. versionadded:: 1.4.0b2

        �r�cSsg|]}t|��qSr()�CreateColumn)�.0�columnr(r(r)�
<listcomp>�z(CreateTable.__init__.<locals>.<listcomp>N)r�rp�columnsr�)r%r{r�r�r�r(r)rp�s
zCreateTable.__init__�NF)r{rr�r�r�r1�r:r;r<r=ryrpr�r(r(r�r)r��s�r�c@�eZdZdZdZdS)�	_DropViewz�Semi-public 'DROP VIEW' construct.

    Used by the test suite for dialect-agnostic drops of views.
    This object will eventually be part of a public "view" API.

    �	drop_viewN�r:r;r<r=ryr(r(r(r)r�sr�c@seZdZddd�ZdS)�CreateConstraintr{rcC�
||_dSr6�r{r}r(r(r)rp(�
zCreateConstraint.__init__N)r{r)r:r;r<rpr(r(r(r)r�'sr�c@seZdZdZdZdd�ZdS)r�a�Represent a :class:`_schema.Column`
    as rendered in a CREATE TABLE statement,
    via the :class:`.CreateTable` construct.

    This is provided to support custom column DDL within the generation
    of CREATE TABLE statements, by using the
    compiler extension documented in :ref:`sqlalchemy.ext.compiler_toplevel`
    to extend :class:`.CreateColumn`.

    Typical integration is to examine the incoming :class:`_schema.Column`
    object, and to redirect compilation if a particular flag or condition
    is found::

        from sqlalchemy import schema
        from sqlalchemy.ext.compiler import compiles


        @compiles(schema.CreateColumn)
        def compile(element, compiler, **kw):
            column = element.element

            if "special" not in column.info:
                return compiler.visit_create_column(element, **kw)

            text = "%s SPECIAL DIRECTIVE %s" % (
                column.name,
                compiler.type_compiler.process(column.type),
            )
            default = compiler.get_column_default_string(column)
            if default is not None:
                text += " DEFAULT " + default

            if not column.nullable:
                text += " NOT NULL"

            if column.constraints:
                text += " ".join(
                    compiler.process(const) for const in column.constraints
                )
            return text

    The above construct can be applied to a :class:`_schema.Table`
    as follows::

        from sqlalchemy import Table, Metadata, Column, Integer, String
        from sqlalchemy import schema

        metadata = MetaData()

        table = Table(
            "mytable",
            MetaData(),
            Column("x", Integer, info={"special": True}, primary_key=True),
            Column("y", String(50)),
            Column("z", String(20), info={"special": True}),
        )

        metadata.create_all(conn)

    Above, the directives we've added to the :attr:`_schema.Column.info`
    collection
    will be detected by our custom compilation scheme:

    .. sourcecode:: sql

        CREATE TABLE mytable (
                x SPECIAL DIRECTIVE INTEGER NOT NULL,
                y VARCHAR(50),
                z SPECIAL DIRECTIVE VARCHAR(20),
            PRIMARY KEY (x)
        )

    The :class:`.CreateColumn` construct can also be used to skip certain
    columns when producing a ``CREATE TABLE``.  This is accomplished by
    creating a compilation rule that conditionally returns ``None``.
    This is essentially how to produce the same effect as using the
    ``system=True`` argument on :class:`_schema.Column`, which marks a column
    as an implicitly-present "system" column.

    For example, suppose we wish to produce a :class:`_schema.Table`
    which skips
    rendering of the PostgreSQL ``xmin`` column against the PostgreSQL
    backend, but on other backends does render it, in anticipation of a
    triggered rule.  A conditional compilation rule could skip this name only
    on PostgreSQL::

        from sqlalchemy.schema import CreateColumn


        @compiles(CreateColumn, "postgresql")
        def skip_xmin(element, compiler, **kw):
            if element.element.name == "xmin":
                return None
            else:
                return compiler.visit_create_column(element, **kw)


        my_table = Table(
            "mytable",
            metadata,
            Column("id", Integer, primary_key=True),
            Column("xmin", Integer),
        )

    Above, a :class:`.CreateTable` construct will generate a ``CREATE TABLE``
    which only includes the ``id`` column in the string; the ``xmin`` column
    will be omitted, but only against the PostgreSQL backend.

    �
create_columncCr�r6r�r}r(r(r)rp�r�zCreateColumn.__init__N)r:r;r<r=ryrpr(r(r(r)r�,snr�c�(eZdZdZdZd
d�fdd	�
Z�ZS)�	DropTablez!Represent a DROP TABLE statement.�
drop_tableFr{rr�r1cr�)aVCreate a :class:`.DropTable` construct.

        :param element: a :class:`_schema.Table` that's the subject
         of the DROP.
        :param on: See the description for 'on' in :class:`.DDL`.
        :param if_exists: if True, an IF EXISTS operator will be applied to the
         construct.

         .. versionadded:: 1.4.0b2

        �r�Nr�r�r�r(r)rp�szDropTable.__init__r�)r{rr�r1r�r(r(r�r)r���r�cr�)�CreateSequencez&Represent a CREATE SEQUENCE statement.�create_sequenceFr{rr�r1c�t�j||d�dS)Nr�r�r�r�r(r)rp��zCreateSequence.__init__r�)r{rr�r1r�r(r(r�r)r��r�r�cr�)�DropSequencez$Represent a DROP SEQUENCE statement.�
drop_sequenceFr{rr�r1cr�)Nr�r�r�r�r(r)rp�r�zDropSequence.__init__r�)r{rr�r1r�r(r(r�r)r��r�r�c�&eZdZdZdZd�fdd�	Z�ZS)�CreateIndexz#Represent a CREATE INDEX statement.�create_indexFcr�)a Create a :class:`.Createindex` construct.

        :param element: a :class:`_schema.Index` that's the subject
         of the CREATE.
        :param if_not_exists: if True, an IF NOT EXISTS operator will be
         applied to the construct.

         .. versionadded:: 1.4.0b2

        r�Nr�r�r�r(r)rp��zCreateIndex.__init__r�r�r(r(r�r)r���r�cr�)�	DropIndexz!Represent a DROP INDEX statement.�
drop_indexFcr�)aCreate a :class:`.DropIndex` construct.

        :param element: a :class:`_schema.Index` that's the subject
         of the DROP.
        :param if_exists: if True, an IF EXISTS operator will be applied to the
         construct.

         .. versionadded:: 1.4.0b2

        r�Nr�r�r�r(r)rp�r�zDropIndex.__init__r�r�r(r(r�r)r��r�r�cs$eZdZdZdZ�fdd�Z�ZS)�
AddConstraintz2Represent an ALTER TABLE ADD CONSTRAINT statement.�add_constraintcst��|�t�|j�|_dSr6)r�rpr�portable_instancemethodr��_create_ruler}r�r(r)rp�s
�zAddConstraint.__init__r�r(r(r�r)r��sr�cr�)�DropConstraintz3Represent an ALTER TABLE DROP CONSTRAINT statement.�drop_constraintFcs0||_t�j|fd|i|��t�|j�|_dS)Nr�)r�r�rprr�r�r�)r%r{r�r�r'r�r(r)rp�s

�zDropConstraint.__init__r�r�r(r(r�r)r��r�r�c@r�)�SetTableCommentz*Represent a COMMENT ON TABLE IS statement.�set_table_commentNr�r(r(r(r)r��r�c@r�)�DropTableCommentzfRepresent a COMMENT ON TABLE '' statement.

    Note this varies a lot across database backends.

    �drop_table_commentNr�r(r(r(r)r�sr�c@r�)�SetColumnCommentz+Represent a COMMENT ON COLUMN IS statement.�set_column_commentNr�r(r(r(r)r�r�r�c@r�)�DropColumnCommentz0Represent a COMMENT ON COLUMN IS NULL statement.�drop_column_commentNr�r(r(r(r)r�r�r�c@r�)�SetConstraintCommentz/Represent a COMMENT ON CONSTRAINT IS statement.�set_constraint_commentNr�r(r(r(r)r�"r�r�c@r�)�DropConstraintCommentz4Represent a COMMENT ON CONSTRAINT IS NULL statement.�drop_constraint_commentNr�r(r(r(r)r�(r�r�c@s"eZdZdd�Zejdd��ZdS)�
InvokeDDLBasecCr�r6)r\)r%r\r(r(r)rp/r�zInvokeDDLBase.__init__cKr5)�dhelper context manager that will apply appropriate DDL events
        to a CREATE or DROP operation.r7�r%rBr'r(r(r)�with_ddl_events2szInvokeDDLBase.with_ddl_eventsN)r:r;r<rp�
contextlib�contextmanagerr�r(r(r(r)r�.sr�c@�eZdZejdd��ZdS)�InvokeCreateDDLBaseck�D�|jj||jfd|i|��dV|jj||jfd|i|��dS�r��_ddl_runnerN)�dispatch�
before_creater\�after_creater�r(r(r)r�;� ������
�z#InvokeCreateDDLBase.with_ddl_eventsN�r:r;r<r�r�r�r(r(r(r)r�:�r�c@r�)�InvokeDropDDLBaseckr�r�)r��before_dropr\�
after_dropr�r(r(r)r�Jr�z!InvokeDropDDLBase.with_ddl_eventsNr�r(r(r(r)r�Ir�r�csleZdZ	d�fdd�	Zdd�Zdd�Zd	d
�Zdd�Z			dd
d�Zdd�Z	ddd�Z
ddd�Z�ZS)�SchemaGeneratorFNc�8t�j|fi|��||_||_|j|_||_i|_dSr6�r�rprJrE�identifier_preparer�preparerr&�memo�r%r&r\rJrE�kwargsr�r(r)rpY�
zSchemaGenerator.__init__cCsJ|j�|j�|j�|�}|r|j�|�|jp$|jj|j|j|d�S�N)�schema�r&�validate_identifierrSr\�schema_for_objectrJ�	has_table�r%�table�effective_schemar(r(r)�_can_create_tablecs
�z!SchemaGenerator._can_create_tablecCsD|j�|j�}|r|j�|�|jp!|jj|j|jj|j|d�Sr��r\r�r�r&r�rJ�	has_indexrS�r%�indexr�r(r(r)�_can_create_indexls�z!SchemaGenerator._can_create_indexcCsF|j�|�}|jjo"|jjs|jo"|jp"|jj|j|j|d�Sr��	r\r�r&�supports_sequences�sequences_optional�optionalrJ�has_sequencerS�r%�sequencer�r(r(r)�_can_create_sequencews
��z$SchemaGenerator._can_create_sequencec
s��jdur	�j}nt|j���}t�fdd�|D��}�fdd�|j��D�}dd�|D�}�j||�jd��4|D]	}�j|dd�q:|D]\}}|durX�j|d|dd�qF|D]}	��|	�qZqFWd�dS1snwYdS)	Nc�g|]	}��|�r|�qSr()r��r��trr(r)r���z2SchemaGenerator.visit_metadata.<locals>.<listcomp>cs$g|]}|jdur��|�r|�qSr6)r�r
�r�rjrr(r)r���
�cS�g|]
\}}|dur|�qSr6r(�r�r
�fksr(r(r)r����rErJT��	create_ok)rr��_is_metadata_operation)rErU�values�sort_tables_and_constraints�
_sequencesr�rJ�traverse_single)
r%�metadatarE�
collection�seq_coll�event_collection�seqr��fkcs�fkcr(rr)�visit_metadata�s<
�
�����"�zSchemaGenerator.visit_metadatacCs^|s	|�|�s	dS|j||j|d���|jD]
}|jdur#|�|j�q|jjs*d}t||d��	|j
�t|d�rF|jD]	}|j|dd�q<|jj
r�|jjs�|jdur[t|��	|j
�|jD]}|jdurmt|��	|j
�q^|jjr�|jD]'}|jdur�|j
�t|��quWd�dSWd�dSWd�dSWd�dS1s�wYdS)N�rJr)r��indexesTr)r�r�rJr�r�rr&�supports_alterr�rer\�hasattrr&�supports_comments�inline_comments�commentr�r��supports_constraint_comments�constraintsrdr�)r%r�rr�rr�r�
constraintr(r(r)�visit_table�s\�

��


��


�

�����#�$"�zSchemaGenerator.visit_tablecC�L|jjsdS|�|��t|��|j�Wd�dS1swYdSr6)r&r'r�r�rer\�r%r.r(r(r)�visit_foreign_key_constraint�s
"�z,SchemaGenerator.visit_foreign_key_constraintcC�R|s	|�|�s	dS|�|��t|��|j�Wd�dS1s"wYdSr6)r
r�r�rer\)r%r	rr(r(r)�visit_sequence��
"�zSchemaGenerator.visit_sequencecCr3r6)rr�r�rer\)r%rrr(r(r)�visit_index�r5zSchemaGenerator.visit_index�FN)FNFr�)
r:r;r<rpr�rr
r$r/r2r4r6r�r(r(r�r)r�Xs�
	
)
�4
r�csleZdZ	d�fdd�	Zdd�Zdd�Zd	d
�Zdd�Zdd
d�Z			ddd�Z	dd�Z
ddd�Z�ZS)�
SchemaDropperFNcr�r6r�r�r�r(r)rp�r�zSchemaDropper.__init__c
s��jdur	�j}nt|j���}z�fdd�|D�}ttt|�fdd�d���}WnMtjyv}z@�jjsPt	�
dd�tdd�|j
D����d	d�|D�}ntj|jd
|j
|jdd�tdd�|j
D���d
�|�WYd}~nd}~ww�fdd�|j��D�}dd�|D�}�j||�jd��7|D]\}}	|dur��j|dd|d�q�|	D]}
��|
�q�q�|D]}�j||jdud�q�Wd�dS1s�wYdS)Ncrr()�_can_drop_tablerrr(r)r�rz0SchemaDropper.visit_metadata.<locals>.<listcomp>cs�jjr	|jdurdSdSr�)r&r'rS)r.rr(r)�<lambda>	s
�
�z.SchemaDropper.visit_metadata.<locals>.<lambda>��	filter_fna4Can't sort tables for DROP; an unresolvable foreign key dependency exists between tables: %s; and backend does not support ALTER.  To restore at least a partial sort, apply use_alter=True to ForeignKey and ForeignKeyConstraint objects involved in the cycle to mark these as known cycles that will be ignored.rqcS�g|]}|j�qSr(��fullnamerr(r(r)r��cSsg|]}|df�qS)r(r(rr(r(r)r�r�rz�Can't sort tables for DROP; an unresolvable foreign key dependency exists between tables: %s.  Please ensure that the ForeignKey and ForeignKeyConstraint objects involved in the cycle have names so that they can be dropped using DROP CONSTRAINT.cSr=r(r>rr(r(r)r�,r@)�msgcrr()�_can_drop_sequencerrr(r)r�/s��cSrr6r(rr(r(r)r�5rrT)�drop_okr�_ignore_sequences)rC)rErUr�reversedrr�CircularDependencyErrorr&r'r�warnrv�sorted�cycles�args�edgesrr�rJrr�)r%rrE�unsorted_tablesr�err2rr r�r"r#r!r(rr)r$�st

���
��������
�����"�zSchemaDropper.visit_metadatacCsH|j�|j�|j�|�}|r|j�|�|jp#|jj|j|j|d�Sr�r�r�r(r(r)r9Ks
�zSchemaDropper._can_drop_tablecCsB|j�|j�}|r|j�|�|jp |jj|j|jj|j|d�Sr�r�rr(r(r)�_can_drop_indexTs�zSchemaDropper._can_drop_indexcCsD|j�|�}|jjo!|jjs|jo!|jp!|jj|j|j|d�Sr�rrr(r(r)rB_s
��z SchemaDropper._can_drop_sequencecCsR|s	|�|�s	dS|�|��t|�||j�Wd�dS1s"wYdSr6)rNr�r�r\)r%rrCr(r(r)r6ks
"�zSchemaDropper.visit_indexr(cCs�|s	|�|�s	dS|j||j|d��'t|��|j�|jD]}|jdur0|j|vr0|�|j�qWd�dS1s<wYdS)Nr%)	r9r�rJr�rer\r�r�r)r%r�rCrrDr�r(r(r)r/rs�
	

��"�zSchemaDropper.visit_tablecCr0r6)r&r'r�r�rer\r1r(r(r)r2�s
"�z*SchemaDropper.visit_foreign_key_constraintcCr3r6)rBr�r�rer\)r%r	rCr(r(r)r4�r5zSchemaDropper.visit_sequencer7r�)FFr()
r:r;r<rpr$r9rNrBr6r/r2r4r�r(r(r�r)r8�s�
N	


�r8rE�Iterable[TableClause]�skip_fn�0Optional[Callable[[ForeignKeyConstraint], bool]]�extra_dependencies�:Optional[typing_Sequence[Tuple[TableClause, TableClause]]]r3�List[Table]cs8|dur
|��fdd�}nd}dd�t|||dd�D�S)a
Sort a collection of :class:`_schema.Table` objects based on
    dependency.

    This is a dependency-ordered sort which will emit :class:`_schema.Table`
    objects such that they will follow their dependent :class:`_schema.Table`
    objects.
    Tables are dependent on another based on the presence of
    :class:`_schema.ForeignKeyConstraint`
    objects as well as explicit dependencies
    added by :meth:`_schema.Table.add_is_dependent_on`.

    .. warning::

        The :func:`._schema.sort_tables` function cannot by itself
        accommodate automatic resolution of dependency cycles between
        tables, which are usually caused by mutually dependent foreign key
        constraints. When these cycles are detected, the foreign keys
        of these tables are omitted from consideration in the sort.
        A warning is emitted when this condition occurs, which will be an
        exception raise in a future release.   Tables which are not part
        of the cycle will still be returned in dependency order.

        To resolve these cycles, the
        :paramref:`_schema.ForeignKeyConstraint.use_alter` parameter may be
        applied to those constraints which create a cycle.  Alternatively,
        the :func:`_schema.sort_tables_and_constraints` function will
        automatically return foreign key constraints in a separate
        collection when cycles are detected so that they may be applied
        to a schema separately.

        .. versionchanged:: 1.3.17 - a warning is emitted when
           :func:`_schema.sort_tables` cannot perform a proper sort due to
           cyclical dependencies.  This will be an exception in a future
           release.  Additionally, the sort will continue to return
           other tables not involved in the cycle in dependency order
           which was not the case previously.

    :param tables: a sequence of :class:`_schema.Table` objects.

    :param skip_fn: optional callable which will be passed a
     :class:`_schema.ForeignKeyConstraint` object; if it returns True, this
     constraint will not be considered as a dependency.  Note this is
     **different** from the same parameter in
     :func:`.sort_tables_and_constraints`, which is
     instead passed the owning :class:`_schema.ForeignKeyConstraint` object.

    :param extra_dependencies: a sequence of 2-tuples of tables which will
     also be considered as dependent on each other.

    .. seealso::

        :func:`.sort_tables_and_constraints`

        :attr:`_schema.MetaData.sorted_tables` - uses this function to sort


    Ncs|jD]	}�|�rdSqdSrb)�elements)r#�fk��
fixed_skip_fnr(r)�_skip_fn�s

�zsort_tables.<locals>._skip_fncSrr6r()r�r
r"r(r(r)r��s
�zsort_tables.<locals>.<listcomp>T)r<rR�_warn_for_cycles)r)rErPrRrYr(rWr)�sort_tables�sA��r[Fc
s�t�}t�}|dur|�|�t��|D]>��jD]+}|jdur&��|�q�r6�|�}|dur6��|�q|j}|�urD|�|�f�q|��fdd��jD��qz
tt�	|�
|�|��}	Wnitjy�}
z\|r~t
�dd�tdd�|
jD���f�|
jD]2}||vr�|d��|
jvr�q��fd	d
��jD�}��|�|D]}|j}|�ur�|�|�f�q�q�tt�	|�
|�|��}	WYd}
~
nd}
~
ww�fdd
�|	D�dt��fgS)a�Sort a collection of :class:`_schema.Table`  /
    :class:`_schema.ForeignKeyConstraint`
    objects.

    This is a dependency-ordered sort which will emit tuples of
    ``(Table, [ForeignKeyConstraint, ...])`` such that each
    :class:`_schema.Table` follows its dependent :class:`_schema.Table`
    objects.
    Remaining :class:`_schema.ForeignKeyConstraint`
    objects that are separate due to
    dependency rules not satisfied by the sort are emitted afterwards
    as ``(None, [ForeignKeyConstraint ...])``.

    Tables are dependent on another based on the presence of
    :class:`_schema.ForeignKeyConstraint` objects, explicit dependencies
    added by :meth:`_schema.Table.add_is_dependent_on`,
    as well as dependencies
    stated here using the :paramref:`~.sort_tables_and_constraints.skip_fn`
    and/or :paramref:`~.sort_tables_and_constraints.extra_dependencies`
    parameters.

    :param tables: a sequence of :class:`_schema.Table` objects.

    :param filter_fn: optional callable which will be passed a
     :class:`_schema.ForeignKeyConstraint` object,
     and returns a value based on
     whether this constraint should definitely be included or excluded as
     an inline constraint, or neither.   If it returns False, the constraint
     will definitely be included as a dependency that cannot be subject
     to ALTER; if True, it will **only** be included as an ALTER result at
     the end.   Returning None means the constraint is included in the
     table-based result unless it is detected as part of a dependency cycle.

    :param extra_dependencies: a sequence of 2-tuples of tables which will
     also be considered as dependent on each other.

    .. seealso::

        :func:`.sort_tables`


    NTc3s�|]}|�fVqdSr6r()r��parent)r�r(r)�	<genexpr>>s�
�z.sort_tables_and_constraints.<locals>.<genexpr>aCannot correctly sort tables; there are unresolvable cycles between tables "%s", which is usually caused by mutually dependent foreign key constraints.  Foreign key constraints involving these tables will not be considered; this warning may raise an error in a future release.rqcss�|]}|jVqdSr6r>rr(r(r)r]Qs�r
cs$g|]}�dus�|�dur|�qSr�r()r�r#r;r(r)r�Xrz/sort_tables_and_constraints.<locals>.<listcomp>csg|]
}||j���f�qSr()�foreign_key_constraints�
difference)r�r�)�remaining_fkcsr(r)r�is��)rV�updater^�	use_alter�add�referred_table�_extra_dependenciesrUr�sort�unionrrFrrGrvrHrIrK�discard)
rEr<rRrZ�fixed_dependencies�mutable_dependenciesr#�filtered�dependent_on�candidate_sort�err�edge�
can_remover()r<r`r�r)r�s~.




�
�����


�
�����
 ��rrL)rErOrPrQrRrSr3rT)NNF)Sr=�
__future__rr��typingrrrrrr�typing_Sequencer	�r�baserr
rrUrrrr�util.typingrr�
TYPE_CHECKINGr@rrrr�rrrr�
selectabler�engine.baser�engine.interfacesrr r!r"r#r?�
NamedTuplerM�DDLRolerY�
DDLElementrlrzr�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r8r[rr(r(r(r)�<module>s� (;W "u		

/�[�