관리-도구
편집 파일: schema.cpython-38.pyc
U -?�fԀ � @ s( U d Z ddlmZ ddlmZ ddlZddlmZ ddlZddl Z ddl m Z ddl m Z ddl m Z dd l m Z dd l mZ dd l mZ dd l mZ dd l mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl 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% dd l#m&Z& dd!l#m'Z' dd"l#m(Z( dd#l#m)Z) dd$l#m*Z* dd%l#m+Z+ dd&l#m,Z, dd'l m-Z- dd(l.m/Z/ dd)l.m0Z0 dd*l.m1Z1 dd+l.m2Z2 dd,l.m3Z3 dd-l4m5Z5 dd.l!m6Z6 dd/l"m7Z7 d0d1l m8Z8 d0d2l m9Z9 d0d3l m:Z: d0d4l m;Z; d0d5l;m<Z< d0d6l=m>Z> d0d7l=m?Z? d0d8l=m@Z@ d0d9l=mAZA d0d:l=mBZB d0d;l=mCZC e j�r�dd<lDmEZE dd=lDmFZF dd>lDmGZG dd?lDmHZH dd@lDmIZI ddAl#mJZJ ddBlKmLZL ddCl.mMZM ddDlNmOZO ddEl!mPZP ddFl"mQZQ d0dGlRmSZS d0dHlRmTZT d0dIlUmVZV d0dJlUmWZW d0dKlUmXZX d0dLlYmZZZ d0dMl[m\Z\ d0dNl]m^Z^ edOdPdQ�Z_edRdSdQ�Z`edTdUdQ�Zae dV Zbee ece&f Zde dWece3e1e f ZeeeZfG dXdY� dYe�ZgegjhZhdZeid[< egjjZjd\eid]< egjkZkd^eid_< d`dad`db�dcdd�Zldedfdfdedg�dhdi�Zme:jnG djdS� dSe,e"jo��ZpG dkdl� dl�ZqG dmdn� dnep�ZrG dodU� dUe*ere5e:jsdU �ZtG dpdq� dqe*epe0e_ �Zud�ddrds�dadtdudvdwdx�dydz�ZvG d{d|� d|e*ep�Zwe�r(d}d~d�d�d��Zxd}d�d�d�d��Zyd}d�d�d�d��Zzn e�{d��Zxe�{d��Zye�{d��ZzG d�d�� d�e+ep�Z|G d�d�� d�e|e�Z}G d�d�� d�e}�Z~G d�d�� d�e}�Ze d� Z�G d�d�� d�e}�Z�G d�d�� d�e@�Z�G d�d�� d�e}�Z�G d�d�� d��Z�G d�d�� d�ere�e|�Ze:jnG d�dW� dWe,��Z�G d�d�� d�e��Z�G d�d�� d�e*eqep�Z�G d�d�� d��Z�G d�d�� d�e�e��Z�G d�d�� d�e��Z�G d�d�� d�e��Z�G d�d�� d�e��Z�G d�d�� d�e��Z�G d�d�� d�e*e�eqep�Z�e e�etgecf Z�e ece�f Z�G d�d�� d�eBd�d��Z�e e�ee e�f f Z�e;��d�d�i�Z�d�eid�< G d�d�� d�er�Z�G d�d�� d�e�ep�Z�G d�d�� d�e�e�ep�Z�dS )�a/ The schema module provides the building blocks for database metadata. Each element within this module describes a database entity which can be created and dropped, or is otherwise part of such an entity. Examples include tables, columns, sequences, and indexes. All entities are subclasses of :class:`~sqlalchemy.schema.SchemaItem`, and as defined in this module they are intended to be agnostic of any vendor-specific constructs. A collection of entities are grouped into a unit called :class:`~sqlalchemy.schema.MetaData`. MetaData serves as a logical grouping of schema elements, and can also be associated with an actual database connection such that operations involving the contained elements can contact the database as needed. Two of the elements here also build upon their "syntactic" counterparts, which are defined in :class:`~sqlalchemy.sql.expression.`, specifically :class:`~sqlalchemy.schema.Table` and :class:`~sqlalchemy.schema.Column`. Since these objects are part of the SQL expression language, they are usable as components in SQL expressions. � )� annotations)�ABCN)�Enum)�Any)�Callable)�cast)� Collection)�Dict)�Iterable)�Iterator)�List)�Mapping)�NoReturn)�Optional)�overload)�Sequence)�Set)�Tuple)� TYPE_CHECKING)�TypeVar)�Union� )� coercions)�ddl)�roles)�type_api)�visitors)�_DefaultDescriptionTuple)�_NoArg)� _NoneName)� _SentinelColumnCharacterization)� _SentinelDefaultCharacterization)�DedupeColumnCollection)� DialectKWArgs)� Executable)�SchemaEventTarget)�_document_text_coercion)� ClauseElement)� ColumnClause)� ColumnElement)� quoted_name)� TextClause)� TableClause)� to_instance)�ExternallyTraversible� )�event)�exc)� inspection)�util)� HasMemoized)�Final)�Literal)�Protocol)�Self)� TypedDict)� TypeGuard)�_AutoIncrementType)�_DDLColumnArgument)� _InfoType)� _TextCoercedExpressionArgument)�_TypeEngineArgument)�ReadOnlyColumnCollection)� DDLCompiler)� BindParameter)�Function)� TypeEngine)�anon_map)� Connection)�Engine)�_CoreMultiExecuteParams)�CoreExecuteOptionsParameter)�ExecutionContext)�MockConnection)�_ReflectionInfo)� FromClause�_Tr )�bound�_SI� SchemaItem�_TAB�Table)rG rF rK � FetchedValuec @ s e Zd ZdZdZdZdS )� SchemaConstr r/ � N)�__name__� __module__� __qualname__� RETAIN_SCHEMA� BLANK_SCHEMA�NULL_UNSPECIFIED� r] r] �E/opt/hc_python/lib64/python3.8/site-packages/sqlalchemy/sql/schema.pyrU � s rU z)Final[Literal[SchemaConst.RETAIN_SCHEMA]]rZ z(Final[Literal[SchemaConst.BLANK_SCHEMA]]r[ z,Final[Literal[SchemaConst.NULL_UNSPECIFIED]]r\ �str� Optional[str]��name�schema�returnc C s |d kr | S |d | S d S )N�.r] )rb rc r] r] r^ �_get_table_key� s rf �ColumnElement[Any]�Optional[Table])� expression� source_table� target_tablerd c sL |d ks|d kr| S |� |�dddd�� �fdd� }t tt t�| i |��S )Nr. r z Optional[ExternallyTraversible])�element�kwrd c s4 t | t�r,| j� kr,| j� jkr,�j| j S d S d S �N)� isinstance�Column�table�key�c)rl rm �Zfixed_source_tableZfixed_target_tabler] r^ �replace� s �� � z!_copy_expression.<locals>.replace)r r) r r Zreplacement_traverse)ri rj rk ru r] rt r^ �_copy_expression� s �rv c @ s` e Zd ZdZdZdZd ddd�dd�Zd d �d d �Zej d d �dd��Z ddd�dd�Z dZ dS )rQ z3Base class for items that define a database schema.� schema_item�defaultr �None��argsrm rd c O sb |D ]X}|dk rz |j }W n4 tk rN } zt�d|���|�W 5 d}~X Y qX || f|� qdS )z7Initialize the list of child items for this SchemaItem.NzH'SchemaItem' object, such as a 'Column' or a 'Constraint' expected, got )�_set_parent_with_dispatch�AttributeErrorr1 � ArgumentError)�selfr{ rm �itemZspwd�errr] r] r^ � _init_items� s ��zSchemaItem._init_itemsr_ �rd c C s t j| dgd�S )N�info)Z omit_kwarg�r3 Z generic_repr�r r] r] r^ �__repr__� s zSchemaItem.__repr__r= c C s i S )aZ Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.SchemaItem`. The dictionary is automatically generated when first accessed. It can also be specified in the constructor of some objects, such as :class:`_schema.Table` and :class:`_schema.Column`. r] r� r] r] r^ r� � s zSchemaItem.inforP )rw rd c C s( d| j kr| j�� |_|j�| j� |S )Nr� )�__dict__r� �copy�dispatch�_update)r rw r] r] r^ �_schema_item_copy� s z SchemaItem._schema_item_copyTN) rW rX rY �__doc__�__visit_name__Z create_drop_stringify_dialectr� r� r3 �memoized_propertyr� r� Z_use_schema_mapr] r] r] r^ rQ � s c @ s4 e Zd ZU dZdZded< d ddddd �d d �ZdS ) �HasConditionalDDLz�define a class that includes the :meth:`.HasConditionalDDL.ddl_if` method, allowing for conditional rendering of DDL. Currently applies to constraints and indexes. .. versionadded:: 2.0 NzOptional[ddl.DDLIf]�_ddl_ifr` zOptional[ddl.DDLIfCallable]� Optional[Any]r8 )�dialect� callable_�staterd c C s t �|||�| _| S )a� apply a conditional DDL rule to this schema item. These rules work in a similar manner to the :meth:`.ExecutableDDLElement.execute_if` callable, with the added feature that the criteria may be checked within the DDL compilation phase for a construct such as :class:`.CreateTable`. :meth:`.HasConditionalDDL.ddl_if` currently applies towards the :class:`.Index` construct as well as all :class:`.Constraint` constructs. :param dialect: string name of a dialect, or a tuple of string names to indicate multiple dialect types. :param callable\_: a callable that is constructed using the same form as that described in :paramref:`.ExecutableDDLElement.execute_if.callable_`. :param state: any arbitrary object that will be passed to the callable, if present. .. versionadded:: 2.0 .. seealso:: :ref:`schema_ddl_ddl_if` - background and usage examples )r ZDDLIfr� )r r� r� r� r] r] r^ �ddl_if s "zHasConditionalDDL.ddl_if)NNN)rW rX rY r� r� �__annotations__r� r] r] r] r^ r� s �r� c @ s e Zd ZU dZded< dS )� HasSchemaAttrz1schema item that includes a top-level schema namer` rc N)rW rX rY r� r� r] r] r] r^ r� 5 s r� c s� e Zd ZU dZdZer>ejdd�dd��Zejdd�dd ��Z d e d < d e d < de d< de d< er�ejdd�dd��Z ejdd�dd��Z ejdd�dd��Z dddd �d d �Zejs�ejd d �d!d!d!d"�d#d$��Zed!d!d!d"�d%d&��Zd'd'd'd'd(d)d)d(d'd(d'd'd'd'd'd(d*�d+d,d-d.d/d/d0d1d1d1d1d2d1d3d4d5d6d7d1d!d8d9�� fd:d;�Zdd,d=d2d>d1d7d?d8d@�dAdB�ZedCd�dDdE��ZedFd�dGdH��Zd!d!d8dI�dJdK�Zd!d8dL�dMdN�Zd8d�dOdP�Zd8d�dQdR�Z ejdSd�dTdU��Z ej dVd�dWdX��Z edSd�dYdZ��Z ed+d�d[d\��Z!d+d�d]d^�Z"d+d�d_d`�Z#d d8da�dbdc�Z$d�ddd1d8de�dfdg�Z%dhd8di�djdk�Z&dld!d8dm�dndo�Z'd�dpd1d8dq�drds�Z(d�dpd1d8dq�dtdu�Z)e�*dvdw�e+d'd'fd,dxdyd3d dz�d{d|��Z,e+d'd'fd,dxdyd3d dz�d}d~�Z-� Z.S )�rS a Represent a table in a database. e.g.:: mytable = Table( "mytable", metadata, Column('mytable_id', Integer, primary_key=True), Column('value', String(50)) ) The :class:`_schema.Table` object constructs a unique instance of itself based on its name and optional schema name within the given :class:`_schema.MetaData` object. Calling the :class:`_schema.Table` constructor with the same name and same :class:`_schema.MetaData` argument a second time will return the *same* :class:`_schema.Table` object - in this way the :class:`_schema.Table` constructor acts as a registry function. .. seealso:: :ref:`metadata_describing` - Introduction to database metadata rq �PrimaryKeyConstraintr� c C s d S rn r] r� r] r] r^ � primary_key[ s zTable.primary_key�Set[ForeignKey]c C s d S rn r] r� r] r] r^ � foreign_keys^ s zTable.foreign_keys�#DedupeColumnCollection[Column[Any]]�_columns�Optional[Column[Any]]�_sentinel_column�Set[Constraint]� constraintsz Set[Index]�indexes�*ReadOnlyColumnCollection[str, Column[Any]]c C s d S rn r] r� r] r] r^ �columns� s z Table.columnsc C s d S rn r] r� r] r] r^ �exported_columns� s zTable.exported_columnsc C s d S rn r] r� r] r] r^ rs � s zTable.crE zList[BindParameter[Any]]zTuple[Any, ...])rE � bindparamsrd c C s | j r| f| j S | fS d S rn )Z _annotationsZ_annotations_cache_key)r rE r� r] r] r^ �_gen_cache_key� s zTable._gen_cache_key)�1.4z8Deprecated alias of :paramref:`_schema.Table.must_exist`)� mustexistr rz c O s | j ||�S rn )�_new)�clsr{ rm r] r] r^ �__new__� s z Table.__new__c O s� |s|st �| �S z$|d |d |dd � }}}W n tk rR td��Y nX |�dd �}|d krp|j}n |tkr|d }|�dd�}|�dd�}|r�|r�d }t�|��|� d |� d d��} t ||�} | |j k�r|s�|s�t |�r�t� d | � d ���|j | } |�r| j||� | S | �r.t� d | � d���t �| �} | j�| |� |�||| � z0| j||f|�ddi|�� | j�| |� | W S tk �r� t�� � |�||� W 5 Q R X Y nX d S )Nr r r/ zJTable() takes at least two positional-only arguments 'name' and 'metadata'rc � keep_existingF�extend_existingz9keep_existing and extend_existing are mutually exclusive.� must_existr� �Table 'z�' is already defined for this MetaData instance. Specify 'extend_existing=True' to redefine options and columns on an existing Table object.z ' not defined�_no_init)�objectr� � IndexError� TypeError�getrc r[ r1 r~ �poprf �tables�bool�InvalidRequestError�_init_existingr� Zbefore_parent_attach� _add_table�__init__�after_parent_attach� Exceptionr3 Z safe_reraise� _remove_table) r� r{ rm rb �metadatarc r� r� �msgr� rr rq r] r] r^ r� � sR $� � z Table._newNTF)rc �quote� quote_schema� autoload_with�autoload_replacer� r� � resolve_fks�include_columns�implicit_returning�commentr� � listeners�prefixes� _extend_onr� r_ �MetaDatarQ �7Optional[Union[str, Literal[SchemaConst.BLANK_SCHEMA]]]�Optional[bool]z#Optional[Union[Engine, Connection]]r� zOptional[Collection[str]]r` zOptional[Dict[Any, Any]]z:Optional[_typing_Sequence[Tuple[str, Callable[..., Any]]]]z Optional[_typing_Sequence[str]]zOptional[Set[Table]]ry )rb r� r{ rc r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rm rd c sf |rdS t � �t||�� || _|dkr2|j| _n.|tkrBd| _n |}t|t�sTt�t||�| _d| _ t � | _ t � | _ t dd��| � t � | _t � | _| jdk r�d| j| jf | _n| j| _| | _|�dd�}| | _|dk r�|| _|dk �r|D ]\}}t�| ||� q�|�r|ng | _| jf |� |dk �rD| j||| ||| d� | j || �pX|�pX|i d�� dS )a�6 Constructor for :class:`_schema.Table`. :param name: The name of this table as represented in the database. The table name, along with the value of the ``schema`` parameter, forms a key which uniquely identifies this :class:`_schema.Table` within the owning :class:`_schema.MetaData` collection. Additional calls to :class:`_schema.Table` with the same name, metadata, and schema name will return the same :class:`_schema.Table` object. Names which contain no upper case characters will be treated as case insensitive names, and will not be quoted unless they are a reserved word or contain special characters. A name with any number of upper case characters is considered to be case sensitive, and will be sent as quoted. To enable unconditional quoting for the table name, specify the flag ``quote=True`` to the constructor, or use the :class:`.quoted_name` construct to specify the name. :param metadata: a :class:`_schema.MetaData` object which will contain this table. The metadata is used as a point of association of this table with other tables which are referenced via foreign key. It also may be used to associate this table with a particular :class:`.Connection` or :class:`.Engine`. :param \*args: Additional positional arguments are used primarily to add the list of :class:`_schema.Column` objects contained within this table. Similar to the style of a CREATE TABLE statement, other :class:`.SchemaItem` constructs may be added here, including :class:`.PrimaryKeyConstraint`, and :class:`_schema.ForeignKeyConstraint`. :param autoload_replace: Defaults to ``True``; when using :paramref:`_schema.Table.autoload_with` in conjunction with :paramref:`_schema.Table.extend_existing`, indicates that :class:`_schema.Column` objects present in the already-existing :class:`_schema.Table` object should be replaced with columns of the same name retrieved from the autoload process. When ``False``, columns already present under existing names will be omitted from the reflection process. Note that this setting does not impact :class:`_schema.Column` objects specified programmatically within the call to :class:`_schema.Table` that also is autoloading; those :class:`_schema.Column` objects will always replace existing columns of the same name when :paramref:`_schema.Table.extend_existing` is ``True``. .. seealso:: :paramref:`_schema.Table.autoload_with` :paramref:`_schema.Table.extend_existing` :param autoload_with: An :class:`_engine.Engine` or :class:`_engine.Connection` object, or a :class:`_reflection.Inspector` object as returned by :func:`_sa.inspect` against one, with which this :class:`_schema.Table` object will be reflected. When set to a non-None value, the autoload process will take place for this table against the given engine or connection. .. seealso:: :ref:`metadata_reflection_toplevel` :meth:`_events.DDLEvents.column_reflect` :ref:`metadata_reflection_dbagnostic_types` :param extend_existing: When ``True``, indicates that if this :class:`_schema.Table` is already present in the given :class:`_schema.MetaData`, apply further arguments within the constructor to the existing :class:`_schema.Table`. If :paramref:`_schema.Table.extend_existing` or :paramref:`_schema.Table.keep_existing` are not set, and the given name of the new :class:`_schema.Table` refers to a :class:`_schema.Table` that is already present in the target :class:`_schema.MetaData` collection, and this :class:`_schema.Table` specifies additional columns or other constructs or flags that modify the table's state, an error is raised. The purpose of these two mutually-exclusive flags is to specify what action should be taken when a :class:`_schema.Table` is specified that matches an existing :class:`_schema.Table`, yet specifies additional constructs. :paramref:`_schema.Table.extend_existing` will also work in conjunction with :paramref:`_schema.Table.autoload_with` to run a new reflection operation against the database, even if a :class:`_schema.Table` of the same name is already present in the target :class:`_schema.MetaData`; newly reflected :class:`_schema.Column` objects and other options will be added into the state of the :class:`_schema.Table`, potentially overwriting existing columns and options of the same name. As is always the case with :paramref:`_schema.Table.autoload_with`, :class:`_schema.Column` objects can be specified in the same :class:`_schema.Table` constructor, which will take precedence. Below, the existing table ``mytable`` will be augmented with :class:`_schema.Column` objects both reflected from the database, as well as the given :class:`_schema.Column` named "y":: Table("mytable", metadata, Column('y', Integer), extend_existing=True, autoload_with=engine ) .. seealso:: :paramref:`_schema.Table.autoload_with` :paramref:`_schema.Table.autoload_replace` :paramref:`_schema.Table.keep_existing` :param implicit_returning: True by default - indicates that RETURNING can be used, typically by the ORM, in order to fetch server-generated values such as primary key values and server side defaults, on those backends which support RETURNING. In modern SQLAlchemy there is generally no reason to alter this setting, except for some backend specific cases (see :ref:`mssql_triggers` in the SQL Server dialect documentation for one such example). :param include_columns: A list of strings indicating a subset of columns to be loaded via the ``autoload`` operation; table columns who aren't present in this list will not be represented on the resulting ``Table`` object. Defaults to ``None`` which indicates all columns should be reflected. :param resolve_fks: Whether or not to reflect :class:`_schema.Table` objects related to this one via :class:`_schema.ForeignKey` objects, when :paramref:`_schema.Table.autoload_with` is specified. Defaults to True. Set to False to disable reflection of related tables as :class:`_schema.ForeignKey` objects are encountered; may be used either to save on SQL calls or to avoid issues with related tables that can't be accessed. Note that if a related table is already present in the :class:`_schema.MetaData` collection, or becomes present later, a :class:`_schema.ForeignKey` object associated with this :class:`_schema.Table` will resolve to that table normally. .. versionadded:: 1.3 .. seealso:: :paramref:`.MetaData.reflect.resolve_fks` :param info: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. :param keep_existing: When ``True``, indicates that if this Table is already present in the given :class:`_schema.MetaData`, ignore further arguments within the constructor to the existing :class:`_schema.Table`, and return the :class:`_schema.Table` object as originally created. This is to allow a function that wishes to define a new :class:`_schema.Table` on first call, but on subsequent calls will return the same :class:`_schema.Table`, without any of the declarations (particularly constraints) being applied a second time. If :paramref:`_schema.Table.extend_existing` or :paramref:`_schema.Table.keep_existing` are not set, and the given name of the new :class:`_schema.Table` refers to a :class:`_schema.Table` that is already present in the target :class:`_schema.MetaData` collection, and this :class:`_schema.Table` specifies additional columns or other constructs or flags that modify the table's state, an error is raised. The purpose of these two mutually-exclusive flags is to specify what action should be taken when a :class:`_schema.Table` is specified that matches an existing :class:`_schema.Table`, yet specifies additional constructs. .. seealso:: :paramref:`_schema.Table.extend_existing` :param listeners: A list of tuples of the form ``(<eventname>, <fn>)`` which will be passed to :func:`.event.listen` upon construction. This alternate hook to :func:`.event.listen` allows the establishment of a listener function specific to this :class:`_schema.Table` before the "autoload" process begins. Historically this has been intended for use with the :meth:`.DDLEvents.column_reflect` event, however note that this event hook may now be associated with the :class:`_schema.MetaData` object directly:: def listen_for_reflect(table, column_info): "handle the column reflection event" # ... t = Table( 'sometable', autoload_with=engine, listeners=[ ('column_reflect', listen_for_reflect) ]) .. seealso:: :meth:`_events.DDLEvents.column_reflect` :param must_exist: When ``True``, indicates that this Table must already be present in the given :class:`_schema.MetaData` collection, else an exception is raised. :param prefixes: A list of strings to insert after CREATE in the CREATE TABLE statement. They will be separated by spaces. :param quote: Force quoting of this table's name on or off, corresponding to ``True`` or ``False``. When left at its default of ``None``, the column identifier will be quoted according to whether the name is case sensitive (identifiers with at least one upper case character are treated as case sensitive), or if it's a reserved word. This flag is only needed to force quoting of a reserved word which is not known by the SQLAlchemy dialect. .. note:: setting this flag to ``False`` will not provide case-insensitive behavior for table reflection; table reflection will always search for a mixed-case name in a case sensitive fashion. Case insensitive names are specified in SQLAlchemy only by stating the name with all lower case characters. :param quote_schema: same as 'quote' but applies to the schema identifier. :param schema: The schema name for this table, which is required if the table resides in a schema other than the default selected schema for the engine's database connection. Defaults to ``None``. If the owning :class:`_schema.MetaData` of this :class:`_schema.Table` specifies its own :paramref:`_schema.MetaData.schema` parameter, then that schema name will be applied to this :class:`_schema.Table` if the schema parameter here is set to ``None``. To set a blank schema name on a :class:`_schema.Table` that would otherwise use the schema set on the owning :class:`_schema.MetaData`, specify the special symbol :attr:`.BLANK_SCHEMA`. The quoting rules for the schema name are the same as those for the ``name`` parameter, in that quoting is applied for reserved words or case-sensitive names; to enable unconditional quoting for the schema name, specify the flag ``quote_schema=True`` to the constructor, or use the :class:`.quoted_name` construct to specify the name. :param comment: Optional string that will render an SQL comment on table creation. .. versionadded:: 1.2 Added the :paramref:`_schema.Table.comment` parameter to :class:`_schema.Table`. :param \**kw: Additional keyword arguments not mentioned above are dialect specific, and passed in the form ``<dialectname>_<argname>``. See the documentation regarding an individual dialect at :ref:`dialect_toplevel` for detail on documented arguments. NT)�_implicit_generated�%s.%s� _reflect_info)r� r� r� ��allow_replacements� all_names) �superr� r* r� rc r[ ro r_ �AssertionErrorr� �setr� r� r� r| r� �_extra_dependenciesrb �fullnamer� r� r� r� r0 �listen� _prefixes� _extra_kwargs� _autoloadr� )r rb r� rc r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r{ rm r� �evt�fn�� __class__r] r^ r� � sj D �� � ��zTable.__init__r] �Union[Engine, Connection]zCollection[str]z_ReflectionInfo | None)r� r� r� �exclude_columnsr� r� r� rd c C s8 t �|�}|�� � } | j| |||||d� W 5 Q R X d S )N�r� r� )r2 �inspect�_inspection_contextZ reflect_table) r r� r� r� r� r� r� r� �inspZ conn_inspr] r] r^ r� m s �zTable._autoloadzList[Constraint]c C s t | jdd� d�S )zTReturn the set of constraints as a list, sorted by creation order. c S s | j S rn )�_creation_order)rs r] r] r^ �<lambda>� � z+Table._sorted_constraints.<locals>.<lambda>�rr )�sortedr� r� r] r] r^ �_sorted_constraints� s zTable._sorted_constraintszSet[ForeignKeyConstraint]c C s dd� | j D �S )a� :class:`_schema.ForeignKeyConstraint` objects referred to by this :class:`_schema.Table`. This list is produced from the collection of :class:`_schema.ForeignKey` objects currently associated. .. seealso:: :attr:`_schema.Table.constraints` :attr:`_schema.Table.foreign_keys` :attr:`_schema.Table.indexes` c S s h | ]}|j d k r|j �qS rn )� constraint)�.0�fkcr] r] r^ � <setcomp>� s �z0Table.foreign_key_constraints.<locals>.<setcomp>)r� r� r] r] r^ �foreign_key_constraints� s �z Table.foreign_key_constraints)r{ �kwargsrd c O s� |� dd �}|� d|d k �}|� dd�}|� dd �}|� dd �}|� dd �}|� dd �} |� d d �} | slt�| rtt�|r�|| jkr�t�d | j� d |� d ���|� dd �} | d k r�| jD ]} | j| kr�| j�| � q�|� dd�} dD ]}||kr�t�d��q�|� d| j �| _ |� d| j �| _ |� d| j �| _ |�rf|�sHdd� | jD �}nd}| j | j || || ||d� dd� | jD �}| jf |� | j|d|d�� d S ) Nr� �autoloadr� Trc r� r� r� Fr� z,Can't change schema of existing table from 'z' to '�'r� r� )r� r� z2Can't redefine 'quote' or 'quote_schema' argumentsr� r� r� c S s g | ] }|j �qS r] �rb �r� rs r] r] r^ � <listcomp>� s z(Table._init_existing.<locals>.<listcomp>r] r� c S s i | ] }|j |�qS r] r� r� r] r] r^ � <dictcomp>� s z(Table._init_existing.<locals>.<dictcomp>r� )r� r� rc r1 r~ rs rb r� �remover� r� r� r� r� r� r� )r r{ r� r� r� r� rc r� r� r� r� r� rs r� rr r� r� r] r] r^ r� � s^ � � �� zTable._init_existing�r� rd c K s | � |� d S rn ��_validate_dialect_kwargs�r r� r] r] r^ r� � s zTable._extra_kwargsc C s d S rn r] r� r] r] r^ �_init_collections� s zTable._init_collectionsc C s d S rn r] r� r] r] r^ �_reset_exported� s zTable._reset_exported�Optional[Column[int]]c C s | j jS rn )r� �_autoincrement_columnr� r] r] r^ r � s zTable._autoincrement_columnr c C s� d}d}d}| j }|dk r$|f}d}| j}|rH||krH|dk sBt�d}n|dkrb|dk rb|f}d}tj}|�r�|d }|jr�|jjr�|r�t�d��q�|r�d}d}d}ntj }n�|j dkr�|j dkr�|j r�t�d|� d���tj }n�|j dk �rR|j jr�tj}nRt|j ��r@|j j�r8|�r&t�d��n|�r4d}d}d}tj}n|j j�r�tj}n.|j dk �r�|�rzt�d|d � d ���tj}|dk�r�| j�r�|dk�s�t�| jD ]*}|j dk �s�|j �r�|j j�s� �q�q�t| j�}tj}t||||�S ) a determine a candidate column (or columns, in case of a client generated composite primary key) which can be used as an "insert sentinel" for an INSERT statement. The returned structure, :class:`_SentinelColumnCharacterization`, includes all the details needed by :class:`.Dialect` and :class:`.SQLCompiler` to determine if these column(s) can be used as an INSERT..RETURNING sentinel for a particular database dialect. .. versionadded:: 2.0.10 FNTr zQCan't use IDENTITY default with negative increment as an explicit sentinel columnzColumn z� has been marked as a sentinel column with no default generation function; it at least needs to be marked nullable=False assuming user-populated sentinel values will be used.zQCan't use SEQUENCE default with negative increment as an explicit sentinel columnzn can't be a sentinel column because it uses an explicit server side default that's not the Identity() default.)r� r r� r! �UNKNOWN�identity�_increment_is_negativer1 r� ZIDENTITYrx �server_default�nullable�NONE� is_sentinelZSENTINEL_DEFAULT�default_is_sequenceZSEQUENCE� is_callableZ CLIENTSIDEZ SERVERSIDEr� �tupler ) r Zsentinel_is_explicitZsentinel_is_autoincZ the_sentinelZexplicit_sentinel_colZ autoinc_colZdefault_characterizationZthe_sentinel_zeroZ_pkcr] r] r^ � _sentinel_column_characteristics� s� ���� �� � �� � �� �� ��z&Table._sentinel_column_characteristicsc C s | j S )a� Returns the :class:`.Column` object which currently represents the "auto increment" column, if any, else returns None. This is based on the rules for :class:`.Column` as defined by the :paramref:`.Column.autoincrement` parameter, which generally means the column within a single integer column primary key constraint that is not constrained by a foreign key. If the table does not have such a primary key constraint, then there's no "autoincrement" column. A :class:`.Table` may have only one column defined as the "autoincrement" column. .. versionadded:: 2.0.4 .. seealso:: :paramref:`.Column.autoincrement` )r r� r] r] r^ �autoincrement_columnw s zTable.autoincrement_columnc C s t | j| j�S )a� Return the 'key' for this :class:`_schema.Table`. This value is used as the dictionary key within the :attr:`_schema.MetaData.tables` collection. It is typically the same as that of :attr:`_schema.Table.name` for a table with no :attr:`_schema.Table.schema` set; otherwise it is typically of the form ``schemaname.tablename``. )rf rb rc r� r] r] r^ rr � s z Table.keyc sD dd� t� j�gt� j�g dd� � jD � � fdd�dD � � S )Nz Table(%s)�, c S s g | ] }t |��qS r] ��repr�r� �xr] r] r^ r� � s z"Table.__repr__.<locals>.<listcomp>c s" g | ]}d |t t� |��f �qS �z%s=%s�r �getattr�r� �kr� r] r^ r� � s �rc )�joinr rb r� r� r� r] r� r^ r� � s ����zTable.__repr__c C s t | j| j�S rn )rf � descriptionrc r� r] r] r^ �__str__� s z Table.__str__�rq rd c C s | j �|� dS )a� Add a 'dependency' for this Table. This is another Table object which must be created first before this one can, or dropped after this one. Usually, dependencies between tables are determined via ForeignKey objects. However, for other situations that create dependencies outside of foreign keys (rules, inheriting), this method can manually establish such a link. N)r� �add�r rq r] r] r^ �add_is_dependent_on� s zTable.add_is_dependent_onzColumnClause[Any])�column�replace_existingrd c C sb z |j | |dd� | jD �d� W n< tjk r\ } z t�|jd � d��|�W 5 d}~X Y nX dS )a� Append a :class:`_schema.Column` to this :class:`_schema.Table`. The "key" of the newly added :class:`_schema.Column`, i.e. the value of its ``.key`` attribute, will then be available in the ``.c`` collection of this :class:`_schema.Table`, and the column definition will be included in any CREATE TABLE, SELECT, UPDATE, etc. statements generated from this :class:`_schema.Table` construct. Note that this does **not** change the definition of the table as it exists within any underlying database, assuming that table has already been created in the database. Relational databases support the addition of columns to existing tables using the SQL ALTER command, which would need to be emitted for an already-existing table that doesn't contain the newly added column. :param replace_existing: When ``True``, allows replacing existing columns. When ``False``, the default, an warning will be raised if a column with the same ``.key`` already exists. A future version of sqlalchemy will instead rise a warning. .. versionadded:: 1.4.0 c S s i | ] }|j |�qS r] r� r� r] r] r^ r� � s z'Table.append_column.<locals>.<dictcomp>r� r zV Specify replace_existing=True to Table.append_column() to replace an existing column.N)r| rs r1 �DuplicateColumnErrorr{ )r r# r$ �der] r] r^ � append_column� s � ��zTable.append_columnzUnion[Index, Constraint])r� rd c C s |� | � dS )a� Append a :class:`_schema.Constraint` to this :class:`_schema.Table`. This has the effect of the constraint being included in any future CREATE TABLE statement, assuming specific DDL creation events have not been associated with the given :class:`_schema.Constraint` object. Note that this does **not** produce the constraint within the relational database automatically, for a table that already exists in the database. To add a constraint to an existing relational database table, the SQL ALTER command must be used. SQLAlchemy also provides the :class:`.AddConstraint` construct which can produce this SQL when invoked as an executable clause. N�r| )r r� r] r] r^ �append_constraint� s zTable.append_constraintr% ��parentrm rd c K s. |}t |t�st�|�| j| j| � || _d S rn )ro r� r� r� rb rc r� )r r+ rm r� r] r] r^ � _set_parent� s zTable._set_parent�_CreateDropBind��bind� checkfirstrd c C s |j tj| |d� dS )z�Issue a ``CREATE`` statement for this :class:`_schema.Table`, using the given :class:`.Connection` or :class:`.Engine` for connectivity. .. seealso:: :meth:`_schema.MetaData.create_all`. �r0 N��_run_ddl_visitorr ZSchemaGenerator�r r/ r0 r] r] r^ �create� s z Table.createc C s |j tj| |d� dS )z�Issue a ``DROP`` statement for this :class:`_schema.Table`, using the given :class:`.Connection` or :class:`.Engine` for connectivity. .. seealso:: :meth:`_schema.MetaData.drop_all`. r1 N�r3 r Z SchemaDropperr4 r] r] r^ �drop s z Table.dropr� zP:meth:`_schema.Table.tometadata` is renamed to :meth:`_schema.Table.to_metadata`z.Union[str, Literal[SchemaConst.RETAIN_SCHEMA]]z^Optional[Callable[[Table, Optional[str], ForeignKeyConstraint, Optional[str]], Optional[str]]])r� rc �referred_schema_fnrb rd c C s | j ||||d�S )z�Return a copy of this :class:`_schema.Table` associated with a different :class:`_schema.MetaData`. See :meth:`_schema.Table.to_metadata` for a full description. )rc r8 rb )� to_metadata)r r� rc r8 rb r] r] r^ � tometadata s �zTable.tometadatac sx |dkr� j }|tkr � j}n|dkr.|j}n|}t||�}||jkrdt�d� j� d�� |j| S g }� jD ]}|� |j |d�� qnt ||f|�|� j d�� j ���� jD ]t} t| t�r�| j} |r�|� || | �} n| � jkr�|nd} ��| j | �d�� q�| js�| j�r q���| j |�d�� q�� jD ]D} | j�r8�q(t| j f� �fdd�| jD ��| j�d �| j �� �q(� ���S ) aq Return a copy of this :class:`_schema.Table` associated with a different :class:`_schema.MetaData`. E.g.:: m1 = MetaData() user = Table('user', m1, Column('id', Integer, primary_key=True)) m2 = MetaData() user_copy = user.to_metadata(m2) .. versionchanged:: 1.4 The :meth:`_schema.Table.to_metadata` function was renamed from :meth:`_schema.Table.tometadata`. :param metadata: Target :class:`_schema.MetaData` object, into which the new :class:`_schema.Table` object will be created. :param schema: optional string name indicating the target schema. Defaults to the special symbol :attr:`.RETAIN_SCHEMA` which indicates that no change to the schema name should be made in the new :class:`_schema.Table`. If set to a string name, the new :class:`_schema.Table` will have this new name as the ``.schema``. If set to ``None``, the schema will be set to that of the schema set on the target :class:`_schema.MetaData`, which is typically ``None`` as well, unless set explicitly:: m2 = MetaData(schema='newschema') # user_copy_one will have "newschema" as the schema name user_copy_one = user.to_metadata(m2, schema=None) m3 = MetaData() # schema defaults to None # user_copy_two will have None as the schema name user_copy_two = user.to_metadata(m3, schema=None) :param referred_schema_fn: optional callable which can be supplied in order to provide for the schema name that should be assigned to the referenced table of a :class:`_schema.ForeignKeyConstraint`. The callable accepts this parent :class:`_schema.Table`, the target schema that we are changing to, the :class:`_schema.ForeignKeyConstraint` object, and the existing "target schema" of that constraint. The function should return the string schema name that should be applied. To reset the schema to "none", return the symbol :data:`.BLANK_SCHEMA`. To effect no change, return ``None`` or :data:`.RETAIN_SCHEMA`. .. versionchanged:: 1.4.33 The ``referred_schema_fn`` function may return the :data:`.BLANK_SCHEMA` or :data:`.RETAIN_SCHEMA` symbols. E.g.:: def referred_schema_fn(table, to_schema, constraint, referred_schema): if referred_schema == 'base_tables': return referred_schema else: return to_schema new_table = table.to_metadata(m2, schema="alt_schema", referred_schema_fn=referred_schema_fn) :param name: optional string name indicating the target table name. If not specified or None, the table name is retained. This allows a :class:`_schema.Table` to be copied to the same :class:`_schema.MetaData` target with a new name. Nr� z9' already exists within the given MetaData - not copying.r )rc r� �rc rk c s g | ]}t |� ���qS r] )rv �r� �exprr! r] r^ r� � s �z%Table.to_metadata.<locals>.<listcomp>)�unique�_table)rb rZ rc rf r� r3 �warnr r� �append�_copyrS r� r� r� ro �ForeignKeyConstraint�_referred_schemar) � _type_bound� _column_flagr� �Index�_table_bound_expressionsr> r� ) r r� rc r8 rb Z actual_schemarr r{ �col�constZreferred_schemaZfk_constraint_schema�indexr] r! r^ r9 1 s� W � ���� ��� �� � � ���� zTable.to_metadata)r] TNN)F)F)F)/rW rX rY r� r� r r3 Zro_non_memoized_propertyr� r� r� r� r� rs r� �typingZdeprecated_paramsr� � classmethodr� r� r� �propertyr� r� r� r� r r r �ro_memoized_propertyr r rr r� r r" r' r) r, r5 r7 � deprecatedrZ r: r9 � __classcell__r] r] r� r^ rS ; s� �;�> � B �) �� �c s e Zd ZU dZdZdZded< ded< d_ddd ejejddddde j dd dddd dd d dd �d d dddddddddddddddddddddddd�� fdd �Z d ed < d ed < d!ed"< ded#< ded$< d%ed&< d'ed(< d)d*d+�d,d-�Z e jd.d/�d0d1��Ze jd.d/�d2d3��Zejdd/�d4d5��Zdd*d6�d7d8�Zdd/�d9d:�Zd;dd<�d=d>�Zd?d*d@�dAdB�Zdd/�dCdD�ZddEddd*dF�dGdH�ZdId*dJ�dKdL�ZdId*dJ�dMdN�Ze� dOdP�dd;dQ�dRdS��Z dd;dQ�dTdU�Z d;d*dV�dWdX�Z d`dYddddZdd[d\�d]d^�Z � Z!S )arp z(Represents a column in a database table.r# Tr_ rr zOptional[FetchedValue]r N�autoF)rb �type_� autoincrementrx �insert_default�docrr rK r> r� r �onupdater� r �server_onupdater� �systemr� �insert_sentinel�_omit_from_statements�_proxiesz@Optional[Union[str, _TypeEngineArgument[_T], SchemaEventTarget]]z;Optional[Union[_TypeEngineArgument[_T], SchemaEventTarget]]r% r` �!Optional[_TypeEngineArgument[_T]]r; r� r� �Optional[_InfoType]z<Optional[Union[bool, Literal[SchemaConst.NULL_UNSPECIFIED]]]r� z Optional[_ServerDefaultArgument]z!Optional[_ServerOnUpdateArgument]r )�_Column__name_pos�_Column__type_posr{ rb rS rT rx rU rV rr rK r> r� r rW r� r rX r� rY r� rZ r[ r\ �dialect_kwargsc s� ||gt |� }~|rXt|d t�rB|dk r6t�d��|�d�}n|d dkrX|�d� |r�|d }t|d�r�|dk r�t�d��|�d�}n|d dkr�|�d� |dk r�t||�}n|dk r�t�d��t� � ||� | dk r�| n|| _ || _ || _ || _ | | _} | tk �r| | _n| | _| | _| | _|| _|| _|| _t� | _t� | _|| _d| _d| _|dk �rp|| _ n | � | j � |t j k �r�|} n|t j k �r�|} nd} | dk �r�t| t!t"f��s�t!| �} | | _#|�$| � nd| _#|dk �rt|t!t"f��st!|dd�}|| _%|�$|� nd| _%|dk �rZt|t&��rH|�'d �}|�$|� nt(|�}|�$|� || _)|dk �r�t|t&��r�|�'d�}|�$|� nt(|dd�}|�$|� || _*| j+t,t-t. |�� t/�0| � | dk �r�| | _1| j2f |� dS ) a!b Construct a new ``Column`` object. :param name: The name of this column as represented in the database. This argument may be the first positional argument, or specified via keyword. Names which contain no upper case characters will be treated as case insensitive names, and will not be quoted unless they are a reserved word. Names with any number of upper case characters will be quoted and sent exactly. Note that this behavior applies even for databases which standardize upper case names as case insensitive such as Oracle. The name field may be omitted at construction time and applied later, at any time before the Column is associated with a :class:`_schema.Table`. This is to support convenient usage within the :mod:`~sqlalchemy.ext.declarative` extension. :param type\_: The column's type, indicated using an instance which subclasses :class:`~sqlalchemy.types.TypeEngine`. If no arguments are required for the type, the class of the type can be sent as well, e.g.:: # use a type with arguments Column('data', String(50)) # use no arguments Column('level', Integer) The ``type`` argument may be the second positional argument or specified by keyword. If the ``type`` is ``None`` or is omitted, it will first default to the special type :class:`.NullType`. If and when this :class:`_schema.Column` is made to refer to another column using :class:`_schema.ForeignKey` and/or :class:`_schema.ForeignKeyConstraint`, the type of the remote-referenced column will be copied to this column as well, at the moment that the foreign key is resolved against that remote :class:`_schema.Column` object. :param \*args: Additional positional arguments include various :class:`.SchemaItem` derived constructs which will be applied as options to the column. These include instances of :class:`.Constraint`, :class:`_schema.ForeignKey`, :class:`.ColumnDefault`, :class:`.Sequence`, :class:`.Computed` :class:`.Identity`. In some cases an equivalent keyword argument is available such as ``server_default``, ``default`` and ``unique``. :param autoincrement: Set up "auto increment" semantics for an **integer primary key column with no foreign key dependencies** (see later in this docstring for a more specific definition). This may influence the :term:`DDL` that will be emitted for this column during a table create, as well as how the column will be considered when INSERT statements are compiled and executed. The default value is the string ``"auto"``, which indicates that a single-column (i.e. non-composite) primary key that is of an INTEGER type with no other client-side or server-side default constructs indicated should receive auto increment semantics automatically. Other values include ``True`` (force this column to have auto-increment semantics for a :term:`composite primary key` as well), ``False`` (this column should never have auto-increment semantics), and the string ``"ignore_fk"`` (special-case for foreign key columns, see below). The term "auto increment semantics" refers both to the kind of DDL that will be emitted for the column within a CREATE TABLE statement, when methods such as :meth:`.MetaData.create_all` and :meth:`.Table.create` are invoked, as well as how the column will be considered when an INSERT statement is compiled and emitted to the database: * **DDL rendering** (i.e. :meth:`.MetaData.create_all`, :meth:`.Table.create`): When used on a :class:`.Column` that has no other default-generating construct associated with it (such as a :class:`.Sequence` or :class:`.Identity` construct), the parameter will imply that database-specific keywords such as PostgreSQL ``SERIAL``, MySQL ``AUTO_INCREMENT``, or ``IDENTITY`` on SQL Server should also be rendered. Not every database backend has an "implied" default generator available; for example the Oracle backend always needs an explicit construct such as :class:`.Identity` to be included with a :class:`.Column` in order for the DDL rendered to include auto-generating constructs to also be produced in the database. * **INSERT semantics** (i.e. when a :func:`_sql.insert` construct is compiled into a SQL string and is then executed on a database using :meth:`_engine.Connection.execute` or equivalent): A single-row INSERT statement will be known to produce a new integer primary key value automatically for this column, which will be accessible after the statement is invoked via the :attr:`.CursorResult.inserted_primary_key` attribute upon the :class:`_result.Result` object. This also applies towards use of the ORM when ORM-mapped objects are persisted to the database, indicating that a new integer primary key will be available to become part of the :term:`identity key` for that object. This behavior takes place regardless of what DDL constructs are associated with the :class:`_schema.Column` and is independent of the "DDL Rendering" behavior discussed in the previous note above. The parameter may be set to ``True`` to indicate that a column which is part of a composite (i.e. multi-column) primary key should have autoincrement semantics, though note that only one column within a primary key may have this setting. It can also be set to ``True`` to indicate autoincrement semantics on a column that has a client-side or server-side default configured, however note that not all dialects can accommodate all styles of default as an "autoincrement". It can also be set to ``False`` on a single-column primary key that has a datatype of INTEGER in order to disable auto increment semantics for that column. The setting *only* has an effect for columns which are: * Integer derived (i.e. INT, SMALLINT, BIGINT). * Part of the primary key * Not referring to another column via :class:`_schema.ForeignKey`, unless the value is specified as ``'ignore_fk'``:: # turn on autoincrement for this column despite # the ForeignKey() Column('id', ForeignKey('other.id'), primary_key=True, autoincrement='ignore_fk') It is typically not desirable to have "autoincrement" enabled on a column that refers to another via foreign key, as such a column is required to refer to a value that originates from elsewhere. The setting has these effects on columns that meet the above criteria: * DDL issued for the column, if the column does not already include a default generating construct supported by the backend such as :class:`.Identity`, will include database-specific keywords intended to signify this column as an "autoincrement" column for specific backends. Behavior for primary SQLAlchemy dialects includes: * AUTO INCREMENT on MySQL and MariaDB * SERIAL on PostgreSQL * IDENTITY on MS-SQL - this occurs even without the :class:`.Identity` construct as the :paramref:`.Column.autoincrement` parameter pre-dates this construct. * SQLite - SQLite integer primary key columns are implicitly "auto incrementing" and no additional keywords are rendered; to render the special SQLite keyword ``AUTOINCREMENT`` is not included as this is unnecessary and not recommended by the database vendor. See the section :ref:`sqlite_autoincrement` for more background. * Oracle - The Oracle dialect has no default "autoincrement" feature available at this time, instead the :class:`.Identity` construct is recommended to achieve this (the :class:`.Sequence` construct may also be used). * Third-party dialects - consult those dialects' documentation for details on their specific behaviors. * When a single-row :func:`_sql.insert` construct is compiled and executed, which does not set the :meth:`_sql.Insert.inline` modifier, newly generated primary key values for this column will be automatically retrieved upon statement execution using a method specific to the database driver in use: * MySQL, SQLite - calling upon ``cursor.lastrowid()`` (see `https://www.python.org/dev/peps/pep-0249/#lastrowid <https://www.python.org/dev/peps/pep-0249/#lastrowid>`_) * PostgreSQL, SQL Server, Oracle - use RETURNING or an equivalent construct when rendering an INSERT statement, and then retrieving the newly generated primary key values after execution * PostgreSQL, Oracle for :class:`_schema.Table` objects that set :paramref:`_schema.Table.implicit_returning` to False - for a :class:`.Sequence` only, the :class:`.Sequence` is invoked explicitly before the INSERT statement takes place so that the newly generated primary key value is available to the client * SQL Server for :class:`_schema.Table` objects that set :paramref:`_schema.Table.implicit_returning` to False - the ``SELECT scope_identity()`` construct is used after the INSERT statement is invoked to retrieve the newly generated primary key value. * Third-party dialects - consult those dialects' documentation for details on their specific behaviors. * For multiple-row :func:`_sql.insert` constructs invoked with a list of parameters (i.e. "executemany" semantics), primary-key retrieving behaviors are generally disabled, however there may be special APIs that may be used to retrieve lists of new primary key values for an "executemany", such as the psycopg2 "fast insertmany" feature. Such features are very new and may not yet be well covered in documentation. :param default: A scalar, Python callable, or :class:`_expression.ColumnElement` expression representing the *default value* for this column, which will be invoked upon insert if this column is otherwise not specified in the VALUES clause of the insert. This is a shortcut to using :class:`.ColumnDefault` as a positional argument; see that class for full detail on the structure of the argument. Contrast this argument to :paramref:`_schema.Column.server_default` which creates a default generator on the database side. .. seealso:: :ref:`metadata_defaults_toplevel` :param insert_default: An alias of :paramref:`.Column.default` for compatibility with :func:`_orm.mapped_column`. .. versionadded: 2.0.31 :param doc: optional String that can be used by the ORM or similar to document attributes on the Python side. This attribute does **not** render SQL comments; use the :paramref:`_schema.Column.comment` parameter for this purpose. :param key: An optional string identifier which will identify this ``Column`` object on the :class:`_schema.Table`. When a key is provided, this is the only identifier referencing the ``Column`` within the application, including ORM attribute mapping; the ``name`` field is used only when rendering SQL. :param index: When ``True``, indicates that a :class:`_schema.Index` construct will be automatically generated for this :class:`_schema.Column`, which will result in a "CREATE INDEX" statement being emitted for the :class:`_schema.Table` when the DDL create operation is invoked. Using this flag is equivalent to making use of the :class:`_schema.Index` construct explicitly at the level of the :class:`_schema.Table` construct itself:: Table( "some_table", metadata, Column("x", Integer), Index("ix_some_table_x", "x") ) To add the :paramref:`_schema.Index.unique` flag to the :class:`_schema.Index`, set both the :paramref:`_schema.Column.unique` and :paramref:`_schema.Column.index` flags to True simultaneously, which will have the effect of rendering the "CREATE UNIQUE INDEX" DDL instruction instead of "CREATE INDEX". The name of the index is generated using the :ref:`default naming convention <constraint_default_naming_convention>` which for the :class:`_schema.Index` construct is of the form ``ix_<tablename>_<columnname>``. As this flag is intended only as a convenience for the common case of adding a single-column, default configured index to a table definition, explicit use of the :class:`_schema.Index` construct should be preferred for most use cases, including composite indexes that encompass more than one column, indexes with SQL expressions or ordering, backend-specific index configuration options, and indexes that use a specific name. .. note:: the :attr:`_schema.Column.index` attribute on :class:`_schema.Column` **does not indicate** if this column is indexed or not, only if this flag was explicitly set here. To view indexes on a column, view the :attr:`_schema.Table.indexes` collection or use :meth:`_reflection.Inspector.get_indexes`. .. seealso:: :ref:`schema_indexes` :ref:`constraint_naming_conventions` :paramref:`_schema.Column.unique` :param info: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. :param nullable: When set to ``False``, will cause the "NOT NULL" phrase to be added when generating DDL for the column. When ``True``, will normally generate nothing (in SQL this defaults to "NULL"), except in some very specific backend-specific edge cases where "NULL" may render explicitly. Defaults to ``True`` unless :paramref:`_schema.Column.primary_key` is also ``True`` or the column specifies a :class:`_sql.Identity`, in which case it defaults to ``False``. This parameter is only used when issuing CREATE TABLE statements. .. note:: When the column specifies a :class:`_sql.Identity` this parameter is in general ignored by the DDL compiler. The PostgreSQL database allows nullable identity column by setting this parameter to ``True`` explicitly. :param onupdate: A scalar, Python callable, or :class:`~sqlalchemy.sql.expression.ClauseElement` representing a default value to be applied to the column within UPDATE statements, which will be invoked upon update if this column is not present in the SET clause of the update. This is a shortcut to using :class:`.ColumnDefault` as a positional argument with ``for_update=True``. .. seealso:: :ref:`metadata_defaults` - complete discussion of onupdate :param primary_key: If ``True``, marks this column as a primary key column. Multiple columns can have this flag set to specify composite primary keys. As an alternative, the primary key of a :class:`_schema.Table` can be specified via an explicit :class:`.PrimaryKeyConstraint` object. :param server_default: A :class:`.FetchedValue` instance, str, Unicode or :func:`~sqlalchemy.sql.expression.text` construct representing the DDL DEFAULT value for the column. String types will be emitted as-is, surrounded by single quotes:: Column('x', Text, server_default="val") x TEXT DEFAULT 'val' A :func:`~sqlalchemy.sql.expression.text` expression will be rendered as-is, without quotes:: Column('y', DateTime, server_default=text('NOW()')) y DATETIME DEFAULT NOW() Strings and text() will be converted into a :class:`.DefaultClause` object upon initialization. This parameter can also accept complex combinations of contextually valid SQLAlchemy expressions or constructs:: from sqlalchemy import create_engine from sqlalchemy import Table, Column, MetaData, ARRAY, Text from sqlalchemy.dialects.postgresql import array engine = create_engine( 'postgresql+psycopg2://scott:tiger@localhost/mydatabase' ) metadata_obj = MetaData() tbl = Table( "foo", metadata_obj, Column("bar", ARRAY(Text), server_default=array(["biz", "bang", "bash"]) ) ) metadata_obj.create_all(engine) The above results in a table created with the following SQL:: CREATE TABLE foo ( bar TEXT[] DEFAULT ARRAY['biz', 'bang', 'bash'] ) Use :class:`.FetchedValue` to indicate that an already-existing column will generate a default value on the database side which will be available to SQLAlchemy for post-fetch after inserts. This construct does not specify any DDL and the implementation is left to the database, such as via a trigger. .. seealso:: :ref:`server_defaults` - complete discussion of server side defaults :param server_onupdate: A :class:`.FetchedValue` instance representing a database-side default generation function, such as a trigger. This indicates to SQLAlchemy that a newly generated value will be available after updates. This construct does not actually implement any kind of generation function within the database, which instead must be specified separately. .. warning:: This directive **does not** currently produce MySQL's "ON UPDATE CURRENT_TIMESTAMP()" clause. See :ref:`mysql_timestamp_onupdate` for background on how to produce this clause. .. seealso:: :ref:`triggered_columns` :param quote: Force quoting of this column's name on or off, corresponding to ``True`` or ``False``. When left at its default of ``None``, the column identifier will be quoted according to whether the name is case sensitive (identifiers with at least one upper case character are treated as case sensitive), or if it's a reserved word. This flag is only needed to force quoting of a reserved word which is not known by the SQLAlchemy dialect. :param unique: When ``True``, and the :paramref:`_schema.Column.index` parameter is left at its default value of ``False``, indicates that a :class:`_schema.UniqueConstraint` construct will be automatically generated for this :class:`_schema.Column`, which will result in a "UNIQUE CONSTRAINT" clause referring to this column being included in the ``CREATE TABLE`` statement emitted, when the DDL create operation for the :class:`_schema.Table` object is invoked. When this flag is ``True`` while the :paramref:`_schema.Column.index` parameter is simultaneously set to ``True``, the effect instead is that a :class:`_schema.Index` construct which includes the :paramref:`_schema.Index.unique` parameter set to ``True`` is generated. See the documentation for :paramref:`_schema.Column.index` for additional detail. Using this flag is equivalent to making use of the :class:`_schema.UniqueConstraint` construct explicitly at the level of the :class:`_schema.Table` construct itself:: Table( "some_table", metadata, Column("x", Integer), UniqueConstraint("x") ) The :paramref:`_schema.UniqueConstraint.name` parameter of the unique constraint object is left at its default value of ``None``; in the absence of a :ref:`naming convention <constraint_naming_conventions>` for the enclosing :class:`_schema.MetaData`, the UNIQUE CONSTRAINT construct will be emitted as unnamed, which typically invokes a database-specific naming convention to take place. As this flag is intended only as a convenience for the common case of adding a single-column, default configured unique constraint to a table definition, explicit use of the :class:`_schema.UniqueConstraint` construct should be preferred for most use cases, including composite constraints that encompass more than one column, backend-specific index configuration options, and constraints that use a specific name. .. note:: the :attr:`_schema.Column.unique` attribute on :class:`_schema.Column` **does not indicate** if this column has a unique constraint or not, only if this flag was explicitly set here. To view indexes and unique constraints that may involve this column, view the :attr:`_schema.Table.indexes` and/or :attr:`_schema.Table.constraints` collections or use :meth:`_reflection.Inspector.get_indexes` and/or :meth:`_reflection.Inspector.get_unique_constraints` .. seealso:: :ref:`schema_unique_constraint` :ref:`constraint_naming_conventions` :paramref:`_schema.Column.index` :param system: When ``True``, indicates this is a "system" column, that is a column which is automatically made available by the database, and should not be included in the columns list for a ``CREATE TABLE`` statement. For more elaborate scenarios where columns should be conditionally rendered differently on different backends, consider custom compilation rules for :class:`.CreateColumn`. :param comment: Optional string that will render an SQL comment on table creation. .. versionadded:: 1.2 Added the :paramref:`_schema.Column.comment` parameter to :class:`_schema.Column`. :param insert_sentinel: Marks this :class:`_schema.Column` as an :term:`insert sentinel` used for optimizing the performance of the :term:`insertmanyvalues` feature for tables that don't otherwise have qualifying primary key configurations. .. versionadded:: 2.0.10 .. seealso:: :func:`_schema.insert_sentinel` - all in one helper for declaring sentinel columns :ref:`engine_insertmanyvalues` :ref:`engine_insertmanyvalues_sentinel_columns` r Nz0May not pass name positionally and as a keyword.Z _sqla_typez1May not pass type_ positionally and as a keyword.z9Explicit 'name' is required when sending 'quote' argumentT�� for_updateF)3�listro r_ r1 r~ r� �hasattrr* r� r� rr r� �_insert_sentinelr[ �_user_defined_nullabler\ r rK r> rY rV rT r� r� r� r� �computedr r\ � _set_type�typer �NO_ARG� ColumnDefaultr rx rA rW rT �_as_for_update� DefaultClauser rX r� r �_typing_SequencerQ r3 �set_creation_orderr� r� ) r r_ r` rb rS rT rx rU rV rr rK r> r� r rW r� r rX r� rY r� rZ r[ r\ r{ ra Zl_argsZcoltypeZudnZresolved_defaultr� r] r^ r� � s� � � � � zColumn.__init__rS rq r� r� r� r� rK r> zOptional[Computed]rh zOptional[Identity]r zTypeEngine[Any]ry )rS rd c C s^ | j js|| j kst�|| _ t| j t�r4| j �| � | j j�� D ]}t|t�r@|�| � q@d S rn )rj �_isnullr� ro r% r| �_variant_mapping�values)r rS �implr] r] r^ ri � s zColumn._set_typer r� c C s t �| j�S �z1used by default.py -> _process_execute_defaults())r �_from_column_defaultrx r� r] r] r^ �_default_description_tuple� s z!Column._default_description_tuplec C s t �| j�S ru )r rv rW r� r] r] r^ �_onupdate_description_tuple� s z"Column._onupdate_description_tuplec C s | j dk o| j jS )z�special attribute used by cache key gen, if true, we will use a static cache key for the annotations dictionary, else we will generate a new cache key for annotations each time. Added for #8790 N)rq Z _is_tabler� r] r] r^ �!_gen_static_annotations_cache_key� s z(Column._gen_static_annotations_cache_keyr� c K s | � |� d S rn r� r r] r] r^ r� � s zColumn._extra_kwargsc C sD | j d krdS | jd k r:| jjr2| jjd | j S | jS n| jS d S )Nz (no name)re )rb rq Znamed_with_columnr r� r] r] r^ r � s zColumn.__str__� Column[Any]�r# rd c C s& | j D ]}|jj�|j�r dS qdS )zOReturn True if this Column references the given column via foreign key.TFN)r� r# Z proxy_set� intersection�r r# �fkr] r] r^ � references� s zColumn.references� ForeignKey�r~ rd c C s |� | � d S rn r( )r r~ r] r] r^ �append_foreign_key� s zColumn.append_foreign_keyc s� g }� j � jkr|�d� � jr*|�d� � js:|�d� � jrJ|�d� � jrZ|�d� � jrj|�d� � jrz|�d� dd � t � j�gt � j �g d d � � j D � d d � � j D � � jd k r�d � jj p�dg � fdd �|D � � S )Nrr r� r rW rx r r� z Column(%s)r c S s g | ]}|d k rt |��qS rn r r r] r] r^ r� � s z#Column.__repr__.<locals>.<listcomp>c S s g | ] }t |��qS r] r r r] r] r^ r� � s z table=<%s>z table=Nonec s" g | ]}d |t t� |��f �qS r r r r� r] r^ r� � s )rr rb rA r� r rW rx r r� r r rj r� r� rq r )r �kwargr] r� r^ r� � s@ ��� ��� ��zColumn.__repr__zDict[str, Column[Any]])r+ r� r� rm rd c s� |� t � t�st�| js"t�d��| �� | jd kr<| j| _t| dd �}|d k rt|� k rtt�d| j� d|j � d���d }d }d}| j� j kr�� j | j }| j| jkr�d}q�d}n | j|kr�|| j }|h}d}|d k �rP|| k �rP|�st� d |� d |dk�r| jn| j� d � j� d ���|j D ].} � j � | � | j� jk�r � j� | j� �q |�r�|d k �r�| j| jk�r�t�d |j� d| j� d|j� d�� � j j| |d� | || j< � | _| j�r�| jjd k �r�t�d��| | j_| j�r� j�| � n*| j� jk�rt�d| j� d� j� d���| j�rZt | jt��r:t�d��� �t d | jt | j �dd�� n4| j �r�t | j t��rzt�d��� �t | jdd�� | � � fdd�� | j!�r�t | j"t#��s�t | j$t#��r�t�d ��d S ) NzfColumn must be constructed with a non-blank name or assign a non-blank .name before adding to a Table.rq zColumn object 'z ' already assigned to Table 'r� � rb rr zA column with z 'z ' is already present in table '�'.z Column with user-specified key "z-" is being replaced with plain named column "z", key "zs" is being removed. If this is a reflection operation, specify autoload_replace=False to prevent this replacement.)� extra_removez2a Table may have only one explicit sentinel columnz'Trying to redefine primary-key column 'z(' as a non-primary-key column on table 'z�The 'index' keyword argument on Column is boolean only. To create indexes with a specific name, create an explicit Index object external to the Table.T)r> rF z�The 'unique' keyword argument on Column is boolean only. To create unique constraints or indexes with a specific name, append an explicit UniqueConstraint to the Table's list of elements, or create an explicit Index object external to the Table.)rF c s | � � �S rn )�_set_remote_table�r~ �rq r] r^ r� o r� z$Column._set_parent.<locals>.<lambda>z4An column cannot specify both Identity and Sequence.)%ro rS r� rb r1 r~ Z_reset_memoizationsrr r r r� r% r� r� r� r� r3 r@ ru rq rf r� r� �_replacer� rK r_ r) rG r� r> �UniqueConstraint�_setup_on_memoized_fksr rx r rW ) r r+ r� r� rm �existingr� Z existing_colZ conflicts_onr~ r] r� r^ r, � s� � � �� � ��� ��� � � ��zColumn._set_parent�Callable[..., Any]�r� rd c C sj | j j| jfdf| j j| jfdfg}|D ]<\}}|| j jjkr(| j jj| D ]}|j|krL||� qLq(d S )NFT)rq rr rb r� � _fk_memos� link_to_name)r r� Zfk_keys�fk_keyr� r~ r] r] r^ r� y s � z Column._setup_on_memoized_fksc C s* | j d k r|| | j � nt�| d|� d S )Nr� )rq r0 r� )r r� r] r] r^ �_on_table_attach� s zColumn._on_table_attachr� z]The :meth:`_schema.Column.copy` method is deprecated and will be removed in a future release.�rm rd c K s | j f |�S rn �rB �r rm r] r] r^ r� � s z Column.copyc s � fdd�| j D �� fdd�| jD � }i }| jD ]2}| j| j}|�� D ]\}}|||d | < qJq2| j}| j} t|tt f�r�|� |j f � �� d }} | j } t| t �r�| jf � �} | j|| j| | j| j| j| j| j| j| j|| j| | j| j| j| j d�|��} | j | _ | j | _ | � | �S )z�Create a copy of this ``Column``, uninitialized. This is used in :meth:`_schema.Table.to_metadata` and by the ORM. c s g | ]}|j s|jf � ��qS r] )rE rB r� �rm r] r^ r� � s z Column._copy.<locals>.<listcomp>c s g | ]}|j s|jf � ��qS r] )r� rB r� r� r] r^ r� � s �_N)rb rS rr r� r> rY rK rT rx r rW rX rV r� r[ rZ ) r� r� �dialect_options� _non_defaults�itemsr rX ro �Computed�IdentityrA rB rj r% r� � _constructorrb rr r� r> rY rK rT rx rW rV r� r[ rf r rg r� ) r rm r{ Z column_kwargs� dialect_namer� �dialect_option_key�dialect_option_valuer rX rS rs r] r� r^ rB � s\ �� �� ���z Column._copy)�otherrd c C sZ | j r d|_ | jdkr(|jdkr(| j|_| jr6| j|_| jrJ|j�| j� | j}|js�|jjr�t|t�rp|� � }||_t|t�r�|� |� |j � � D ]}t|t�r�|� |� q�| j tk r�|j tkr�| j|_| j |_ | jdk r�|jdkr�| j�� }|�|� | j�r:|jdk�r:| j}t|t��r4|�� }|�|� n||_| j�rf|jdk�rf| j}|�� }|�|� | j�r�|jdk�r�| j�� }|�|� | jdk�r�|jdk�r�| j|_| jdk�r�|jdk�r�| j|_| j�r�|jdk�r�| j|_| j�r|jdk�r| j|_| jD ] }|j �s |�� } | �|� �q | j D ] } | j �s4| �� } | �|� �q4dS )z�merge the elements of another column into this one. this is used by ORM pep-593 merge and will likely need a lot of fixes. TrR N)TF) r� rT rY r� �updaterj rq ro r% r� r| rr rs rg r\ r rx rB r, r rT rX rW rK r> rV r� r� rE r� r� ) r r� rS rt Z new_defaultZnew_server_defaultZnew_server_onupdateZ new_onupdaterJ Z new_constr~ Znew_fkr] r] r^ �_merge� sp �� z Column._mergerM z.Optional[_typing_Sequence[ColumnElement[Any]]]z Tuple[str, ColumnClause[_T]])� selectablerb rr �name_is_truncatable�compound_select_colsrm rd c K s. dd� dd� | j D �D �}|dkr6| jdkr6t�d��zj| j|rXt�tj|rP|n| j�n|p`| j| j f|�|rr|n |rz|n| j | j | j |r�t |�n| gd��}W n2 tk r� } ztd| j �| �W 5 d} ~ X Y nX ||_|j|_|jdk r�|jj�|j �|_| j �r|j �|� |�r$|j �|� |j |fS )a$ Create a *proxy* for this column. This is a copy of this ``Column`` referenced by a different parent (such as an alias or select statement). The column should be used only in select scenarios, as its full DDL/default information is not transferred. c S s2 g | ]*\}}t |d k r|n|j|d k|jd��qS )N)� _unresolvable� _constraint)r� �_colspecr� )r� �frI r] r] r^ r� ? s ��z&Column._make_proxy.<locals>.<listcomp>c S s g | ]}||j d d�f�qS )F��raiseerr��_resolve_column)r� r~ r] r] r^ r� E s �Nz^Cannot initialize a sub-selectable with this Column object until its 'name' has been assigned.)rr r� r r\ z�Could not create a copy of this %r object. Ensure the class includes a _constructor() attribute or method which accepts the standard Column constructor arguments, or references the Column class itself.)r� rb r1 r� r� r �expectr ZTruncatedLabelRolerj rr r� r rd r� r� rq Z_propagate_attrsZ _is_clone_ofr� r� r r� ) r r� rb rr r� r� rm r~ rs r� r] r] r^ � _make_proxy+ sZ �� �� ��� � � ��� zColumn._make_proxy)NN)NNFN)"rW rX rY r� r� Z inherit_cacher� r rk rU r\ r� ri r4 Zmemoized_attributerw rx r3 r� ry r� r r r� r� r, r� r� rP r� rB r� r� rQ r] r] r� r^ rp � s� � �F } �DX �rp T)rx �omit_from_statementsr] r� r� rz )rb rS rx r� rd c C s. t | |dkrtjn||dk r |nt� |dd�S )a� Provides a surrogate :class:`_schema.Column` that will act as a dedicated insert :term:`sentinel` column, allowing efficient bulk inserts with deterministic RETURNING sorting for tables that don't otherwise have qualifying primary key configurations. Adding this column to a :class:`.Table` object requires that a corresponding database table actually has this column present, so if adding it to an existing model, existing database tables would need to be migrated (e.g. using ALTER TABLE or similar) to include this column. For background on how this object is used, see the section :ref:`engine_insertmanyvalues_sentinel_columns` as part of the section :ref:`engine_insertmanyvalues`. The :class:`_schema.Column` returned will be a nullable integer column by default and make use of a sentinel-specific default generator used only in "insertmanyvalues" operations. .. seealso:: :func:`_orm.orm_insert_sentinel` :paramref:`_schema.Column.insert_sentinel` :ref:`engine_insertmanyvalues` :ref:`engine_insertmanyvalues_sentinel_columns` .. versionadded:: 2.0.10 NT)rb rS rx r[ rZ )rp r � INTEGERTYPE� _InsertSentinelColumnDefault)rb rS rx r� r] r] r^ rZ z s '�rZ c @ s� e Zd ZU dZdZded< ded< dTd d d d d d dd d d dd d dd�dd�Zdd�dd�Ze� dd�dd�d dd d�d d ��Z dd�d dd d�d d �Z dUd d d dd!�d"d#�Z e d d�d$d%��Zdd�d&d'�Ze e �Zd(d d)�d*d+�Zd,dd)�d-d.�Zejd/d�d0d1��Zd2d�d3d4�Zd(d(d dd5�d6d7�Zdd8d9�d:d;�Zejdd�d<d=��Zed>d?�d@ddA�dBdC��Zed>d?�d ddA�dDdC��ZdEd?�d ddA�dFdC�ZdGdd8dH�dIdJ�Z d(d8d)�dKdL�Z dMd8dN�dOdP�Z dd(d8dQ�dRdS�Z dS )Vr� a; Defines a dependency between two columns. ``ForeignKey`` is specified as an argument to a :class:`_schema.Column` object, e.g.:: t = Table("remote_table", metadata, Column("remote_id", ForeignKey("main_table.id")) ) Note that ``ForeignKey`` is only a marker object that defines a dependency between two columns. The actual constraint is in all cases represented by the :class:`_schema.ForeignKeyConstraint` object. This object will be generated automatically when a ``ForeignKey`` is associated with a :class:`_schema.Column` which in turn is associated with a :class:`_schema.Table`. Conversely, when :class:`_schema.ForeignKeyConstraint` is applied to a :class:`_schema.Table`, ``ForeignKey`` markers are automatically generated to be present on each associated :class:`_schema.Column`, which are also associated with the constraint object. Note that you cannot define a "composite" foreign key constraint, that is a constraint between a grouping of multiple parent/child columns, using ``ForeignKey`` objects. To define this grouping, the :class:`_schema.ForeignKeyConstraint` object must be used, and applied to the :class:`_schema.Table`. The associated ``ForeignKey`` objects are created automatically. The ``ForeignKey`` objects associated with an individual :class:`_schema.Column` object are available in the `foreign_keys` collection of that column. Further examples of foreign key configuration are in :ref:`metadata_foreignkeys`. Z foreign_keyrz r+ r� � _table_columnNFr< z Optional[ForeignKeyConstraint]r� �_ConstraintNameArgumentr` r� r^ r )r# r� � use_alterrb rW �ondelete� deferrable� initiallyr� �matchr� r� r� � dialect_kwc K s� t �tj|�| _| | _t| jt�r*d| _n0| j| _t| jj t d�t f�sZt � d| jj ��|| _d| _|| _|| _|| _|| _|| _|| _| | _| | _| | _| r�| | _|| _dS )a� Construct a column-level FOREIGN KEY. The :class:`_schema.ForeignKey` object when constructed generates a :class:`_schema.ForeignKeyConstraint` which is associated with the parent :class:`_schema.Table` object's collection of constraints. :param column: A single target column for the key relationship. A :class:`_schema.Column` object or a column name as a string: ``tablename.columnkey`` or ``schema.tablename.columnkey``. ``columnkey`` is the ``key`` which has been assigned to the column (defaults to the column name itself), unless ``link_to_name`` is ``True`` in which case the rendered name of the column is used. :param name: Optional string. An in-database name for the key if `constraint` is not provided. :param onupdate: Optional string. If set, emit ON UPDATE <value> when issuing DDL for this constraint. Typical values include CASCADE, DELETE and RESTRICT. :param ondelete: Optional string. If set, emit ON DELETE <value> when issuing DDL for this constraint. Typical values include CASCADE, DELETE and RESTRICT. :param deferrable: Optional bool. If set, emit DEFERRABLE or NOT DEFERRABLE when issuing DDL for this constraint. :param initially: Optional string. If set, emit INITIALLY <value> when issuing DDL for this constraint. :param link_to_name: if True, the string name given in ``column`` is the rendered name of the referenced column, not its locally assigned ``key``. :param use_alter: passed to the underlying :class:`_schema.ForeignKeyConstraint` to indicate the constraint should be generated/dropped externally from the CREATE TABLE/ DROP TABLE statement. See :paramref:`_schema.ForeignKeyConstraint.use_alter` for further description. .. seealso:: :paramref:`_schema.ForeignKeyConstraint.use_alter` :ref:`use_alter` :param match: Optional string. If set, emit MATCH <value> when issuing DDL for this constraint. Typical values include SIMPLE, PARTIAL and FULL. :param info: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. :param comment: Optional string that will render an SQL comment on foreign key constraint creation. .. versionadded:: 2.0 :param \**dialect_kw: Additional keyword arguments are dialect specific, and passed in the form ``<dialectname>_<argname>``. The arguments are ultimately handled by a corresponding :class:`_schema.ForeignKeyConstraint`. See the documentation regarding an individual dialect at :ref:`dialect_toplevel` for detail on documented arguments. Nz8ForeignKey received Column not bound to a Table, got: %r)r r� r ZDDLReferredColumnRoler� r� ro r_ r� rq rj r, r1 r~ r� r+ r� rb rW r� r� r� r� r� r� r� �_unvalidated_dialect_kw)r r# r� r� rb rW r� r� r� r� r� r� r� r� r� r] r] r^ r� � s8 X ��� zForeignKey.__init__r_ r� c C s d| � � S )NzForeignKey(%r))� _get_colspecr� r] r] r^ r� Y s zForeignKey.__repr__r� zaThe :meth:`_schema.ForeignKey.copy` method is deprecated and will be removed in a future release.r )rc rm rd c K s | j f d|i|��S )Nrc r� )r rc rm r] r] r^ r� \ s zForeignKey.copyc K sJ t | j|d�f| j| j| j| j| j| j| j| j | j d� | j ��}| � |�S )a Produce a copy of this :class:`_schema.ForeignKey` object. The new :class:`_schema.ForeignKey` will not be bound to any :class:`_schema.Column`. This method is usually used by the internal copy procedures of :class:`_schema.Column`, :class:`_schema.Table`, and :class:`_schema.MetaData`. :param schema: The returned :class:`_schema.ForeignKey` will reference the original table and column name, qualified by the given string schema name. r ) r� rb rW r� r� r� r� r� r� ) r� r� r� rb rW r� r� r� r� r� r� r� r� )r rc rm r~ r] r] r^ rB d s �� � zForeignKey._copyzROptional[Union[str, Literal[SchemaConst.RETAIN_SCHEMA, SchemaConst.BLANK_SCHEMA]]])rc � table_name�_is_copyrd c C s� |dt fkrH| j\}}}|dk r$|}|tkr8d||f S d|||f S n�|rx| j\}}}|rjd|||f S d||f S nb| jdk r�| jjdkr�|r�t�d| j����n| jjS d| jjj| jjf S t | j t �s�t �| j S dS )z�Return a string based 'column specification' for this :class:`_schema.ForeignKey`. This is usually the equivalent of the string-based "tablename.colname" argument first passed to the object's constructor. Nr� z%s.%s.%szDCan't copy ForeignKey object which refers to non-table bound Column ) rZ �_column_tokensr[ r� rq r1 r� rr r� ro r� r_ r� )r rc r� r� Z_schema�tname�colnamer] r] r^ r� � s2 ��zForeignKey._get_colspecc C s | j d S �Nr )r� r� r] r] r^ rD � s zForeignKey._referred_schemac C s@ | j d k r&| j jd krd S | j jjS n| j\}}}t||�S d S rn )r� rq rr r� rf )r rc r� r� r] r] r^ � _table_key� s zForeignKey._table_keyrS r c C s |� | j�dk S )zrReturn True if the given :class:`_schema.Table` is referenced by this :class:`_schema.ForeignKey`.N)�corresponding_columnr# r! r] r] r^ r � s zForeignKey.referencesrM c C s |j �| j�S )a- Return the :class:`_schema.Column` in the given :class:`_schema.Table` (or any :class:`.FromClause`) referenced by this :class:`_schema.ForeignKey`. Returns None if this :class:`_schema.ForeignKey` does not reference the given :class:`_schema.Table`. )r� r� r# r! r] r] r^ � get_referent� s zForeignKey.get_referentz(Tuple[Optional[str], str, Optional[str]]c C sx | � � �d�}|dkr(t�d| j� ���t|�dkrB|�� }d}n|�� }|�� }t|�dkrjd�|�}nd}|||fS )z7parse a string-based _colspec into its component parts.re Nz*Invalid foreign key column specification: r r )r� �splitr1 r~ r� �lenr� r )r �mr� r� rc r] r] r^ r� � s � zForeignKey._column_tokensz Tuple[Table, str, Optional[str]]c C s� | j d krt�d��n| j jd kr,t�d��| j j}| jrZ| j\}}}t||�}|||fS | j jD ] }t|t �rb|j|ks~t � q�qbds�t �| j\}}}|d kr�|j j d k r�|j j }t||�}|||fS )NzLthis ForeignKey object does not yet have a parent Column associated with it.zCthis ForeignKey's parent column is not yet associated with a Table.F) r+ r1 r� rq r� r� rf Z base_columnsro rp r� r� rc )r � parenttablerc r� r� �tablekeyrs r] r] r^ �_resolve_col_tokens� s. � � z ForeignKey._resolve_col_tokens)r� rq r� rd c C s� d }|d kr4| j }|d k s t�|j}|j�|d �}n8| jrZ|}|jD ]}|j|krD|}qDn|}|j�|d �}|d kr�t�d| j � d|j� d|j� d|� d� |j|��|S )Nz3Could not initialize target column for ForeignKey 'z ' on table 'z ': table 'z' has no column named 'r� ) r+ r� rr rs r� r� rb r1 �NoReferencedColumnErrorr� )r r� rq r� �_columnr+ rr rs r] r] r^ �_link_to_col_by_colstring s( "� z$ForeignKey._link_to_col_by_colstringry r{ c sL | j d k st�| j jjr"� j| j _ddd�� fdd� }| j �|� � | _d S )Nr� ry r� c s | j jjr� j| j _d S rn )r+ rj rq r� �r# r] r^ �set_typeN s z/ForeignKey._set_target_column.<locals>.set_type)r+ r� rj rq r� r# )r r# r� r] r� r^ �_set_target_columnD s z ForeignKey._set_target_columnc C s | � � S )z�Return the target :class:`_schema.Column` referenced by this :class:`_schema.ForeignKey`. If no target column has been established, an exception is raised. r� r� r] r] r^ r# V s zForeignKey.column.r� z Literal[True])r� rd c C s d S rn r] �r r� r] r] r^ r� b s zForeignKey._resolve_columnc C s d S rn r] r� r] r] r^ r� g s Tc C s� t | jt�r�| �� \}}}| js*||jkrV|s2d S t�d| j� d|� d|� d�|��q�|j |jkr~|sjd S t� d|� d���q�|jj | }| � |||�S n$t | jd�r�| j�� }|S | j}|S d S )Nz$Foreign key associated with column 'z' could not find table 'z9' with which to generate a foreign key to target column 'r� zTable z1 is no longer associated with its parent MetaData�__clause_element__)ro r� r_ r� r� r� r1 ZNoReferencedTableErrorr+ rr r� r� r� re r� )r r� r� r� r� rq r� r] r] r^ r� l s4 � � � r% r* c K sR t |t�st�| jd k r,| j|k r,t�d��|| _| jj�| � | j�| j � d S )Nz&This ForeignKey already has a parent !) ro rp r� r+ r1 r� r� r r� � _set_table�r r+ rm r] r] r^ r, � s �zForeignKey._set_parentc C sD | � � \}}}| �|||�}| �|� | jd k s4t�| j�|� d S rn )r� r� r� r� r� �_validate_dest_table)r rq r� r� r� r� r] r] r^ r� � s z ForeignKey._set_remote_tabler� �r� rd c C s8 | � � \}}}||f}| |j| kr4|j| �| � d S rn )r� r� r� )r r� r� � table_keyr� r� r] r] r^ �_remove_from_metadata� s z ForeignKey._remove_from_metadata�r# rq rd c C s0 t |t�st�| jd krjtg g f| j| j| j| j| j | j | j | j d�| j ��| _| j�|| � | j�|� |j�| � t | jt�r�| �� \}}}||f}||jjkr�|jj| }z| �|||�}W n tjk r� Y n X | �|� |jj| � | � n4t | jd��r | j� � }| �|� n| j}| �|� d S )N)r� rb rW r� r� r� r� r� r� ) ro rS r� r� rC r� rb rW r� r� r� r� r� r� �_append_elementr| r� r r� r_ r� r� r� r� r1 r� r� r� rA re r� )r r# rq r� r� r� r� r� r] r] r^ r� � sP �� � � zForeignKey._set_table) NFNNNNNFNNNF)NNF) rW rX rY r� r� r� r� r� r3 rP r� rB r� rN rD r� Ztarget_fullnamer r� r� r� r� r� r� rO r# r r� r, r� r� r� r] r] r] r^ r� � sj ' �*�% �1 ($ ���& r� zOptional[DefaultGenerator]zTypeGuard[Sequence])�objrd c C s d S rn r] �r� r] r] r^ r � s r z%TypeGuard[ColumnElementColumnDefault]c C s d S rn r] r� r] r] r^ �default_is_clause_element� s r� z%TypeGuard[ScalarElementColumnDefault]c C s d S rn r] r� r] r] r^ �default_is_scalar� s r� � is_sequence�is_clause_element� is_scalarc @ s� e Zd ZU dZdZdZdZdZdZdZ dZ dZ dZ dZ ded< d ddd �d d �Zd d dd�dd�Zd d�dd�Zdddd d�dd�Zdddd d�dd�Zd S ) �DefaultGeneratorz�Base class for column *default* values. This object is only present on column.default or column.onupdate. It's not valid as a server default. Zdefault_generatorTFr� r# r� ry �rc rd c C s || _ d S rn rb �r rc r] r] r^ r� s zDefaultGenerator.__init__r% r r* c K s4 t rt|t�st�|| _| jr(| | j_n| | j_d S rn )r ro rp r� r# rc rW rx r� r] r] r^ r, s z DefaultGenerator._set_parentr� c C s t � �d S rn ��NotImplementedErrorr� r] r] r^ rB s zDefaultGenerator._copyrF rH rI )� connection�distilled_params�execution_optionsrd c C s t �dd� | �|||�S )NzoUsing the .execute() method to invoke a DefaultGenerator object is deprecated; please use the .scalar() method.z2.0)r3 Zwarn_deprecated�_execute_on_scalar�r r� r� r� r] r] r^ �_execute_on_connection s � �z'DefaultGenerator._execute_on_connectionc C s |� | ||�S rn )Z_execute_defaultr� r] r] r^ r� % s �z#DefaultGenerator._execute_on_scalarN)F)rW rX rY r� r� Z_is_default_generatorr� � is_identity�is_server_defaultr� r r� �has_argr r� r� r, rB r� r� r] r] r] r^ r� � s" r� c @ s� e Zd ZU dZded< eddddd�d d ��Zedd dd d�d d ��Zedddd d�dd ��Zdddd d�dd �Zdd�dd�ZdS )rl a� A plain default value on a column. This could correspond to a constant, a callable function, or a SQL clause. :class:`.ColumnDefault` is generated automatically whenever the ``default``, ``onupdate`` arguments of :class:`_schema.Column` are used. A :class:`.ColumnDefault` can be passed positionally as well. For example, the following:: Column('foo', Integer, default=50) Is equivalent to:: Column('foo', Integer, ColumnDefault(50)) r �arg.r� r� �CallableColumnDefault�r� rc rd c C s d S rn r] �r� r� rc r] r] r^ r� H s zColumnDefault.__new__rg �ColumnElementColumnDefaultc C s d S rn r] r� r] r] r^ r� M s r� c C s d S rn r] r� r] r] r^ r� U s NFc C sJ t |t�rt�d��n*t|�r$t} n t |t�r4t} n |dk r@t} t � | �S )a{ Construct a new :class:`.ColumnDefault`. :param arg: argument representing the default value. May be one of the following: * a plain non-callable Python value, such as a string, integer, boolean, or other simple type. The default value will be used as is each time. * a SQL expression, that is one which derives from :class:`_expression.ColumnElement`. The SQL expression will be rendered into the INSERT or UPDATE statement, or in the case of a primary key column when RETURNING is not used may be pre-executed before an INSERT within a SELECT. * A Python callable. The function will be invoked for each new row subject to an INSERT or UPDATE. The callable must accept exactly zero or one positional arguments. The one-argument form will receive an instance of the :class:`.ExecutionContext`, which provides contextual information as to the current :class:`_engine.Connection` in use as well as the current statement and parameters. z4ColumnDefault may not be a server-side default type.N) ro rT r1 r~ �callabler� r' r� �ScalarElementColumnDefaultr� r� r� r] r] r^ r� X s � r_ r� c C s | j j� d| j�d�S )N�(�))r� rW r� r� r] r] r^ r� � s zColumnDefault.__repr__).).).)NF)rW rX rY r� r� r r� r� r] r] r] r^ rl 0 s � � �*rl c @ s: e Zd ZdZdZdZddddd�dd �Zd d �d d �Zd S )r� zQdefault generator for a fixed scalar Python value .. versionadded: 2.0 TFr r� ry r� c C s || _ || _d S rn �rc r� �r r� rc r] r] r^ r� � s z#ScalarElementColumnDefault.__init__r� c C s t | j| jd�S �N�r� rc )r� r� rc r� r] r] r^ rB � s �z ScalarElementColumnDefault._copyN)F)rW rX rY r� r� r� r� rB r] r] r] r^ r� � s r� c s` e Zd ZdZdZdZdZd d�dd�Zdd�d d �Zd d dd �� fdd� Z d d�dd�Z � Z S )r� z�Default generator that's specific to the use of a "sentinel" column when using the insertmanyvalues feature. This default is used as part of the :func:`_schema.insert_sentinel` construct. TFNr� c C s t �| �S rn )r� r� )r� r] r] r^ r� � s z$_InsertSentinelColumnDefault.__new__ry c C s d S rn r] r� r] r] r^ r� � s z%_InsertSentinelColumnDefault.__init__r% r r* c s@ t d|�}|js t�d��n|js,t�d��t� j|f|� d S )Nrz z_The _InsertSentinelColumnDefault may only be applied to a Column marked as insert_sentinel=TruezQThe _InsertSentinelColumnDefault may only be applied to a Column that is nullable)r rf r1 r~ r r� r, �r r+ rm rI r� r] r^ r, � s ��z(_InsertSentinelColumnDefault._set_parentc C s t � S rn )r� r� r] r] r^ rB � s z"_InsertSentinelColumnDefault._copy) rW rX rY r� r rc r� r� r� r, rB rQ r] r] r� r^ r� � s r� )rg r+ c @ sb e Zd ZU dZdZdZded< ddddd�d d �Zd d �d d �Ze j e � d�dd �dd���Z dS )r� zGdefault generator for a SQL expression .. versionadded:: 2.0 T�_SQLExprDefaultr� Fr� ry r� c C s || _ || _d S rn r� r� r] r] r^ r� � s z#ColumnElementColumnDefault.__init__r� c C s t | j| jd�S r� )r� r� rc r� r] r] r^ rB � s �z ColumnElementColumnDefault._copyzsqlalchemy.sql.sqltypesc C s t jj}t| jj|j� S rn )r3 � preloadedZ sql_sqltypesro r� rj ZNullType)r Zsqltypesr] r] r^ � _arg_is_typed� s z(ColumnElementColumnDefault._arg_is_typedN)F) rW rX rY r� r� r� r� r� rB r3 r� �preload_moduler r] r] r] r^ r� � s �r� c @ s e Zd Zddd�dd�ZdS )� _CallableColumnDefaultProtocolrJ r )�contextrd c C s d S rn r] )r r r] r] r^ �__call__� r� z'_CallableColumnDefaultProtocol.__call__N)rW rX rY r r] r] r] r^ r � s r c @ sT e Zd ZU dZdZded< dZddddd �d d �Zd d �d d�Zddd�dd�Z dS )r� zQdefault generator for a callable Python function .. versionadded:: 2.0 Tr r� Fz8Union[_CallableColumnDefaultProtocol, Callable[[], Any]]r� ry r� c C s || _ | �|�| _d S rn )rc �_maybe_wrap_callabler� r� r] r] r^ r� � s z CallableColumnDefault.__init__r� c C s t | j| jd�S r� )r� r� rc r� r] r] r^ rB � s zCallableColumnDefault._copyr� c s� zt j� dd�}W n( tk r: t �� fdd�� � Y S X |d dk rTt|d �pVd}t|d �| }|dkr�t �� fdd�� �S |d kr�� S t�d ��dS ) z�Wrap callables that don't accept a context. This is to allow easy compatibility with default callables that aren't specific to accepting of a context. T)Zno_selfc s � � S rn r] ��ctx�r� r] r^ r� r� z<CallableColumnDefault._maybe_wrap_callable.<locals>.<lambda>rV Nr c s � � S rn r] r r r] r^ r� r� r zDColumnDefault Python function takes zero or one positional arguments)r3 Zget_callable_argspecr� Z wrap_callabler� r1 r~ )r r� ZargspecZ defaulted� positionalsr] r r^ r � s �z*CallableColumnDefault._maybe_wrap_callableN)F) rW rX rY r� r r� r� r� rB r r] r] r] r^ r� � s �r� c @ sD e Zd ZdZd ddddddddddd� dd�Zed d �d d ��ZdS )�IdentityOptionsz�Defines options for a named database sequence or an identity column. .. versionadded:: 1.3.18 .. seealso:: :class:`.Sequence` N� Optional[int]r� ry ) �start� increment�minvalue�maxvalue� nominvalue� nomaxvalue�cycle�cache�orderrd c C s: || _ || _|| _|| _|| _|| _|| _|| _| | _dS )a\ Construct a :class:`.IdentityOptions` object. See the :class:`.Sequence` documentation for a complete description of the parameters. :param start: the starting index of the sequence. :param increment: the increment value of the sequence. :param minvalue: the minimum value of the sequence. :param maxvalue: the maximum value of the sequence. :param nominvalue: no minimum value of the sequence. :param nomaxvalue: no maximum value of the sequence. :param cycle: allows the sequence to wrap around when the maxvalue or minvalue has been reached. :param cache: optional integer value; number of future values in the sequence which are calculated in advance. :param order: optional boolean value; if ``True``, renders the ORDER keyword. N� r r r r r r r r r ) r r r r r r r r r r r] r] r^ r� & s zIdentityOptions.__init__r� r� c C s | j d k o| j dk S r� )r r� r] r] r^ r O s z&IdentityOptions._increment_is_negative) NNNNNNNNN)rW rX rY r� r� rN r r] r] r] r^ r s �")r c s� e Zd ZU dZdZdZded< ded< d3d d d d d d d d d d d ddd dd ddd�dd�Ze� d�dd�dd��Z dddd �� fd d � Z d d�d d �Z d!d"dd#�d$d%�Z d&dd'�d(d)�Zd4d*ddd+�d,d-�Zd5d*ddd+�d.d/�Zd0d�d1d2�Z� ZS )6r a Represents a named database sequence. The :class:`.Sequence` object represents the name and configurational parameters of a database sequence. It also represents a construct that can be "executed" by a SQLAlchemy :class:`_engine.Engine` or :class:`_engine.Connection`, rendering the appropriate "next value" function for the target database and returning a result. The :class:`.Sequence` is typically associated with a primary key column:: some_table = Table( 'some_table', metadata, Column('id', Integer, Sequence('some_table_seq', start=1), primary_key=True) ) When CREATE TABLE is emitted for the above :class:`_schema.Table`, if the target platform supports sequences, a CREATE SEQUENCE statement will be emitted as well. For platforms that don't support sequences, the :class:`.Sequence` construct is ignored. .. seealso:: :ref:`defaults_sequences` :class:`.CreateSequence` :class:`.DropSequence` �sequenceTr� r# zOptional[TypeEngine[int]]� data_typeNFr_ r r� r� z"Optional[_TypeEngineArgument[int]]r� zOptional[MetaData]ry )rb r r r r r r r rc r r r �optionalr� r� r� rc rd c C s� t j| |d� tj| |||||||| | d� d| _t||�| _| | _| tkrXd | _} n2|dk r|| dkr||jr||j | _} nt� | |�| _|| _ t || �| _ |r�| � |� | dk r�t| �| _nd| _dS )a� Construct a :class:`.Sequence` object. :param name: the name of the sequence. :param start: the starting index of the sequence. This value is used when the CREATE SEQUENCE command is emitted to the database as the value of the "START WITH" clause. If ``None``, the clause is omitted, which on most platforms indicates a starting value of 1. .. versionchanged:: 2.0 The :paramref:`.Sequence.start` parameter is required in order to have DDL emit "START WITH". This is a reversal of a change made in version 1.4 which would implicitly render "START WITH 1" if the :paramref:`.Sequence.start` were not included. See :ref:`change_7211` for more detail. :param increment: the increment value of the sequence. This value is used when the CREATE SEQUENCE command is emitted to the database as the value of the "INCREMENT BY" clause. If ``None``, the clause is omitted, which on most platforms indicates an increment of 1. :param minvalue: the minimum value of the sequence. This value is used when the CREATE SEQUENCE command is emitted to the database as the value of the "MINVALUE" clause. If ``None``, the clause is omitted, which on most platforms indicates a minvalue of 1 and -2^63-1 for ascending and descending sequences, respectively. :param maxvalue: the maximum value of the sequence. This value is used when the CREATE SEQUENCE command is emitted to the database as the value of the "MAXVALUE" clause. If ``None``, the clause is omitted, which on most platforms indicates a maxvalue of 2^63-1 and -1 for ascending and descending sequences, respectively. :param nominvalue: no minimum value of the sequence. This value is used when the CREATE SEQUENCE command is emitted to the database as the value of the "NO MINVALUE" clause. If ``None``, the clause is omitted, which on most platforms indicates a minvalue of 1 and -2^63-1 for ascending and descending sequences, respectively. :param nomaxvalue: no maximum value of the sequence. This value is used when the CREATE SEQUENCE command is emitted to the database as the value of the "NO MAXVALUE" clause. If ``None``, the clause is omitted, which on most platforms indicates a maxvalue of 2^63-1 and -1 for ascending and descending sequences, respectively. :param cycle: allows the sequence to wrap around when the maxvalue or minvalue has been reached by an ascending or descending sequence respectively. This value is used when the CREATE SEQUENCE command is emitted to the database as the "CYCLE" clause. If the limit is reached, the next number generated will be the minvalue or maxvalue, respectively. If cycle=False (the default) any calls to nextval after the sequence has reached its maximum value will return an error. :param schema: optional schema name for the sequence, if located in a schema other than the default. The rules for selecting the schema name when a :class:`_schema.MetaData` is also present are the same as that of :paramref:`_schema.Table.schema`. :param cache: optional integer value; number of future values in the sequence which are calculated in advance. Renders the CACHE keyword understood by Oracle and PostgreSQL. :param order: optional boolean value; if ``True``, renders the ORDER keyword, understood by Oracle, indicating the sequence is definitively ordered. May be necessary to provide deterministic ordering using Oracle RAC. :param data_type: The type to be returned by the sequence, for dialects that allow us to choose between INTEGER, BIGINT, etc. (e.g., mssql). .. versionadded:: 1.4.0 :param optional: boolean value, when ``True``, indicates that this :class:`.Sequence` object only needs to be explicitly generated on backends that don't provide another way to generate primary key identifiers. Currently, it essentially means, "don't create this sequence on the PostgreSQL backend, where the SERIAL keyword creates a sequence for us automatically". :param quote: boolean value, when ``True`` or ``False``, explicitly forces quoting of the :paramref:`_schema.Sequence.name` on or off. When left at its default of ``None``, normal quoting rules based on casing and reserved words take place. :param quote_schema: Set the quoting preferences for the ``schema`` name. :param metadata: optional :class:`_schema.MetaData` object which this :class:`.Sequence` will be associated with. A :class:`.Sequence` that is associated with a :class:`_schema.MetaData` gains the following capabilities: * The :class:`.Sequence` will inherit the :paramref:`_schema.MetaData.schema` parameter specified to the target :class:`_schema.MetaData`, which affects the production of CREATE / DROP DDL, if any. * The :meth:`.Sequence.create` and :meth:`.Sequence.drop` methods automatically use the engine bound to the :class:`_schema.MetaData` object, if any. * The :meth:`_schema.MetaData.create_all` and :meth:`_schema.MetaData.drop_all` methods will emit CREATE / DROP for this :class:`.Sequence`, even if the :class:`.Sequence` is not associated with any :class:`_schema.Table` / :class:`_schema.Column` that's a member of this :class:`_schema.MetaData`. The above behaviors can only occur if the :class:`.Sequence` is explicitly associated with the :class:`_schema.MetaData` via this parameter. .. seealso:: :ref:`sequence_metadata` - full discussion of the :paramref:`.Sequence.metadata` parameter. :param for_update: Indicates this :class:`.Sequence`, when associated with a :class:`_schema.Column`, should be invoked for UPDATE statements on that column's table, rather than for INSERT statements, when no value is otherwise present for that column in the statement. rb r N)r� r� r r# r* rb r r[ rc � constructr� rf �_key� _set_metadatar- r )r rb r r r r r r r rc r r r r r� r� r� rc r] r] r^ r� | s: � zSequence.__init__zsqlalchemy.sql.functionsz Function[int]r� c C s t jjj�| �S )z�Return a :class:`.next_value` function element which will render the appropriate increment function for this :class:`.Sequence` within any SQL expression. )r3 r Z sql_functions�func� next_valuer� r] r] r^ r 2 s zSequence.next_valuer% r r* c s. |}t |t�st�t� �|� |�| j� d S rn )ro rp r� r� r, r� r� �r r+ rm r# r� r] r^ r, ; s zSequence._set_parentc C sD t | j| j| j| j| j| j| j| j| j | j | j | j | j | j| jd�S )N)rb r r r r r r r rc r r r r r� rc )r rb r r r r r r r rc r r r r r� rc r� r] r] r^ rB A s" �zSequence._copyrz rS r� c C s | � |j� d S rn )r r� )r r# rq r] r] r^ r� T s zSequence._set_tabler� r� c C s || _ | | j j| j< d S rn )r� � _sequencesr )r r� r] r] r^ r W s zSequence._set_metadatar- r. c C s |j tj| |d� dS )z&Creates this sequence in the database.r1 Nr2 r4 r] r] r^ r5 [ s zSequence.createc C s |j tj| |d� dS )z&Drops this sequence from the database.r1 Nr6 r4 r] r] r^ r7 ` s z Sequence.dropr c C s t �d| jj� d���d S )NzThis z� cannot be used directly as a column expression. Use func.next_value(sequence) to produce a 'next value' function that's usable as a column element.)r1 r� r� rW r� r] r] r^ �_not_a_column_expre s �zSequence._not_a_column_expr)NNNNNNNNNNNFNNNF)T)T)rW rX rY r� r� r� r� r� r3 r r r, rB r� r r5 r7 r# rQ r] r] r� r^ r T s@ �2 7r c @ s� e Zd ZU dZdZdZdZdZdZde d< d ddd�d d �Z dd d�d d �Z d d �dd�Z ddd�dd�Z dddd�dd�Zdd �dd�ZdS ) rT a� A marker for a transparent database-side default. Use :class:`.FetchedValue` when the database is configured to provide some automatic default for a column. E.g.:: Column('foo', Integer, FetchedValue()) Would indicate that some trigger or default generator will create a new value for the ``foo`` column during an INSERT. .. seealso:: :ref:`triggered_columns` TFr� r# r� ry r� c C s || _ d S rn rb r� r] r] r^ r� � s zFetchedValue.__init__c C s || j kr| S | �|�S d S rn )rc �_cloner� r] r] r^ rm � s zFetchedValue._as_for_updater� c C s t | j�S rn )rT rc r� r] r] r^ rB � s zFetchedValue._copyr8 c C s4 | j �| j �}|j�| j� |j�dd � ||_|S )Nr# )r� r� r� r� r� rc )r rc �nr] r] r^ r$ � s zFetchedValue._cloner% r r* c K s4 |}t |t�st�|| _| jr(| | j_n| | j_d S rn )ro rp r� r# rc rX r r! r] r] r^ r, � s zFetchedValue._set_parentr_ c C s t �| �S rn r� r� r] r] r^ r� � s zFetchedValue.__repr__N)F)rW rX rY r� r� � reflected� has_argumentr� r� r� r� rm rB r$ r, r� r] r] r] r^ rT n s c sN e Zd ZdZdZdddddd�� fdd � Zd d �d d �Zd d �dd�Z� ZS )rn a> A DDL-specified DEFAULT column value. :class:`.DefaultClause` is a :class:`.FetchedValue` that also generates a "DEFAULT" clause when "CREATE TABLE" is emitted. :class:`.DefaultClause` is generated automatically whenever the ``server_default``, ``server_onupdate`` arguments of :class:`_schema.Column` are used. A :class:`.DefaultClause` can be passed positionally as well. For example, the following:: Column('foo', Integer, server_default="50") Is equivalent to:: Column('foo', Integer, DefaultClause("50")) TFz%Union[str, ClauseElement, TextClause]r� ry )r� rc � _reflectedrd c s0 t �|tttfd� t� �|� || _|| _d S )Nr� ) r3 Zassert_arg_typer_ r' r+ r� r� r� r& )r r� rc r( r� r] r^ r� � s zDefaultClause.__init__r� c C s t | j| j| jd�S )N)r� rc r( )rn r� rc r& r� r] r] r^ rB � s �zDefaultClause._copyr_ c C s d| j | jf S )Nz DefaultClause(%r, for_update=%r)r� r� r] r] r^ r� � s zDefaultClause.__repr__)FF) rW rX rY r� r' r� rB r� rQ r] r] r� r^ rn � s � rn c @ s� e Zd ZU dZdZded< ded< d'd d d d d d dddd� dd�Zdddd�dd�Zedd�dd��Z dddd �d d �Z e � d d �dd!d"�d#d$��Z dd!d"�d%d&�ZdS )(� Constraintar A table-level SQL constraint. :class:`_schema.Constraint` serves as the base class for the series of constraint objects that can be associated with :class:`_schema.Table` objects, including :class:`_schema.PrimaryKeyConstraint`, :class:`_schema.ForeignKeyConstraint` :class:`_schema.UniqueConstraint`, and :class:`_schema.CheckConstraint`. r� �intr� r� rF NFr� r� r` r^ r� r ry ) rb r� r� r� r� � _create_rulerE r� rd c K sF || _ || _|| _|r || _|| _|| _t�| � | �|� || _ dS )a� Create a SQL constraint. :param name: Optional, the in-database name of this ``Constraint``. :param deferrable: Optional bool. If set, emit DEFERRABLE or NOT DEFERRABLE when issuing DDL for this constraint. :param initially: Optional string. If set, emit INITIALLY <value> when issuing DDL for this constraint. :param info: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. :param comment: Optional string that will render an SQL comment on foreign key constraint creation. .. versionadded:: 2.0 :param \**dialect_kw: Additional keyword arguments are dialect specific, and passed in the form ``<dialectname>_<argname>``. See the documentation regarding an individual dialect at :ref:`dialect_toplevel` for detail on documented arguments. :param _create_rule: used internally by some datatypes that also create constraints. :param _type_bound: used internally to indicate that this constraint is associated with a specific datatype. N) rb r� r� r� r+ rE r3 rp r� r� ) r rb r� r� r� r� r+ rE r� r] r] r^ r� � s . zConstraint.__init__rA )�compilerrm rd c K sL | j d k r| � |�sdS | jd k rD| jjt�| �| d fd|i|��S dS d S )NFr, T)r+ r� Z_should_executer ZCreateConstraint)r r, rm r] r] r^ �_should_create_for_compiler! s ���z&Constraint._should_create_for_compilerrS r� c C s< zt | jt�r| jW S W n tk r, Y nX t�d��d S )NzdThis constraint is not bound to a table. Did you mean to call table.append_constraint(constraint) ?)ro r+ rS r} r1 r� r� r] r] r^ rq - s �zConstraint.tabler% r* c K s( t |ttf�st�|| _|j�| � d S rn )ro rS rp r� r+ r� r r� r] r] r^ r, 9 s zConstraint._set_parentr� zaThe :meth:`_schema.Constraint.copy` method is deprecated and will be removed in a future release.r8 r� c K s | j f |�S rn r� r� r] r] r^ r� > s zConstraint.copyc K s t � �d S rn r� r� r] r] r^ rB F s zConstraint._copy)NNNNNNF)rW rX rY r� r� r� r� r- rN rq r, r3 rP r� rB r] r] r] r^ r) � s, � 9 �r) c @ s� e Zd ZU dZded< dZded< er8ddd d �d d �Zd ddd�ddddd d�dd�Zd&dd d�dd�Z e j dd�dd ��Z e j dd�d d ��Z d d d!�d"d#�Zddd d �d$d%�ZdS )'�ColumnCollectionMixinz�A :class:`_expression.ColumnCollection` of :class:`_schema.Column` objects. This collection represents the columns which are referred to by this object. r� r� Fz'List[Optional[Union[str, Column[Any]]]]�_pending_colargsr% r ry r* c K s d S rn r] r� r] r] r^ r| [ s z/ColumnCollectionMixin._set_parent_with_dispatchTN)� _autoattachrF �_gather_expressionsr< r� z.Optional[List[Union[str, ColumnElement[Any]]]])r� r0 rF r1 rd c G sz || _ t� | _|}|d k rTg | _t�tj|�D ]"\}}}}| j�|� |�|� q.ndd� |D �| _|rv| jrv| � � d S )Nc S s g | ]}t �tj|��qS r] )r r� r �DDLConstraintColumnRole)r� r# r] r] r^ r� | s �z2ColumnCollectionMixin.__init__.<locals>.<listcomp>) rF r" r� r/ r Z expect_col_expression_collectionr r2 rA � _check_attach) r r0 rF r1 r� Zprocessed_expressionsr= r� Z add_elementr] r] r^ r� _ s, � �� � z ColumnCollectionMixin.__init__)r� rd c s, dd� �j D �}dd� |D �}t|��|�� � r�|r<td��dd� �j D ��|�}|s�ddd d �� �fd d � }� �_� D ]}|�|� qxd S |}d d� |D �}t|�dkr���|�� � nnt|�dk�r(�j �s(|d j ��fdd�|dd � D �} | �r(d� dd� | D ��} t � d| � d�j� d���d S )Nc S s g | ]}t |t�r|�qS r] �ro rp r� r] r] r^ r� � s z7ColumnCollectionMixin._check_attach.<locals>.<listcomp>c S s g | ]}t |jt�r|�qS r] )ro rq rS r� r] r] r^ r� � s z#Should not reach here on event callc S s h | ]}|d k r|�qS rn r] r� r] r] r^ r� � s z6ColumnCollectionMixin._check_attach.<locals>.<setcomp>rz rS ry r� c s( t |t�r$� �| � � s$�jdd� d S )NT)r� )ro rS �discardr3 )r# rq )� cols_wo_tabler r] r^ � _col_attached� s z:ColumnCollectionMixin._check_attach.<locals>._col_attachedc S s h | ] }|j �qS r] r� r� r] r] r^ r� � s r r c s g | ]}|j � k r|�qS r] r� r� r� r] r^ r� � s r c s s | ]}d | V qdS �z'%s'Nr] r� r] r] r^ � <genexpr>� s z6ColumnCollectionMixin._check_attach.<locals>.<genexpr>z Column(s) z are not part of table 'r� )r/ r� � differencer� Z_cols_wo_tabler� r� r| r� �_allow_multiple_tablesrq r r1 r~ r ) r r� Zcol_objsZ cols_w_tableZhas_string_colsr7 rI r� r� ZothersZ other_strr] )r6 r rq r^ r3 � s8 �� �z#ColumnCollectionMixin._check_attachr� r� c C s | j �� S rn �r� Z as_readonlyr� r] r] r^ r� � s z ColumnCollectionMixin.columnsc C s | j �� S rn r< r� r] r] r^ rs � s zColumnCollectionMixin.czUnion[Table, Column[Any]]zList[Optional[Column[Any]]])r+ rd c s� t � t�r4dd� | jD �}t|�t| j�ks0t�|S z� fdd�| jD �W S tk r� } z0t�d| jj � d� j � d|j d � d��|�W 5 d }~X Y nX d S ) Nc S s g | ]}t |t�r|�qS r] r4 r� r] r] r^ r� � s z:ColumnCollectionMixin._col_expressions.<locals>.<listcomp>c s$ g | ] }t |t�r � j| n|�qS r] )ro r_ rs �r� rI �r+ r] r^ r� � s �z Can't create z on table 'z': no column named 'r z ' is present.) ro rp r/ r� r� �KeyErrorr1 Z ConstraintColumnNotFoundErrorr� rW r r{ )r r+ �resultZker] r> r^ �_col_expressions� s � �"��z&ColumnCollectionMixin._col_expressionsc K s: t |ttf�st�| �|�D ]}|d k r | j�|� q d S rn )ro rS rp r� rA r� r r r] r] r^ r, � s z!ColumnCollectionMixin._set_parent)F)rW rX rY r� r� r; r r| r� r3 r3 rO r� rs rA r, r] r] r] r^ r. J s" �%0r. c @ s� e Zd ZU dZdddddddd�dddd d d d d d dd� dd�Zded< dd dd�dd�Zd d d�dd�Ze� dd �dd �d d d d �d d!��Z dd �d d d d �d"d#�Z d$d d%�d&d'�Z d(d)�d*d+�Z d,d)�d-d.�ZdS )/�ColumnCollectionConstraintz-A constraint that proxies a ColumnCollection.NTF)rb r� r� r� r0 rF r1 r< r� r� r` r^ r� z"Optional[List[_DDLColumnArgument]]r ry ) r� rb r� r� r� r0 rF r1 r� rd c O s8 t j| f||||d�| �� tj| f|�||d�� dS )al :param \*columns: A sequence of column names or Column objects. :param name: Optional, the in-database name of this constraint. :param deferrable: Optional bool. If set, emit DEFERRABLE or NOT DEFERRABLE when issuing DDL for this constraint. :param initially: Optional string. If set, emit INITIALLY <value> when issuing DDL for this constraint. :param \**dialect_kw: other keyword arguments including dialect-specific arguments are propagated to the :class:`.Constraint` superclass. �rb r� r� r� )r0 rF N)r) r� r. ) r rb r� r� r� r0 rF r1 r� r� r] r] r^ r� � s$ ����� �z#ColumnCollectionConstraint.__init__r� r� r% r* c K s. t |ttf�st�t�| |� t�| |� d S rn )ro rp rS r� r) r, r. r� r] r] r^ r, s z&ColumnCollectionConstraint._set_parent)r rd c C s || j kS rn )r� )r r r] r] r^ � __contains__ s z'ColumnCollectionConstraint.__contains__r� zqThe :meth:`_schema.ColumnCollectionConstraint.copy` method is deprecated and will be removed in a future release.�rk rh �rk rm rd c K s | j f d|i|��S �Nrk r� �r rk rm r] r] r^ r� s z ColumnCollectionConstraint.copyc s� i }� j D ]2}� j | j}|�� D ]\}}|||d | < q"q t� jt�sNt�� j� �fdd�� jD �� j � j � j � j d�|��}� � |�S )Nr� c s g | ]}t |� j���qS r] )rv r+ r< �r rk r] r^ r� ; s �z4ColumnCollectionConstraint._copy.<locals>.<listcomp>)rb r� r� r� )r� r� r� ro r+ rS r� r� r� rb r� r� r� r� ) r rk rm Zconstraint_kwargsr� r� r� r� rs r] rI r^ rB $ s, �� ��� � z ColumnCollectionConstraint._copyrz �rI rd c C s | j �|�S )z�Return True if this constraint contains the given column. Note that this object also contains an attribute ``.columns`` which is a :class:`_expression.ColumnCollection` of :class:`_schema.Column` objects. )r� �contains_column�r rI r] r] r^ rK D s z*ColumnCollectionConstraint.contains_columnzIterator[Column[Any]]r� c C s t | j�S rn )�iterr� r� r] r] r^ �__iter__O s z#ColumnCollectionConstraint.__iter__r* c C s t | j�S rn )r� r� r� r] r] r^ �__len__R s z"ColumnCollectionConstraint.__len__)rW rX rY r� r� r� r, rD r3 rP r� rB rK rN rO r] r] r] r^ rB � s. �$,�� � rB c s� e Zd ZdZdZdZeddd�d!d d d d d ddddddd� � fdd� �Zedd�dd��Z e � dd�dd�d dd d �d d ��Z dd�d dd d �d d �Z � ZS )"�CheckConstraintzlA table- or column-level CHECK constraint. Can be included in the definition of a Table or Column. TZ table_or_column_check_constraint�sqltextz:class:`.CheckConstraint`z$:paramref:`.CheckConstraint.sqltext`NFz#_TextCoercedExpressionArgument[Any]r� r� r` rh r^ r� r� r ry ) rQ rb r� r� rq r� r+ r0 rE r� rd c sb t �tj|�| _g } t�| ji d| ji� t� j | |||||| |d�| �� |dk r^| � |� dS )a� Construct a CHECK constraint. :param sqltext: A string containing the constraint definition, which will be used verbatim, or a SQL expression construct. If given as a string, the object is converted to a :func:`_expression.text` object. If the textual string includes a colon character, escape this using a backslash:: CheckConstraint(r"foo ~ E'a(?\:b|c)d") :param name: Optional, the in-database name of the constraint. :param deferrable: Optional bool. If set, emit DEFERRABLE or NOT DEFERRABLE when issuing DDL for this constraint. :param initially: Optional string. If set, emit INITIALLY <value> when issuing DDL for this constraint. :param info: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. r# )rb r� r� r+ r� rE r0 N) r r� r �DDLExpressionRolerQ r �traverserA r� r� r| ) r rQ rb r� r� rq r� r+ r0 rE r� r� r� r] r^ r� ` s" -�� � zCheckConstraint.__init__r� c C s t | jt� S rn )ro r+ rS r� r] r] r^ �is_column_level� s z CheckConstraint.is_column_levelr� zfThe :meth:`_schema.CheckConstraint.copy` method is deprecated and will be removed in a future release.rE rF c K s | j f d|i|��S rG r� rH r] r] r^ r� � s zCheckConstraint.copyc K sP |d k rt | j| j|�}n| j}t|| j| j| j| j|| jd| j d� }| � |�S )NF)rb r� r� r+ rq r� r0 rE ) rv rQ rq rP rb r� r� r+ r� rE r� )r rk rm rQ rs r] r] r^ rB � s � zCheckConstraint._copy)NNNNNNTF)rW rX rY r� r; r� r& r� rN rT r3 rP r� rB rQ r] r] r� r^ rP V s6 � �*:���rP c @ s$ e Zd ZU dZdZd8dddddddd d dd d dd d d�dd�Zddd d�dd�Zded< ded< edd�d d ��Z edd�d d ��Z ed d�d!d"��Z d d d#�d$d%�Z ed&d�d'd(��Z ed)d�d*d+��Zd,d d d-�d.d/�Ze�d0d1�ddd2�dd d d d3�d4d5��Zddd2�dd d d d3�d6d7�ZdS )9rC a� A table-level FOREIGN KEY constraint. Defines a single column or composite FOREIGN KEY ... REFERENCES constraint. For a no-frills, single column foreign key, adding a :class:`_schema.ForeignKey` to the definition of a :class:`_schema.Column` is a shorthand equivalent for an unnamed, single column :class:`_schema.ForeignKeyConstraint`. Examples of foreign key configuration are in :ref:`metadata_foreignkeys`. Zforeign_key_constraintNFz$_typing_Sequence[_DDLColumnArgument]r� r` r� r� rh r^ r ry )r� � refcolumnsrb rW r� r� r� r� r� r� rq r� r� r� rd c s� t j� f|||| | d�|�� |� _|� _| � _|� _| � _tt|��t|�krztt|��t|�krpt � d��n t � d��� fdd�|D �� _ t j� f|�� | dk r�t � d�r�| � jks�t�� �| � dS )a� Construct a composite-capable FOREIGN KEY. :param columns: A sequence of local column names. The named columns must be defined and present in the parent Table. The names should match the ``key`` given to each column (defaults to the name) unless ``link_to_name`` is True. :param refcolumns: A sequence of foreign column names or Column objects. The columns must all be located within the same Table. :param name: Optional, the in-database name of the key. :param onupdate: Optional string. If set, emit ON UPDATE <value> when issuing DDL for this constraint. Typical values include CASCADE, DELETE and RESTRICT. :param ondelete: Optional string. If set, emit ON DELETE <value> when issuing DDL for this constraint. Typical values include CASCADE, DELETE and RESTRICT. :param deferrable: Optional bool. If set, emit DEFERRABLE or NOT DEFERRABLE when issuing DDL for this constraint. :param initially: Optional string. If set, emit INITIALLY <value> when issuing DDL for this constraint. :param link_to_name: if True, the string name given in ``column`` is the rendered name of the referenced column, not its locally assigned ``key``. :param use_alter: If True, do not emit the DDL for this constraint as part of the CREATE TABLE definition. Instead, generate it via an ALTER TABLE statement issued after the full collection of tables have been created, and drop it via an ALTER TABLE statement before the full collection of tables are dropped. The use of :paramref:`_schema.ForeignKeyConstraint.use_alter` is particularly geared towards the case where two or more tables are established within a mutually-dependent foreign key constraint relationship; however, the :meth:`_schema.MetaData.create_all` and :meth:`_schema.MetaData.drop_all` methods will perform this resolution automatically, so the flag is normally not needed. .. seealso:: :ref:`use_alter` :param match: Optional string. If set, emit MATCH <value> when issuing DDL for this constraint. Typical values include SIMPLE, PARTIAL and FULL. :param info: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. :param comment: Optional string that will render an SQL comment on foreign key constraint creation. .. versionadded:: 2.0 :param \**dialect_kw: Additional keyword arguments are dialect specific, and passed in the form ``<dialectname>_<argname>``. See the documentation regarding an individual dialect at :ref:`dialect_toplevel` for detail on documented arguments. )rb r� r� r� r� zOForeignKeyConstraint with duplicate source column references are not supported.z_ForeignKeyConstraint number of constrained columns must match the number of referenced columns.c sB g | ]:}t |f� � j� j� j� j� j� j� j� jd � � j ���qS )) r� rb rW r� r� r� r� r� r� ) r� rb rW r� r� r� r� r� r� ra )r� Zrefcolr� r] r^ r� M s ��� �z1ForeignKeyConstraint.__init__.<locals>.<listcomp>Nr+ )r) r� rW r� r� r� r� r� r� r1 r~ �elementsr. re r+ r� r| )r r� rU rb rW r� r� r� r� r� r� rq r� r� r� r] r� r^ r� � s@ T��� �� � z ForeignKeyConstraint.__init__rz r� )r# r~ rd c C s | j �|� | j�|� d S rn )r� r rV rA r} r] r] r^ r� d s z$ForeignKeyConstraint._append_elementr� r� zList[ForeignKey]rV z!util.OrderedDict[str, ForeignKey]r� c C s t �t| j| j��S rn )r3 � OrderedDict�zip� column_keysrV r� r] r] r^ � _elementsy s z ForeignKeyConstraint._elementsc C s | j D ] }|j S d S rn )rV rD )r �elemr] r] r^ rD ~ s z%ForeignKeyConstraint._referred_schemarS c C s | j d jjS )aK The :class:`_schema.Table` object to which this :class:`_schema.ForeignKeyConstraint` references. This is a dynamically calculated attribute which may not be available if the constraint and/or parent table is not yet associated with a metadata collection that contains the referred table. r )rV r# rq r� r] r] r^ �referred_table� s z#ForeignKeyConstraint.referred_tabler c C sb dd� | j D �}d |kr^t|�dkr^t|�dd� \}}t�d|j� d| j� d|� d |� ���d S ) Nc S s h | ] }|� � �qS r] )r� )r� r[ r] r] r^ r� � s z<ForeignKeyConstraint._validate_dest_table.<locals>.<setcomp>r r r/ zForeignKeyConstraint on r� z$) refers to multiple remote tables: � and )rV r� r� r1 r~ r� �_col_description)r rq Z table_keysZelem0Zelem1r] r] r^ r� � s �z)ForeignKeyConstraint._validate_dest_tablez_typing_Sequence[str]c C s( t | d�r| j�� S dd� | jD �S dS )a� Return a list of string keys representing the local columns in this :class:`_schema.ForeignKeyConstraint`. This list is either the original string arguments sent to the constructor of the :class:`_schema.ForeignKeyConstraint`, or if the constraint has been initialized with :class:`_schema.Column` objects, is the string ``.key`` of each element. r+ c S s$ g | ] }t |t�r|jnt|��qS r] )ro r) rr r_ r= r] r] r^ r� � s �z4ForeignKeyConstraint.column_keys.<locals>.<listcomp>N)re r� �keysr/ r� r] r] r^ rY � s �z ForeignKeyConstraint.column_keysr_ c C s d� | j�S )Nr )r rY r� r] r] r^ r^ � s z%ForeignKeyConstraint._col_descriptionr% r* c K sn |}t |t�st�t�| |� t�| |� t| j| j�D ]&\}}t |d�rT|j |k r8|� |� q8| � |� d S )Nr+ ) ro rS r� r) r, rB rX r� rV re r+ r| r� )r r+ rm rq rI r~ r] r] r^ r, � s z ForeignKeyConstraint._set_parentr� zkThe :meth:`_schema.ForeignKeyConstraint.copy` method is deprecated and will be removed in a future release.r; )rc rk rm rd c K s | j f ||d�|��S )Nr; r� )r rc rk rm r] r] r^ r� � s zForeignKeyConstraint.copyc sz t dd� | jD �� �fdd�| jD �| j| j| j| j| j| j| j| j | j d� }t | j|j�D ]\}}|� |� q\| � |�S )Nc S s g | ] }|j j�qS r] )r+ rr r r] r] r^ r� � s z.ForeignKeyConstraint._copy.<locals>.<listcomp>c s< g | ]4}|j � �d k r.|�� |jjjkr.�jnd dd��qS )NT)rc r� r� )r� r� r+ rq rr rb r r; r] r^ r� � s ����) rb rW r� r� r� r� r� r� r� ) rC rV rb rW r� r� r� r� r� r� r� rX r� )r rc rk rm r� Zself_fkZother_fkr] r; r^ rB � s$ � � zForeignKeyConstraint._copy) NNNNNFFNNNN)rW rX rY r� r� r� r� r� rN rZ rD r\ r� rY r^ r, r3 rP r� rB r] r] r] r^ rC � sP �, �� �rC c s� e Zd ZdZdZdddddd�ddddd d d d d �� fdd�Zdd d d�� fdd� Zdd d�dd�Zdd d�dd�Ze d d �d d ��Z e j d d �d!d"��Z � ZS )#r� a� A table-level PRIMARY KEY constraint. The :class:`.PrimaryKeyConstraint` object is present automatically on any :class:`_schema.Table` object; it is assigned a set of :class:`_schema.Column` objects corresponding to those marked with the :paramref:`_schema.Column.primary_key` flag:: >>> my_table = Table('mytable', metadata, ... Column('id', Integer, primary_key=True), ... Column('version_id', Integer, primary_key=True), ... Column('data', String(50)) ... ) >>> my_table.primary_key PrimaryKeyConstraint( Column('id', Integer(), table=<mytable>, primary_key=True, nullable=False), Column('version_id', Integer(), table=<mytable>, primary_key=True, nullable=False) ) The primary key of a :class:`_schema.Table` can also be specified by using a :class:`.PrimaryKeyConstraint` object explicitly; in this mode of usage, the "name" of the constraint can also be specified, as well as other options which may be recognized by dialects:: my_table = Table('mytable', metadata, Column('id', Integer), Column('version_id', Integer), Column('data', String(50)), PrimaryKeyConstraint('id', 'version_id', name='mytable_pk') ) The two styles of column-specification should generally not be mixed. An warning is emitted if the columns present in the :class:`.PrimaryKeyConstraint` don't match the columns that were marked as ``primary_key=True``, if both are present; in this case, the columns are taken strictly from the :class:`.PrimaryKeyConstraint` declaration, and those columns otherwise marked as ``primary_key=True`` are ignored. This behavior is intended to be backwards compatible with previous behavior. For the use case where specific options are to be specified on the :class:`.PrimaryKeyConstraint`, but the usual style of using ``primary_key=True`` flags is still desirable, an empty :class:`.PrimaryKeyConstraint` may be specified, which will take on the primary key column collection from the :class:`_schema.Table` based on the flags:: my_table = Table('mytable', metadata, Column('id', Integer, primary_key=True), Column('version_id', Integer, primary_key=True), Column('data', String(50)), PrimaryKeyConstraint(name='mytable_pk', mssql_clustered=True) ) Zprimary_key_constraintNF)rb r� r� r� r� r< r` r� r^ r� r ry )r� rb r� r� r� r� r� rd c s& || _ t� j|||||d�|�� d S )NrC )r� r� r� )r rb r� r� r� r� r� r� r� r] r^ r� 0 s ��z PrimaryKeyConstraint.__init__r% r* c s |}t |t�st�t� �|� |j| k rH|j�|j� | |_|j�| � dd� |j D �}| j r�|r�t |�t | j �kr�d� dd� |D ��}d� dd� | j D ��}t �d|j� d|� d |� d |� d � � g |d d �< | j D ]}d |_|jtkr�d |_q�|�r| j �|� d S )Nc S s g | ]}|j r|�qS r] )r� r� r] r] r^ r� N s z4PrimaryKeyConstraint._set_parent.<locals>.<listcomp>r c s s | ]}d |j V qdS r8 r� r� r] r] r^ r9 U s z3PrimaryKeyConstraint._set_parent.<locals>.<genexpr>c s s | ]}d |j V qdS r8 r� r� r] r] r^ r9 V s r� z' specifies columns z= as primary_key=True, not matching locally specified columns z-; setting the current primary key columns to z:. This warning may become an exception in a future releaseTF)ro rS r� r� r, r� r� r5 r rs r� r� r r3 r@ rb rg r\ r �extend)r r+ rm rq Z table_pksZ table_pk_strZcol_strrs r� r] r^ r, D s4 ��� � z PrimaryKeyConstraint._set_parentzIterable[Column[Any]])r� rd c C s8 |D ] }d|_ q| j�|� tj�| � | �| j� dS )aK repopulate this :class:`.PrimaryKeyConstraint` given a set of columns. Existing columns in the table that are marked as primary_key=True are maintained. Also fires a new event. This is basically like putting a whole new :class:`.PrimaryKeyConstraint` object on the parent :class:`_schema.Table` object without actually replacing the object. The ordering of the given list of columns is also maintained; these columns will be appended to the list of columns after any which are already present. TN)r� r� r` r� r �_resetr| rq )r r� rI r] r] r^ �_reloadl s z PrimaryKeyConstraint._reloadrz rJ c C s* t j�| � | j�|� | j�| |� d S rn )r� r ra r� ru r� Z'_sa_event_column_added_to_pk_constraintrL r] r] r^ r� � s z PrimaryKeyConstraint._replacezList[Column[Any]]r� c s6 | j � � d k r(� g� fdd�| jD � S t| j�S d S )Nc s g | ]}|� k r|�qS r] r] r� ��autoincr] r^ r� � s z>PrimaryKeyConstraint.columns_autoinc_first.<locals>.<listcomp>)r r� rd r� r] rc r^ �columns_autoinc_first� s z*PrimaryKeyConstraint.columns_autoinc_firstr c C s� dddd�dd�}t | j�dkrdt| j�d }|jdkrF||d� |S |jd kr^||d �r^|S d S nRd }| jD ]B}|jdkrn||d� |d k r�t�d |j� d |j� d ���qn|}qn|S d S )Nrz r� )rI � autoinc_truerd c S s� | j jd ks&t| j jtjjtjjf�sL|rFt�d| j � d| � d���q�dS nNt| j t d �t f�sh|shdS | j d k r�t| j t �s�|s�dS | j r�| jdkr�dS dS )Nz Column type z on column 'z+' is not compatible with autoincrement=TrueF)T� ignore_fkT)rj Z_type_affinity� issubclassr r� Z NUMERICTYPEr1 r~ ro rx r r r� r� rT )rI rf r] r] r^ �_validate_autoinc� s4 ������ ��zEPrimaryKeyConstraint._autoincrement_column.<locals>._validate_autoincr r T)rR rg Fz=Only one Column may be marked autoincrement=True, found both r] re )r� r� rd rT r1 r~ rb )r ri rI rd r] r] r^ r � s* ! � �z*PrimaryKeyConstraint._autoincrement_column)rW rX rY r� r� r� r, rb r� rN re r3 rO r rQ r] r] r� r^ r� � s ;�$( r� c @ s e Zd ZdZdZdS )r� a A table-level UNIQUE constraint. Defines a single column or composite UNIQUE constraint. For a no-frills, single column constraint, adding ``unique=True`` to the ``Column`` definition is a shorthand equivalent for an unnamed, single column UniqueConstraint. Zunique_constraintN)rW rX rY r� r� r] r] r] r^ r� � s r� c @ s� e Zd ZU dZdZded< ded< ded< d d d d d d �d d dddddddd� dd�Zdddd�dd�Zd$dddd�d d �Zd%dddd�d d �Z d d!�d"d#�Z d S )&rG a� A table-level INDEX. Defines a composite (one or more column) INDEX. E.g.:: sometable = Table("sometable", metadata, Column("name", String(50)), Column("address", String(100)) ) Index("some_index", sometable.c.name) For a no-frills, single column index, adding :class:`_schema.Column` also supports ``index=True``:: sometable = Table("sometable", metadata, Column("name", String(50), index=True) ) For a composite index, multiple columns can be specified:: Index("some_index", sometable.c.name, sometable.c.address) Functional indexes are supported as well, typically by using the :data:`.func` construct in conjunction with table-bound :class:`_schema.Column` objects:: Index("some_index", func.lower(sometable.c.name)) An :class:`.Index` can also be manually associated with a :class:`_schema.Table`, either through inline declaration or using :meth:`_schema.Table.append_constraint`. When this approach is used, the names of the indexed columns can be specified as strings:: Table("sometable", metadata, Column("name", String(50)), Column("address", String(100)), Index("some_index", "name", "address") ) To support functional or expression-based indexes in this form, the :func:`_expression.text` construct may be used:: from sqlalchemy import text Table("sometable", metadata, Column("name", String(50)), Column("address", String(100)), Index("some_index", text("lower(name)")) ) .. seealso:: :ref:`schema_indexes` - General information on :class:`.Index`. :ref:`postgresql_indexes` - PostgreSQL-specific options available for the :class:`.Index` construct. :ref:`mysql_indexes` - MySQL-specific options available for the :class:`.Index` construct. :ref:`mssql_indexes` - MSSQL-specific options available for the :class:`.Index` construct. rK rh rq z0_typing_Sequence[Union[str, ColumnElement[Any]]]� expressionsz$_typing_Sequence[ColumnElement[Any]]rH FN)r> r� r� r? rF r` r< r� r� r^ r ry ) rb rj r> r� r� r? rF r� rd c O sx d | _ } t�||�| _|| _|dk r,|| _|dk r8|} | �|� g | _tj | f|�|| jd�� | dk rt| � | � dS )av Construct an index object. :param name: The name of the index :param \*expressions: Column expressions to include in the index. The expressions are normally instances of :class:`_schema.Column`, but may also be arbitrary SQL expressions which ultimately refer to a :class:`_schema.Column`. :param unique=False: Keyword only argument; if True, create a unique index. :param quote=None: Keyword only argument; whether to apply quoting to the name of the index. Works in the same manner as that of :paramref:`_schema.Column.quote`. :param info=None: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. :param \**dialect_kw: Additional keyword arguments not mentioned above are dialect specific, and passed in the form ``<dialectname>_<argname>``. See the documentation regarding an individual dialect at :ref:`dialect_toplevel` for detail on documented arguments. N)rF r1 ) rq r* r rb r> r� r� rj r. r� r, ) r rb r> r� r� r? rF rj r� rq r] r] r^ r� 4 s& ( ���zIndex.__init__r% r* c K s� |}t |t�st�t�| |� | jd k rX|| jk rXt�d| j� d| jj � d|j � d���|| _|j � | � | j }| � |�}t|�t|�ks�t�g }t||�D ]:\}}t |t�r�|�|� q�|d k r�|�|� q�ds�t�q�| | _ | _d S )NzIndex 'z' is against table 'z(', and cannot be associated with table 'r� F)ro rS r� r. r, rq r1 r~ rb r r� r rj rA r� rX r' rA rH ) r r+ rm rq rj Zcol_expressionsZexprsr= Zcolexprr] r] r^ r, v s( � zIndex._set_parentr- r. c C s |j tj| |d� dS )z�Issue a ``CREATE`` statement for this :class:`.Index`, using the given :class:`.Connection` or :class:`.Engine`` for connectivity. .. seealso:: :meth:`_schema.MetaData.create_all`. r1 Nr2 r4 r] r] r^ r5 � s z Index.createc C s |j tj| |d� dS )z�Issue a ``DROP`` statement for this :class:`.Index`, using the given :class:`.Connection` or :class:`.Engine` for connectivity. .. seealso:: :meth:`_schema.MetaData.drop_all`. r1 Nr6 r4 r] r] r^ r7 � s z Index.dropr_ r� c C s6 dd� t| j�gdd� | jD � | jr,dgp.g � S )Nz Index(%s)r c S s g | ] }t |��qS r] r )r� �er] r] r^ r� � s z"Index.__repr__.<locals>.<listcomp>z unique=True)r r rb rj r> r� r] r] r^ r� � s ����zIndex.__repr__)F)F) rW rX rY r� r� r� r� r, r5 r7 r� r] r] r] r^ rG � s E�"B rG c @ s6 e Zd ZU ded< ded< ded< ded< ded< dS )�_NamingSchemaTD�_NamingSchemaDirectiver~ �pk�ixZckZuqN)rW rX rY r� r] r] r] r^ rl � s rl F)�totalro zix_%(column_0_label)s�_NamingSchemaParameter�DEFAULT_NAMING_CONVENTIONc @ sf e Zd ZU dZdZdAdddddd �d d �Zd ed < dd�dd�Zddd�dd�Zddddd�dd�Z dddd�d d �Z d d�d d �Z d dd!�d"d#�Z dd�d$d%�Z ddd&�d'd(�Zed)d�d*d+��ZedBd-ddd.dddd/dd0� d1d2��ZedCd3ddd.dddd/dd0� d4d2��Ze�d5�dDd8ddd.dddd/dd0� d9d2��ZdEd:d;ddd<�d=d>�ZdFd:d;ddd<�d?d@�ZdS )Gr� aD A collection of :class:`_schema.Table` objects and their associated schema constructs. Holds a collection of :class:`_schema.Table` objects as well as an optional binding to an :class:`_engine.Engine` or :class:`_engine.Connection`. If bound, the :class:`_schema.Table` objects in the collection and their columns may participate in implicit SQL execution. The :class:`_schema.Table` objects themselves are stored in the :attr:`_schema.MetaData.tables` dictionary. :class:`_schema.MetaData` is a thread-safe object for read operations. Construction of new tables within a single :class:`_schema.MetaData` object, either explicitly or via reflection, may not be completely thread-safe. .. seealso:: :ref:`metadata_describing` - Introduction to database metadata r� Nr` r� z Optional[_NamingSchemaParameter]r^ ry )rc r� �naming_conventionr� rd c C sv |dk r(t |t�s(t�dt|�� d���t�� | _t� ||�| _ |rH|nt | _ |rX|| _ t� | _i | _t�t�| _dS )a Create a new MetaData object. :param schema: The default schema to use for the :class:`_schema.Table`, :class:`.Sequence`, and potentially other objects associated with this :class:`_schema.MetaData`. Defaults to ``None``. .. seealso:: :ref:`schema_metadata_schema_name` - details on how the :paramref:`_schema.MetaData.schema` parameter is used. :paramref:`_schema.Table.schema` :paramref:`.Sequence.schema` :param quote_schema: Sets the ``quote_schema`` flag for those :class:`_schema.Table`, :class:`.Sequence`, and other objects which make usage of the local ``schema`` name. :param info: Optional data dictionary which will be populated into the :attr:`.SchemaItem.info` attribute of this object. :param naming_convention: a dictionary referring to values which will establish default naming conventions for :class:`.Constraint` and :class:`.Index` objects, for those objects which are not given a name explicitly. The keys of this dictionary may be: * a constraint or Index class, e.g. the :class:`.UniqueConstraint`, :class:`_schema.ForeignKeyConstraint` class, the :class:`.Index` class * a string mnemonic for one of the known constraint classes; ``"fk"``, ``"pk"``, ``"ix"``, ``"ck"``, ``"uq"`` for foreign key, primary key, index, check, and unique constraint, respectively. * the string name of a user-defined "token" that can be used to define new naming tokens. The values associated with each "constraint class" or "constraint mnemonic" key are string naming templates, such as ``"uq_%(table_name)s_%(column_0_name)s"``, which describe how the name should be composed. The values associated with user-defined "token" keys should be callables of the form ``fn(constraint, table)``, which accepts the constraint/index object and :class:`_schema.Table` as arguments, returning a string result. The built-in names are as follows, some of which may only be available for certain types of constraint: * ``%(table_name)s`` - the name of the :class:`_schema.Table` object associated with the constraint. * ``%(referred_table_name)s`` - the name of the :class:`_schema.Table` object associated with the referencing target of a :class:`_schema.ForeignKeyConstraint`. * ``%(column_0_name)s`` - the name of the :class:`_schema.Column` at index position "0" within the constraint. * ``%(column_0N_name)s`` - the name of all :class:`_schema.Column` objects in order within the constraint, joined without a separator. * ``%(column_0_N_name)s`` - the name of all :class:`_schema.Column` objects in order within the constraint, joined with an underscore as a separator. * ``%(column_0_label)s``, ``%(column_0N_label)s``, ``%(column_0_N_label)s`` - the label of either the zeroth :class:`_schema.Column` or all :class:`.Columns`, separated with or without an underscore * ``%(column_0_key)s``, ``%(column_0N_key)s``, ``%(column_0_N_key)s`` - the key of either the zeroth :class:`_schema.Column` or all :class:`.Columns`, separated with or without an underscore * ``%(referred_column_0_name)s``, ``%(referred_column_0N_name)s`` ``%(referred_column_0_N_name)s``, ``%(referred_column_0_key)s``, ``%(referred_column_0N_key)s``, ... column tokens which render the names/keys/labels of columns that are referenced by a :class:`_schema.ForeignKeyConstraint`. * ``%(constraint_name)s`` - a special key that refers to the existing name given to the constraint. When this key is present, the :class:`.Constraint` object's existing name will be replaced with one that is composed from template string that uses this token. When this token is present, it is required that the :class:`.Constraint` is given an explicit name ahead of time. * user-defined: any additional token may be implemented by passing it along with a ``fn(constraint, table)`` callable to the naming_convention dictionary. .. versionadded:: 1.3.0 - added new ``%(column_0N_name)s``, ``%(column_0_N_name)s``, and related tokens that produce concatenations of names, keys, or labels for all columns referred to by a given constraint. .. seealso:: :ref:`constraint_naming_conventions` - for detailed usage examples. Nz-expected schema argument to be a string, got re )ro r_ r1 r~ rj r3 Z FacadeDictr� r* r rc rr rs r� r� �_schemasr" � collections� defaultdictrd r� )r rc r� rs r� r] r] r^ r� � s y� ���zMetaData.__init__zutil.FacadeDict[str, Table]r� r_ r� c C s dS )Nz MetaData()r] r� r] r] r^ r� � s zMetaData.__repr__zUnion[str, Table]r� )� table_or_keyrd c C s t |t�s|j}|| jkS rn )ro r_ rr r� )r rw r] r] r^ rD � s zMetaData.__contains__rS )rb rc rq rd c C s, t ||�}| j�||� |r(| j�|� d S rn )rf r� Z _insert_itemrt r )r rb rc rq rr r] r] r^ r� � s zMetaData._add_tablera c C sX t ||�}t�| j|d �}|d k r8|jD ]}|�| � q(| jrTdd� | j�� D �| _d S )Nc S s h | ]}|j d k r|j �qS rn r )r� �tr] r] r^ r� � s z)MetaData._remove_table.<locals>.<setcomp>)rf �dictr� r� r� r� rt rs )r rb rc rr Zremovedr~ r] r] r^ r� � s �zMetaData._remove_tablezDict[str, Any]c C s | j | j| j| j| j| jd�S )N)r� rc �schemas� sequences�fk_memosrs )r� rc rt r" r� rs r� r] r] r^ � __getstate__� s �zMetaData.__getstate__)r� rd c C s@ |d | _ |d | _|d | _|d | _|d | _|d | _d S )Nr� rc rs r{ rz r| )r� rc rs r" rt r� )r r� r] r] r^ � __setstate__� s zMetaData.__setstate__c C s$ t �| j� | j�� | j�� dS )z+Clear all Table objects from this MetaData.N)ry �clearr� rt r� r� r] r] r^ r � s zMetaData.clearr c C s | � |j|j� dS )z1Remove the given Table object from this MetaData.N)r� rb rc r! r] r] r^ r� � s zMetaData.removez List[Table]c C s t �t| j�� dd� d��S )a� Returns a list of :class:`_schema.Table` objects sorted in order of foreign key dependency. The sorting will place :class:`_schema.Table` objects that have dependencies first, before the dependencies themselves, representing the order in which they can be created. To get the order in which the tables would be dropped, use the ``reversed()`` Python built-in. .. warning:: The :attr:`.MetaData.sorted_tables` attribute 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 :attr:`.MetaData.sorted_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. .. seealso:: :func:`_schema.sort_tables` :func:`_schema.sort_tables_and_constraints` :attr:`_schema.MetaData.tables` :meth:`_reflection.Inspector.get_table_names` :meth:`_reflection.Inspector.get_sorted_table_and_fkc_names` c S s | j S rn r� )rx r] r] r^ r� � r� z(MetaData.sorted_tables.<locals>.<lambda>r� )r Z sort_tablesr� r� rs r� r] r] r^ � sorted_tables� s 3�zMetaData.sorted_tables.rG zCUnion[_typing_Sequence[str], Callable[[str, MetaData], bool], None]r ) r/ rc �views�onlyr� r� r� ra rd c K s d S rn r] � r r/ rc r� r� r� r� r� ra r] r] r^ �reflect� s zMetaData.reflectrF c K s d S rn r] r� r] r] r^ r� s z sqlalchemy.engine.reflectionFTr� c s0 t �|��� ��} | �||t� d�} | �|� �dkr<�j��dk rL�| d< tjjj j } t� | � ���� |r�tjjj j } � �| ���� z� �| ���� W n tk r� Y nX �dk r�t� �fdd�� D ��} n� } t�j���dk�r��fdd�t� | �D �} n�t���r2����fdd�t� | �D �} nh� fdd��D �}|�r���rZd � �p\d }d �|�}t�d |j�|� d |� d�����fdd��D �} | jf �| � | tjjjj d�|��}|| d< | D ]V}zt|�f| � W n< tjk �r } zt� d|� d|� �� W 5 d}~X Y nX �q�W 5 Q R X dS )a. Load all available table definitions from the database. Automatically creates ``Table`` entries in this ``MetaData`` for any table available in the database but not yet present in the ``MetaData``. May be called multiple times to pick up tables recently added to the database, however no special action is taken if a table in this ``MetaData`` no longer exists in the database. :param bind: A :class:`.Connection` or :class:`.Engine` used to access the database. :param schema: Optional, query and reflect tables from an alternate schema. If None, the schema associated with this :class:`_schema.MetaData` is used, if any. :param views: If True, also reflect views (materialized and plain). :param only: Optional. Load only a sub-set of available named tables. May be specified as a sequence of names or a callable. If a sequence of names is provided, only those tables will be reflected. An error is raised if a table is requested but not available. Named tables already present in this ``MetaData`` are ignored. If a callable is provided, it will be used as a boolean predicate to filter the list of potential table names. The callable is called with a table name and this ``MetaData`` instance as positional arguments and should return a true value for any table to reflect. :param extend_existing: Passed along to each :class:`_schema.Table` as :paramref:`_schema.Table.extend_existing`. :param autoload_replace: Passed along to each :class:`_schema.Table` as :paramref:`_schema.Table.autoload_replace`. :param resolve_fks: if True, reflect :class:`_schema.Table` objects linked to :class:`_schema.ForeignKey` objects located in each :class:`_schema.Table`. For :meth:`_schema.MetaData.reflect`, this has the effect of reflecting related tables that might otherwise not be in the list of tables being reflected, for example if the referenced table is in a different schema or is omitted via the :paramref:`.MetaData.reflect.only` parameter. When False, :class:`_schema.ForeignKey` objects are not followed to the :class:`_schema.Table` in which they link, however if the related table is also part of the list of tables that would be reflected in any case, the :class:`_schema.ForeignKey` object will still resolve to its related :class:`_schema.Table` after the :meth:`_schema.MetaData.reflect` operation is complete. Defaults to True. .. versionadded:: 1.3.0 .. seealso:: :paramref:`_schema.Table.resolve_fks` :param \**dialect_kwargs: Additional keyword arguments not mentioned above are dialect specific, and passed in the form ``<dialectname>_<argname>``. See the documentation regarding an individual dialect at :ref:`dialect_toplevel` for detail on documented arguments. .. seealso:: :ref:`metadata_reflection_toplevel` :meth:`_events.DDLEvents.column_reflect` - Event used to customize the reflected columns. Usually used to generalize the types using :meth:`_types.TypeEngine.as_generic` :ref:`metadata_reflection_dbagnostic_types` - describes how to reflect tables using general types. )r� r� r� r� r� Nrc c s g | ]}� � d |� ��qS )re r] �r� rb r r] r^ r� � s z$MetaData.reflect.<locals>.<listcomp>c s g | ]\}}�s|� kr|�qS r] r] �r� rb Zschname��currentr� r] r^ r� � s �c s* g | ]"\}}�s|� kr�|��r|�qS r] r] r� )r� r� r� r r] r^ r� � s �c s g | ]}|� kr|�qS r] r] r� )� availabler] r^ r� � s z schema '%s'r� r z7Could not reflect: requested table(s) not available in z: (r� c s g | ]}�s|� kr|�qS r] r] r� r� r] r^ r� � s �)rc Z filter_namesr� �kind�scoper� zSkipping table z: ) r2 r� r� r� r� rc r3 r Zengine_reflectionZ ObjectKindZTABLEZ OrderedSetZget_table_names�ANYZget_view_namesZget_materialized_view_namesr� r� rX r� r r1 r� �engineZ_get_reflection_infoZ ObjectScoperS ZUnreflectableTableErrorr@ )r r/ rc r� r� r� r� r� ra r� Z reflect_optsr� Zavailable_w_schema�load�missing�sZ missing_strr� rb Zuerrr] )r� r� r� r� rc r r^ r� s| c� � � � � � � ��r- z!Optional[_typing_Sequence[Table]])r/ r� r0 rd c C s |j tj| ||d� dS )aD Create all tables stored in this metadata. Conditional by default, will not attempt to recreate tables already present in the target database. :param bind: A :class:`.Connection` or :class:`.Engine` used to access the database. :param tables: Optional list of ``Table`` objects, which is a subset of the total tables in the ``MetaData`` (others are ignored). :param checkfirst: Defaults to True, don't issue CREATEs for tables already present in the target database. �r0 r� Nr2 �r r/ r� r0 r] r] r^ � create_all� s �zMetaData.create_allc C s |j tj| ||d� dS )a? Drop all tables stored in this metadata. Conditional by default, will not attempt to drop tables not present in the target database. :param bind: A :class:`.Connection` or :class:`.Engine` used to access the database. :param tables: Optional list of ``Table`` objects, which is a subset of the total tables in the ``MetaData`` (others are ignored). :param checkfirst: Defaults to True, only issue DROPs for tables confirmed to be present in the target database. r� Nr6 r� r] r] r^ �drop_all� s �zMetaData.drop_all)NNNN)......)......)NFNFTT)NT)NT)rW rX rY r� r� r� r� r� rD r� r� r} r~ r r� rN r� r r� r3 r r� r� r] r] r] r^ r� � sd � 8 �" �" �" 9 � �r� c @ s� e Zd ZU dZdZded< eddd�d"d d d d �d d��Zddd d�dd�Zddd�dd�Z e � dd�dd�d dd d �d d ��Z dd�d dd d �d d!�Z dS )#r� a Defines a generated column, i.e. "GENERATED ALWAYS AS" syntax. The :class:`.Computed` construct is an inline construct added to the argument list of a :class:`_schema.Column` object:: from sqlalchemy import Computed Table('square', metadata_obj, Column('side', Float, nullable=False), Column('area', Float, Computed('side * side')) ) See the linked documentation below for complete details. .. versionadded:: 1.3.11 .. seealso:: :ref:`computed_ddl` Zcomputed_columnr� r# rQ z:class:`.Computed`z :paramref:`.Computed.sqltext`Nr< r� ry )rQ � persistedrd c C s t �tj|�| _|| _d| _dS )a Construct a GENERATED ALWAYS AS DDL construct to accompany a :class:`_schema.Column`. :param sqltext: A string containing the column generation expression, which will be used verbatim, or a SQL expression construct, such as a :func:`_expression.text` object. If given as a string, the object is converted to a :func:`_expression.text` object. :param persisted: Optional, controls how this column should be persisted by the database. Possible values are: * ``None``, the default, it will use the default persistence defined by the database. * ``True``, will render ``GENERATED ALWAYS AS ... STORED``, or the equivalent for the target database if supported. * ``False``, will render ``GENERATED ALWAYS AS ... VIRTUAL``, or the equivalent for the target database if supported. Specifying ``True`` or ``False`` may raise an error when the DDL is emitted to the target database if the database does not support that persistence option. Leaving this parameter at its default of ``None`` is guaranteed to succeed for all databases that support ``GENERATED ALWAYS AS``. N)r r� r rR rQ r� r# )r rQ r� r] r] r^ r� & s "zComputed.__init__r% r r* c K s` t |t�st�t |jtd �tf�r6t |jtd �tf�s@t�d��|| _ | |_ | | j _| | j _d S )NzPA generated column cannot specify a server_default or a server_onupdate argument) ro rp r� r rj r� rX r1 r~ r# rh r� r] r] r^ r, L s ���zComputed._set_parentr� rT r� c C s | S rn r] r� r] r] r^ rm [ s zComputed._as_for_updater� z_The :meth:`_schema.Computed.copy` method is deprecated and will be removed in a future release.rE rh rF c K s | j f d|i|��S rG r� rH r] r] r^ r� ^ s z Computed.copyc K s8 t | j| jd k r| jjnd |�}t|| jd�}| �|�S )N)r� )rv rQ r# rq r� r� r� )r rk rm rQ �gr] r] r^ rB h s �zComputed._copy)N)rW rX rY r� r� r� r& r� r, rm r3 rP r� rB r] r] r] r^ r� s( � �#���r� c @ s� e Zd ZdZdZdZd dddddddddddd d � d d �Zd dd d�dd�Zddd�dd�Ze � dd�dd d�dd��Z dd d�dd �Z dS ) r� a Defines an identity column, i.e. "GENERATED { ALWAYS | BY DEFAULT } AS IDENTITY" syntax. The :class:`.Identity` construct is an inline construct added to the argument list of a :class:`_schema.Column` object:: from sqlalchemy import Identity Table('foo', metadata_obj, Column('id', Integer, Identity()) Column('description', Text), ) See the linked documentation below for complete details. .. versionadded:: 1.4 .. seealso:: :ref:`identity_ddl` Zidentity_columnTFNr� r� r ry ) �always�on_nullr r r r r r r r r rd c C s4 t j| ||||||| | | d� || _|| _d| _dS )ah Construct a GENERATED { ALWAYS | BY DEFAULT } AS IDENTITY DDL construct to accompany a :class:`_schema.Column`. See the :class:`.Sequence` documentation for a complete description of most parameters. .. note:: MSSQL supports this construct as the preferred alternative to generate an IDENTITY on a column, but it uses non standard syntax that only support :paramref:`_schema.Identity.start` and :paramref:`_schema.Identity.increment`. All other parameters are ignored. :param always: A boolean, that indicates the type of identity column. If ``False`` is specified, the default, then the user-specified value takes precedence. If ``True`` is specified, a user-specified value is not accepted ( on some backends, like PostgreSQL, OVERRIDING SYSTEM VALUE, or similar, may be specified in an INSERT to override the sequence value). Some backends also have a default value for this parameter, ``None`` can be used to omit rendering this part in the DDL. It will be treated as ``False`` if a backend does not have a default value. :param on_null: Set to ``True`` to specify ON NULL in conjunction with a ``always=False`` identity column. This option is only supported on some backends, like Oracle. :param start: the starting index of the sequence. :param increment: the increment value of the sequence. :param minvalue: the minimum value of the sequence. :param maxvalue: the maximum value of the sequence. :param nominvalue: no minimum value of the sequence. :param nomaxvalue: no maximum value of the sequence. :param cycle: allows the sequence to wrap around when the maxvalue or minvalue has been reached. :param cache: optional integer value; number of future values in the sequence which are calculated in advance. :param order: optional boolean value; if true, renders the ORDER keyword. r N)r r� r� r� r# ) r r� r� r r r r r r r r r r] r] r^ r� � s ;� zIdentity.__init__r% r r* c K sv t |t�st�t |jtd �tf�r2t |jtd ��s<t�d��|j dkrPt�d��|| _ | |_ |j t krld|_| |_d S )Nz^A column with an Identity object cannot specify a server_default or a server_onupdate argumentFzCA column with an Identity object cannot specify autoincrement=False)ro rp r� r rj r� rX r1 r~ rT r# r rg r\ r r� r] r] r^ r, � s& ��� � zIdentity._set_parentrT r� c C s | S rn r] r� r] r] r^ rm � s zIdentity._as_for_updater� z_The :meth:`_schema.Identity.copy` method is deprecated and will be removed in a future release.r� c K s | j f |�S rn r� r� r] r] r^ r� � s z Identity.copyc K s> t | j| j| j| j| j| j| j| j| j | j | j d� }| � |�S )N) r� r� r r r r r r r r r ) r� r� r� r r r r r r r r r r� )r rm �ir] r] r^ rB � s �zIdentity._copy) FNNNNNNNNNN) rW rX rY r� r� r� r� r, rm r3 rP r� rB r] r] r] r^ r� u s. �&K�r� )NN)�r� � __future__r �abcr ru �enumr �operatorrL r r r r r r r r r r r r r ro r r r r r r� r r r r r �baser r r r r! r" r# r$ r% r& rV r' r( r) r* r+ r� r, r- r. r0 r1 r2 r3 r4 Z util.typingr5 r6 r7 r8 r9 r: Z_typingr; r< r= r> r? r@ r, rA rB Z functionsrC rD rE r� rF rG Zengine.interfacesrH rI rJ Z engine.mockrK Zengine.reflectionrL Zsql.selectablerM rN rP rR r- r_ r� Z_ServerDefaultArgumentZ_ServerOnUpdateArgumentrU rZ r� r[ r\ rf rv Z_self_inspectsZ VisitablerQ r� r� Z InspectablerS rp rZ r� r r� r� � attrgetterr� rl r� r� r r� r r� r rT rn r) r. rB rP rC r� r� rG Z_NamingSchemaCallablerm rl rq Z immutabledictrr r� r� r� r] r] r] r^ �<module> s� �#� � � -3 � ! 1 ��2 3 ?V& 49 <,s |o / i � Q �� � =j