sqlalchemy.sql.base

module documentation
(source)

Foundational utilities common to many sql modules.

Class CacheableOptions Undocumented
Class ColumnCollection Collection of :class:`_expression.ColumnElement` instances, typically for :class:`_sql.FromClause` objects.
Class ColumnSet Undocumented
Class CompileState Produces additional object state necessary for a statement to be compiled.
Class DedupeColumnCollection A :class:`_expression.ColumnCollection` that maintains deduplicating behavior.
Class DialectKWArgs Establish the ability for a class to have dialect-specific arguments with defaults and constructor validation.
Class Executable Mark a :class:`_expression.ClauseElement` as supporting execution.
Class ExecutableOption No class docstring; 0/4 class variable, 1/1 method documented
Class Generative Provide a method-chaining pattern in conjunction with the @_generative decorator.
Class HasCompileState A class that has a :class:`.CompileState` associated with it.
Class Immutable mark a ClauseElement as 'immutable' when expressions are cloned.
Class InPlaceGenerative Provide a method-chaining pattern in conjunction with the @_generative decorator that mutates in place.
Class Options A cacheable option dictionary with defaults.
Class ReadOnlyColumnCollection Undocumented
Class SchemaEventTarget Base class for elements that are the targets of :class:`.DDLEvents` events.
Class SchemaVisitor Define the visiting for ``SchemaItem`` objects.
Class SingletonConstant Represent SQL constants like NULL, TRUE, FALSE
Variable coercions Undocumented
Variable elements Undocumented
Variable type_api Undocumented
Class _ColumnMetrics Undocumented
Class _DialectArgDict A dictionary view of dialect-level arguments for a specific dialect.
Class _DialectArgView A dictionary view of dialect-level arguments in the form <dialectname>_<argument_name>.
Class _EntityNamespace Undocumented
Class _GenerativeType Undocumented
Class _HasEntityNamespace Undocumented
Class _MetaOptions metaclass for the Options class.
Class _NoArg Undocumented
Class _NoneName No class docstring; 1/1 constant documented
Function _clone Undocumented
Function _cloned_difference Undocumented
Function _cloned_intersection return the intersection of sets a and b, counting any overlap between 'cloned' predecessors.
Function _entity_namespace Return the nearest .entity_namespace for the given entity.
Function _entity_namespace_key Return an entry from an entity_namespace.
Function _exclusive_against Undocumented
Function _expand_cloned expand the given set of ClauseElements to be the set of all 'cloned' predecessors.
Function _from_objects Undocumented
Function _generative non-caching _generative() decorator.
Function _is_has_entity_namespace Undocumented
Function _kw_reg_for_dialect Undocumented
Function _select_iterables expand tables into individual columns in the given list of column expressions.
Type Variable _COL Undocumented
Type Variable _COL_co Undocumented
Type Variable _COLKEY Undocumented
Type Variable _Fn Undocumented
Type Variable _NAMEDCOL Undocumented
Type Variable _Self Undocumented
Type Variable _SelfGenerativeType Undocumented
Type Variable _T Undocumented
Type Alias _AmbiguousTableNameMap Undocumented
coercions = (source)

Undocumented

elements = (source)

Undocumented

type_api = (source)

Undocumented

def _clone(element, **kw): (source)

Undocumented

def _cloned_difference(a: Iterable[_CLE], b: Iterable[_CLE]) -> Set[_CLE]: (source)

Undocumented

def _cloned_intersection(a: Iterable[_CLE], b: Iterable[_CLE]) -> Set[_CLE]: (source)

return the intersection of sets a and b, counting any overlap between 'cloned' predecessors. The returned set is in terms of the entities present within 'a'.

def _entity_namespace(entity: Union[_HasEntityNamespace, ExternallyTraversible]) -> _EntityNamespace: (source)

Return the nearest .entity_namespace for the given entity. If not immediately available, does an iterate to find a sub-element that has one, if any.

def _entity_namespace_key(entity: Union[_HasEntityNamespace, ExternallyTraversible], key: str, default: Union[SQLCoreOperations[Any], _NoArg] = NO_ARG) -> SQLCoreOperations[Any]: (source)

Return an entry from an entity_namespace. Raises :class:`_exc.InvalidRequestError` rather than attribute error on not found.

def _exclusive_against(*names: str, **kw: Any) -> Callable[[_Fn], _Fn]: (source)

Undocumented

def _expand_cloned(elements: Iterable[_CLE]) -> Iterable[_CLE]: (source)

expand the given set of ClauseElements to be the set of all 'cloned' predecessors.

def _from_objects(*elements: Union[ColumnElement[Any], FromClause, TextClause, _JoinTargetElement]) -> Iterator[FromClause]: (source)

Undocumented

def _generative(fn: _Fn) -> _Fn: (source)

non-caching _generative() decorator. This is basically the legacy decorator that copies the object and runs a method on the new copy.

def _is_has_entity_namespace(element: Any) -> TypeGuard[_HasEntityNamespace]: (source)

Undocumented

@util.preload_module('sqlalchemy.dialects')
def _kw_reg_for_dialect(dialect_name): (source)

Undocumented

def _select_iterables(elements: Iterable[roles.ColumnsClauseRole]) -> _SelectIterable: (source)

expand tables into individual columns in the given list of column expressions.

_COL = (source)

Undocumented

Value
TypeVar('_COL',
        bound='KeyedColumnElement[Any]')
_COL_co = (source)

Undocumented

Value
TypeVar('_COL_co',
        bound='ColumnElement[Any]', covariant=True)
_COLKEY = (source)

Undocumented

Value
TypeVar('_COLKEY', Union[None, str], str)
_Fn = (source)

Undocumented

Value
TypeVar('_Fn',
        bound=Callable[..., Any])
_NAMEDCOL = (source)

Undocumented

Value
TypeVar('_NAMEDCOL',
        bound='NamedColumn[Any]')
_Self = (source)

Undocumented

Value
TypeVar('_Self',
        bound=Any)
_SelfGenerativeType = (source)

Undocumented

Value
TypeVar('_SelfGenerativeType',
        bound='_GenerativeType')
_T = (source)

Undocumented

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

Undocumented

Value
MutableMapping[str, str]