sqlalchemy.sql._typing

module documentation
(source)

Undocumented

Function has_schema_attr Undocumented
Function is_column_element Undocumented
Function is_ddl_compiler Undocumented
Function is_dml Undocumented
Function is_from_clause Undocumented
Function is_has_clause_element Undocumented
Function is_insert_update Undocumented
Function is_keyed_column_element Undocumented
Function is_named_from_clause Undocumented
Function is_quoted_name Undocumented
Function is_select_base Undocumented
Function is_select_statement Undocumented
Function is_selectable Undocumented
Function is_sql_compiler Undocumented
Function is_subquery Undocumented
Function is_table Undocumented
Function is_table_value_type Undocumented
Function is_text_clause Undocumented
Function is_tuple_type Undocumented
Class _CoreAdapterProto protocol for the ClauseAdapter/ColumnAdapter.traverse() method.
Class _HasClauseElement indicates a class that has a __clause_element__() method
Function _no_kw Undocumented
Type Variable _CE Undocumented
Type Variable _CLE Undocumented
Type Variable _DMLKey Undocumented
Type Variable _MAYBE_ENTITY Undocumented
Type Variable _NOT_ENTITY Undocumented
Type Variable _T Undocumented
Type Variable _T0 Undocumented
Type Variable _T1 Undocumented
Type Variable _T2 Undocumented
Type Variable _T3 Undocumented
Type Variable _T4 Undocumented
Type Variable _T5 Undocumented
Type Variable _T6 Undocumented
Type Variable _T7 Undocumented
Type Variable _T8 Undocumented
Type Variable _T9 Undocumented
Type Variable _TP Undocumented
Type Alias _AutoIncrementType Undocumented
Type Alias _ColumnExpressionArgument narrower "column expression" argument.
Type Alias _ColumnExpressionOrLiteralArgument Undocumented
Type Alias _ColumnExpressionOrStrLabelArgument Undocumented
Type Alias _ColumnsClauseArgument open-ended SELECT columns clause argument.
Type Alias _DDLColumnArgument DDL column.
Type Alias _DMLColumnArgument A DML column expression. This is a "key" inside of insert().values(), update().values(), and related.
Type Alias _DMLColumnKeyMapping Undocumented
Type Alias _DMLTableArgument Undocumented
Type Alias _EquivalentColumnMap Undocumented
Type Alias _FromClauseArgument A FROM clause, like we would send to select().select_from().
Type Alias _InfoType the .info dictionary accepted and used throughout Core /ORM
Type Alias _JoinTargetArgument target for join() builds on _FromClauseArgument to include additional join target roles such as those which come from the ORM.
Type Alias _LimitOffsetType Undocumented
Type Alias _OnClauseArgument target for an ON clause, includes additional roles such as those which come from the ORM.
Type Alias _SelectStatementForCompoundArgument SELECT statement acceptable by ``union()`` and other SQL set operations
Type Alias _TextCoercedExpressionArgument Undocumented
Type Alias _TypedColumnClauseArgument Undocumented
Type Alias _TypeEngineArgument Undocumented
Variable _PropagateAttrsType Undocumented
def has_schema_attr(t: FromClauseRole) -> TypeGuard[TableClause]: (source)

Undocumented

def is_column_element(c: ClauseElement) -> TypeGuard[ColumnElement[Any]]: (source)

Undocumented

def is_ddl_compiler(c: Compiled) -> TypeGuard[DDLCompiler]: (source)

Undocumented

def is_dml(c: ClauseElement) -> TypeGuard[UpdateBase]: (source)

Undocumented

def is_from_clause(c: ClauseElement) -> TypeGuard[FromClause]: (source)

Undocumented

def is_has_clause_element(s: object) -> TypeGuard[_HasClauseElement]: (source)

Undocumented

def is_insert_update(c: ClauseElement) -> TypeGuard[ValuesBase]: (source)

Undocumented

def is_keyed_column_element(c: ClauseElement) -> TypeGuard[KeyedColumnElement[Any]]: (source)

Undocumented

def is_named_from_clause(t: FromClauseRole) -> TypeGuard[NamedFromClause]: (source)

Undocumented

def is_quoted_name(s: str) -> TypeGuard[quoted_name]: (source)

Undocumented

def is_select_base(t: Union[Executable, ReturnsRows]) -> TypeGuard[SelectBase]: (source)

Undocumented

def is_select_statement(t: Union[Executable, ReturnsRows]) -> TypeGuard[Select[Any]]: (source)

Undocumented

def is_selectable(t: Any) -> TypeGuard[Selectable]: (source)

Undocumented

def is_sql_compiler(c: Compiled) -> TypeGuard[SQLCompiler]: (source)

Undocumented

def is_subquery(t: FromClause) -> TypeGuard[Subquery]: (source)

Undocumented

def is_table(t: FromClause) -> TypeGuard[TableClause]: (source)

Undocumented

def is_table_value_type(t: TypeEngine[Any]) -> TypeGuard[TableValueType]: (source)

Undocumented

def is_text_clause(c: ClauseElement) -> TypeGuard[TextClause]: (source)

Undocumented

def is_tuple_type(t: TypeEngine[Any]) -> TypeGuard[TupleType]: (source)

Undocumented

def _no_kw() -> exc.ArgumentError: (source)

Undocumented

_CE = (source)

Undocumented

Value
TypeVar('_CE',
        bound='ColumnElement[Any]')
_CLE = (source)

Undocumented

Value
TypeVar('_CLE',
        bound='ClauseElement')
_DMLKey = (source)

Undocumented

Value
TypeVar('_DMLKey',
        bound=_DMLColumnArgument)
_MAYBE_ENTITY = (source)

Undocumented

