관리-도구
편집 파일: selectable.cpython-38.pyc
U -?�f6� � @ sj d Z ddlmZ ddlZddlmZ ddlZddlmZ ddlm Z ddlm Z ddlm Z ddlm Z dd lm Z dd lmZ dd lmZ dd lmZ dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm 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.m/Z/ dd*l.m0Z0 dd+l1m2Z2 dd,l1m3Z3 dd-l1m4Z4 dd.l1m5Z5 dd/l1m6Z6 dd0l1m7Z7 dd1l1m8Z8 dd2l1m9Z9 dd3l1m:Z: dd4l1m;Z; dd5l1m<Z< dd6l1m=Z= dd7l1m>Z> dd8l1m?Z? dd9l1m@Z@ dd:l1mAZA dd;l1mBZB dd<l1mCZC dd=l1mDZD dd>l1mEZE dd?l1mFZF dd@l mGZG ddAlHmIZI ddBlHmJZJ ddClHmKZK ddDlHmLZL ddElHmMZM ddFlHmNZN ddGlHmOZO ddHlHmPZP ddIlHmQZQ ddJlHmRZR ddKlHmSZS ddLlHmTZT ddMl mUZU ddNlVmWZW ddOl$mXZX ddPl$mYZY ddQl$mZZZ dRdSl m[Z[ dRdTl m\Z\ dRdUl\m]Z] dRdVl^m_Z_ dRdWl^m`Z` dRdXl^maZa eKjbZbedYe dZ�Zce�r�dd[l%mdZd dd\l%meZe dd]l%mfZf dd^l%mgZg dd_l%mhZh dd`l%miZi ddal%mjZj ddbl%mkZk ddcl%mlZl dddl%mmZm ddel%mnZn ddfl%moZo ddgl%mpZp ddhl%mqZq ddil%mrZr ddjl%msZs ddkl%mtZt ddll%muZu ddml%mvZw ddnl%mxZx ddol1myZy ddpl1mzZz ddql1m{Z{ ddrl m|Z| ddsl}m~Z~ ddtlm�Z� ddulm�Z� ddvlHm�Z� ddwlHm�Z� ddxlHm�Z� ddylHm�Z� ddzlHm�Z� dd{l�m�Z� dd|l�m�Z� dd}l�m�Z� dd~lVm�Z� ddl#m�Z� dd�l$m�Z� e d�eOe d�f Z�e e d� gee� f Z�G d�d�� d�e`�Z�e d�e�f Z�e d�e�f Z�e e d� ed� f Z�ee�ee� ed� e e�e f f Z�ee d� Z�G d�d�� d�eJe� �Z�G d�d�� d�e!j�eP�Z�G d�d�� d�eBe��Z�G d�d�� d�e�ee( �Z�G d�d�� d�e��Z�G d�d�� d��Z�G d�d�� d��Z�G d�d�� d��Z�G d�d�� d�e!j�e��Z�G d�d�� d�e��Z�G d�d�� d�e�Z�e�e��\Z�Z�Z�Z�e�Z�G d�d�� d�e!j�e��Z�G d�d�� d��Z�G d�d�� d�e��Z�G d�d�� d�e�e��Z�G d�d�� d�e��Z�G d�d�� d�e!j�e��Z�G d�d�� d�e�e��Z�G d�d�� d�e�e��Z�G d�d�� d�e��Z�G d�d�� d�e!j�e!j�eCe�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!j�e��Z�G d�d�� d�e��Z�G d�d�� d�eQe��Z�G d�d�� d�e�e��Z�G d�d�� d�e!j�eFe��Z�e d�de�e e�e f f Z�G d�d d�eL�Z�G d�dń d�e!j�eCe��Z�G d�dDŽ d�e!j�eQeOe �Z�G d�dɄ d�e!j�e!j�e!j�e!j�e�e0e�� Z�ed�e�dZ�Z�G d�d̄ d�eQe�ee� �Z�G d�d΄ d�e�eC�Z�e@��d�dСG d�d҄ d�e@��Z�G d�dԄ d�e�Z�G d�dք d�eDe�e��Z�e�D ]Z�e�e�e�j�e҃ � q�e@��d�dסG d�dل d�e\j�e@��Z�G d�dۄ dۃZ�G d�d݄ d�e j�e"j�e$jڃZ�G d�d߄ d�e�e�e�eDe�e�e�e( � Z�G d�d� d�e!j�eCeQeOec �Z�G d�d� d�eTe� �Z�G d�d� d�e�e�eC�Z�e�Z�G d�d� d�e/�Z�dS )�ztThe :class:`_expression.FromClause` class of SQL expression elements, representing SQL tables and derived rowsets. � )� annotationsN)�Enum)� AbstractSet)�Any)�Callable)�cast)�Dict)�Generic)�Iterable)�Iterator)�List)� NamedTuple)�NoReturn)�Optional)�overload)�Sequence)�Set)�Tuple)�Type)� TYPE_CHECKING)�TypeVar)�Union� )� cache_key)� coercions)� operators)�roles)� traversals)�type_api)�visitors)�_ColumnsClauseArgument)�_no_kw)�_TP��is_column_element)�is_select_statement)� is_subquery)�is_table)�is_text_clause)� Annotated)�SupportsCloneAnnotations)�_clone)�_cloned_difference��_cloned_intersection��_entity_namespace_key)�_EntityNamespace)�_expand_cloned�� _from_objects)� _generative��_never_select_column)�_NoArg)�_select_iterables)�CacheableOptions)�ColumnCollection)� ColumnSet)� CompileState)�DedupeColumnCollection)� Executable)� Generative)�HasCompileState)� HasMemoized)� Immutable)�_document_text_coercion)�_anonymous_label)� BindParameter)�BooleanClauseList)� ClauseElement)� ClauseList)� ColumnClause)� ColumnElement)�DQLDMLClauseElement)�GroupedElement)�literal_column)�TableValuedColumn)�UnaryExpression)� OperatorType)�NULLTYPE)�_TraverseInternalsType)�InternalTraversal)�prefix_anon_map� )�exc)�util)�!HasMemoized_ro_memoized_attribute)�Literal)�Protocol)�Self�_T)�bound)�_ColumnExpressionArgument)�#_ColumnExpressionOrStrLabelArgument)�_FromClauseArgument)�_JoinTargetArgument)�_LimitOffsetType)� _MAYBE_ENTITY)� _NOT_ENTITY)�_OnClauseArgument)�#_SelectStatementForCompoundArgument)�_T0)�_T1)�_T2)�_T3)�_T4)�_T5)�_T6)�_T7)� _TextCoercedExpressionArgument)�_TypedColumnClauseArgument)�_TypeEngineArgument)�_AmbiguousTableNameMap)�ExecutableOption)�ReadOnlyColumnCollection)�_CacheKeyTraversalType)� SQLCompiler)�Delete)�Update)�BinaryExpression)�KeyedColumnElement)�Label)� NamedColumn)� TextClause)�Function)� ForeignKey)�ForeignKeyConstraint)�TableValueType)� TypeEngine)�_CloneCallableType� FromClauser~ )�ColumnElement[Any]r~ c @ s4 e Zd Zejdd�dd��Zejdd�dd��ZdS ) �_JoinTargetProtocol�List[FromClause]��returnc C s d S �N� ��selfr� r� �I/opt/hc_python/lib64/python3.8/site-packages/sqlalchemy/sql/selectable.pyr4 � s z!_JoinTargetProtocol._from_objectsr1 c C s d S r� r� r� r� r� r� �entity_namespace� s z$_JoinTargetProtocol.entity_namespaceN)�__name__� __module__� __qualname__rX �ro_non_memoized_propertyr4 r� r� r� r� r� r� � s r� �ColumnElement[bool])� _ColumnExpressionArgument[Any]ra r� c @ s" e Zd ZdZedd�dd��ZdS )�_OffsetLimitParamT� Optional[int]r� c C s | j S r� )Zeffective_valuer� r� r� r� �_limit_offset_value� s z%_OffsetLimitParam._limit_offset_valueN)r� r� r� � inherit_cache�propertyr� r� r� r� r� r� � s r� c @ s� e Zd ZdZdZdZdZdZdZe d d�dd��Z e j dd�dd ��Z d d d �d d�Zddd �dd�Zddd�dd�Ze dd�dd��ZdS )� ReturnsRowsa� The base-most class for Core constructs that have some concept of columns that can represent rows. While the SELECT statement and TABLE are the primary things we think of in this category, DML like INSERT, UPDATE and DELETE can also specify RETURNING which means they can be used in CTEs and other forms, and PostgreSQL has functions that return rows also. .. versionadded:: 1.4 TFr� c C s | S r� r� r� r� r� r� � selectable� s zReturnsRows.selectable�_SelectIterablec C s t � �dS )aE A sequence of column expression objects that represents the "selected" columns of this :class:`_expression.ReturnsRows`. This is typically equivalent to .exported_columns except it is delivered in the form of a straight sequence and not keyed :class:`_expression.ColumnCollection`. N��NotImplementedErrorr� r� r� r� �_all_selected_columns� s z!ReturnsRows._all_selected_columns�Optional[FromClause]�bool�� fromclauser� c C s t � �dS )z�Return ``True`` if this :class:`.ReturnsRows` is 'derived' from the given :class:`.FromClause`. An example would be an Alias of a Table is derived from that Table. Nr� �r� r� r� r� r� �is_derived_from� s zReturnsRows.is_derived_fromr� �Nonec C s t � �dS )z=Populate columns into an :class:`.AliasedReturnsRows` object.Nr� r� r� r� r� �#_generate_fromclause_column_proxies� s z/ReturnsRows._generate_fromclause_column_proxiesr� ��columnr� c C s t � �dS )z>reset internal collections for an incoming column being added.Nr� �r� r� r� r� r� �_refresh_for_new_column� s z#ReturnsRows._refresh_for_new_columnz"ReadOnlyColumnCollection[Any, Any]c C s t � �dS )a A :class:`_expression.ColumnCollection` that represents the "exported" columns of this :class:`_expression.ReturnsRows`. The "exported" columns represent the collection of :class:`_expression.ColumnElement` expressions that are rendered by this SQL construct. There are primary varieties which are the "FROM clause columns" of a FROM clause, such as a table, join, or subquery, the "SELECTed columns", which are the columns in the "columns clause" of a SELECT statement, and the RETURNING columns in a DML statement.. .. versionadded:: 1.4 .. seealso:: :attr:`_expression.FromClause.exported_columns` :attr:`_expression.SelectBase.exported_columns` Nr� r� r� r� r� �exported_columns� s z ReturnsRows.exported_columnsN)r� r� r� �__doc__Z_is_returns_rows�_is_from_clause�_is_select_base�_is_select_statement� _is_lateralr� r� rX r� r� r� r� r� r� r� r� r� r� r� � s r� c @ s e Zd ZdZdS )�ExecutableReturnsRows�0base for executable statements that return rows.N�r� r� r� r� r� r� r� r� r� s r� c @ s e Zd ZdZdS )�TypedReturnsRowsr� Nr� r� r� r� r� r� s r� c @ sx e Zd ZdZdZdZddd�dd�Zd d d d �d d�Zej ddd�e� d�dddd�dd���Z d!ddd d �d d �Z d S )"� Selectablez!Mark a class as being selectable.r� Tr� r� r� c C s t � �d S r� r� r� r� r� r� r� ' s z"Selectable._refresh_for_new_columnN� Optional[str]�LateralFromClause��namer� c C s t j| |d�S )�; Return a LATERAL alias of this :class:`_expression.Selectable`. The return value is the :class:`_expression.Lateral` construct also provided by the top-level :func:`_expression.lateral` function. .. seealso:: :ref:`tutorial_lateral_correlation` - overview of usage. �r� )�Lateral� _construct�r� r� r� r� r� �lateral* s zSelectable.lateral�1.4z�The :meth:`.Selectable.replace_selectable` method is deprecated, and will be removed in a future release. Similar functionality is available via the sqlalchemy.sql.visitors module.)�message�sqlalchemy.sql.utilr� �Aliasr\ )�old�aliasr� c C s t jj�|��| �S )z�Replace all occurrences of :class:`_expression.FromClause` 'old' with the given :class:`_expression.Alias` object, returning a copy of this :class:`_expression.FromClause`. )rX � preloaded�sql_util� ClauseAdapter�traverse)r� r� r� r� r� r� �replace_selectable7 s z Selectable.replace_selectableFzKeyedColumnElement[Any]r� z!Optional[KeyedColumnElement[Any]])r� �require_embeddedr� c C s | j �||�S )a� Given a :class:`_expression.ColumnElement`, return the exported :class:`_expression.ColumnElement` object from the :attr:`_expression.Selectable.exported_columns` collection of this :class:`_expression.Selectable` which corresponds to that original :class:`_expression.ColumnElement` via a common ancestor column. :param column: the target :class:`_expression.ColumnElement` to be matched. :param require_embedded: only return corresponding columns for the given :class:`_expression.ColumnElement`, if the given :class:`_expression.ColumnElement` is actually present within a sub-element of this :class:`_expression.Selectable`. Normally the column will match if it merely shares a common ancestor with one of the exported columns of this :class:`_expression.Selectable`. .. seealso:: :attr:`_expression.Selectable.exported_columns` - the :class:`_expression.ColumnCollection` that is used for the operation. :meth:`_expression.ColumnCollection.corresponding_column` - implementation method. )r� �corresponding_column)r� r� r� r� r� r� r� F s # �z Selectable.corresponding_column)N)F) r� r� r� r� �__visit_name__� is_selectabler� r� rX � deprecated�preload_moduler� r� r� r� r� r� r� s � �r� c @ sV e Zd ZU dZded< dejfgZded< ee ddd�d d �d d d d�dd���Z dS )� HasPrefixesr� �+Tuple[Tuple[DQLDMLClauseElement, str], ...]� _prefixesrS � _has_prefixes_traverse_internals�prefixesz+:meth:`_expression.HasPrefixes.prefix_with`z.:paramref:`.HasPrefixes.prefix_with.*prefixes`�*��dialect�#_TextCoercedExpressionArgument[Any]�strr\ )r� r� r� c s" | j t� fdd�|D �� | _ | S )a� Add one or more expressions following the statement keyword, i.e. SELECT, INSERT, UPDATE, or DELETE. Generative. This is used to support backend-specific prefix keywords such as those provided by MySQL. E.g.:: stmt = table.insert().prefix_with("LOW_PRIORITY", dialect="mysql") # MySQL 5.7 optimizer hints stmt = select(table).prefix_with( "/*+ BKA(t1) */", dialect="mysql") Multiple prefixes can be specified by multiple calls to :meth:`_expression.HasPrefixes.prefix_with`. :param \*prefixes: textual or :class:`_expression.ClauseElement` construct which will be rendered following the INSERT, UPDATE, or DELETE keyword. :param dialect: optional string dialect name which will limit rendering of this prefix to only that dialect. c s g | ]}t �tj|�� f�qS r� �r �expectr ZStatementOptionRole��.0�pr� r� r� � <listcomp>� s �z+HasPrefixes.prefix_with.<locals>.<listcomp>)r� �tuple)r� r� r� r� r� r� � prefix_withu s $ ��zHasPrefixes.prefix_withN) r� r� r� r� �__annotations__rT �dp_prefix_sequencer� r5 rD r� r� r� r� r� r� n s � ��r� c @ sV e Zd ZU dZded< dejfgZded< ee ddd�d d �d d d d�dd���Z dS )� HasSuffixesr� r� � _suffixesrS � _has_suffixes_traverse_internals�suffixesz+:meth:`_expression.HasSuffixes.suffix_with`z.:paramref:`.HasSuffixes.suffix_with.*suffixes`r� r� r� r� r\ )r� r� r� c s" | j t� fdd�|D �� | _ | S )a� Add one or more expressions following the statement as a whole. This is used to support backend-specific suffix keywords on certain constructs. E.g.:: stmt = select(col1, col2).cte().suffix_with( "cycle empno set y_cycle to 1 default 0", dialect="oracle") Multiple suffixes can be specified by multiple calls to :meth:`_expression.HasSuffixes.suffix_with`. :param \*suffixes: textual or :class:`_expression.ClauseElement` construct which will be rendered following the target clause. :param dialect: Optional string dialect name which will limit rendering of this suffix to only that dialect. c s g | ]}t �tj|�� f�qS r� r� r� r� r� r� r� � s �z+HasSuffixes.suffix_with.<locals>.<listcomp>)r� r� )r� r� r� r� r� r� � suffix_with� s ��zHasSuffixes.suffix_withN) r� r� r� r� r� rT r� r� r5 rD r� r� r� r� r� r� � s � ��r� c @ s� e Zd ZU e�� Zded< dZded< dej fdej fgZ ded< dd d d d �d d �Z e ddd d d d�dd��Zdd d d d�dd�ZdS )�HasHintsz/util.immutabledict[Tuple[FromClause, str], str]�_hintsr� zTuple[Tuple[str, str], ...]�_statement_hintsrS � _has_hints_traverse_internalsr� r� r\ )�text� dialect_namer� c C s | � d||�S )a� Add a statement hint to this :class:`_expression.Select` or other selectable object. This method is similar to :meth:`_expression.Select.with_hint` except that it does not require an individual table, and instead applies to the statement as a whole. Hints here are specific to the backend database and may include directives such as isolation levels, file directives, fetch directives, etc. .. seealso:: :meth:`_expression.Select.with_hint` :meth:`_expression.Select.prefix_with` - generic SELECT prefixing which also can suit some database-specific HINT syntaxes such as MySQL optimizer hints N�� _with_hint)r� r� r� r� r� r� �with_statement_hint� s z HasHints.with_statement_hintra )r� r� r� r� c C s | � |||�S )a� Add an indexing or other executional context hint for the given selectable to this :class:`_expression.Select` or other selectable object. The text of the hint is rendered in the appropriate location for the database backend in use, relative to the given :class:`_schema.Table` or :class:`_expression.Alias` passed as the ``selectable`` argument. The dialect implementation typically uses Python string substitution syntax with the token ``%(name)s`` to render the name of the table or alias. E.g. when using Oracle, the following:: select(mytable).\ with_hint(mytable, "index(%(name)s ix_mytable)") Would render SQL as:: select /*+ index(mytable ix_mytable) */ ... from mytable The ``dialect_name`` option will limit the rendering of a particular hint to a particular backend. Such as, to add hints for both Oracle and Sybase simultaneously:: select(mytable).\ with_hint(mytable, "index(%(name)s ix_mytable)", 'oracle').\ with_hint(mytable, "WITH INDEX ix_mytable", 'mssql') .. seealso:: :meth:`_expression.Select.with_statement_hint` r� �r� r� r� r� r� r� r� � with_hint� s *zHasHints.with_hintz Optional[_FromClauseArgument]c C sB |d kr | j ||ff7 _ n | j�t�tj|�|f|i�| _| S r� )r� r� �unionr r� r �FromClauseRoler� r� r� r� r� s ���zHasHints._with_hintN)r� )r� )r� r� r� rX Z immutabledictr� r� r� rT Zdp_statement_hint_listZdp_table_hint_listr� r� r5 r� r� r� r� r� r� r� � s � � �+r� c @ s e Zd ZU dZdZdZejdd�dd��Zde d < d e d < d Z d e d< dZ dZ dZ dZdd�dd�ZdZdddddd�dd�Zd[ddddd�dd �Zd\d dd d �d d �Zd]d!d d"d#d$�d%d&�Zddd'�d(d)�Zd dd*�d+d,�Zejd-d�d.d/��Zd d0d'�d1d2�Zejd3d�d4d5��Zejd3d�d6d7��Zejd3d�d8d9��Zejd:d�d;d<��Z ejd=d�d>d?��Z ejd@d�dAdB��Z d0d�dCdD�Z ejdEd�dFdG��Z d0d�dHdI�Z!e"dd�dJdK��Z#d0d�dLdM�Z$dNd0dO�dPdQ�Z%d ddR�d dd d �dSdT�Z&e'�r d^dUdVdW�dXdY�Z(d S )_r� aE Represent an element that can be used within the ``FROM`` clause of a ``SELECT`` statement. The most common forms of :class:`_expression.FromClause` are the :class:`_schema.Table` and the :func:`_expression.select` constructs. Key features common to all :class:`_expression.FromClause` objects include: * a :attr:`.c` collection, which provides per-name access to a collection of :class:`_expression.ColumnElement` objects. * a :attr:`.primary_key` attribute, which is a collection of all those :class:`_expression.ColumnElement` objects that indicate the ``primary_key`` flag. * Methods to generate various derivations of a "from" clause, including :meth:`_expression.FromClause.alias`, :meth:`_expression.FromClause.join`, :meth:`_expression.FromClause.select`. r� F�Iterable[FromClause]r� c C s dS �Nr� r� r� r� r� r� � _hide_fromsL s zFromClause._hide_fromsr� � _is_clone_ofzColumnCollection[Any, Any]�_columnsNr� �schemaT� Select[Any]c C s t | �S )a# Return a SELECT of this :class:`_expression.FromClause`. e.g.:: stmt = some_table.select().where(some_table.c.id == 5) .. seealso:: :func:`_expression.select` - general purpose method which allows for arbitrary column lists. ��Selectr� r� r� r� �selectc s zFromClause.selectra z)Optional[_ColumnExpressionArgument[bool]]r� �Join)�right�onclause�isouter�fullr� c C s t | ||||�S )aa Return a :class:`_expression.Join` from this :class:`_expression.FromClause` to another :class:`FromClause`. E.g.:: from sqlalchemy import join j = user_table.join(address_table, user_table.c.id == address_table.c.user_id) stmt = select(user_table).select_from(j) would emit SQL along the lines of:: SELECT user.id, user.name FROM user JOIN address ON user.id = address.user_id :param right: the right side of the join; this is any :class:`_expression.FromClause` object such as a :class:`_schema.Table` object, and may also be a selectable-compatible object such as an ORM-mapped class. :param onclause: a SQL expression representing the ON clause of the join. If left at ``None``, :meth:`_expression.FromClause.join` will attempt to join the two tables based on a foreign key relationship. :param isouter: if True, render a LEFT OUTER JOIN, instead of JOIN. :param full: if True, render a FULL OUTER JOIN, instead of LEFT OUTER JOIN. Implies :paramref:`.FromClause.join.isouter`. .. seealso:: :func:`_expression.join` - standalone function :class:`_expression.Join` - the type of object produced �r )r� r r r r r� r� r� �joins s 0zFromClause.join)r r r r� c C s t | ||d|�S )a� Return a :class:`_expression.Join` from this :class:`_expression.FromClause` to another :class:`FromClause`, with the "isouter" flag set to True. E.g.:: from sqlalchemy import outerjoin j = user_table.outerjoin(address_table, user_table.c.id == address_table.c.user_id) The above is equivalent to:: j = user_table.join( address_table, user_table.c.id == address_table.c.user_id, isouter=True) :param right: the right side of the join; this is any :class:`_expression.FromClause` object such as a :class:`_schema.Table` object, and may also be a selectable-compatible object such as an ORM-mapped class. :param onclause: a SQL expression representing the ON clause of the join. If left at ``None``, :meth:`_expression.FromClause.join` will attempt to join the two tables based on a foreign key relationship. :param full: if True, render a FULL OUTER JOIN, instead of LEFT OUTER JOIN. .. seealso:: :meth:`_expression.FromClause.join` :class:`_expression.Join` Tr )r� r r r r� r� r� � outerjoin� s /zFromClause.outerjoin�NamedFromClause�r� �flatr� c C s t j| |d�S )at Return an alias of this :class:`_expression.FromClause`. E.g.:: a2 = some_table.alias('a2') The above code creates an :class:`_expression.Alias` object which can be used as a FROM clause in any SELECT statement. .. seealso:: :ref:`tutorial_using_aliases` :func:`_expression.alias` r� )r� r� �r� r� r r� r� r� r� � s zFromClause.alias�Union[float, Function[Any]]�*Optional[roles.ExpressionElementRole[Any]]� TableSample)�samplingr� �seedr� c C s t j| |||d�S )aW Return a TABLESAMPLE alias of this :class:`_expression.FromClause`. The return value is the :class:`_expression.TableSample` construct also provided by the top-level :func:`_expression.tablesample` function. .. seealso:: :func:`_expression.tablesample` - usage guidelines and parameters )r r� r )r r� )r� r r� r r� r� r� � tablesample� s �zFromClause.tablesampler� c C s || j kS )z�Return ``True`` if this :class:`_expression.FromClause` is 'derived' from the given ``FromClause``. An example would be an Alias of a Table is derived from that Table. )� _cloned_setr� r� r� r� r� s zFromClause.is_derived_from��otherr� c C s t | j�|j��S )z�Return ``True`` if this :class:`_expression.FromClause` and the other represent the same lexical identity. This tests if either one is a copy of the other, or if they are the same via annotation identity. )r� r � intersection�r� r r� r� r� �_is_lexical_equivalent s z!FromClause._is_lexical_equivalentr� c C s t | d| jjd �S )z|A brief description of this :class:`_expression.FromClause`. Used primarily for error message formatting. r� z object)�getattr� __class__r� r� r� r� r� � description s zFromClause.descriptionr� c s � j �� fdd�| jD �� d S )Nc 3 s | ]}|� � �V qd S r� �� _make_proxy�r� �col�r� r� r� � <genexpr>$ s zAFromClause._generate_fromclause_column_proxies.<locals>.<genexpr>)r� �_populate_separate_keys�cr� r� r# r� r� ! s �z.FromClause._generate_fromclause_column_proxies�6ReadOnlyColumnCollection[str, KeyedColumnElement[Any]]c C s | j S )a� A :class:`_expression.ColumnCollection` that represents the "exported" columns of this :class:`_expression.Selectable`. The "exported" columns for a :class:`_expression.FromClause` object are synonymous with the :attr:`_expression.FromClause.columns` collection. .. versionadded:: 1.4 .. seealso:: :attr:`_expression.Selectable.exported_columns` :attr:`_expression.SelectBase.exported_columns` �r& r� r� r� r� r� ( s zFromClause.exported_columnsc C s | j S )a� A named-based collection of :class:`_expression.ColumnElement` objects maintained by this :class:`_expression.FromClause`. The :attr:`.columns`, or :attr:`.c` collection, is the gateway to the construction of SQL expressions using table-bound or other selectable-bound columns:: select(mytable).where(mytable.c.somecolumn == 5) :return: a :class:`.ColumnCollection` object. r( r� r� r� r� �columns@ s zFromClause.columnsc C s$ d| j kr| �� | �� | j�� S )zk A synonym for :attr:`.FromClause.columns` :return: a :class:`.ColumnCollection` r� )�__dict__�_init_collections�_populate_column_collectionr� � as_readonlyr� r� r� r� r& R s z FromClause.cr1 c C s | j S )a� Return a namespace used for name-based access in SQL expressions. This is the namespace that is used to resolve "filter_by()" type expressions, such as:: stmt.filter_by(address='some address') It defaults to the ``.c`` collection, however internally it can be overridden using the "entity_namespace" annotation to deliver alternative results. r( r� r� r� r� r� _ s zFromClause.entity_namespace�Iterable[NamedColumn[Any]]c C s | � � | �� | jS )ap Return the iterable collection of :class:`_schema.Column` objects which comprise the primary key of this :class:`_selectable.FromClause`. For a :class:`_schema.Table` object, this collection is represented by the :class:`_schema.PrimaryKeyConstraint` which itself is an iterable collection of :class:`_schema.Column` objects. )r+ r, � primary_keyr� r� r� r� r/ o s zFromClause.primary_key�Iterable[ForeignKey]c C s | � � | �� | jS )aV Return the collection of :class:`_schema.ForeignKey` marker objects which this FromClause references. Each :class:`_schema.ForeignKey` is a member of a :class:`_schema.Table`-wide :class:`_schema.ForeignKeyConstraint`. .. seealso:: :attr:`_schema.Table.foreign_key_constraints` )r+ r, � foreign_keysr� r� r� r� r1 } s zFromClause.foreign_keysc C s dD ]}| j �|d� qdS )a Reset the attributes linked to the ``FromClause.c`` attribute. This collection is separate from all the other memoized things as it has shown to be sensitive to being cleared out in situations where enclosing code, typically in a replacement traversal scenario, has already established strong relationships with the exported columns. The collection is cleared for the case where a table is having a column added to it as well as within a Join during copy internals. )r� r) r& r/ r1 N)r* �pop)r� �keyr� r� r� �_reset_column_collection� s z#FromClause._reset_column_collectionr� c C s dd� | j D �S )Nc s s | ]}t |�s|V qd S r� r6 �r� r& r� r� r� r$ � s z.FromClause._select_iterable.<locals>.<genexpr>r( r� r� r� r� �_select_iterable� s zFromClause._select_iterablec C sF d| j kst�d| j ks t�d| j ks*t�t� | _t� | _t� | _d S )Nr� r/ r1 )r* �AssertionErrorr; r� r< r/ �setr1 r� r� r� r� r+ � s z FromClause._init_collectionsc C s d| j kS )Nr� )r* r� r� r� r� �_cols_populated� s zFromClause._cols_populatedc C s dS )z�Called on subclasses to establish the .c collection. Each implementation has a different way of establishing this collection. Nr� r� r� r� r� r, � s z&FromClause._populate_column_collectionr� r� c C s | � � dS )aN Given a column added to the .c collection of an underlying selectable, produce the local version of that column, assuming this selectable ultimately should proxy this column. this is used to "ping" a derived selectable to add a new column to its .c. collection when a Column has been added to one of the Table objects it ultimately derives from. If the given selectable hasn't populated its .c. collection yet, it should at least pass on the message to the contained selectables, but it will return None. This method is currently used by Declarative to allow Table columns to be added to a partially constructed inheritance mapping that may have already produced joins. The method isn't public right now, as the full span of implications and/or caveats aren't yet clear. It's also possible that this functionality could be invoked by default via an event, which would require that selectables maintain a weak referencing collection of all derivations. N)r4 r� r� r� r� r� � s z"FromClause._refresh_for_new_column�r� r c C s | j |d�S �Nr� )r� r r� r� r� �_anonymous_fromclause� s z FromClause._anonymous_fromclause�Optional[OperatorType]zUnion[FromGrouping, Self]��againstr� c C s d S r� r� �r� r? r� r� r� � self_group� s zFromClause.self_group)NFF)NF)NF)NN)N))r� r� r� r� r� �named_with_columnrX r� r� r� r� r� r� �_is_joinZ_use_schema_mapr r r r� r r� r r r� r� r) �ro_memoized_propertyr& r� r/ r1 r4 r6 r+ r� r9 r, r� r< r rA r� r� r� r� r� 4 sr �5 �2 � � � �c @ s6 e Zd ZU dZdZded< e�d�dd�dd ��Zd S ) r z�A :class:`.FromClause` that has a name. Examples include tables, subqueries, CTEs, aliased tables. .. versionadded:: 2.0 Tr� r� zsqlalchemy.sql.sqltypes�TableValuedColumn[Any]r� c C s t | tj�S )ap Return a :class:`_sql.TableValuedColumn` object for this :class:`_expression.FromClause`. A :class:`_sql.TableValuedColumn` is a :class:`_sql.ColumnElement` that represents a complete row in a table. Support for this construct is backend dependent, and is supported in various forms by backends such as PostgreSQL, Oracle and SQL Server. E.g.: .. sourcecode:: pycon+sql >>> from sqlalchemy import select, column, func, table >>> a = table("a", column("id"), column("x"), column("y")) >>> stmt = select(func.row_to_json(a.table_valued())) >>> print(stmt) {printsql}SELECT row_to_json(a) AS row_to_json_1 FROM a .. versionadded:: 1.4.0b2 .. seealso:: :ref:`tutorial_functions` - in the :ref:`unified_tutorial` )rO r � TABLEVALUEr� r� r� r� � table_valued� s z NamedFromClause.table_valuedN) r� r� r� r� rB r� rX r� rG r� r� r� r� r � s r c @ s$ e Zd ZdZdZdZdZeZdZdS )�SelectLabelStylezTLabel style constants that may be passed to :meth:`_sql.Select.set_label_style`.r r rV � N) r� r� r� r� �LABEL_STYLE_NONE� LABEL_STYLE_TABLENAME_PLUS_COL� LABEL_STYLE_DISAMBIGUATE_ONLY�LABEL_STYLE_DEFAULTZLABEL_STYLE_LEGACY_ORMr� r� r� r� rH s rH c s� e Zd ZU dZdZdejfdejfdejfdejfdejfgZde d < d Z d e d< d e d< d e d< d e d< d e d< dSdddd d d�dd�Z e j dd�dd��Zdd d�dd �ZdTd d d �d d!�Ze �d"�d#d�d$d%��Zefd&d'd#d(�� fd)d*� Zd+d#d,�� fd-d.� Zd d d/d0�d1d2�Zeddd3�d d dd4d/d5�d6d7��Zedd8�d d d4d d9�d:d;��Zee �d"�d dd d4d<d=�d>d?���Zed d d@dAd#dB�dCdD��ZdEd�dFdG�Z e �d"�dUdHd dIdJ�dKdL��Z e j dMd�dNdO��Z e j dPd�dQdR��Z � Z S )Vr a� Represent a ``JOIN`` construct between two :class:`_expression.FromClause` elements. The public constructor function for :class:`_expression.Join` is the module-level :func:`_expression.join()` function, as well as the :meth:`_expression.FromClause.join` method of any :class:`_expression.FromClause` (e.g. such as :class:`_schema.Table`). .. seealso:: :func:`_expression.join` :meth:`_expression.FromClause.join` r �leftr r r r rS �_traverse_internalsTr� z Optional[ColumnElement[bool]]r� NFra �Optional[_OnClauseArgument])rN r r r r c C sj t �tj|�| _t �tj|��� | _|dkr@| �| j| j�| _nt �tj |�jt j d�| _|| _ || _ dS )z�Construct a new :class:`_expression.Join`. The usual entrypoint here is the :func:`_expression.join` function or the :meth:`_expression.FromClause.join` method of any :class:`_expression.FromClause` object. N�r? )r r� r r� rN rA r �_match_primariesr � OnClauseRoler Z_asboolr r )r� rN r r r r r� r� r� �__init__� s$ �� ��z Join.__init__r� r� c C s$ d| j jt| j �| jjt| j�f S )Nz Join object on %s(%d) and %s(%d))rN r �idr r� r� r� r� r � s �zJoin.descriptionr� r� c C s( t |�t | �kp&| j�|�p&| j�|�S r� )�hashrN r� r r� r� r� r� r� � s � �zJoin.is_derived_fromr= � FromGroupingr> c C s t | �S r� )rW r@ r� r� r� rA � s zJoin.self_groupr� r� c C s� t jj}dd� | jjD �dd� | jjD � }| j�|�dd� |D �| j �� | j � dd� |D �� | j � tjdd� |D �� � d S )Nc S s g | ]}|�qS r� r� r5 r� r� r� r� � s z4Join._populate_column_collection.<locals>.<listcomp>c s s | ]}|j r|V qd S r� )r/ r5 r� r� r� r$ � s z3Join._populate_column_collection.<locals>.<genexpr>c s s | ]}|j |fV qd S r� )� _tq_key_labelr! r� r� r� r$ � s c S s g | ] }|j �qS r� )r1 r! r� r� r� r� � s )rX r� r� rN r& r r/ �extend�reduce_columnsr r� r% r1 �update� itertools�chain)r� �sqlutilr) r� r� r� r, � s � �� ��z Join._populate_column_collectionr� r ��clone�kwr� c sp t t�t| j�t| j���}� �fdd�|D ��dddd��fdd� }|�d < t� jf d � i��� | �� d S ) Nc s i | ]}|� |f���qS r� r� �r� �f�r` ra r� r� � <dictcomp> s z(Join._copy_internals.<locals>.<dictcomp>�/Union[BinaryExpression[Any], ColumnClause[Any]]r �0Optional[KeyedColumnElement[ColumnElement[Any]]]��objra r� c s, t | t�r(| j� kr(� | j �| �}|S d S r� �� isinstancerJ �tabler� �ri ra Znewelem�� new_fromsr� r� �replace s z%Join._copy_internals.<locals>.replacerp r` ) r8 r\ r] r4 rN r �super�_copy_internals�_reset_memoizations)r� r` ra � all_the_fromsrp �r �r` ra ro r� rr � s �� zJoin._copy_internalsr� r� c s( t � �|� | j�|� | j�|� d S r� )rq r� rN r r� ru r� r� r� s z Join._refresh_for_new_columnr� )rN r r� c C s& t |t�r|j}nd }| j|||d�S )N)�a_subset)rk r r �_join_condition)r� rN r � left_rightr� r� r� rR s zJoin._match_primaries)rw �consider_as_foreign_keysz(Optional[AbstractSet[ColumnClause[Any]]])�a�brw rz r� c C s� | � ||||�}t|�dkr,| �||||� t|�dkrdt|t�rHd}nd}t�d|j|j|f ��dd� t|� � �d D �}t|�dkr�|d S t |� S dS ) z�Create a join condition between two tables or selectables. See sqlalchemy.sql.util.join_condition() for full docs. r r zI Perhaps you meant to convert the right side to a subquery using alias()?� zACan't find any foreign key relationships between '%s' and '%s'.%sc S s g | ]\}}||k�qS r� r� )r� �x�yr� r� r� r� P s z(Join._join_condition.<locals>.<listcomp>N) �_joincond_scan_left_right�len�_joincond_trim_constraintsrk rW rW ZNoForeignKeysErrorr �list�values�and_)�clsr{ r| rw rz � constraints�hint�critr� r� r� rx ) s6 � � � �� zJoin._join_condition)rz )rN r rz r� c C s0 t |t�r|j}nd }| j||||d�}t|�S )N)r{ r| rw rz )rk r r r� r� )r� rN r rz ry r� r� r� r� � _can_joinV s �zJoin._can_joinzjcollections.defaultdict[Optional[ForeignKeyConstraint], List[Tuple[ColumnClause[Any], ColumnClause[Any]]]])r{ rw r| rz r� c C s� t jj}t�tj|�}t�tj|�}t�t �}||fD �]�}|d krFq6t |j dd� d�D ]�}|d k rp|j |krpqXz|� |�} W nN tjk r� } z.dd� |�|�D �} | j| kr�� nW Y �qXW 5 d } ~ X Y nX | d k rX||j �| |j f� qX||k �r�t |j dd� d�D ]�}|d k �r(|j |k�r(�q z|� |�} W nT tjk �r� } z2dd� |�|�D �} | j| k�rp� n W Y ��q W 5 d } ~ X Y nX | d k �r ||j �| |j f� �q |r6 �q�q6|S )Nc S s | j jS r� ��parentZ_creation_order��fkr� r� r� �<lambda>� � z0Join._joincond_scan_left_right.<locals>.<lambda>�r3 c S s h | ] }|j �qS r� r� �r� �tr� r� r� � <setcomp>� s z1Join._joincond_scan_left_right.<locals>.<setcomp>c S s | j jS r� r� r� r� r� r� r� � r� c S s h | ] }|j �qS r� r� r� r� r� r� r� � s )rX r� r� r r� r r� � collections� defaultdictr� �sortedr1 r� Z get_referentrW ZNoReferenceErrorZ find_tablesZ table_name� constraint�append) r� r{ rw r| rz r� r� rN r� r" ZnrteZ table_namesr� r� r� r� n s` �� �� � �� z Join._joincond_scan_left_rightzDict[Any, Any]z Optional[Any])r{ r| r� rz r� c C s� |r0t |�D ]"}dd� |jD �t|�kr ||= q t|�dkrrdd� |�� D �}t|�dkrrt |�d }||| i}t|�dkr�t�d|j|jf ��d S )Nc S s h | ] }|j �qS r� )r� rb r� r� r� r� � s z2Join._joincond_trim_constraints.<locals>.<setcomp>r c S s h | ] }t |��qS r� )r� )r� r� r� r� r� r� � s r z�Can't determine join between '%s' and '%s'; tables have more than one foreign key constraint relationship between them. Please specify the 'onclause' of this join explicitly.)r� �elementsr8 r� r� rW ZAmbiguousForeignKeysErrorr )r� r{ r| r� rz �const�deduper3 r� r� r� r� � s" � ��z Join._joincond_trim_constraintsr c C s t | j| j��| �S )a� Create a :class:`_expression.Select` from this :class:`_expression.Join`. E.g.:: stmt = table_a.join(table_b, table_a.c.id == table_b.c.a_id) stmt = stmt.select() The above will produce a SQL string resembling:: SELECT table_a.id, table_a.col, table_b.id, table_b.a_id FROM table_a JOIN table_b ON table_a.id = table_b.a_id )r rN r � select_fromr� r� r� r� r � s z Join.selectr� �TODO_Anyr c C s� t jj}|r�t| jttf�r"|}n(|rFt| jt�rF|� d| jj� �}n|}t| j ttf�r`|}n(|r�t| j t�r�|� d| j j� �}n|}| jj ||d�| j j ||d� }}|� |�� |� |��}|j ||�| j�| j| jd�S | �� �t��d ��|�S d S )N�_r: �r r )rX r� r� rk rN rW r r r� r r< r� r] r r� r r r r �set_label_stylerK � correlater� ) r� r� r r^ Z left_nameZ right_nameZleft_aZright_a�adapterr� r� r� r< � s@ � � �����zJoin._anonymous_fromclauser� c C s t jdd� | jD �� S )Nc S s g | ]}t |j|j��qS r� )r4 rN r )r� r~ r� r� r� r� s z$Join._hide_froms.<locals>.<listcomp>)r\ r] r r� r� r� r� r� s �zJoin._hide_fromsr� c C s | g}|| j j | jj S r� )rN r4 r )r� Z self_listr� r� r� r4 s zJoin._from_objects)NFF)N)NF)!r� r� r� r� r� rT �dp_clauseelement� dp_booleanrO r� rC rT rX r� r r� rA r� r, r+ rr r� rR � classmethodrx r� r� r� r r< r� r4 � __classcell__r� r� ru r� r t sd � �. ��' � ,�D" �)r c @ s e Zd Zddd�dd�ZdS )�NoInitr )�argra c O s* t d| jj| jj�� | jj�� f ��d S )Nz�The %s class is not intended to be constructed directly. Please use the %s() standalone function or the %s() method available from appropriate selectable objects.)r� r r� �lower�r� r� ra r� r� r� rT s ���zNoInit.__init__N)r� r� r� rT r� r� r� r� r� s r� c @ s e Zd ZdZdS )r� z>mark a FROM clause as being able to render directly as LATERALNr� r� r� r� r� r� . s r� c s e Zd ZU dZdZdZded< dejfdej fgZ ded< e d d �d d d d d�dd��Z d d �d d dd�dd�Z ddd�� fdd� Zdd�dd�Zejd d�d d ��Zejd d�d d!��Zedd�d"d#��Zd$d d%�d&d'�Zefd(d dd)�� fd*d+� Zed,d�d-d.��Z� ZS )/�AliasedReturnsRowszLBase class of aliases against tables, subqueries, and other selectables.TFr� �elementr� rS rO Nr� r r� r\ )r� r� ra r� c K s$ | � | �}|j|fd|i|�� |S )Nr� )�__new__�_init)r� r� r� ra ri r� r� r� r� K s z AliasedReturnsRows._constructr� �r� r� r� c C sp t jtj|| d�| _|| _|| _|d krft|t�rR|jrRt |dd �}t|t �rRd }t � t | �|pbd�}|| _ d S )N�Zapply_propagate_attrsr� �anon)r r� r �ReturnsRowsRoler� Z _orig_namerk r� rB r rE �safe_constructrU r� )r� r� r� r� r� r� r� W s" ��� zAliasedReturnsRows._initr� r� c s t � �|� | j�|� d S r� )rq r� r� r� ru r� r� r� h s z*AliasedReturnsRows._refresh_for_new_columnr� c C s | j �| � d S r� �r� r� r� r� r� r� r, l s z.AliasedReturnsRows._populate_column_collectionr� c C s | j }t|t�rd}|S )NZanon_1)r� rk rE r� r� r� r� r o s z AliasedReturnsRows.descriptionr� c C s | j jS r� )r� �implicit_returningr� r� r� r� r� w s z%AliasedReturnsRows.implicit_returningc C s | j S )z9Legacy for dialects that are referring to Alias.original.�r� r� r� r� r� �original{ s zAliasedReturnsRows.originalr� r� c C s || j krdS | j�|�S �NT)r r� r� r� r� r� r� r� � s z"AliasedReturnsRows.is_derived_fromr� r_ c s2 | j }t� jf d|i|�� || j k r.| �� d S )Nr` )r� rq rr r4 )r� r` ra Zexisting_elementru r� r� rr � s z"AliasedReturnsRows._copy_internalsr� c C s | gS r� r� r� r� r� r� r4 � s z AliasedReturnsRows._from_objects)r� r� r� r� �_is_from_container�_supports_derived_columnsr� rT r� � dp_anon_namerO r� r� r� r� r, rX r� r r� r� r� r� r+ rr r4 r� r� r� ru r� r� < s0 � � �r� c @ s e Zd ZU ded< dS )�FromClauseAliasr� r� N�r� r� r� r� r� r� r� r� r� � s r� c @ s< e Zd ZU dZdZdZded< edddd d d �d d ��ZdS )r� a Represents an table or selectable alias (AS). Represents an alias, as typically applied to any table or sub-select within a SQL statement using the ``AS`` keyword (or without the keyword on certain databases such as Oracle). This object is constructed from the :func:`_expression.alias` module level function as well as the :meth:`_expression.FromClause.alias` method available on all :class:`_expression.FromClause` subclasses. .. seealso:: :meth:`_expression.FromClause.alias` r� Tr� r� NFr� r� r )r� r� r r� c C s t jtj|dd�j||d�S )NT)Z allow_selectr: )r r� r r� r� )r� r� r� r r� r� r� �_factory� s � �zAlias._factory)NF) r� r� r� r� r� r� r� r� r� r� r� r� r� r� � s �r� c s� e Zd ZU dZdZdZdZdZdZde j fde j fde j fde j fd e j fgZd ed < d d dd �dddddd�� fdd�Zejdd�dd��Zd$ddd d�dd �Zd%dd d �d d �Zd&ddd d!�d"d#�Z� ZS )'�TableValuedAliasa� An alias against a "table valued" SQL function. This construct provides for a SQL function that returns columns to be used in the FROM clause of a SELECT statement. The object is generated using the :meth:`_functions.FunctionElement.table_valued` method, e.g.: .. sourcecode:: pycon+sql >>> from sqlalchemy import select, func >>> fn = func.json_array_elements_text('["one", "two", "three"]').table_valued("value") >>> print(select(fn.c.value)) {printsql}SELECT anon_1.value FROM json_array_elements_text(:json_array_elements_text_1) AS anon_1 .. versionadded:: 1.4.0b2 .. seealso:: :ref:`tutorial_functions_table_valued` - in the :ref:`unified_tutorial` Ztable_valued_aliasTFr� r� �_tableval_type�_render_derived�_render_derived_w_typesrS rO N�r� �table_value_type�joins_implicitlyr r� zOptional[TableValueType]r� r� )r� r� r� r� r� c s. t � j||d� || _|d kr$tjn|| _d S r; )rq r� r� r rF r� )r� r� r� r� r� ru r� r� r� � s ��zTableValuedAlias._initrE r� c C s t | | j�S )a Return a column expression representing this :class:`_sql.TableValuedAlias`. This accessor is used to implement the :meth:`_functions.FunctionElement.column_valued` method. See that method for further details. E.g.: .. sourcecode:: pycon+sql >>> print(select(func.some_func().table_valued("value").column)) {printsql}SELECT anon_1 FROM some_func() AS anon_1 .. seealso:: :meth:`_functions.FunctionElement.column_valued` )rO r� r� r� r� r� r� � s zTableValuedAlias.columnr c C s. t j| || j| jd�}| jr*d|_| j|_|S )z�Return a new alias of this :class:`_sql.TableValuedAlias`. This creates a distinct FROM object that will be distinguished from the original one when used in a SQL statement. r� T)r� r� r� r� r� r� )r� r� r �tvar� r� r� r� s �zTableValuedAlias.aliasr� r� c C s | j |d�}d|_|S )z�Return a new :class:`_sql.TableValuedAlias` with the lateral flag set, so that it renders as LATERAL. .. seealso:: :func:`_expression.lateral` r� T)r� r� )r� r� r� r� r� r� r� ' s zTableValuedAlias.lateral)r� � with_typesr� c C s( t j| j|| j| jd�}d|_||_|S )a� Apply "render derived" to this :class:`_sql.TableValuedAlias`. This has the effect of the individual column names listed out after the alias name in the "AS" sequence, e.g.: .. sourcecode:: pycon+sql >>> print( ... select( ... func.unnest(array(["one", "two", "three"])). table_valued("x", with_ordinality="o").render_derived() ... ) ... ) {printsql}SELECT anon_1.x, anon_1.o FROM unnest(ARRAY[%(param_1)s, %(param_2)s, %(param_3)s]) WITH ORDINALITY AS anon_1(x, o) The ``with_types`` keyword will render column types inline within the alias expression (this syntax currently applies to the PostgreSQL database): .. sourcecode:: pycon+sql >>> print( ... select( ... func.json_to_recordset( ... '[{"a":1,"b":"foo"},{"a":"2","c":"bar"}]' ... ) ... .table_valued(column("a", Integer), column("b", String)) ... .render_derived(with_types=True) ... ) ... ) {printsql}SELECT anon_1.a, anon_1.b FROM json_to_recordset(:json_to_recordset_1) AS anon_1(a INTEGER, b VARCHAR) :param name: optional string name that will be applied to the alias generated. If left as None, a unique anonymizing name will be used. :param with_types: if True, the derived columns will include the datatype specification with each column. This is a special syntax currently known to be required by PostgreSQL for some SQL functions. r� T)r� r� r� r� r� r� r� )r� r� r� Z new_aliasr� r� r� �render_derived4 s 8�z TableValuedAlias.render_derived)NF)N)NF)r� r� r� r� r� r� r� r� r� rT r� r� �dp_typer� rO r� r� rB �memoized_attributer� r� r� r� r� r� r� ru r� r� � s2 � � � �r� c @ s4 e Zd ZdZdZdZdZed dddd�d d ��ZdS ) r� a� Represent a LATERAL subquery. This object is constructed from the :func:`_expression.lateral` module level function as well as the :meth:`_expression.FromClause.lateral` method available on all :class:`_expression.FromClause` subclasses. While LATERAL is part of the SQL standard, currently only more recent PostgreSQL versions provide support for this keyword. .. seealso:: :ref:`tutorial_lateral_correlation` - overview of usage. r� TNz&Union[SelectBase, _FromClauseArgument]r� r� r� c C s t jtj|dd�j|d�S )NT)Zexplicit_subqueryr� )r r� r r� r� �r� r� r� r� r� r� r� � s ��zLateral._factory)N) r� r� r� r� r� r� r� r� r� r� r� r� r� r� w s �r� c s� e Zd ZU dZdZejdejfdejfg Zde d< e ddd d d d d �d d��Z e � d�ddd�dd d d dd�� fdd��Zdd�dd�Z� ZS )r aI Represent a TABLESAMPLE clause. This object is constructed from the :func:`_expression.tablesample` module level function as well as the :meth:`_expression.FromClause.tablesample` method available on all :class:`_expression.FromClause` subclasses. .. seealso:: :func:`_expression.tablesample` r r r rS rO Nra r r� r )r� r r� r r� c C s t �tj|�j|||d�S )N�r� r )r r� r r� r )r� r� r r� r r� r� r� r� � s �zTableSample._factoryzsqlalchemy.sql.functionsr� r r� )r� r� r r r� c sL |d k s t �tjj}t||j�s,|j�|�}|| _|| _ t � j ||d� d S r; ) r7 rX r� Z sql_functionsrk r �func�systemr r rq r� )r� r� r� r r � functionsru r� r� r� � s zTableSample._initz Function[Any]r� c C s | j S r� )r r� r� r� r� � _get_method� s zTableSample._get_method)NN)r� r� r� r� r� r� rO rT r� r� r� r� rX r� r� r� r� r� r� ru r� r � s" ��� � � r c s� e Zd ZU dZdZejdejfdejfdej fdej fg e j e j Zded< d ed < ed(d d dd d�dd��Zd d d d d d d d�dd dddddddd� � fdd�Zdd�dd �Zd)d dd d �d d �Zd d d!�d"d#�Zd d d!�d$d%�Zd d�d&d'�Z� ZS )*�CTEaU Represent a Common Table Expression. The :class:`_expression.CTE` object is obtained using the :meth:`_sql.SelectBase.cte` method from any SELECT statement. A less often available syntax also allows use of the :meth:`_sql.HasCTE.cte` method present on :term:`DML` constructs such as :class:`_sql.Insert`, :class:`_sql.Update` and :class:`_sql.Delete`. See the :meth:`_sql.HasCTE.cte` method for usage details on CTEs. .. seealso:: :ref:`tutorial_subqueries_ctes` - in the 2.0 tutorial :meth:`_sql.HasCTE.cte` - examples of calling styles �cte� _cte_alias� _restates� recursive�nestingrS rO �HasCTEr� NFr� r� )r� r� r� r� c C s t �tj|�j||d�S )z�Return a new :class:`_expression.CTE`, or Common Table Expression instance. Please see :meth:`_expression.HasCTE.cte` for detail on CTE usage. )r� r� )r r� r � HasCTERoler� )r� r� r� r� r� r� r� r� � s �z CTE._factory)r� r� r� r� r� r� r� r z Optional[CTE]zOptional[Tuple[()]]r� ) r� r� r� r� r� r� r� r� r� c s@ || _ || _|| _|| _|r"|| _|r,|| _t� j||d� d S r; )r� r� r� r� r� r� rq r� ) r� r� r� r� r� r� r� r� r� ru r� r� r� s z CTE._initr� c C s( | j d k r| j �| � n | j�| � d S r� )r� r� r� r� r� r� r� r, $ s z CTE._populate_column_collectionr c C s" t j| j|| j| j| | j| jd�S )a2 Return an :class:`_expression.Alias` of this :class:`_expression.CTE`. This method is a CTE-specific specialization of the :meth:`_expression.FromClause.alias` method. .. seealso:: :ref:`tutorial_using_aliases` :func:`_expression.alias` )r� r� r� r� r� r� )r� r� r� r� r� r� r� r r� r� r� r� * s �z CTE.aliasrg r c G sF t | j�s td| j� d���tj| jj|� | j| j| j| | j | j d�S )a� Return a new :class:`_expression.CTE` with a SQL ``UNION`` of the original CTE against the given selectables provided as positional arguments. :param \*other: one or more elements with which to create a UNION. .. versionchanged:: 1.4.28 multiple elements are now accepted. .. seealso:: :meth:`_sql.HasCTE.cte` - examples of calling styles � CTE element fz does not support union()�r� r� r� r� r� r� ) r% r� r7 r� r� r� r� r� r� r� r� r r� r� r� r� B s � � �z CTE.unionc G sF t | j�s td| j� d���tj| jj|� | j| j| j| | j | j d�S )a� Return a new :class:`_expression.CTE` with a SQL ``UNION ALL`` of the original CTE against the given selectables provided as positional arguments. :param \*other: one or more elements with which to create a UNION. .. versionchanged:: 1.4.28 multiple elements are now accepted. .. seealso:: :meth:`_sql.HasCTE.cte` - examples of calling styles r� z does not support union_all()r� ) r% r� r7 r� r� � union_allr� r� r� r� r� r r� r� r� r� _ s � � �z CTE.union_allc C s | j dk r| j S | S )z� A recursive CTE is updated to attach the recursive part. Updated CTEs should still refer to the original CTE. This function returns this reference identifier. N)r� r� r� r� r� �_get_reference_cte} s zCTE._get_reference_cte)NF)NF)r� r� r� r� r� r� rO rT r� r� r� r� r� r� r� r� r� r� r, r� r� r� r� r� r� r� ru r� r� � s@ ����� ��& r� c @ s e Zd ZU ded< dS )�_CTEOptsr� r� Nr� r� r� r� r� r� � s r� c @ s6 e Zd ZU ded< ded< ded< ded< ded< d S ) �_ColumnsPlusNamesr� �required_label_name� proxy_key�fallback_label_name�%Union[ColumnElement[Any], TextClause]r� r� �repeatedNr� r� r� r� r� r� � s r� c @ s2 e Zd ZU dZeZded< d dddd�d d �ZdS ) � SelectsRowszvSub-base of ReturnsRows for elements that deliver rows directly, namely SELECT and INSERT/UPDATE/DELETE..RETURNINGrH � _label_styleNr� zOptional[_SelectIterable]zList[_ColumnsPlusNames])�anon_for_dupe_key�colsr� c C sj |dkr| j }t�| j�}i }g }|j}| jtk}| jtk}d} |D �] } d} | jsbd } } }n�|r�trvt | �svt �d } } | j p�| j }n�tr�t | �s�t �|r�| j } } }n| j } }d} | dk�r<| j}|dk�r0| j |k} | || j < d } } | �r(|�r| �| �}| d7 } n| �| �}| d7 } n| j }n | } } }| dk �rLt�rZt | ��sZt �| |k�rDt|| �t| �k�r|�r�| j } }n | j } }|�r�| |k�r�t|| �t| �k�s�t �|�r�| �| � } }| d7 } n| �| � } }| d7 } d} n| || < n>|�rL|�r(| �| � } }| d7 } n| �| � } }| d7 } d} n| || < |t| || �|| | �� qD|S )ac Generate column names as rendered in a SELECT statement by the compiler. This is distinct from the _column_naming_convention generator that's intended for population of .c collections and similar, which has different rules. the collection returned here calls upon the _column_naming_convention as well. Nr FT)r� � SelectState�_column_naming_conventionr� r� rK rJ Z _render_label_in_columns_clauser r$ r7 Z_non_anon_labelZ_anon_name_label� _tq_labelZ_expression_labelZ_dedupe_anon_tq_label_idxZ_dedupe_anon_label_idxrV Z_anon_tq_labelr� )r� r� r� Zkey_naming_convention�names�resultZ result_append�table_qualifiedZlabel_style_noneZ dedupe_hashr& r� Zeffective_namer� r� Z expr_labelr� r� r� � _generate_columns_plus_names� s� � � �� � � � ��� � � ��� z(SelectsRows._generate_columns_plus_names)N)r� r� r� r� rJ r� r� r� r� r� r� r� r� � s �r� c @ sx e Zd ZU dZdejfdejfgZded< dZ ded< dZ ded< e d d �d d d d�dd��Z ddd d d d�dd�Z dS )r� z3Mixin that declares a class to include CTE support.�_independent_ctes�_independent_ctes_optsrS � _has_ctes_traverse_internalsr� zTuple[CTE, ...]zTuple[_CTEOpts, ...]F�� nest_herer� r� r\ ��ctesr� r� c G sD t |�}|D ]2}t�tj|�}| j|f7 _| j|f7 _q | S )aM Add one or more :class:`_sql.CTE` constructs to this statement. This method will associate the given :class:`_sql.CTE` constructs with the parent statement such that they will each be unconditionally rendered in the WITH clause of the final statement, even if not referenced elsewhere within the statement or any sub-selects. The optional :paramref:`.HasCTE.add_cte.nest_here` parameter when set to True will have the effect that each given :class:`_sql.CTE` will render in a WITH clause rendered directly along with this statement, rather than being moved to the top of the ultimate rendered statement, even if this statement is rendered as a subquery within a larger statement. This method has two general uses. One is to embed CTE statements that serve some purpose without being referenced explicitly, such as the use case of embedding a DML statement such as an INSERT or UPDATE as a CTE inline with a primary statement that may draw from its results indirectly. The other is to provide control over the exact placement of a particular series of CTE constructs that should remain rendered directly in terms of a particular statement that may be nested in a larger statement. E.g.:: from sqlalchemy import table, column, select t = table('t', column('c1'), column('c2')) ins = t.insert().values({"c1": "x", "c2": "y"}).cte() stmt = select(t).add_cte(ins) Would render:: WITH anon_1 AS (INSERT INTO t (c1, c2) VALUES (:param_1, :param_2)) SELECT t.c1, t.c2 FROM t Above, the "anon_1" CTE is not referenced in the SELECT statement, however still accomplishes the task of running an INSERT statement. Similarly in a DML-related context, using the PostgreSQL :class:`_postgresql.Insert` construct to generate an "upsert":: from sqlalchemy import table, column from sqlalchemy.dialects.postgresql import insert t = table("t", column("c1"), column("c2")) delete_statement_cte = ( t.delete().where(t.c.c1 < 1).cte("deletions") ) insert_stmt = insert(t).values({"c1": 1, "c2": 2}) update_statement = insert_stmt.on_conflict_do_update( index_elements=[t.c.c1], set_={ "c1": insert_stmt.excluded.c1, "c2": insert_stmt.excluded.c2, }, ).add_cte(delete_statement_cte) print(update_statement) The above statement renders as:: WITH deletions AS (DELETE FROM t WHERE t.c1 < %(c1_1)s) INSERT INTO t (c1, c2) VALUES (%(c1)s, %(c2)s) ON CONFLICT (c1) DO UPDATE SET c1 = excluded.c1, c2 = excluded.c2 .. versionadded:: 1.4.21 :param \*ctes: zero or more :class:`.CTE` constructs. .. versionchanged:: 2.0 Multiple CTE instances are accepted :param nest_here: if True, the given CTE or CTEs will be rendered as though they specified the :paramref:`.HasCTE.cte.nesting` flag to ``True`` when they were added to this :class:`.HasCTE`. Assuming the given CTEs are not referenced in an outer-enclosing statement as well, the CTEs given should render at the level of this statement when this flag is given. .. versionadded:: 2.0 .. seealso:: :paramref:`.HasCTE.cte.nesting` )r� r r� r � IsCTERoler� r� )r� r� r� �optr� r� r� r� �add_cted s `�zHasCTE.add_cteNr� )r� r� r� r� c C s t j| |||d�S )a�% Return a new :class:`_expression.CTE`, or Common Table Expression instance. Common table expressions are a SQL standard whereby SELECT statements can draw upon secondary statements specified along with the primary statement, using a clause called "WITH". Special semantics regarding UNION can also be employed to allow "recursive" queries, where a SELECT statement can draw upon the set of rows that have previously been selected. CTEs can also be applied to DML constructs UPDATE, INSERT and DELETE on some databases, both as a source of CTE rows when combined with RETURNING, as well as a consumer of CTE rows. SQLAlchemy detects :class:`_expression.CTE` objects, which are treated similarly to :class:`_expression.Alias` objects, as special elements to be delivered to the FROM clause of the statement as well as to a WITH clause at the top of the statement. For special prefixes such as PostgreSQL "MATERIALIZED" and "NOT MATERIALIZED", the :meth:`_expression.CTE.prefix_with` method may be used to establish these. .. versionchanged:: 1.3.13 Added support for prefixes. In particular - MATERIALIZED and NOT MATERIALIZED. :param name: name given to the common table expression. Like :meth:`_expression.FromClause.alias`, the name can be left as ``None`` in which case an anonymous symbol will be used at query compile time. :param recursive: if ``True``, will render ``WITH RECURSIVE``. A recursive common table expression is intended to be used in conjunction with UNION ALL in order to derive rows from those already selected. :param nesting: if ``True``, will render the CTE locally to the statement in which it is referenced. For more complex scenarios, the :meth:`.HasCTE.add_cte` method using the :paramref:`.HasCTE.add_cte.nest_here` parameter may also be used to more carefully control the exact placement of a particular CTE. .. versionadded:: 1.4.24 .. seealso:: :meth:`.HasCTE.add_cte` The following examples include two from PostgreSQL's documentation at https://www.postgresql.org/docs/current/static/queries-with.html, as well as additional examples. Example 1, non recursive:: from sqlalchemy import (Table, Column, String, Integer, MetaData, select, func) metadata = MetaData() orders = Table('orders', metadata, Column('region', String), Column('amount', Integer), Column('product', String), Column('quantity', Integer) ) regional_sales = select( orders.c.region, func.sum(orders.c.amount).label('total_sales') ).group_by(orders.c.region).cte("regional_sales") top_regions = select(regional_sales.c.region).\ where( regional_sales.c.total_sales > select( func.sum(regional_sales.c.total_sales) / 10 ) ).cte("top_regions") statement = select( orders.c.region, orders.c.product, func.sum(orders.c.quantity).label("product_units"), func.sum(orders.c.amount).label("product_sales") ).where(orders.c.region.in_( select(top_regions.c.region) )).group_by(orders.c.region, orders.c.product) result = conn.execute(statement).fetchall() Example 2, WITH RECURSIVE:: from sqlalchemy import (Table, Column, String, Integer, MetaData, select, func) metadata = MetaData() parts = Table('parts', metadata, Column('part', String), Column('sub_part', String), Column('quantity', Integer), ) included_parts = select(\ parts.c.sub_part, parts.c.part, parts.c.quantity\ ).\ where(parts.c.part=='our part').\ cte(recursive=True) incl_alias = included_parts.alias() parts_alias = parts.alias() included_parts = included_parts.union_all( select( parts_alias.c.sub_part, parts_alias.c.part, parts_alias.c.quantity ).\ where(parts_alias.c.part==incl_alias.c.sub_part) ) statement = select( included_parts.c.sub_part, func.sum(included_parts.c.quantity). label('total_quantity') ).\ group_by(included_parts.c.sub_part) result = conn.execute(statement).fetchall() Example 3, an upsert using UPDATE and INSERT with CTEs:: from datetime import date from sqlalchemy import (MetaData, Table, Column, Integer, Date, select, literal, and_, exists) metadata = MetaData() visitors = Table('visitors', metadata, Column('product_id', Integer, primary_key=True), Column('date', Date, primary_key=True), Column('count', Integer), ) # add 5 visitors for the product_id == 1 product_id = 1 day = date.today() count = 5 update_cte = ( visitors.update() .where(and_(visitors.c.product_id == product_id, visitors.c.date == day)) .values(count=visitors.c.count + count) .returning(literal(1)) .cte('update_cte') ) upsert = visitors.insert().from_select( [visitors.c.product_id, visitors.c.date, visitors.c.count], select(literal(product_id), literal(day), literal(count)) .where(~exists(update_cte.select())) ) connection.execute(upsert) Example 4, Nesting CTE (SQLAlchemy 1.4.24 and above):: value_a = select( literal("root").label("n") ).cte("value_a") # A nested CTE with the same name as the root one value_a_nested = select( literal("nesting").label("n") ).cte("value_a", nesting=True) # Nesting CTEs takes ascendency locally # over the CTEs at a higher level value_b = select(value_a_nested.c.n).cte("value_b") value_ab = select(value_a.c.n.label("a"), value_b.c.n.label("b")) The above query will render the second CTE nested inside the first, shown with inline parameters below as:: WITH value_a AS (SELECT 'root' AS n), value_b AS (WITH value_a AS (SELECT 'nesting' AS n) SELECT value_a.n AS n FROM value_a) SELECT value_a.n AS a, value_b.n AS b FROM value_a, value_b The same CTE can be set up using the :meth:`.HasCTE.add_cte` method as follows (SQLAlchemy 2.0 and above):: value_a = select( literal("root").label("n") ).cte("value_a") # A nested CTE with the same name as the root one value_a_nested = select( literal("nesting").label("n") ).cte("value_a") # Nesting CTEs takes ascendency locally # over the CTEs at a higher level value_b = ( select(value_a_nested.c.n). add_cte(value_a_nested, nest_here=True). cte("value_b") ) value_ab = select(value_a.c.n.label("a"), value_b.c.n.label("b")) Example 5, Non-Linear CTE (SQLAlchemy 1.4.28 and above):: edge = Table( "edge", metadata, Column("id", Integer, primary_key=True), Column("left", Integer), Column("right", Integer), ) root_node = select(literal(1).label("node")).cte( "nodes", recursive=True ) left_edge = select(edge.c.left).join( root_node, edge.c.right == root_node.c.node ) right_edge = select(edge.c.right).join( root_node, edge.c.left == root_node.c.node ) subgraph_cte = root_node.union(left_edge, right_edge) subgraph = select(subgraph_cte) The above query will render 2 UNIONs inside the recursive CTE:: WITH RECURSIVE nodes(node) AS ( SELECT 1 AS node UNION SELECT edge."left" AS "left" FROM edge JOIN nodes ON edge."right" = nodes.node UNION SELECT edge."right" AS "right" FROM edge JOIN nodes ON edge."left" = nodes.node ) SELECT nodes.node FROM nodes .. seealso:: :meth:`_orm.Query.cte` - ORM version of :meth:`_expression.HasCTE.cte`. )r� r� r� )r� r� )r� r� r� r� r� r� r� r� � s �z HasCTE.cte)NFF)r� r� r� r� rT �dp_clauseelement_list� dp_plain_objr� r� r� r� r5 r� r� r� r� r� r� r� Y s � j �r� c @ sX e Zd ZU dZdZdZdZded< edddd d�d d ��Z e � d d �d d�dd��Z dS )�Subquerya� Represent a subquery of a SELECT. A :class:`.Subquery` is created by invoking the :meth:`_expression.SelectBase.subquery` method, or for convenience the :meth:`_expression.SelectBase.alias` method, on any :class:`_expression.SelectBase` subclass which includes :class:`_expression.Select`, :class:`_expression.CompoundSelect`, and :class:`_expression.TextualSelect`. As rendered in a FROM clause, it represents the body of the SELECT statement inside of parenthesis, followed by the usual "AS <somename>" that defines all "alias" objects. The :class:`.Subquery` object is very similar to the :class:`_expression.Alias` object and can be used in an equivalent way. The difference between :class:`_expression.Alias` and :class:`.Subquery` is that :class:`_expression.Alias` always contains a :class:`_expression.FromClause` object whereas :class:`.Subquery` always contains a :class:`_expression.SelectBase` object. .. versionadded:: 1.4 The :class:`.Subquery` class was added which now serves the purpose of providing an aliased version of a SELECT statement. �subqueryT� SelectBaser� Nr� r� c C s t �tj|�j|d�S )z#Return a :class:`.Subquery` object.r� )r r� r �SelectStatementRoler� r� r� r� r� r� s ��zSubquery._factoryr� ax The :meth:`.Subquery.as_scalar` method, which was previously ``Alias.as_scalar()`` prior to version 1.4, is deprecated and will be removed in a future release; Please use the :meth:`_expression.Select.scalar_subquery` method of the :func:`_expression.select` construct before constructing a subquery object, or with the ORM use the :meth:`_query.Query.scalar_subquery` method.�ScalarSelect[Any]r� c C s | j �t��� S r� )r� r� rJ �scalar_subqueryr� r� r� r� � as_scalar s zSubquery.as_scalar)N) r� r� r� r� r� Z _is_subqueryr� r� r� r� rX r� r r� r� r� r� r� � s � � r� c @ s( e Zd ZU dZdejfgZded< ded< dd�dd�Zd d �d d �Z e j d d �dd��Z e j d d �dd��Z edd �dd��Zedd �dd��Zddd�dd �Zd9d dd d!�d"d#�Zd$d d%�d&d'�Ze j d(d �d)d*��Ze j d+d �d,d-��Zd.d �d/d0�Zd.d d1�d2d3�Ze�r$d:d4d5d6�d7d8�Zd S );rW z%Represent a grouping of a FROM clauser� rS rO r� r� c C s t �tj|�| _d S r� )r r� r r� r� �r� r� r� r� r� rT & s zFromGrouping.__init__r� r� c C s d S r� r� r� r� r� r� r+ ) s z FromGrouping._init_collectionsr' c C s | j jS r� �r� r) r� r� r� r� r) , s zFromGrouping.columnsc C s | j jS r� r r� r� r� r� r& 2 s zFromGrouping.cr. c C s | j jS r� )r� r/ r� r� r� r� r/ 6 s zFromGrouping.primary_keyr0 c C s | j jS r� )r� r1 r� r� r� r� r1 : s zFromGrouping.foreign_keysr� r� r� c C s | j �|�S r� )r� r� r� r� r� r� r� > s z FromGrouping.is_derived_fromNFr� �NamedFromGroupingr c C s t | jj||d��S )Nr: )r r� r� r r� r� r� r� A s zFromGrouping.aliasr �ra r� c K s t | jjf |��S r� )rW r� r< �r� ra r� r� r� r< F s z"FromGrouping._anonymous_fromclauser� c C s | j jS r� )r� r� r� r� r� r� r� I s zFromGrouping._hide_fromsr� c C s | j jS r� �r� r4 r� r� r� r� r4 M s zFromGrouping._from_objectszDict[str, FromClause]c C s d| j iS �Nr� r� r� r� r� r� � __getstate__Q s zFromGrouping.__getstate__��stater� c C s |d | _ d S r r� �r� r r� r� r� � __setstate__T s zFromGrouping.__setstate__r= r\ r> c C s d S r� r� r@ r� r� r� rA Y s zFromGrouping.self_group)NF)N)r� r� r� r� rT r� rO r� rT r+ rX r� r) r& r� r/ r1 r� r� r< r� r4 r r r rA r� r� r� r� rW s8 � � �rW c @ s* e Zd ZdZdZer&d ddd�dd�ZdS ) r zLrepresent a grouping of a named FROM clause .. versionadded:: 2.0 TNr= r\ r> c C s d S r� r� r@ r� r� r� rA i s z NamedFromGrouping.self_group)N)r� r� r� r� r� r rA r� r� r� r� r ^ s �r c sP e Zd ZU dZdZdejfdejfdejfgZde d< dZ d e d < d Z e j d d �dd��Zd ddd�� fdd� Zer�e jdd �dd��Ze jdd �dd��Zd d �dd�Zd d d �d d �Zd d �d!d"�Ze j d d �d#d$��Zdd d%�d&d'�Ze �d(�d)d �d*d+��Ze �d(�d,d �d-d.��Ze �d(�d/d �d0d1��Z e jd2d �d3d4��Z � Z S )5� TableClausea- Represents a minimal "table" construct. This is a lightweight table object that has only a name, a collection of columns, which are typically produced by the :func:`_expression.column` function, and a schema:: from sqlalchemy import table, column user = table("user", column("id"), column("name"), column("description"), ) The :class:`_expression.TableClause` construct serves as the base for the more commonly used :class:`_schema.Table` object, providing the usual set of :class:`_expression.FromClause` services including the ``.c.`` collection and statement generation methods. It does **not** provide all the additional schema-level services of :class:`_schema.Table`, including constraints, references to other tables, or support for :class:`_schema.MetaData`-level services. It's useful on its own as an ad-hoc construct used to generate quick SQL statements when a more fully fledged :class:`_schema.Table` is not on hand. rl r) r� r� rS rO Tr� �fullnameFzOptional[ColumnClause[Any]]r� c C s dS )z4No PK or default support so no autoincrement column.Nr� r� r� r� r� �_autoincrement_column� s z!TableClause._autoincrement_column�ColumnClause[Any]r )r� r) ra c s� t � �� || _t� | _t� | _t� | _|D ]}| � |� q,|� dd �}|d k rV|| _ | j d k rtd| j | jf | _ n| j| _ |r�t �dt|� ��d S )Nr� z%s.%szUnsupported argument(s): %s)rq rT r� r> r� r< r/ r8 r1 � append_columnr2 r� r rW � ArgumentErrorr� )r� r� r) ra r& r� ru r� r� rT � s zTableClause.__init__z0ReadOnlyColumnCollection[str, ColumnClause[Any]]c C s d S r� r� r� r� r� r� r) � s zTableClause.columnsc C s d S r� r� r� r� r� r� r& � s z TableClause.cc C s$ | j d k r| j d | j S | jS d S )N�.)r� r� r� r� r� r� �__str__� s zTableClause.__str__r� r� r� c C s d S r� r� r� r� r� r� r� � s z#TableClause._refresh_for_new_columnc C s d S r� r� r� r� r� r� r+ � s z TableClause._init_collectionsc C s | j S r� r� r� r� r� r� r � s zTableClause.description)r& r� c C s@ |j }|d k r*|| k r*t�d|j|f ��| j�|� | |_ d S )Nz1column object '%s' already assigned to table '%s')rl rW r r3 r� �add)r� r& �existingr� r� r� r � s �� zTableClause.append_columnzsqlalchemy.sql.dmlz util.preloaded.sql_dml.Insertc C s t jj�| �S )z�Generate an :class:`_sql.Insert` construct against this :class:`_expression.TableClause`. E.g.:: table.insert().values(name='foo') See :func:`_expression.insert` for argument and usage information. )rX r� �sql_dmlZInsertr� r� r� r� �insert� s zTableClause.insertry c C s t jj�| �S )a Generate an :func:`_expression.update` construct against this :class:`_expression.TableClause`. E.g.:: table.update().where(table.c.id==7).values(name='foo') See :func:`_expression.update` for argument and usage information. )rX r� r ry r� r� r� r� r[ � s �zTableClause.updaterx c C s t jj�| �S )z�Generate a :func:`_expression.delete` construct against this :class:`_expression.TableClause`. E.g.:: table.delete().where(table.c.id==7) See :func:`_expression.delete` for argument and usage information. )rX r� r rx r� r� r� r� �delete� s zTableClause.deleter� c C s | gS r� r� r� r� r� r� r4 s zTableClause._from_objects) r� r� r� r� r� rT Z)dp_fromclause_canonical_column_collection� dp_stringrO r� Z _is_tabler� rX rD r rT r r� r) r& r r� r+ r r r� r r[ r r4 r� r� r� ru r� r n sB �� r � ForUpdateArgc @ s� e Zd ZU dejfdejfdejfdejfdejfgZded< ded< d ed< d ed< d ed< ed d d �d d��Z dd d�dd�Z dd d�dd�Z dd�dd�Z dddddd�d d d d d d�d d �Z dS ) r �of�nowait�read� skip_locked� key_sharerS rO z!Optional[Sequence[ClauseElement]]r� �ForUpdateParameter�Optional[ForUpdateArg])�with_for_updater� c C s< t |t�r|S |dkrd S |dkr(t� S tf td|��S d S )N)NFT�Dict[str, Any])rk r r )r� r% r� r� r� �_from_argument s zForUpdateArg._from_argumentr r c C sF t |t�oD|j| jkoD|j| jkoD|j| jkoD|j| jkoD|j| jkS r� )rk r r r r! r" r r r� r� r� �__eq__- s � � � � �zForUpdateArg.__eq__c C s | � |� S r� )r( r r� r� r� �__ne__7 s zForUpdateArg.__ne__�intr� c C s t | �S r� )rU r� r� r� r� �__hash__: s zForUpdateArg.__hash__FN�r r r r! r" � Optional[_ForUpdateOfArgument]c C sB || _ || _|| _|| _|dk r8dd� t�|�D �| _nd| _dS )zZRepresents arguments specified to :meth:`_expression.Select.for_update`. Nc S s g | ]}t �tj|��qS r� �r r� r ZColumnsClauseRole�r� �elemr� r� r� r� P s �z)ForUpdateArg.__init__.<locals>.<listcomp>)r r r! r" rX �to_listr �r� r r r r! r" r� r� r� rT = s � zForUpdateArg.__init__)r� r� r� rT r� r� rO r� r� r' r( r) r+ rT r� r� r� r� r s* � �c s� e Zd ZU dZdZdZded< ded< dejfdej fd ej fd ej fgZ d ed < d dd�dddd�� fdd�Z edd�dd��Zed.dddd�dd ��Zed/dd d �d d ��Zed!dd"�d#d$��Zd%d�d&d'�Zd(d�d)d*�Zejd+d�d,d-��Z� ZS )0�Valuesz�Represent a ``VALUES`` construct that can be used as a FROM element in a statement. The :class:`_expression.Values` object is created from the :func:`_expression.values` function. .. versionadded:: 1.4 r� r� �%Tuple[Sequence[Tuple[Any, ...]], ...]�_datar� �_unnamed� _column_argsr� � literal_bindsrS rO NF)r� r8 r r� )r) r� r8 c sR t � �� || _|d kr2d| _t�t| �d�| _n d| _|| _|| _| j | _ d S )NTr� F) rq rT r7 r6 rE r� rU r� r8 rB )r� r� r8 r) ru r� r� rT o s zValues.__init__�List[TypeEngine[Any]]r� c C s dd� | j D �S )Nc S s g | ] }|j �qS r� ��typer! r� r� r� r� � s z(Values._column_types.<locals>.<listcomp>�r7 r� r� r� r� � _column_types� s zValues._column_typesr\ r c C s4 |dkrt �t| �d�}n|}|| _d| _d| _| S )aY Return a new :class:`_expression.Values` construct that is a copy of this one with the given name. This method is a VALUES-specific specialization of the :meth:`_expression.FromClause.alias` method. .. seealso:: :ref:`tutorial_using_aliases` :func:`_expression.alias` Nr� TF)rE r� rU r� rB r6 )r� r� r � non_none_namer� r� r� r� � s z Values.aliasr� r� c C s* |dkr| j }n|}d| _|| _ d| _| S )z�Return a new :class:`_expression.Values` with the lateral flag set, so that it renders as LATERAL. .. seealso:: :func:`_expression.lateral` NTF)r� r� r6 )r� r� r> r� r� r� r� � s zValues.lateralzSequence[Tuple[Any, ...]])r� r� c C s | j |f7 _ | S )aj Return a new :class:`_expression.Values` construct, adding the given data to the data list. E.g.:: my_values = my_values.data([(1, 'value 1'), (2, 'value2')]) :param values: a sequence (i.e. list) of tuples that map to the column expressions given in the :class:`_expression.Values` constructor. )r5 )r� r� r� r� r� �data� s z Values.data� ScalarValuesc C s t | j| j| j�S )z�Returns a scalar ``VALUES`` construct that can be used as a COLUMN element in a statement. .. versionadded:: 2.0.0b4 )r@ r7 r5 r8 r� r� r� r� � scalar_values� s zValues.scalar_valuesr� c C sN | j D ]B}|jd k r.|j| k r.|�| �\}}n|�� | j�|� | |_qd S r� )r7 rl r rs r� r )r� r& r� r� r� r� r, � s z"Values._populate_column_collectionr� c C s | gS r� r� r� r� r� r� r4 � s zValues._from_objects)NF)N)r� r� r� r� r� r5 r� rT r� �dp_dml_multi_valuesr r� rO rT r� r= r5 r� r� r? rA r, rX r� r4 r� r� r� ru r� r3 X s0 � � r3 c s� e Zd ZU dZdZdejfdejfdejfgZ de d< dd d d �� fd d � Z e dd�dd��Z d d�dd�Zer�dddd�dd�Z� ZS )r@ a{ Represent a scalar ``VALUES`` construct that can be used as a COLUMN element in a statement. The :class:`_expression.ScalarValues` object is created from the :meth:`_expression.Values.scalar_values` method. It's also automatically generated when a :class:`_expression.Values` is used in an ``IN`` or ``NOT IN`` condition. .. versionadded:: 2.0.0b4 rA r7 r5 r8 rS rO zSequence[ColumnClause[Any]]r4 r� )r) r? r8 c s t � �� || _|| _|| _d S r� )rq rT r7 r5 r8 )r� r) r? r8 ru r� r� rT � s zScalarValues.__init__r9 r� c C s dd� | j D �S )Nc S s g | ] }|j �qS r� r: r! r� r� r� r� s z.ScalarValues._column_types.<locals>.<listcomp>r< r� r� r� r� r= s zScalarValues._column_typesc C s | S r� r� r� r� r� r� �__clause_element__ s z ScalarValues.__clause_element__Nr= r\ r> c C s d S r� r� r@ r� r� r� rA s zScalarValues.self_group)N)r� r� r� r� r� rT r� rB r� rO r� rT r� r= rC r rA r� r� r� ru r� r@ � s � �r@ c @ s� e Zd ZU dZdZdZeZded< ddd�dd �Z e j d d �d d ��Z dd�dddd�dd�Z e j dd �dd��Zedd �dd��Zee �dd �d d �d d ���Zed d �d d!��Zdd �d"d#�Zdd$d%�d&d'�Ze �dd(�d)d)d*d+�d,d-��Zejd.d �d/d0��Zd1d �d2d3�Ze �dd4�d5d �d6d7��Zd8d �d9d:�Z d5d �d;d<�Z d=d>d?�d@dA�Z dNd=dBd?�dCdD�Z dOd=d.d?�dEdF�Z d$d �dGdH�Z!dPd=dJd.dK�dLdM�Z"dS )Qr� z�Base class for SELECT statements. This includes :class:`_expression.Select`, :class:`_expression.CompoundSelect` and :class:`_expression.TextualSelect`. TrH r� r� r� r� c C s | � � d S r� )rs r� r� r� r� r� * s z"SelectBase._refresh_for_new_column�)ColumnCollection[str, ColumnElement[Any]]r� c C s t � �dS )a$ A :class:`_expression.ColumnCollection` representing the columns that this SELECT statement or similar construct returns in its result set. This collection differs from the :attr:`_expression.FromClause.columns` collection of a :class:`_expression.FromClause` in that the columns within this collection cannot be directly nested inside another SELECT statement; a subquery must be applied first which provides for the necessary parenthesization required by SQL. .. note:: The :attr:`_sql.SelectBase.selected_columns` collection does not include expressions established in the columns clause using the :func:`_sql.text` construct; these are silently omitted from the collection. To use plain textual column expressions inside of a :class:`_sql.Select` construct, use the :func:`_sql.literal_column` construct. .. seealso:: :attr:`_sql.Select.selected_columns` .. versionadded:: 1.4 Nr� r� r� r� r� �selected_columns- s zSelectBase.selected_columnsN��proxy_compound_columnsr� �0Optional[Iterable[Sequence[ColumnElement[Any]]]]�r� rG r� c C s t � �d S r� r� �r� r� rG r� r� r� r� M s z.SelectBase._generate_fromclause_column_proxiesr� c C s t � �dS )a A sequence of expressions that correspond to what is rendered in the columns clause, including :class:`_sql.TextClause` constructs. .. versionadded:: 1.4.12 .. seealso:: :attr:`_sql.SelectBase.exported_columns` Nr� r� r� r� r� r� W s z SelectBase._all_selected_columnsz1ReadOnlyColumnCollection[str, ColumnElement[Any]]c C s | j �� S )af A :class:`_expression.ColumnCollection` that represents the "exported" columns of this :class:`_expression.Selectable`, not including :class:`_sql.TextClause` constructs. The "exported" columns for a :class:`_expression.SelectBase` object are synonymous with the :attr:`_expression.SelectBase.selected_columns` collection. .. versionadded:: 1.4 .. seealso:: :attr:`_expression.Select.exported_columns` :attr:`_expression.Selectable.exported_columns` :attr:`_expression.FromClause.exported_columns` )rE r- r� r� r� r� r� f s zSelectBase.exported_columnsr� a� The :attr:`_expression.SelectBase.c` and :attr:`_expression.SelectBase.columns` attributes are deprecated and will be removed in a future release; these attributes implicitly create a subquery that should be explicit. Please call :meth:`_expression.SelectBase.subquery` first in order to create a subquery, which then contains this attribute. To access the columns that this SELECT object SELECTs from, use the :attr:`_expression.SelectBase.selected_columns` attribute.r' c C s | j jS r� )�_implicit_subqueryr) r� r� r� r� r& � s z SelectBase.cc C s | j S r� r( r� r� r� r� r) � s zSelectBase.columnsc C s t � �dS )zX Retrieve the current label style. Implemented by subclasses. Nr� r� r� r� r� �get_label_style� s zSelectBase.get_label_styler\ ��styler� c C s t � �dS )zeReturn a new selectable with the specified label style. Implemented by subclasses. Nr� �r� rN r� r� r� r� � s zSelectBase.set_label_stylea The :meth:`_expression.SelectBase.select` method is deprecated and will be removed in a future release; this method implicitly creates a subquery that should be explicit. Please call :meth:`_expression.SelectBase.subquery` first in order to create a subquery, which then can be selected.r r )r� ra r� c O s | j j||�S r� )rK r r� r� r� r� r � s zSelectBase.selectr� c C s | � � S r� �r� r� r� r� r� rK � s z SelectBase._implicit_subquery�TypeEngine[Any]c C s t � �d S r� r� r� r� r� r� � _scalar_type� s zSelectBase._scalar_typez�The :meth:`_expression.SelectBase.as_scalar` method is deprecated and will be removed in a future release. Please refer to :meth:`_expression.SelectBase.scalar_subquery`.r c C s | � � S r� )r r� r� r� r� r � s zSelectBase.as_scalar�Existsc C s t | �S )aa Return an :class:`_sql.Exists` representation of this selectable, which can be used as a column expression. The returned object is an instance of :class:`_sql.Exists`. .. seealso:: :func:`_sql.exists` :ref:`tutorial_exists` - in the :term:`2.0 style` tutorial. .. versionadded:: 1.4 )rS r� r� r� r� �exists� s zSelectBase.existsc C s | j tk r| �t�} t| �S )aX Return a 'scalar' representation of this selectable, which can be used as a column expression. The returned object is an instance of :class:`_sql.ScalarSelect`. Typically, a select statement which has only one column in its columns clause is eligible to be used as a scalar expression. The scalar subquery can then be used in the WHERE clause or columns clause of an enclosing SELECT. Note that the scalar subquery differentiates from the FROM-level subquery that can be produced using the :meth:`_expression.SelectBase.subquery` method. .. versionchanged: 1.4 - the ``.as_scalar()`` method was renamed to :meth:`_expression.SelectBase.scalar_subquery`. .. seealso:: :ref:`tutorial_scalar_subquery` - in the 2.0 tutorial )r� rJ r� � ScalarSelectr� r� r� r� r � s zSelectBase.scalar_subqueryr� z Label[Any]r� c C s | � � �|�S )z�Return a 'scalar' representation of this selectable, embedded as a subquery with a label. .. seealso:: :meth:`_expression.SelectBase.scalar_subquery`. )r �labelr� r� r� r� rV � s zSelectBase.labelr� c C s t �| |�S )r� )r� r� r� r� r� r� r� s zSelectBase.lateralc C s t j| �� |d�S )a� Return a subquery of this :class:`_expression.SelectBase`. A subquery is from a SQL perspective a parenthesized, named construct that can be placed in the FROM clause of another SELECT statement. Given a SELECT statement such as:: stmt = select(table.c.id, table.c.name) The above statement might look like:: SELECT table.id, table.name FROM table The subquery form by itself renders the same way, however when embedded into the FROM clause of another SELECT statement, it becomes a named sub-element:: subq = stmt.subquery() new_stmt = select(subq) The above renders as:: SELECT anon_1.id, anon_1.name FROM (SELECT table.id, table.name FROM table) AS anon_1 Historically, :meth:`_expression.SelectBase.subquery` is equivalent to calling the :meth:`_expression.FromClause.alias` method on a FROM object; however, as a :class:`_expression.SelectBase` object is not directly FROM object, the :meth:`_expression.SelectBase.subquery` method provides clearer semantics. .. versionadded:: 1.4 r� )r� r� �_ensure_disambiguated_namesr� r� r� r� r� s ( �zSelectBase.subqueryc C s t � �dS )ztEnsure that the names generated by this selectbase will be disambiguated in some way, if possible. Nr� r� r� r� r� rW 9 s z&SelectBase._ensure_disambiguated_namesFr� r c C s | j |d�S )a. Return a named subquery against this :class:`_expression.SelectBase`. For a :class:`_expression.SelectBase` (as opposed to a :class:`_expression.FromClause`), this returns a :class:`.Subquery` object which behaves mostly the same as the :class:`_expression.Alias` object that is used with a :class:`_expression.FromClause`. .. versionchanged:: 1.4 The :meth:`_expression.SelectBase.alias` method is now a synonym for the :meth:`_expression.SelectBase.subquery` method. r� rP r r� r� r� r� A s zSelectBase.alias)N)N)NF)#r� r� r� r� r� � is_selectrJ r� r� r� rX r� rE r� r� r� r� r� r& r) rL r� r rB r� rK rR r rT r rV r� r� rW r� r� r� r� r� r� sZ %� � � � , �r� �_SBc @ s e Zd ZU dZdZdejfgej Z de d< dZ de d< ddd �d d �Z d d �dd�Z dd �dd�Zdd d�dd�Zedd �dd��Zd6ddd�d d �Zer�dd �d d �Zdd �d!d"dd#�d$d%�Zejd&d �d'd(��Zejd)d �d*d+��Zejd,d �d-d.��Zd/d0�d1d2dd3�d4d5�ZdS )7�SelectStatementGroupingz�Represent a grouping of a :class:`_expression.SelectBase`. This differs from :class:`.Subquery` in that we are still an "inner" SELECT statement, this is strictly for grouping inside of compound selects. Zselect_statement_groupingr� rS rO TrY r� �r� r� c C s t tt�tj|��| _d S r� )r rY r r� r r� r� r r� r� r� rT j s �z SelectStatementGrouping.__init__z SelectStatementGrouping[_SB]r� c C s$ | j �� }|| j k r t|�S | S d S r� )r� rW rZ )r� � new_elementr� r� r� rW o s z3SelectStatementGrouping._ensure_disambiguated_namesrH c C s | j �� S r� )r� rL r� r� r� r� rL v s z'SelectStatementGrouping.get_label_style�� label_styler� c C s t | j�|��S r� )rZ r� r� )r� r^ r� r� r� r� y s �z'SelectStatementGrouping.set_label_stylec C s | j S r� r� r� r� r� r� �select_statement� s z(SelectStatementGrouping.select_statementNr= r\ r> c C s | S r� r� r@ r� r� r� rA � s z"SelectStatementGrouping.self_groupc C s d S r� r� r� r� r� r� �_ungroup� r� z SelectStatementGrouping._ungrouprF r� rH rI c C s | j j||d� d S )NrF r� rJ r� r� r� r� � s �z;SelectStatementGrouping._generate_fromclause_column_proxiesr� c C s | j jS r� )r� r� r� r� r� r� r� � s z-SelectStatementGrouping._all_selected_columnsrD c C s | j jS )a: A :class:`_expression.ColumnCollection` representing the columns that the embedded SELECT statement returns in its result set, not including :class:`_sql.TextClause` constructs. .. versionadded:: 1.4 .. seealso:: :attr:`_sql.Select.selected_columns` )r� rE r� r� r� r� rE � s z(SelectStatementGrouping.selected_columnsr� c C s | j jS r� r r� r� r� r� r4 � s z%SelectStatementGrouping._from_objectsFr� r� r� r� c G s t �d S r� r� )r� r� r� r� r� r� r� � s z SelectStatementGrouping.add_cte)N) r� r� r� r� r� rT r� r* �%_clone_annotations_traverse_internalsrO r� Z_is_select_containerrT rW rL r� r� r_ rA r r` r� rX r� r� rE r4 r� r� r� r� r� rZ X s4 �� � rZ c @ s e Zd ZU dZdZded< dZded< dZded< dZded < dZ ded < dZ d ed < dZ d ed< e fdd�dd�Z edddddd�ddddddd�dd��Zdd�d d �Zddd �d d �Zed!d�d"d#��Zed!d�d$d%��ZdVd&d'd(d)d*�d+d,�Zed)d-d.d/�d0d1��Zed2d-d3d/�d4d1��Zdd-d5d/�d6d1�Zed3d�d7d8��Zd9dd:�d;d<�Zed3d�d=d>��Zedd�d?d@��Zed&ddA�dBdC��Z edWd&ddddD�dEdF��Z ed&ddG�dHdI��Z ee � dJ�dKdKddL�dMdN���Z!ee"j#fdOdPddQ�dRdS��Z$ee"j#fdOdPddQ�dTdU��Z%dS )X�GenerativeSelecta& Base class for SELECT statements where additional elements can be added. This serves as the base for :class:`_expression.Select` and :class:`_expression.CompoundSelect` where elements such as ORDER BY, GROUP BY can be added and column rendering can be controlled. Compare to :class:`_expression.TextualSelect`, which, while it subclasses :class:`_expression.SelectBase` and is also a SELECT construct, represents a fixed textual string which cannot be altered at this level, only wrapped as a subquery. r� � Tuple[ColumnElement[Any], ...]�_order_by_clauses�_group_by_clausesN� Optional[ColumnElement[Any]]� _limit_clause�_offset_clause� _fetch_clausezOptional[Dict[str, bool]]�_fetch_clause_optionsr$ �_for_update_argrH �r� c C s || _ d S r� rl )r� r� r� r� r� rT � s zGenerativeSelect.__init__Fr, r� r- r\ )r r r r! r" r� c C s t |||||d�| _| S )a" Specify a ``FOR UPDATE`` clause for this :class:`_expression.GenerativeSelect`. E.g.:: stmt = select(table).with_for_update(nowait=True) On a database like PostgreSQL or Oracle, the above would render a statement like:: SELECT table.a, table.b FROM table FOR UPDATE NOWAIT on other backends, the ``nowait`` option is ignored and instead would produce:: SELECT table.a, table.b FROM table FOR UPDATE When called with no arguments, the statement will render with the suffix ``FOR UPDATE``. Additional arguments can then be provided which allow for common database-specific variants. :param nowait: boolean; will render ``FOR UPDATE NOWAIT`` on Oracle and PostgreSQL dialects. :param read: boolean; will render ``LOCK IN SHARE MODE`` on MySQL, ``FOR SHARE`` on PostgreSQL. On PostgreSQL, when combined with ``nowait``, will render ``FOR SHARE NOWAIT``. :param of: SQL expression or list of SQL expression elements, (typically :class:`_schema.Column` objects or a compatible expression, for some backends may also be a table expression) which will render into a ``FOR UPDATE OF`` clause; supported by PostgreSQL, Oracle, some MySQL versions and possibly others. May render as a table or as a column depending on backend. :param skip_locked: boolean, will render ``FOR UPDATE SKIP LOCKED`` on Oracle and PostgreSQL dialects or ``FOR SHARE SKIP LOCKED`` if ``read=True`` is also specified. :param key_share: boolean, will render ``FOR NO KEY UPDATE``, or if combined with ``read=True`` will render ``FOR KEY SHARE``, on the PostgreSQL dialect. r, )r rk r2 r� r� r� r% � s 7�z GenerativeSelect.with_for_updater� c C s | j S )zS Retrieve the current label style. .. versionadded:: 1.4 rl r� r� r� r� rL s z GenerativeSelect.get_label_stylerM c C s | j |k r| �� } || _ | S )a{ Return a new selectable with the specified label style. There are three "label styles" available, :attr:`_sql.SelectLabelStyle.LABEL_STYLE_DISAMBIGUATE_ONLY`, :attr:`_sql.SelectLabelStyle.LABEL_STYLE_TABLENAME_PLUS_COL`, and :attr:`_sql.SelectLabelStyle.LABEL_STYLE_NONE`. The default style is :attr:`_sql.SelectLabelStyle.LABEL_STYLE_DISAMBIGUATE_ONLY`. In modern SQLAlchemy, there is not generally a need to change the labeling style, as per-expression labels are more effectively used by making use of the :meth:`_sql.ColumnElement.label` method. In past versions, :data:`_sql.LABEL_STYLE_TABLENAME_PLUS_COL` was used to disambiguate same-named columns from different tables, aliases, or subqueries; the newer :data:`_sql.LABEL_STYLE_DISAMBIGUATE_ONLY` now applies labels only to names that conflict with an existing name so that the impact of this labeling is minimal. The rationale for disambiguation is mostly so that all column expressions are available from a given :attr:`_sql.FromClause.c` collection when a subquery is created. .. versionadded:: 1.4 - the :meth:`_sql.GenerativeSelect.set_label_style` method replaces the previous combination of ``.apply_labels()``, ``.with_labels()`` and ``use_labels=True`` methods and/or parameters. .. seealso:: :data:`_sql.LABEL_STYLE_DISAMBIGUATE_ONLY` :data:`_sql.LABEL_STYLE_TABLENAME_PLUS_COL` :data:`_sql.LABEL_STYLE_NONE` :data:`_sql.LABEL_STYLE_DEFAULT` )r� � _generaterO r� r� r� r� s & z GenerativeSelect.set_label_stylerI c C s t �tj| j�S )z9ClauseList access to group_by_clauses for legacy dialects)rI �_construct_rawr �comma_opre r� r� r� r� �_group_by_clauseH s �z!GenerativeSelect._group_by_clausec C s t �tj| j�S )z9ClauseList access to order_by_clauses for legacy dialects)rI rn r ro rd r� r� r� r� �_order_by_clauseO s �z!GenerativeSelect._order_by_clauserc r� z"Optional[_TypeEngineArgument[int]]r� )r� r� �type_r� c C s t jtj|||d�S )z�Convert the given value to an "offset or limit" clause. This handles incoming integers and converts to an expression; if an expression is already given, it is passed through. )r� rr )r r� r ZLimitOffsetRole)r� r� r� rr r� r� r� �_offset_or_limit_clauseV s �z(GenerativeSelect._offset_or_limit_clauser� r )�clause�attrnamer� c C s d S r� r� �r� rt ru r� r� r� � _offset_or_limit_clause_asintf s z.GenerativeSelect._offset_or_limit_clause_asintzOptional[_OffsetLimitParam]r� c C s d S r� r� rv r� r� r� rw k s z Union[NoReturn, Optional[int]]c C sX |dkr dS z |j }W n2 tk rH } zt�d| �|�W 5 d}~X Y n X t�|�S dS )z�Convert the "offset or limit" clause of a select construct to an integer. This is only possible if the value is stored as a simple bound parameter. Otherwise, a compilation error is raised. Nz@This SELECT structure does not use a simple integer value for %s)r� �AttributeErrorrW � CompileErrorrX Zasint)r� rt ru �value�errr� r� r� rw p s ���c C s | � | jd�S )z�Get an integer value for the limit. This should only be used by code that cannot support a limit as a BindParameter or other custom clause as it will throw an exception if the limit isn't currently set to an integer. �limit)rw rg r� r� r� r� �_limit� s zGenerativeSelect._limitrH �rt r� c C s t |t�S )zkTrue if the clause is a simple integer, False if it is not present or is a SQL expression. )rk r� )r� rt r� r� r� �_simple_int_clause� s z#GenerativeSelect._simple_int_clausec C s | � | jd�S )z�Get an integer value for the offset. This should only be used by code that cannot support an offset as a BindParameter or other custom clause as it will throw an exception if the offset isn't currently set to an integer. �offset)rw rh r� r� r� r� �_offset� s �zGenerativeSelect._offsetc C s | j d k p | jd k p | jd k S r� )rg rh ri r� r� r� r� �_has_row_limiting_clause� s ��z)GenerativeSelect._has_row_limiting_clause)r| r� c C s d | _ | _| �|�| _| S )a� Return a new selectable with the given LIMIT criterion applied. This is a numerical value which usually renders as a ``LIMIT`` expression in the resulting select. Backends that don't support ``LIMIT`` will attempt to provide similar functionality. .. note:: The :meth:`_sql.GenerativeSelect.limit` method will replace any clause applied with :meth:`_sql.GenerativeSelect.fetch`. :param limit: an integer LIMIT parameter, or a SQL expression that provides an integer result. Pass ``None`` to reset it. .. seealso:: :meth:`_sql.GenerativeSelect.fetch` :meth:`_sql.GenerativeSelect.offset` N)ri rj rs rg )r� r| r� r� r� r| � s zGenerativeSelect.limit)�count� with_ties�percentr� c C s8 d| _ |dkr d | _| _n| �|�| _||d�| _| S )a� Return a new selectable with the given FETCH FIRST criterion applied. This is a numeric value which usually renders as ``FETCH {FIRST | NEXT} [ count ] {ROW | ROWS} {ONLY | WITH TIES}`` expression in the resulting select. This functionality is is currently implemented for Oracle, PostgreSQL, MSSQL. Use :meth:`_sql.GenerativeSelect.offset` to specify the offset. .. note:: The :meth:`_sql.GenerativeSelect.fetch` method will replace any clause applied with :meth:`_sql.GenerativeSelect.limit`. .. versionadded:: 1.4 :param count: an integer COUNT parameter, or a SQL expression that provides an integer result. When ``percent=True`` this will represent the percentage of rows to return, not the absolute value. Pass ``None`` to reset it. :param with_ties: When ``True``, the WITH TIES option is used to return any additional rows that tie for the last place in the result set according to the ``ORDER BY`` clause. The ``ORDER BY`` may be mandatory in this case. Defaults to ``False`` :param percent: When ``True``, ``count`` represents the percentage of the total number of selected rows to return. Defaults to ``False`` .. seealso:: :meth:`_sql.GenerativeSelect.limit` :meth:`_sql.GenerativeSelect.offset` N)r� r� )rg ri rj rs )r� r� r� r� r� r� r� �fetch� s - �zGenerativeSelect.fetch)r� r� c C s | � |�| _| S )a2 Return a new selectable with the given OFFSET criterion applied. This is a numeric value which usually renders as an ``OFFSET`` expression in the resulting select. Backends that don't support ``OFFSET`` will attempt to provide similar functionality. :param offset: an integer OFFSET parameter, or a SQL expression that provides an integer result. Pass ``None`` to reset it. .. seealso:: :meth:`_sql.GenerativeSelect.limit` :meth:`_sql.GenerativeSelect.fetch` )rs rh )r� r� r� r� r� r� s zGenerativeSelect.offsetr� r* )�start�stopr� c C s4 t jj}d | _| _|�| j| j||�\| _| _| S )a Apply LIMIT / OFFSET to this statement based on a slice. The start and stop indices behave like the argument to Python's built-in :func:`range` function. This method provides an alternative to using ``LIMIT``/``OFFSET`` to get a slice of the query. For example, :: stmt = select(User).order_by(User).id.slice(1, 3) renders as .. sourcecode:: sql SELECT users.id AS users_id, users.name AS users_name FROM users ORDER BY users.id LIMIT ? OFFSET ? (2, 1) .. note:: The :meth:`_sql.GenerativeSelect.slice` method will replace any clause applied with :meth:`_sql.GenerativeSelect.fetch`. .. versionadded:: 1.4 Added the :meth:`_sql.GenerativeSelect.slice` method generalized from the ORM. .. seealso:: :meth:`_sql.GenerativeSelect.limit` :meth:`_sql.GenerativeSelect.offset` :meth:`_sql.GenerativeSelect.fetch` N)rX r� r� ri rj Z _make_slicerg rh )r� r� r� r� r� r� r� �slice s - � zGenerativeSelect.slicezMUnion[Literal[None, _NoArg.NO_ARG], _ColumnExpressionOrStrLabelArgument[Any]]z(_ColumnExpressionOrStrLabelArgument[Any])�_GenerativeSelect__first�clausesr� c sH |s|dkrd� _ n0|tjk rD� j t� fdd�|f| D ��7 _ � S )a� Return a new selectable with the given list of ORDER BY criteria applied. e.g.:: stmt = select(table).order_by(table.c.id, table.c.name) Calling this method multiple times is equivalent to calling it once with all the clauses concatenated. All existing ORDER BY criteria may be cancelled by passing ``None`` by itself. New ORDER BY criteria may then be added by invoking :meth:`_orm.Query.order_by` again, e.g.:: # will erase all ORDER BY and ORDER BY new_col alone stmt = stmt.order_by(None).order_by(new_col) :param \*clauses: a series of :class:`_expression.ColumnElement` constructs which will be used to generate an ORDER BY clause. .. seealso:: :ref:`tutorial_order_by` - in the :ref:`unified_tutorial` :ref:`tutorial_order_by_label` - in the :ref:`unified_tutorial` Nr� c 3 s | ]}t jtj|� d �V qdS �r� N)r r� r Z OrderByRole�r� rt r� r� r� r$ t s � �z,GenerativeSelect.order_by.<locals>.<genexpr>)rd r8 �NO_ARGr� �r� r� r� r� r� r� �order_byM s $ � zGenerativeSelect.order_byc sH |s|dkrd� _ n0|tjk rD� j t� fdd�|f| D ��7 _ � S )a~ Return a new selectable with the given list of GROUP BY criterion applied. All existing GROUP BY settings can be suppressed by passing ``None``. e.g.:: stmt = select(table.c.name, func.max(table.c.stat)).\ group_by(table.c.name) :param \*clauses: a series of :class:`_expression.ColumnElement` constructs which will be used to generate an GROUP BY clause. .. seealso:: :ref:`tutorial_group_by_w_aggregates` - in the :ref:`unified_tutorial` :ref:`tutorial_order_by_label` - in the :ref:`unified_tutorial` Nr� c 3 s | ]}t jtj|� d �V qdS r� )r r� r Z GroupByRoler� r� r� r� r$ � s � �z,GenerativeSelect.group_by.<locals>.<genexpr>)re r8 r� r� r� r� r� r� �group_by| s � zGenerativeSelect.group_by)NN)FF)&r� r� r� r� rd r� re rg rh ri rj rk rM rT r5 r% rL r� r� rp rq rs r rw r} r r� r� r| r� r� rX r� r� r8 r� r� r� r� r� r� r� rb � sl � ? + � �72�.�rb �default�compound_selectc @ s e Zd Zejdd�dd��ZdS )�CompoundSelectState�bTuple[Dict[str, ColumnElement[Any]], Dict[str, ColumnElement[Any]], Dict[str, ColumnElement[Any]]]r� c C s* | j �� }d|_dd� |jD �}|||fS )NFc S s i | ] }|j |�qS r� r� r5 r� r� r� re � s z;CompoundSelectState._label_resolve_dict.<locals>.<dictcomp>)� statementr� rB r& )r� Zhacky_subquery�dr� r� r� �_label_resolve_dict� s z'CompoundSelectState._label_resolve_dictN)r� r� r� rX Zmemoized_propertyr� r� r� r� r� r� � s r� c @ s$ e Zd ZdZdZdZdZdZdZdS )�_CompoundSelectKeyword�UNIONz UNION ALL�EXCEPTz EXCEPT ALL� INTERSECTz INTERSECT ALLN) r� r� r� r� � UNION_ALLr� � EXCEPT_ALLr� � INTERSECT_ALLr� r� r� r� r� � s r� c s� e Zd ZU dZdZdejfdejfdejfdejfdejfdejfd ejfd ejfd ej fg e j e j Zd ed < ded< dZdZddd�dd�Zedd d�dd��Zedd d�dd��Zedd d�dd ��Zedd d�d d ��Zedd d�d d ��Zedd d�d!d"��Zd#d$�d%d&�ZdId(d)d*�d+d,�Zd-d.d/�d0d1�Z d2d d3�d4d5�Z d d$�d6d7�Z d'd8�d9d:d;d<�d=d>�Z d?d;d@�� fdAdB� Z e!j"dCd$�dDdE��Z#e!j"dFd$�dGdH��Z$� Z%S )J�CompoundSelectaX Forms the basis of ``UNION``, ``UNION ALL``, and other SELECT-based set operations. .. seealso:: :func:`_expression.union` :func:`_expression.union_all` :func:`_expression.intersect` :func:`_expression.intersect_all` :func:`_expression.except` :func:`_expression.except_all` r� �selectsrg rh ri rj rd re rk �keywordrS rO zList[SelectBase]TFr� rg )r� r� c s( |� _ � fdd�|D �� _t�� � d S )Nc s& g | ] }t jtj|� d �j� d��qS )r� rQ )r r� r �CompoundElementRolerA )r� �sr� r� r� r� � s � ��z+CompoundSelect.__init__.<locals>.<listcomp>)r� r� rb rT )r� r� r� r� r� r� rT � s �zCompoundSelect.__init__)r� r� c G s t tjf|�� S r� )r� r� r� �r� r� r� r� r� � _create_union� s z CompoundSelect._create_unionc G s t tjf|�� S r� )r� r� r� r� r� r� r� �_create_union_all s z CompoundSelect._create_union_allc G s t tjf|�� S r� )r� r� r� r� r� r� r� �_create_except s z CompoundSelect._create_exceptc G s t tjf|�� S r� )r� r� r� r� r� r� r� �_create_except_all s z!CompoundSelect._create_except_allc G s t tjf|�� S r� )r� r� r� r� r� r� r� �_create_intersect s z CompoundSelect._create_intersectc G s t tjf|�� S r� )r� r� r� r� r� r� r� �_create_intersect_all s z$CompoundSelect._create_intersect_allrQ r� c C s | j d �� S �Nr )r� rR r� r� r� r� rR ! s zCompoundSelect._scalar_typeNr= rM r> c C s t | �S r� )rZ r@ r� r� r� rA $ s zCompoundSelect.self_groupr� r� r� c C s | j D ]}|�|�r dS qdS �NTF)r� r� )r� r� r� r� r� r� r� ) s z CompoundSelect.is_derived_fromrH rM c C s< | j |k r8| �� } | jd �|�}|g| jdd � | _| S �Nr r )r� rm r� r� )r� rN �select_0r� r� r� r� / s z CompoundSelect.set_label_stylec C s> | j d �� }|| j d k r:| �� } |g| j dd � | _ | S r� )r� rW rm )r� Z new_selectr� r� r� rW 7 s z*CompoundSelect._ensure_disambiguated_namesrF r� rH r� rI c C sT | j d }| jtk r |�| j�}tdd� dd� t| j �D �D �� }|j||d� d S )Nr c s$ g | ] \� }� fd d�|j D ��qS )c s g | ]}t |�r|�� ��qS r� )r$ Z _annotater5 ��ddr� r� r� X s �zQCompoundSelect._generate_fromclause_column_proxies.<locals>.<listcomp>.<listcomp>)r� )r� �stmtr� r� r� r� W s � �zFCompoundSelect._generate_fromclause_column_proxies.<locals>.<listcomp>c S s g | ]\}}d |d i|f�qS )�weightr r� )r� �ir� r� r� r� r� ] s �rF )r� r� rM r� �zip� enumerater� )r� r� rG r� �extra_col_iteratorr� r� r� r� ? s ��� �z2CompoundSelect._generate_fromclause_column_proxiesr� r� c s& t � �|� | jD ]}|�|� qd S r� )rq r� r� )r� r� r ru r� r� r� m s z&CompoundSelect._refresh_for_new_columnr� c C s | j d jS r� )r� r� r� r� r� r� r� r s z$CompoundSelect._all_selected_columnsrD c C s | j d jS )a\ A :class:`_expression.ColumnCollection` representing the columns that this SELECT statement or similar construct returns in its result set, not including :class:`_sql.TextClause` constructs. For a :class:`_expression.CompoundSelect`, the :attr:`_expression.CompoundSelect.selected_columns` attribute returns the selected columns of the first SELECT statement contained within the series of statements within the set operation. .. seealso:: :attr:`_sql.Select.selected_columns` .. versionadded:: 1.4 r )r� rE r� r� r� r� rE v s z CompoundSelect.selected_columns)N)&r� r� r� r� r� rT r� r� � dp_plain_dictr r* ra r� r� rO r� r� �_auto_correlaterT r� r� r� r� r� r� r� rR rA r� r� rW r� r� rX r� r� rE r� r� r� ru r� r� � s\ � � �� ��.r� r c @ s~ e Zd ZU dZer ded< nG dd� de�ZerDeddd�dd ��Z d d d d �dd�Z edd�dd��Z ed dd�dd��Z ed ddd�dd��Z ed d d�d d ��Zed d d!�d"d#��Zd d d�d$d%�ZedNd'd(d)d d*�d+d,��ZdOd-d-d d.�d/d0�Zd1d�d2d3�Zed d4d5�d6d7��Zed d8d�d9d:��Zd;d<d=d>�d?d@�Ze�dA�d<dBdCdDdEdF�dGdH��Ze�dA�dIdJdK�dLdM��Zd&S )Pr� )� from_clauses�froms�columns_plus_namesr� r: � default_select_compile_optionsc @ s e Zd Zg ZdS )z*SelectState.default_select_compile_optionsN)r� r� r� �_cache_key_traversalr� r� r� r� r� � s r? �Type[SelectState]�r� r� c C s d S r� r� �r� r� r� r� r� �get_plugin_class� s z SelectState.get_plugin_classr zOptional[SQLCompiler]r )r� �compilerra c K s\ || _ |j| _|jD ]}| �|j|j� q|jr@| �|j|j� | �|�| _|�d�| _ d S r� ) r� � _from_objr� �_memoized_select_entities� _setup_joins� _raw_columns� _get_fromsr� r� r� )r� r� r� ra Zmemoized_entitiesr� r� r� rT � s � zSelectState.__init__r r� c C s t d��d S )NzLThe default SELECT construct without plugins does not implement this method.r� )r� r� r� r� �_plugin_not_implemented� s �z#SelectState._plugin_not_implementedzList[Dict[str, Any]]c C s dd� |� d�D �S )Nc S s$ g | ] \}}}}}||j |d ��qS ))r� r; �exprr: )r� r� r� r� r� r� r� r� � s ��z7SelectState.get_column_descriptions.<locals>.<listcomp>F)r� r� r� r� r� �get_column_descriptions� s �z#SelectState.get_column_descriptions�roles.ReturnsRowsRoler� )r� �from_statementr� c C s | � � d S r� )r� )r� r� r� r� r� r� r� � s zSelectState.from_statementr� c C s | � tj�dd� |jD ���S )Nc s s | ] }|j V qd S r� r3 �r� r� r� r� r� r$ � s z7SelectState.get_columns_clause_froms.<locals>.<genexpr>)�_normalize_fromsr\ r] � from_iterabler� r� r� r� r� �get_columns_clause_froms� s ��z$SelectState.get_columns_clause_fromsrH �_LabelConventionCallabler] c s> |t k�|tk � t� �t� �ddddd�� ���fdd� }|S )Nr� r� )r& �col_namer� c s� t | �r d S tr t| �s t�� s6| j}|d kr2d}|S �r@| jn| j}|d krxd}|�krh| �|�� S ��|� |S n.|�kr��r�| j� S | j � S ��|� |S d S )NZ _no_label) r( r r$ r7 Z _proxy_keyrX Z _anon_labelr Z_anon_tq_key_labelZ_anon_key_label)r& r� r� �r� r� �par� r� r� �go� s. � � z1SelectState._column_naming_convention.<locals>.go)N)rK rJ rU r8 )r� r^ r� r� r� r� r� � s � #z%SelectState._column_naming_conventionc C sN i | _ }| jt�| jtj�dd� |jD ��tj�dd� |jD ���||d�S )Nc S s g | ] }|j �qS r� r3 r� r� r� r� r� s �z*SelectState._get_froms.<locals>.<listcomp>c S s g | ] }|j �qS r� r3 r� r� r� r� r� $ s �)�check_statement�ambiguous_table_name_map)Z_ambiguous_table_name_mapr� r\ r] r� r� r� �_where_criteria)r� r� r� r� r� r� r� s$ ������zSelectState._get_fromsNr� zOptional[Select[Any]]z Optional[_AmbiguousTableNameMap])�iterable_of_fromsr� r� r� c s� t � }g }|D ]B}t|�r.|j|kr.t�d��|�|j�s|�|� |�|j� q|r�t t j � dd� |D �����r��fdd�|D �}� dk r�� �� fdd�|D �� |S )a0 given an iterable of things to select FROM, reduce them to what would actually render in the FROM clause of a SELECT. This does the job of checking for JOINs, tables, etc. that are in fact overlapping due to cloning, adaption, present in overlapping joins, etc. z-select() construct refers to itself as a FROMc S s g | ]}t |j��qS r� )r2 r� rb r� r� r� r� M s z0SelectState._normalize_froms.<locals>.<listcomp>c s g | ]}|� kr|�qS r� r� rb )�toremover� r� r� S s Nc 3 sL | ]D}|j D ]8}t|�r |jr |j� kr |jt�t|j�|j�fV q qd S r� )r4 r' r� r� rE r� rV )r� �item�fr)r� r� r� r$ V s � ��z/SelectState._normalize_froms.<locals>.<genexpr>) r8 r& r� rW �InvalidRequestErrorr r r� r[ r\ r] r� )r� r� r� r� �seenr� r� r� )r� r� r� r� . s. � ���z SelectState._normalize_fromsz Optional[Sequence[FromClause]])�explicit_correlate_froms�implicit_correlate_fromsr� c s� �j ��jjr0�jj��r0� ��fdd��D ���jjdk rR� ��fdd��D ���jjr��r�t��dkr���fdd��D ��t��s�t�d�j ���S )a Return the full list of 'from' clauses to be displayed. Takes into account a set of existing froms which may be rendered in the FROM clause of enclosing selects; this Select may want to leave those absent if it is automatically correlating. c s( g | ] }|t t �� pd ���kr|�qS �r� r- rb )r� r� � to_correlater� r� r� y s ����z2SelectState._get_display_froms.<locals>.<listcomp>Nc s, g | ]$}|t t�� pd ��jj�kr|�qS r� )r, r. r� �_correlate_exceptrb )r� r� r� r� r� r� � s ����r c s g | ]}|t � ��kr|�qS r� r- rb )r� r� r� r� r� � s ��z�Select statement '%r' returned no FROM clauses due to auto-correlation; specify correlate(<tables>) to control correlation manually.)r� r� � _correlater� r� r� rW r� )r� r� r� r� )r� r� r� r� r� r� �_get_display_fromsf s6 � � �� � ��� z SelectState._get_display_fromsr� c C sV dd� | j jD �}dd� t| j�D �}|�� }|�� D ]\}}|�||� q6|||fS )Nc S s i | ]}|j r|jp|j|�qS r� )�_allow_label_resolver� r3 r5 r� r� r� re � s � zBSelectState._memoized_attr__label_resolve_dict.<locals>.<dictcomp>c S s i | ]}|j r|j|�qS r� )r� r3 r5 r� r� r� re � s � )r� r� r9 r� �copy�items� setdefault)r� Z with_colsZ only_fromsZ only_colsr3 rz r� r� r� �"_memoized_attr__label_resolve_dict� s ��z.SelectState._memoized_attr__label_resolve_dictz Optional[_JoinTargetElement])r� r� c C s |j r|j d d S d S d S )N���r )r� )r� r� r� r� r� � determine_last_joined_entity� s z(SelectState.determine_last_joined_entityr� c C s dd� t |j�D �S )Nc S s g | ]}|�qS r� r� r5 r� r� r� r� � s z4SelectState.all_selected_columns.<locals>.<listcomp>)r9 r� r� r� r� r� �all_selected_columns� s z SelectState.all_selected_columns� Tuple[_SetupJoinsElement, ...]�List[_ColumnsClauseElement]r� )�args� raw_columnsr� c C s |D ]�\}}}}t r*|d k r*t|t�s*t�|d }|d }|d krX| �||||�\}} n | �|�} t r�t|t�stt�|d k r�t|t�s�t�| d k r�| j| } | jd | � t| ||||d�f | j| d d � | _q|d k s�t�| jt|||||d�f | _qd S )Nr r r� r ) r rk rK r7 �"_join_determine_implicit_left_side� _join_place_explicit_left_sider� r� r ) r� r� r� r r rN �flagsr r �replace_from_obj_indexZ left_clauser� r� r� r� � sV ���� ��� �� �zSelectState._setup_joinsr� r� �_JoinTargetElementrf z*Tuple[Optional[FromClause], Optional[int]])r� rN r r r� c C s� t jj}d}| j}|rB|�|||�}t|�dkr�|d }|| }n|i } | j} t�tj� dd� |D ��tj� dd� | j D ���D ] } d| | < q~t | � � �} |�| ||�}t|�dkr�| |d }t|�dkr�t �d��n|s�t �d |f ��||fS ) z�When join conditions don't express the left side explicitly, determine if an existing FROM or entity in this query can serve as the left hand side. Nr r c S s g | ] }|j �qS r� r3 r� r� r� r� r� + s zBSelectState._join_determine_implicit_left_side.<locals>.<listcomp>c S s g | ] }|j �qS r� r3 r� r� r� r� r� . s �r� a Can't determine which FROM clause to join from, there are multiple FROMS which can join to this entity. Please use the .select_from() method to establish an explicit left side, as well as providing an explicit ON clause if not present already to help resolve the ambiguity.z�Don't know how to join to %r. Please use the .select_from() method to establish an explicit left side, as well as providing an explicit ON clause if not present already to help resolve the ambiguity.)rX r� r� r� Z find_left_clause_to_join_fromr� r� r\ r] r� r� r� �keysrW r� ) r� r� rN r r r� r� r� �indexesZ potentialr� Z from_clauseZ all_clausesr� r� r� r� sX � ���� � ���z.SelectState._join_determine_implicit_left_sider� r� )rN r� c C sX d }t jj}t| j�� �}|r.|�| j|�}ng }t|�dkrHt � d��|rT|d }|S )Nr zrCan't identify which entity in which to assign the left side of this join. Please use a more specific ON clause.r ) rX r� r� r� r� �_iterate_from_elementsZ#find_left_clause_that_matches_givenr� r� rW r� )r� rN r� r� r� r� r� r� r� r� Q s � �z*SelectState._join_place_explicit_left_side)NN)NN)r� r� r� � __slots__r r� r: r� r� r� rT r� r� r� r� r� r� r� r� r� r� r� r� rX r� r� r� r� r� r� r� r� � sH / �9 �D;Gr� c @ s8 e Zd ZU dZded< ded< ded< dd �d d �Zd S ) �_SelectFromElementsr� r� r� rc r� �Tuple[FromClause, ...]r� zIterator[FromClause]r� c c s� t � }| jD ]*}|jD ] }||kr$q|�|� |V qq | jD ]*}|jD ] }||krVqH|�|� |V qHq>| jD ] }||kr~qp|�|� |V qpd S r� )r8 r� r4 r r� r� )r� r� r� r� r� r� r� r� { s$ z*_SelectFromElements._iterate_from_elementsN)r� r� r� r� r� r� r� r� r� r� r� t s r� c @ s� e Zd ZU dZdZdejfdejfdejfgZ de d< de d < d e d< d e d< d e d< e j Z d dd�dd�Zeddd�dd��ZdS )�_MemoizedSelectEntitiesa represents partial state from a Select object, for the case where Select.columns() has redefined the set of columns/entities the statement will be SELECTing from. This object represents the entities from the SELECT before that transformation was applied, so that transformations that were made in terms of the SELECT at that time, such as join() as well as options(), can access the correct context. In previous SQLAlchemy versions, this wasn't needed because these constructs calculated everything up front, like when you called join() or options(), it did everything to figure out how that would translate into specific SQL constructs that would be ready to send directly to the SQL compiler when needed. But as of 1.4, all of that stuff is done in the compilation phase, during the "compile state" portion of the process, so that the work can all be cached. So it needs to be able to resolve joins/options2 based on what the list of entities was when those methods were called. Zmemoized_select_entitiesr� r� � _with_optionsrS rO zOptional[ClauseElement]r� r� r� z Tuple[ExecutableOption, ...]r r\ r c K s8 | j �| j �}dd� | j�� D �|_| j�d| �|_|S )Nc S s i | ]\}}||�qS r� r� )r� �k�vr� r� r� re � s z2_MemoizedSelectEntities._clone.<locals>.<dictcomp>r� )r r� r* r� �getr� )r� ra r& r� r� r� r+ � s z _MemoizedSelectEntities._cloner r� )� select_stmtr� c C sP |j s |jrLt� }|j|_|j |_ |j|_| j|f7 _g |_d |_ |_d S r� )r� r� r� r� r� )r� r r� r� r� r� �_generate_for_statement� s z/_MemoizedSelectEntities._generate_for_statementN)r� r� r� r� r� rT r� �dp_setup_join_tupleZdp_executable_optionsrO r� rX � EMPTY_DICTZ _annotationsr+ r� r r� r� r� r� r� � s � r� c s, e Zd ZU dZdZdZded< dZded< ded < d Zd ed < dZ d ed< dZ ded< dZ ded< dZ d ed< dZ d ed< dZded< dZdZejZded< d ejfdejfdejfdejfdejfdejfdejfdejfdejfdejfd ejfd ejfd ejfd ejfd ejfd ejfdejfd!ej fge j e j e!j" e#j$ e%j& e'j( Z)d"ed#< e)dej*fg Z+d$ed%< d&ed'< e,d(d)d*�d+d,��Z-d-d.�d/d0�Z.d1d2�d3d4�Z/d5d6d7�d8d9�Z0d:d2�d;d<�Z1e2�re3d=d>d?�d@dA��Z4e3dBdCd?�dDdA��Z4e3d>d2�dEdA��Z4d>d2�dFdA�Z4d(d6dG�dHdI�Z5e6d(d2�dJdK��Z7dLdMdN�dOdP�Z8e9d�d d dQ�dRdSd d d6dT�dUdV��Z:d�d dW�dXdRdSd d6dY�dZd[�Z;e9d�d d dQ�dXdRdSd d d6d\�d]d^��Z<d�d dW�dRdSd d6d_�d`da�Z=dbd2�dcdd�Z>e6e?�@dedf�dbd2�dgdh���ZAe6did2�djdk��ZBe6dld2�dmdn��ZCdod dp�dqdr�ZDeEfdsd(dtdu�� fdvdw� ZFd(dxd*�� fdydz� ZGe9d-d)d{�d|d}��ZHd~dtd{�dd��ZIe?�@d�d��d-d)d��d�d���ZJe?�Kd��d�d d)d��d�d���ZLe3d�d�d��d�d���ZMe3d�d�d�d��d�d���ZMe3d�d�d�d�d��d�d���ZMe3d�d�d�d�d�d��d�d���ZMe3d�d�d�d�d�d�d��d�d���ZMe3d�d�d�d�d�d�d�d��d�d���ZMe3d�d�d�d�d�d�d�d�d��d�d���ZMe3d�d�d�d�d�d�d�d�d�d�� d�d���ZMe3d d��d-d d(d)d��d�d���ZMe9d d��d-d d(d)d��d�d���ZMe6d�d2�d�d���ZNeNZOe9d5d6d��d�d���ZPe9d5d6d��d�d���ZQe9d�d6d��d�d���ZRe9dXd6d��d�d���ZSe9d�d6d��d�d�ZTe9d�d6d��d�dĄ�ZUeVd�d2�d�dDŽ�ZWeVdld2�d�dɄ�ZXd)d2�d�d˄ZYdd̜d�d�dtdϜd�dфZZd d2�d�dӄZ[d�d�d�d֜d�dZ\d�d�dۜd�d݄Z]d�d�dۜd�d߄Z^d�d�dۜd�d�Z_d�d�dۜd�d�Z`d�d�dۜd�d�Zad�d�dۜd�d�Zb� ZcS )�r a Represents a ``SELECT`` statement. The :class:`_sql.Select` object is normally constructed using the :func:`_sql.select` function. See that function for details. .. seealso:: :func:`_sql.select` :ref:`tutorial_selecting_data` - in the 2.0 tutorial r r� r� r� zTuple[TODO_Any, ...]r� r� r� Fr� � _distinctrc � _distinct_onr� r� Nz Optional[Tuple[FromClause, ...]]r� r� �_having_criteriar� Tr: �_compile_optionsrd re rg rh ri rj rk r� rS rO rv r� r� �_compile_state_factoryr r r c K s t �t �}|j�|� |S )z�Create a :class:`.Select` using raw ``__new__`` with no coercions. Used internally to build up :class:`.Select` constructs with pre-established state. )r r� r* r[ )r� ra r� r� r� r� �_create_raw_select s zSelect._create_raw_selectz_ColumnsClauseArgument[Any])�entitiesc s" � fdd�|D �� _ t�� � dS )z�Construct a new :class:`_expression.Select`. The public constructor for :class:`_expression.Select` is the :func:`_sql.select` function. c s g | ]}t jtj|� d ��qS �r� r. �r� Zentr� r� r� r� 1 s � �z#Select.__init__.<locals>.<listcomp>N)r� rb rT �r� r r� r� r� rT * s �zSelect.__init__rQ r� c C s( | j s tS | j d }t|j�}|d jS r� )r� rR r� r6 r; )r� r0 r� r� r� r� rR : s zSelect._scalar_type� _ColumnExpressionArgument[bool]r\ )�criteriar� c G s | j |� S )z3A synonym for the :meth:`_sql.Select.where` method.��where)r� r r� r� r� �filterA s z Select.filterzFUnion[FromClause, _JoinTargetProtocol, ColumnElement[Any], TextClause]c C s@ | j r&t�| �j}|| �}|d k r&|S | jr6| jd S | jd S r� )r� r� r� r� r� r� )r� �methZ_last_joined_entityr� r� r� �_filter_by_zeroF s � zSelect._filter_by_zeroz Select[Tuple[_MAYBE_ENTITY]]r )r� r� c C s d S r� r� r� r� r� r� r Z s zSelect.scalar_subqueryzSelect[Tuple[_NOT_ENTITY]]zScalarSelect[_NOT_ENTITY]c C s d S r� r� r� r� r� r� r _ s c C s d S r� r� r� r� r� r� r d s c C s d S r� r� r� r� r� r� r g r� )�kwargsr� c s( | � � � � fdd�|�� D �}| j|� S )zWapply the given filtering criterion as a WHERE clause to this select. c s g | ]\}}t � |�|k�qS r� r/ )r� r3 rz �Z from_entityr� r� r� p s �z$Select.filter_by.<locals>.<listcomp>)r r� r )r� r r� r� r r� � filter_byi s �zSelect.filter_byc C s t �| �j}|| �S )a5 Return a :term:`plugin-enabled` 'column descriptions' structure referring to the columns which are SELECTed by this statement. This attribute is generally useful when using the ORM, as an extended structure which includes information about mapped entities is returned. The section :ref:`queryguide_inspection` contains more background. For a Core-only statement, the structure returned by this accessor is derived from the same objects that are returned by the :attr:`.Select.selected_columns` accessor, formatted as a list of dictionaries which contain the keys ``name``, ``type`` and ``expr``, which indicate the column expressions to be selected:: >>> stmt = select(user_table) >>> stmt.column_descriptions [ { 'name': 'id', 'type': Integer(), 'expr': Column('id', Integer(), ...)}, { 'name': 'name', 'type': String(length=30), 'expr': Column('name', String(length=30), ...)} ] .. versionchanged:: 1.4.33 The :attr:`.Select.column_descriptions` attribute returns a structure for a Core-only set of entities, not just ORM-only entities. .. seealso:: :attr:`.UpdateBase.entity_description` - entity information for an :func:`.insert`, :func:`.update`, or :func:`.delete` :ref:`queryguide_inspection` - ORM background )r� r� r� �r� r r� r� r� �column_descriptionsv s ) zSelect.column_descriptionsr� r� r� c C s t �| �j}|| |�S )a� Apply the columns which this :class:`.Select` would select onto another statement. This operation is :term:`plugin-specific` and will raise a not supported exception if this :class:`_sql.Select` does not select from plugin-enabled entities. The statement is typically either a :func:`_expression.text` or :func:`_expression.select` construct, and should return the set of columns appropriate to the entities represented by this :class:`.Select`. .. seealso:: :ref:`orm_queryguide_selecting_text` - usage examples in the ORM Querying Guide )r� r� r� )r� r� r r� r� r� r� � s zSelect.from_statementr� rb rP )�targetr r r r� c C sP t jtj|| d�}|dk r*t �tj|�}nd}| j||d||d�ff7 _| S )ah Create a SQL JOIN against this :class:`_expression.Select` object's criterion and apply generatively, returning the newly resulting :class:`_expression.Select`. E.g.:: stmt = select(user_table).join(address_table, user_table.c.id == address_table.c.user_id) The above statement generates SQL similar to:: SELECT user.id, user.name FROM user JOIN address ON user.id = address.user_id .. versionchanged:: 1.4 :meth:`_expression.Select.join` now creates a :class:`_sql.Join` object between a :class:`_sql.FromClause` source that is within the FROM clause of the existing SELECT, and a given target :class:`_sql.FromClause`, and then adds this :class:`_sql.Join` to the FROM clause of the newly generated SELECT statement. This is completely reworked from the behavior in 1.3, which would instead create a subquery of the entire :class:`_expression.Select` and then join that subquery to the target. This is a **backwards incompatible change** as the previous behavior was mostly useless, producing an unnamed subquery rejected by most databases in any case. The new behavior is modeled after that of the very successful :meth:`_orm.Query.join` method in the ORM, in order to support the functionality of :class:`_orm.Query` being available by using a :class:`_sql.Select` object with an :class:`_orm.Session`. See the notes for this change at :ref:`change_select_join`. :param target: target table to join towards :param onclause: ON clause of the join. If omitted, an ON clause is generated automatically based on the :class:`_schema.ForeignKey` linkages between the two tables, if one can be unambiguously determined, otherwise an error is raised. :param isouter: if True, generate LEFT OUTER join. Same as :meth:`_expression.Select.outerjoin`. :param full: if True, generate FULL OUTER join. .. seealso:: :ref:`tutorial_select_join` - in the :doc:`/tutorial/index` :ref:`orm_queryguide_joins` - in the :ref:`queryguide_toplevel` :meth:`_expression.Select.join_from` :meth:`_expression.Select.outerjoin` r� Nr� )r r� r �JoinTargetRolerS r� )r� r r r r � join_target�onclause_elementr� r� r� r � s B ���z Select.join)r ra )�from_r r r r� c C s | j |||d|d�S )a Create a SQL LEFT OUTER JOIN against this :class:`_expression.Select` object's criterion and apply generatively, returning the newly resulting :class:`_expression.Select`. Usage is the same as that of :meth:`_selectable.Select.join_from`. T�r r r )� join_from)r� r! r r r r� r� r� �outerjoin_from s �zSelect.outerjoin_from)r! r r r r r� c C sb t jtj|| d�}t jtj|| d�}|dk r<t �tj|�}nd}| j|||||d�ff7 _| S )a Create a SQL JOIN against this :class:`_expression.Select` object's criterion and apply generatively, returning the newly resulting :class:`_expression.Select`. E.g.:: stmt = select(user_table, address_table).join_from( user_table, address_table, user_table.c.id == address_table.c.user_id ) The above statement generates SQL similar to:: SELECT user.id, user.name, address.id, address.email, address.user_id FROM user JOIN address ON user.id = address.user_id .. versionadded:: 1.4 :param from\_: the left side of the join, will be rendered in the FROM clause and is roughly equivalent to using the :meth:`.Select.select_from` method. :param target: target table to join towards :param onclause: ON clause of the join. :param isouter: if True, generate LEFT OUTER join. Same as :meth:`_expression.Select.outerjoin`. :param full: if True, generate FULL OUTER join. .. seealso:: :ref:`tutorial_select_join` - in the :doc:`/tutorial/index` :ref:`orm_queryguide_joins` - in the :ref:`queryguide_toplevel` :meth:`_expression.Select.join` r� Nr� )r r� r r� r rS r� )r� r! r r r r r r r� r� r� r# " s* 7 � ���zSelect.join_from)r r r r� c C s | j ||d|d�S )a� Create a left outer join. Parameters are the same as that of :meth:`_expression.Select.join`. .. versionchanged:: 1.4 :meth:`_expression.Select.outerjoin` now creates a :class:`_sql.Join` object between a :class:`_sql.FromClause` source that is within the FROM clause of the existing SELECT, and a given target :class:`_sql.FromClause`, and then adds this :class:`_sql.Join` to the FROM clause of the newly generated SELECT statement. This is completely reworked from the behavior in 1.3, which would instead create a subquery of the entire :class:`_expression.Select` and then join that subquery to the target. This is a **backwards incompatible change** as the previous behavior was mostly useless, producing an unnamed subquery rejected by most databases in any case. The new behavior is modeled after that of the very successful :meth:`_orm.Query.join` method in the ORM, in order to support the functionality of :class:`_orm.Query` being available by using a :class:`_sql.Select` object with an :class:`_orm.Session`. See the notes for this change at :ref:`change_select_join`. .. seealso:: :ref:`tutorial_select_join` - in the :doc:`/tutorial/index` :ref:`orm_queryguide_joins` - in the :ref:`queryguide_toplevel` :meth:`_expression.Select.join` Tr" )r )r� r r r r� r� r� r n s )zSelect.outerjoinzSequence[FromClause]c C s | � | d��� S )aG Compute the final displayed list of :class:`_expression.FromClause` elements. This method will run through the full computation required to determine what FROM elements will be displayed in the resulting SELECT statement, including shadowing individual tables with JOIN objects, as well as full computation for ORM use cases including eager loading clauses. For ORM use, this accessor returns the **post compilation** list of FROM objects; this collection will include elements such as eagerly loaded tables and joins. The objects will **not** be ORM enabled and not work as a replacement for the :meth:`_sql.Select.select_froms` collection; additionally, the method is not well performing for an ORM enabled statement as it will incur the full ORM construction process. To retrieve the FROM list that's implied by the "columns" collection passed to the :class:`_sql.Select` originally, use the :attr:`_sql.Select.columns_clause_froms` accessor. To select from an alternative set of columns while maintaining the FROM list, use the :meth:`_sql.Select.with_only_columns` method and pass the :paramref:`_sql.Select.with_only_columns.maintain_column_froms` parameter. .. versionadded:: 1.4.23 - the :meth:`_sql.Select.get_final_froms` method replaces the previous :attr:`_sql.Select.froms` accessor, which is deprecated. .. seealso:: :attr:`_sql.Select.columns_clause_froms` N)r r� r� r� r� r� �get_final_froms� s &zSelect.get_final_fromsz1.4.23zqThe :attr:`_expression.Select.froms` attribute is moved to the :meth:`_expression.Select.get_final_froms` method.c C s | � � S )zYReturn the displayed list of :class:`_expression.FromClause` elements. )r% r� r� r� r� r� � s z Select.fromsr� c C s t �| ��| �S )a� Return the set of :class:`_expression.FromClause` objects implied by the columns clause of this SELECT statement. .. versionadded:: 1.4.23 .. seealso:: :attr:`_sql.Select.froms` - "final" FROM list taking the full statement into account :meth:`_sql.Select.with_only_columns` - makes use of this collection to set up a new FROM list )r� r� r� r� r� r� r� �columns_clause_froms� s �zSelect.columns_clause_fromsr� c C s t | j�S )a0 An iterator of all :class:`_expression.ColumnElement` expressions which would be rendered into the columns clause of the resulting SELECT statement. This method is legacy as of 1.4 and is superseded by the :attr:`_expression.Select.exported_columns` collection. )�iterr� r� r� r� r� � inner_columns� s zSelect.inner_columnsr� r� c C s8 |d k r| |j krdS | �� D ]}|�|�r dS q dS r� )r r� r� )r� r� rc r� r� r� r� � s zSelect.is_derived_fromr� r� r_ c s� t t�t| j� t| j� tdd� | jD �� ��}� �fdd�|D ��� �fdd�| jD �}dd� ��� D �� |�� |�}t |�t |� | _dd d d ��fd d � }|�d< t � j f � dd���� | � � d S )Nc S s g | ] }|d �qS )r r� r/ r� r� r� r� s z*Select._copy_internals.<locals>.<listcomp>c s i | ]}|� |f���qS r� r� rb rd r� r� re s z*Select._copy_internals.<locals>.<dictcomp>c s g | ]}� |f���qS r� r� rb rd r� r� r� s c S s h | ]}t |t�r|�qS r� )rk r rb r� r� r� r� s z)Select._copy_internals.<locals>.<setcomp>rf r rg rh c s, t | t�r(| j� kr(� | j �| �}|S d S r� rj rm rn r� r� rp ! s z'Select._copy_internals.<locals>.replacerp )r� )r` � omit_attrs)r8 r\ r] r4 r� r� r� r� r� � differencer� rq rr rs )r� r` ra rt Zexisting_from_objZ add_fromsrp ru rv r� rr � s( ����� zSelect._copy_internalszIterable[ClauseElement]c s" t �t� jf ddi|��| �� �S )Nr) )r� r� r� )r\ r] rq � get_childrenr� r ru r� r� r+ 4 s ���zSelect.get_children)r r� c s& � � � � j� fdd�|D � � _� S )a� Return a new :func:`_expression.select` construct with the given entities appended to its columns clause. E.g.:: my_select = my_select.add_columns(table.c.new_column) The original expressions in the columns clause remain in place. To replace the original expressions with new ones, see the method :meth:`_expression.Select.with_only_columns`. :param \*entities: column, table, or other entity expressions to be added to the columns clause .. seealso:: :meth:`_expression.Select.with_only_columns` - replaces existing expressions rather than appending. :ref:`orm_queryguide_select_multiple_entities` - ORM-centric example c s g | ]}t jtj|� d ��qS r r. )r� r� r� r� r� r� Z s � �z&Select.add_columns.<locals>.<listcomp>)rs r� r r� r� r� � add_columns= s � zSelect.add_columnsz%Iterable[_ColumnsClauseArgument[Any]]c s � fdd�t �|�D �� _d S )Nc s g | ]}t jtj|� d ��qS r r. r r� r� r� r� e s � �z(Select._set_entities.<locals>.<listcomp>)rX r1 r� r r� r� r� � _set_entitiesb s �zSelect._set_entitiesr� z�The :meth:`_expression.Select.column` method is deprecated and will be removed in a future release. Please use :meth:`_expression.Select.add_columns`r� c C s | � |�S )a� Return a new :func:`_expression.select` construct with the given column expression added to its columns clause. E.g.:: my_select = my_select.column(table.c.new_column) See the documentation for :meth:`_expression.Select.with_only_columns` for guidelines on adding /replacing the columns of a :class:`_expression.Select` object. )r, r� r� r� r� r� l s z Select.columnr� )� only_synonymsr� c C s. | j tjjj| jf| j| j �d|i�� }|S )a" Return a new :func:`_expression.select` construct with redundantly named, equivalently-valued columns removed from the columns clause. "Redundant" here means two columns where one refers to the other either based on foreign key, or via a simple equality comparison in the WHERE clause of the statement. The primary purpose of this method is to automatically construct a select statement with all uniquely-named columns, without the need to use table-qualified labels as :meth:`_expression.Select.set_label_style` does. When columns are omitted based on foreign key, the referred-to column is the one that's kept. When columns are omitted based on WHERE equivalence, the first column in the columns clause is the one that's kept. :param only_synonyms: when True, limit the removal of columns to those which have the same name as the equivalent. Otherwise, all columns that are equivalent to another are removed. r. )�with_only_columnsrX r� r� rZ r� r� r� )r� r. Zwocr� r� r� rZ � s � ���zSelect.reduce_columnsz _TCCA[_T0]zSelect[Tuple[_T0]])� _Select__ent0r� c C s d S r� r� )r� r0 r� r� r� r/ � s �Select.with_only_columnsz _TCCA[_T1]zSelect[Tuple[_T0, _T1]])r0 � _Select__ent1r� c C s d S r� r� )r� r0 r2 r� r� r� r/ � s z _TCCA[_T2]z Select[Tuple[_T0, _T1, _T2]])r0 r2 � _Select__ent2r� c C s d S r� r� )r� r0 r2 r3 r� r� r� r/ � s z _TCCA[_T3]z!Select[Tuple[_T0, _T1, _T2, _T3]])r0 r2 r3 � _Select__ent3r� c C s d S r� r� )r� r0 r2 r3 r4 r� r� r� r/ � s z _TCCA[_T4]z&Select[Tuple[_T0, _T1, _T2, _T3, _T4]])r0 r2 r3 r4 � _Select__ent4r� c C s d S r� r� )r� r0 r2 r3 r4 r5 r� r� r� r/ � s z _TCCA[_T5]z+Select[Tuple[_T0, _T1, _T2, _T3, _T4, _T5]])r0 r2 r3 r4 r5 � _Select__ent5r� c C s d S r� r� )r� r0 r2 r3 r4 r5 r6 r� r� r� r/ � s z _TCCA[_T6]z0Select[Tuple[_T0, _T1, _T2, _T3, _T4, _T5, _T6]])r0 r2 r3 r4 r5 r6 � _Select__ent6r� c C s d S r� r� )r� r0 r2 r3 r4 r5 r6 r7 r� r� r� r/ � s z _TCCA[_T7]z5Select[Tuple[_T0, _T1, _T2, _T3, _T4, _T5, _T6, _T7]]) r0 r2 r3 r4 r5 r6 r7 � _Select__ent7r� c C s d S r� r� ) r� r0 r2 r3 r4 r5 r6 r7 r8 r� r� r� r/ � s )�maintain_column_froms)r r9 � _Select__kwr� c O s d S r� r� �r� r9 r r: r� r� r� r/ � s c O sR |r t � �| �� |r*| jj| f| j�� t�| � dd� t�dd|�D �| _ | S )a� Return a new :func:`_expression.select` construct with its columns clause replaced with the given entities. By default, this method is exactly equivalent to as if the original :func:`_expression.select` had been called with the given entities. E.g. a statement:: s = select(table1.c.a, table1.c.b) s = s.with_only_columns(table1.c.b) should be exactly equivalent to:: s = select(table1.c.b) In this mode of operation, :meth:`_sql.Select.with_only_columns` will also dynamically alter the FROM clause of the statement if it is not explicitly stated. To maintain the existing set of FROMs including those implied by the current columns clause, add the :paramref:`_sql.Select.with_only_columns.maintain_column_froms` parameter:: s = select(table1.c.a, table2.c.b) s = s.with_only_columns(table1.c.a, maintain_column_froms=True) The above parameter performs a transfer of the effective FROMs in the columns collection to the :meth:`_sql.Select.select_from` method, as though the following were invoked:: s = select(table1.c.a, table2.c.b) s = s.select_from(table1, table2).with_only_columns(table1.c.a) The :paramref:`_sql.Select.with_only_columns.maintain_column_froms` parameter makes use of the :attr:`_sql.Select.columns_clause_froms` collection and performs an operation equivalent to the following:: s = select(table1.c.a, table2.c.b) s = s.select_from(*s.columns_clause_froms).with_only_columns(table1.c.a) :param \*entities: column expressions to be used. :param maintain_column_froms: boolean parameter that will ensure the FROM list implied from the current columns clause will be transferred to the :meth:`_sql.Select.select_from` method first. .. versionadded:: 1.4.23 c S s g | ]}t �tj|��qS r� r. r5 r� r� r� r� ? s �z,Select.with_only_columns.<locals>.<listcomp>r r1 ) r! Z_assert_no_memoizationsr� Znon_generativer& r� r r Z!_expression_collection_was_a_listr� r; r� r� r� r/ � s$ 8�� ��rf c C s t �| j�S )a Return the completed WHERE clause for this :class:`_expression.Select` statement. This assembles the current collection of WHERE criteria into a single :class:`_expression.BooleanClauseList` construct. .. versionadded:: 1.4 )rG Z_construct_for_whereclauser� r� r� r� r� � whereclauseG s �zSelect.whereclause)r< r� c G s@ t | jt�st�|D ]&}tjtj|| d�}| j|f7 _q| S )z�Return a new :func:`_expression.select` construct with the given expression added to its WHERE clause, joined to the existing clause via AND, if any. r� )rk r� r� r7 r r� r �WhereHavingRole)r� r< � criterionZwhere_criteriar� r� r� r Z s �z Select.where)�havingr� c G s0 |D ]&}t jtj|| d�}| j|f7 _q| S )z�Return a new :func:`_expression.select` construct with the given expression added to its HAVING clause, joined to the existing clause via AND, if any. r� )r r� r r= r )r� r? r> Zhaving_criteriar� r� r� r? k s �z Select.havingr� )r� r� c s4 |r*d� _ � jt� fdd�|D �� � _nd� _ � S )a Return a new :func:`_expression.select` construct which will apply DISTINCT to the SELECT statement overall. E.g.:: from sqlalchemy import select stmt = select(users_table.c.id, users_table.c.name).distinct() The above would produce an statement resembling:: SELECT DISTINCT user.id, user.name FROM user The method also accepts an ``*expr`` parameter which produces the PostgreSQL dialect-specific ``DISTINCT ON`` expression. Using this parameter on other backends which don't support this syntax will raise an error. :param \*expr: optional column expressions. When present, the PostgreSQL dialect will render a ``DISTINCT ON (<expressions>)`` construct. A deprecation warning and/or :class:`_exc.CompileError` will be raised on other backends. .. deprecated:: 1.4 Using \*expr in other dialects is deprecated and will raise :class:`_exc.CompileError` in a future version. Tc 3 s | ]}t jtj|� d �V qdS r� )r r� r ZByOfRole)r� �er� r� r� r$ � s �z"Select.distinct.<locals>.<genexpr>)r r r� )r� r� r� r� r� �distinctz s �zSelect.distinct�r� r� c s$ � j t� fdd�|D ��7 _ � S )a Return a new :func:`_expression.select` construct with the given FROM expression(s) merged into its list of FROM objects. E.g.:: table1 = table('t1', column('a')) table2 = table('t2', column('b')) s = select(table1.c.a).\ select_from( table1.join(table2, table1.c.a==table2.c.b) ) The "from" list is a unique set on the identity of each element, so adding an already present :class:`_schema.Table` or other selectable will have no effect. Passing a :class:`_expression.Join` that refers to an already present :class:`_schema.Table` or other selectable will have the effect of concealing the presence of that selectable as an individual element in the rendered FROM list, instead rendering it into a JOIN clause. While the typical purpose of :meth:`_expression.Select.select_from` is to replace the default, derived FROM clause with a join, it can also be called with individual table elements, multiple times if desired, in the case that the FROM clause cannot be fully derived from the columns clause:: select(func.count('*')).select_from(table1) c 3 s | ]}t jtj|� d �V qdS r� �r r� r r� )r� r� r� r� r� r$ � s � �z%Select.select_from.<locals>.<genexpr>)r� r� )r� r� r� r� r� r� � s $� zSelect.select_from�2Union[Literal[(None, False)], _FromClauseArgument]�� fromclausesr� c G sR d| _ |r|d dkr4t|�dkr,t�d��d| _n| jtdd� |D �� | _| S ) a� Return a new :class:`_expression.Select` which will correlate the given FROM clauses to that of an enclosing :class:`_expression.Select`. Calling this method turns off the :class:`_expression.Select` object's default behavior of "auto-correlation". Normally, FROM elements which appear in a :class:`_expression.Select` that encloses this one via its :term:`WHERE clause`, ORDER BY, HAVING or :term:`columns clause` will be omitted from this :class:`_expression.Select` object's :term:`FROM clause`. Setting an explicit correlation collection using the :meth:`_expression.Select.correlate` method provides a fixed list of FROM objects that can potentially take place in this process. When :meth:`_expression.Select.correlate` is used to apply specific FROM clauses for correlation, the FROM elements become candidates for correlation regardless of how deeply nested this :class:`_expression.Select` object is, relative to an enclosing :class:`_expression.Select` which refers to the same FROM object. This is in contrast to the behavior of "auto-correlation" which only correlates to an immediate enclosing :class:`_expression.Select`. Multi-level correlation ensures that the link between enclosed and enclosing :class:`_expression.Select` is always via at least one WHERE/ORDER BY/HAVING/columns clause in order for correlation to take place. If ``None`` is passed, the :class:`_expression.Select` object will correlate none of its FROM entries, and all will render unconditionally in the local FROM clause. :param \*fromclauses: one or more :class:`.FromClause` or other FROM-compatible construct such as an ORM mapped entity to become part of the correlate collection; alternatively pass a single value ``None`` to remove all existing correlations. .. seealso:: :meth:`_expression.Select.correlate_except` :ref:`tutorial_scalar_subquery` Fr � FNr zKadditional FROM objects not accepted when passing None/False to correlate()r� c s s | ]}t �tj|�V qd S r� rC rb r� r� r� r$ s z#Select.correlate.<locals>.<genexpr>)r� r� rW r r� r� �r� rF r� r� r� r� � s ; � � zSelect.correlatec G sV d| _ |r|d dkr4t|�dkr,t�d��d| _n | jp<dtdd� |D �� | _| S ) a� Return a new :class:`_expression.Select` which will omit the given FROM clauses from the auto-correlation process. Calling :meth:`_expression.Select.correlate_except` turns off the :class:`_expression.Select` object's default behavior of "auto-correlation" for the given FROM elements. An element specified here will unconditionally appear in the FROM list, while all other FROM elements remain subject to normal auto-correlation behaviors. If ``None`` is passed, or no arguments are passed, the :class:`_expression.Select` object will correlate all of its FROM entries. :param \*fromclauses: a list of one or more :class:`_expression.FromClause` constructs, or other compatible constructs (i.e. ORM-mapped classes) to become part of the correlate-exception collection. .. seealso:: :meth:`_expression.Select.correlate` :ref:`tutorial_scalar_subquery` Fr rG r zRadditional FROM objects not accepted when passing None/False to correlate_except()r� c s s | ]}t �tj|�V qd S r� rC rb r� r� r� r$ ? s z*Select.correlate_except.<locals>.<genexpr>)r� r� rW r r� r� rH r� r� r� �correlate_except s ! �� zSelect.correlate_exceptrD c s2 t dt�| j��� t� fdd�| jD ��}|�� S )a� A :class:`_expression.ColumnCollection` representing the columns that this SELECT statement or similar construct returns in its result set, not including :class:`_sql.TextClause` constructs. This collection differs from the :attr:`_expression.FromClause.columns` collection of a :class:`_expression.FromClause` in that the columns within this collection cannot be directly nested inside another SELECT statement; a subquery must be applied first which provides for the necessary parenthesization required by SQL. For a :func:`_expression.select` construct, the collection here is exactly what would be rendered inside the "SELECT" statement, and the :class:`_expression.ColumnElement` objects are directly present as they were given, e.g.:: col1 = column('q', Integer) col2 = column('p', Integer) stmt = select(col1, col2) Above, ``stmt.selected_columns`` would be a collection that contains the ``col1`` and ``col2`` objects directly. For a statement that is against a :class:`_schema.Table` or other :class:`_expression.FromClause`, the collection will use the :class:`_expression.ColumnElement` objects that are in the :attr:`_expression.FromClause.c` collection of the from element. A use case for the :attr:`_sql.Select.selected_columns` collection is to allow the existing columns to be referenced when adding additional criteria, e.g.:: def filter_on_id(my_select, id): return my_select.where(my_select.selected_columns['id'] == id) stmt = select(MyModel) # adds "WHERE id=:param" to the statement stmt = filter_on_id(stmt, 42) .. note:: The :attr:`_sql.Select.selected_columns` collection does not include expressions established in the columns clause using the :func:`_sql.text` construct; these are silently omitted from the collection. To use plain textual column expressions inside of a :class:`_sql.Select` construct, use the :func:`_sql.literal_column` construct. .. versionadded:: 1.4 zCallable[[Any], str]c s g | ]}t |�r� |�|f�qS r� r# r5 ��convr� r� r� � s �z+Select.selected_columns.<locals>.<listcomp>)r r� r� r� r; r� r- )r� �ccr� rJ r� rE E s = � ��zSelect.selected_columnsc C s t �| �j}t|| ��S r� )r� r� r� r� r r� r� r� r� � s z Select._all_selected_columnsc C s | j tkr| �t�} | S r� )r� rJ r� rL r� r� r� r� rW � s z"Select._ensure_disambiguated_namesrF r� rH rI c sP |r(|}� fdd�t | �d�|�D �}n� fdd�| �d�D �}� j�|� dS )zYGenerate column proxies to place in the exported ``.c`` collection of a subquery.c s6 g | ].\\}}}}}}t |�r|j� ||d |d��qS )T)r3 r� �name_is_truncatable�compound_select_cols�r$ r )r� r� r� r� r& r� � extra_colsrP r� r� r� � s ��z>Select._generate_fromclause_column_proxies.<locals>.<listcomp>Fc s0 g | ](\}}}}}t |�r|j� ||d d��qS )T)r3 r� rM rO )r� r� r� r� r& r� rP r� r� r� � s ��N)r� r� r� r% )r� r� rG r� Zproxr� rP r� r� � s �� �z*Select._generate_fromclause_column_proxiesc C s | j pt| jj�S r� )r� r� rq r� r� r� r� r� �_needs_parens_for_grouping� s �z!Select._needs_parens_for_groupingr= z*Union[SelectStatementGrouping[Self], Self]r> c C s" t |t�r| �� s| S t| �S dS )a@ Return a 'grouping' construct as per the :class:`_expression.ClauseElement` specification. This produces an element that can be embedded in an expression. Note that this method is called automatically as needed when constructing expressions and should not require explicit use. N)rk r� rQ rZ r@ r� r� r� rA � s ��zSelect.self_grouprg r� r c G s t j| f|�� S )a� Return a SQL ``UNION`` of this select() construct against the given selectables provided as positional arguments. :param \*other: one or more elements with which to create a UNION. .. versionchanged:: 1.4.28 multiple elements are now accepted. :param \**kwargs: keyword arguments are forwarded to the constructor for the newly created :class:`_sql.CompoundSelect` object. )r� r� r r� r� r� r� � s z Select.unionc G s t j| f|�� S )a� Return a SQL ``UNION ALL`` of this select() construct against the given selectables provided as positional arguments. :param \*other: one or more elements with which to create a UNION. .. versionchanged:: 1.4.28 multiple elements are now accepted. :param \**kwargs: keyword arguments are forwarded to the constructor for the newly created :class:`_sql.CompoundSelect` object. )r� r� r r� r� r� r� � s zSelect.union_allc G s t j| f|�� S )a. Return a SQL ``EXCEPT`` of this select() construct against the given selectable provided as positional arguments. :param \*other: one or more elements with which to create a UNION. .. versionchanged:: 1.4.28 multiple elements are now accepted. )r� r� r r� r� r� �except_ s zSelect.except_c G s t j| f|�� S )a3 Return a SQL ``EXCEPT ALL`` of this select() construct against the given selectables provided as positional arguments. :param \*other: one or more elements with which to create a UNION. .. versionchanged:: 1.4.28 multiple elements are now accepted. )r� r� r r� r� r� � except_all" s zSelect.except_allc G s t j| f|�� S )a� Return a SQL ``INTERSECT`` of this select() construct against the given selectables provided as positional arguments. :param \*other: one or more elements with which to create a UNION. .. versionchanged:: 1.4.28 multiple elements are now accepted. :param \**kwargs: keyword arguments are forwarded to the constructor for the newly created :class:`_sql.CompoundSelect` object. )r� r� r r� r� r� � intersect2 s zSelect.intersectc G s t j| f|�� S )a� Return a SQL ``INTERSECT ALL`` of this select() construct against the given selectables provided as positional arguments. :param \*other: one or more elements with which to create a UNION. .. versionchanged:: 1.4.28 multiple elements are now accepted. :param \**kwargs: keyword arguments are forwarded to the constructor for the newly created :class:`_sql.CompoundSelect` object. )r� r� r r� r� r� � intersect_allE s zSelect.intersect_all)N)N)N)N)T)N)dr� r� r� r� r� r� r� r� r r r� r� r� r r� r� r� r� r� r rT r� Zdp_memoized_select_entitiesZdp_clauseelement_tupler r� r� r� r� r� r� r� r� r� r� r� r� r* ra r? Z _executable_traverse_internalsrO Zdp_has_cache_keyr� r� r rT rR r r r r r r r� r r� r5 r r$ r# r r% rX r� r� r& r( r� r+ rr r+ r, r- r� r� rZ r/ r< Z _whereclauser r? rA r� r� rI rY rE r� rW r� rQ rA r� r� rR rS rT rU r� r� r� ru r� r � sT � ������� �� � + �� W �� �� N ��+(� �: $ �& ��O%+H/J �: �r c @ s e Zd ZU dZdejfdejfgZded< g Z ded< dZ e sBd Z dZ d ed< d d d �d d�Zddd�dd�Zdd�dd�Zdd d�dd�Zedd�d d ��ZeZed d d �d!d"��Zd1d$d d%�d&d'�Ze r�d(d�d)d*�Zed+d d,�d-d.��Zed+d d,�d/d0��Zd#S )2rU a� Represent a scalar subquery. A :class:`_sql.ScalarSelect` is created by invoking the :meth:`_sql.SelectBase.scalar_subquery` method. The object then participates in other SQL expressions as a SQL column expression within the :class:`_sql.ColumnElement` hierarchy. .. seealso:: :meth:`_sql.SelectBase.scalar_subquery` :ref:`tutorial_scalar_subquery` - in the 2.0 tutorial r� r; rS rO r� r4 TFr� r� r[ c C s || _ |�� | _|j| _d S r� )r� rR r; �_propagate_attrsr r� r� r� rT y s zScalarSelect.__init__r� r )�attrr� c C s t | j|�S r� )r r� )r� rW r� r� r� � __getattr__~ s zScalarSelect.__getattr__r& r� c C s | j | jd�S )N�r� r; rY r� r� r� r� r � s zScalarSelect.__getstate__r c C s |d | _ |d | _d S )Nr� r; rY r r� r� r� r � s zScalarSelect.__setstate__r c C s t �d��d S )NzcScalar Select expression has no columns; use this object directly within a column-level expression.)rW r� r� r� r� r� r) � s �zScalarSelect.columnsr r\ )r� r� c C s t d| j��|�| _| S )zuApply a WHERE clause to the SELECT statement referred to by this :class:`_expression.ScalarSelect`. r )r r� r )r� r� r� r� r� r � s zScalarSelect.whereNr= r> c C s | S r� r� r@ r� r� r� rA � s zScalarSelect.self_groupr c C s d S r� r� r� r� r� r� r` � r� zScalarSelect._ungrouprD rE c G s t d| j�j|� | _| S )a� Return a new :class:`_expression.ScalarSelect` which will correlate the given FROM clauses to that of an enclosing :class:`_expression.Select`. This method is mirrored from the :meth:`_sql.Select.correlate` method of the underlying :class:`_sql.Select`. The method applies the :meth:_sql.Select.correlate` method, then returns a new :class:`_sql.ScalarSelect` against that statement. .. versionadded:: 1.4 Previously, the :meth:`_sql.ScalarSelect.correlate` method was only available from :class:`_sql.Select`. :param \*fromclauses: a list of one or more :class:`_expression.FromClause` constructs, or other compatible constructs (i.e. ORM-mapped classes) to become part of the correlate collection. .. seealso:: :meth:`_expression.ScalarSelect.correlate_except` :ref:`tutorial_scalar_subquery` - in the 2.0 tutorial r )r r� r� rH r� r� r� r� � s �zScalarSelect.correlatec G s t d| j�j|� | _| S )a� Return a new :class:`_expression.ScalarSelect` which will omit the given FROM clauses from the auto-correlation process. This method is mirrored from the :meth:`_sql.Select.correlate_except` method of the underlying :class:`_sql.Select`. The method applies the :meth:_sql.Select.correlate_except` method, then returns a new :class:`_sql.ScalarSelect` against that statement. .. versionadded:: 1.4 Previously, the :meth:`_sql.ScalarSelect.correlate_except` method was only available from :class:`_sql.Select`. :param \*fromclauses: a list of one or more :class:`_expression.FromClause` constructs, or other compatible constructs (i.e. ORM-mapped classes) to become part of the correlate-exception collection. .. seealso:: :meth:`_expression.ScalarSelect.correlate` :ref:`tutorial_scalar_subquery` - in the 2.0 tutorial r )r r� rI rH r� r� r� rI � s ! �z ScalarSelect.correlate_except)N)r� r� r� r� rT r� r� rO r� r4 r� r Z_is_implicitly_booleanr� rT rX r r r� r) r& r5 r rA r` r� rI r� r� r� r� rU Y s4 � #rU c @ s� e Zd ZU dZdZded< d%dd�dd �Zejd d �d d ��Z ddd�dd�Z dd �dd�Z ddd�dd�Z ddd�dd �Z d dd �d d �Zd!dd"�d#d$�ZdS )&rS z�Represent an ``EXISTS`` clause. See :func:`_sql.exists` for a description of usage. An ``EXISTS`` clause can also be constructed from a :func:`_sql.select` instance by calling :meth:`_sql.SelectBase.exists`. Tz>Union[SelectStatementGrouping[Select[Any]], ScalarSelect[Any]]r� NzKOptional[Union[_ColumnsClauseArgument[Any], SelectBase, ScalarSelect[Any]]])�_Exists__argumentc C sn |d krt td���� }n8t|t�r6|�� }|j|_n t|t�rF|}n t |��� }tj| |t j t j dd� d S )Nr� T)�operatorrr Zwraps_column_expression) r rN r rk r� rV rU rP rT r rT r Z BOOLEANTYPE)r� rZ r� r� r� r� rT � s �zExists.__init__r� r� c C s g S r� r� r� r� r� r� r4 s zExists._from_objectsz$Callable[[Select[Any]], Select[Any]]z$SelectStatementGrouping[Select[Any]])�fnr� c C s2 | j �� }||�}|jtjd�}t|t�s.t�|S )NrQ )r� r` rA r rT rk rZ r7 )r� r\ r� r\ Z return_valuer� r� r� �_regroup s zExists._regroupzSelect[Tuple[bool]]c C s t | �S )a� Return a SELECT of this :class:`_expression.Exists`. e.g.:: stmt = exists(some_table.c.id).where(some_table.c.id == 5).select() This will produce a statement resembling:: SELECT EXISTS (SELECT id FROM some_table WHERE some_table = :param) AS anon_1 .. seealso:: :func:`_expression.select` - general purpose method which allows for arbitrary column lists. r r� r� r� r� r # s z Exists.selectrD r\ rE c s | � � }| �� fdd��|_|S )z�Apply correlation to the subquery noted by this :class:`_sql.Exists`. .. seealso:: :meth:`_sql.ScalarSelect.correlate` c s | j � � S r� )r� r� �rF r� r� r� E r� z"Exists.correlate.<locals>.<lambda>�r+ r] r� �r� rF r@ r� r^ r� r� 7 s �zExists.correlatec s | � � }| �� fdd��|_|S )z�Apply correlation to the subquery noted by this :class:`_sql.Exists`. .. seealso:: :meth:`_sql.ScalarSelect.correlate_except` c s | j � � S r� )rI r� r^ r� r� r� X r� z)Exists.correlate_except.<locals>.<lambda>r_ r` r� r^ r� rI I s �zExists.correlate_exceptra rB c s | � � }| �� fdd��|_|S )a� Return a new :class:`_expression.Exists` construct, applying the given expression to the :meth:`_expression.Select.select_from` method of the select statement contained. .. note:: it is typically preferable to build a :class:`_sql.Select` statement first, including the desired WHERE clause, then use the :meth:`_sql.SelectBase.exists` method to produce an :class:`_sql.Exists` object at once. c s | j � � S r� )r� r� �r� r� r� r� j r� z$Exists.select_from.<locals>.<lambda>r_ )r� r� r@ r� ra r� r� \ s zExists.select_fromr r~ c s | � � }| �� fdd��|_|S )a� Return a new :func:`_expression.exists` construct with the given expression added to its WHERE clause, joined to the existing clause via AND, if any. .. note:: it is typically preferable to build a :class:`_sql.Select` statement first, including the desired WHERE clause, then use the :meth:`_sql.SelectBase.exists` method to produce an :class:`_sql.Exists` object at once. c s | j � � S r� r r� �rt r� r� r� z r� z Exists.where.<locals>.<lambda>r_ )r� rt r@ r� rb r� r m s z Exists.where)N)r� r� r� r� r� r� rT rX r� r4 r] r r� rI r� r r� r� r� r� rS � s � rS c @ s� e Zd ZU dZdZeZdejfdej fge j e j Zded< dZdZdZd0d d d d d �dd�Zd1d dd d d �dd�Zedd�dd��Zejdd�dd��Zdd d�d d �Zd d�d d �Ze d d!d"d#�d$d%��Z d&d'�d(d)d d*�d+d,�Z d-d�d.d/�Z d&S )2� TextualSelectaF Wrap a :class:`_expression.TextClause` construct within a :class:`_expression.SelectBase` interface. This allows the :class:`_expression.TextClause` object to gain a ``.c`` collection and other FROM-like capabilities such as :meth:`_expression.FromClause.alias`, :meth:`_expression.SelectBase.cte`, etc. The :class:`_expression.TextualSelect` construct is produced via the :meth:`_expression.TextClause.columns` method - see that method for details. .. versionchanged:: 1.4 the :class:`_expression.TextualSelect` class was renamed from ``TextAsFrom``, to more correctly suit its role as a SELECT-oriented object and not a FROM clause. .. seealso:: :func:`_expression.text` :meth:`_expression.TextClause.columns` - primary creation interface. Ztextual_selectr� � column_argsrS rO TFr~ z$List[_ColumnExpressionArgument[Any]]r� r� )r� r) � positionalr� c C s | � |dd� |D �|� d S )Nc S s g | ]}t �tj|��qS r� )r r� r ZLabeledColumnExprRoler5 r� r� r� r� � s �z*TextualSelect.__init__.<locals>.<listcomp>)r� �r� r� r) re r� r� r� rT � s ��zTextualSelect.__init__zList[NamedColumn[Any]]c C s || _ || _|| _d S r� )r� rd re rf r� r� r� r� � s zTextualSelect._initz.ColumnCollection[str, KeyedColumnElement[Any]]r� c C s t dd� | jD ���� S )am A :class:`_expression.ColumnCollection` representing the columns that this SELECT statement or similar construct returns in its result set, not including :class:`_sql.TextClause` constructs. This collection differs from the :attr:`_expression.FromClause.columns` collection of a :class:`_expression.FromClause` in that the columns within this collection cannot be directly nested inside another SELECT statement; a subquery must be applied first which provides for the necessary parenthesization required by SQL. For a :class:`_expression.TextualSelect` construct, the collection contains the :class:`_expression.ColumnElement` objects that were passed to the constructor, typically via the :meth:`_expression.TextClause.columns` method. .. versionadded:: 1.4 c s s | ]}|j |fV qd S r� r� r5 r� r� r� r$ � s z1TextualSelect.selected_columns.<locals>.<genexpr>)r; rd r- r� r� r� r� rE � s �z TextualSelect.selected_columnsr� c C s | j S r� )rd r� r� r� r� r� � s z#TextualSelect._all_selected_columnsrH rM c C s | S r� r� rO r� r� r� r� � s z TextualSelect.set_label_stylec C s | S r� r� r� r� r� r� rW � s z)TextualSelect._ensure_disambiguated_nameszBindParameter[Any]r r\ )�binds�bind_as_valuesr� c O s | j j||�| _ | S r� )r� � bindparams)r� rg rh r� r� r� ri � s zTextualSelect.bindparamsNrF r� rH )r� rG r� c sZ t rt� t�st�|r:� j�� fdd�t| j|�D �� n � j�� fdd�| jD �� d S )Nc 3 s | ]\}}|j � |d �V qdS ))rN Nr )r� r& rP r# r� r� r$ s �zDTextualSelect._generate_fromclause_column_proxies.<locals>.<genexpr>c 3 s | ]}|� � �V qd S r� r r5 r# r� r� r$ s )r rk r� r7 r� r% r� rd )r� r� rG r� r# r� r� � s �� �z1TextualSelect._generate_fromclause_column_proxieszUnion[TypeEngine[Any], Any]c C s | j d jS r� )rd r; r� r� r� r� rR s zTextualSelect._scalar_type)F)F) r� r� r� r� r� rJ r� rT r� r� r* ra r� r� rO r� Z _is_textualZis_textrX rT r� rY rE rX r� r� r� rW r5 ri r� rR r� r� r� r� rc ~ s: ���� � � �rc c s8 e Zd Zddd�� fdd� Zejdd�dd ��Z� ZS ) �AnnotatedFromClauser r� r c s4 t � jf |� |�dd�r0| j}|jj�| �| _d S )NZind_cols_on_fromclauseF)rq rr r �_Annotated__elementr r& �fget)r� ra �eeru r� r� rr s z#AnnotatedFromClause._copy_internalsr' r� c C s | j }|jS )ao proxy the .c collection of the underlying FromClause. Originally implemented in 2008 as a simple load of the .c collection when the annotated construct was created (see d3621ae961a), in modern SQLAlchemy versions this can be expensive for statements constructed with ORM aliases. So for #8796 SQLAlchemy 2.0 we instead proxy it, which works just as well. Two different use cases seem to require the collection either copied from the underlying one, or unique to this AnnotatedFromClause. See test_selectable->test_annotated_corresponding_column )rk r& )r� rm r� r� r� r& s zAnnotatedFromClause.c)r� r� r� rr rX rD r& r� r� r� ru r� rj s rj )�r� � __future__r r� �enumr r\ �typingr 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 r r r Z_typingr r! r" r$ r% r& r' r( � annotationr) r* �baser+ r, r. r0 r1 r2 r4 r5 r7 r8 r9 r: r; r< r= r> r? r@ rA rB rC rD r� rE rF rG rH rI rJ rK rL rM rN rO rP rQ ZsqltypesrR rS rT rU rW rX rY Z util.typingrZ r[ r\ r� r] r_ r` ra rb rc rd re rf rg rh ri rj rk rl rm rn ro rp rq Z_TCCArr rs rt ru rv r� rw Zdmlrx ry rz r{ r| r} r~ r� r r� r� r� r� r� r� Z_ColumnsClauseElementr� r� r� r� Z_OnClauseElementZ_ForUpdateOfArgumentZ_SetupJoinsElementr� r* r� r� r� r� r� r� r� r� r� ZAnonymizedFromClauseRoler� r rH r� rJ rK rL r� rM Z DMLTableRoler r� r� r� r� r� r� r� r r� r� r� r� r� r� r� r� rW r r r� r# r Z InElementRoler3 r@ r� Z DMLSelectRoler� r� rY rZ rb Z plugin_forr� r� r� r0 �setattrr� Z MemoizedSlotsr� r� Z HasCacheKeyZHasCopyInternalsZ Traversibler� r rU rS rc Z TextAsFromrj r� r� r� r� �<module> s. � ��� �� TN4/c /,c� .\$ 8!: � 5! / =A "F . � E a r O b �: � �