Value
TypeVar('_MAYBE_ENTITY',
        roles.ColumnsClauseRole,
        Literal['*', 1],
        Type[Any],
        Inspectable[_HasClauseElement],
        _HasClauseElement)
_NOT_ENTITY = (source)

Undocumented

Value
TypeVar('_NOT_ENTITY',
        int,
        str,
        'datetime',
        'date',
        'time',
        'timedelta',
...
_T = (source)

Undocumented

Value
TypeVar('_T',
        bound=Any)
_T0 = (source)

Undocumented

Value
TypeVar('_T0',
        bound=Any)
_T1 = (source)

Undocumented

Value
TypeVar('_T1',
        bound=Any)
_T2 = (source)

Undocumented

Value
TypeVar('_T2',
        bound=Any)
_T3 = (source)

Undocumented

Value
TypeVar('_T3',
        bound=Any)
_T4 = (source)

Undocumented

Value
TypeVar('_T4',
        bound=Any)
_T5 = (source)

Undocumented

Value
TypeVar('_T5',
        bound=Any)
_T6 = (source)

Undocumented

Value
TypeVar('_T6',
        bound=Any)
_T7 = (source)

Undocumented

Value
TypeVar('_T7',
        bound=Any)
_T8 = (source)

Undocumented

Value
TypeVar('_T8',
        bound=Any)
_T9 = (source)

Undocumented

Value
TypeVar('_T9',
        bound=Any)
_TP = (source)

Undocumented

Value
TypeVar('_TP',
        bound=Tuple[Any, ...])
_AutoIncrementType = (source)

Undocumented

Value
Union[bool, Literal['auto', 'ignore_fk']]
_ColumnExpressionArgument = (source)

narrower "column expression" argument. This type is used for all the other "column" kinds of expressions that typically represent a single SQL column expression, not a set of columns the way a table or ORM entity does. This includes ColumnElement, or ORM-mapped attributes that will have a `__clause_element__()` method, it also has the ExpressionElementRole overall which brings in the TextClause object also.

Value
Union['ColumnElement[_T]',
      _HasClauseElement,
      'SQLCoreOperations[_T]',
      roles.ExpressionElementRole[_T],
      Callable[[], 'ColumnElement[_T]'],
      'LambdaElement']
_ColumnExpressionOrLiteralArgument = (source)

Undocumented

Value
Union[Any, _ColumnExpressionArgument[_T]]
_ColumnExpressionOrStrLabelArgument = (source)

Undocumented

Value
Union[str, _ColumnExpressionArgument[_T]]
_ColumnsClauseArgument = (source)

open-ended SELECT columns clause argument. Includes column expressions, tables, ORM mapped entities, a few literal values. This type is used for lists of columns / entities to be returned in result sets; select(...), insert().returning(...), etc.

Value
Union[roles.TypedColumnsClauseRole[_T],
      roles.ColumnsClauseRole,
      'SQLCoreOperations[_T]',
      Literal['*', 1],
      Type[_T],
      Inspectable[_HasClauseElement],
      _HasClauseElement]
_DDLColumnArgument = (source)

DDL column. used for :class:`.PrimaryKeyConstraint`, :class:`.UniqueConstraint`, etc.

Value
Union[str, 'Column[Any]', roles.DDLConstraintColumnRole]
_DMLColumnArgument = (source)

A DML column expression. This is a "key" inside of insert().values(), update().values(), and related. These are usually strings or SQL table columns. There's also edge cases like JSON expression assignment, which we would want the DMLColumnRole to be able to accommodate.

Value
Union[str, _HasClauseElement, roles.DMLColumnRole, 'SQLCoreOperations']
_DMLColumnKeyMapping = (source)

Undocumented

Value
Mapping[_DMLKey, Any]
_DMLTableArgument = (source)

Undocumented

Value
Union['TableClause',
      'Join',
      'Alias',
      'CTE',
      Type[Any],
      Inspectable[_HasClauseElement],
      _HasClauseElement]
_EquivalentColumnMap = (source)

Undocumented

Value
Dict['ColumnElement[Any]', Set['ColumnElement[Any]']]
_FromClauseArgument = (source)

A FROM clause, like we would send to select().select_from(). Also accommodates ORM entities and related constructs.

Value
Union[roles.FromClauseRole, Type[Any], Inspectable[_HasClauseElement], _HasClauseElement↵
]
_InfoType = (source)

the .info dictionary accepted and used throughout Core /ORM

Value
Dict[Any, Any]
_JoinTargetArgument = (source)

target for join() builds on _FromClauseArgument to include additional join target roles such as those which come from the ORM.

Value
Union[_FromClauseArgument, roles.JoinTargetRole]
_LimitOffsetType = (source)

Undocumented

Value
Union[int, _ColumnExpressionArgument[int], None]
_OnClauseArgument = (source)

target for an ON clause, includes additional roles such as those which come from the ORM.

Value
Union[_ColumnExpressionArgument[Any], roles.OnClauseRole]
_SelectStatementForCompoundArgument = (source)

SELECT statement acceptable by ``union()`` and other SQL set operations

Value
Union['SelectBase', roles.CompoundElementRole]
_TextCoercedExpressionArgument = (source)

Undocumented

Value
Union[str,
      'TextClause',
      'ColumnElement[_T]',
      _HasClauseElement,
      roles.ExpressionElementRole[_T]]
_TypedColumnClauseArgument = (source)

Undocumented

Value
Union[roles.TypedColumnsClauseRole[_T],
      'SQLCoreOperations[_T]',
      roles.ExpressionElementRole[_T],
      Type[_T]]
_TypeEngineArgument = (source)

Undocumented

Value
Union[Type['TypeEngine[_T]'], 'TypeEngine[_T]']
_PropagateAttrsType = (source)

Undocumented