sqlalchemy.sql.util.ClauseAdapter

class documentation

class ClauseAdapter(visitors.ReplacingExternalTraversal): (source)

Known subclasses: sqlalchemy.sql.util.ColumnAdapter

Clones and modifies clauses based on column correspondence. E.g.:: table1 = Table('sometable', metadata, Column('col1', Integer), Column('col2', Integer) ) table2 = Table('someothertable', metadata, Column('col1', Integer), Column('col2', Integer) ) condition = table1.c.col1 == table2.c.col1 make an alias of table1:: s = table1.alias('foo') calling ``ClauseAdapter(s).traverse(condition)`` converts condition to read:: s.c.col1 == table2.c.col1

Method	`__init__`	Undocumented
Method	`replace`	Receive pre-copied elements during a cloning traversal.
Method	`traverse`	Traverse and visit the given expression structure.
Class Variable	`__slots__`	Undocumented
Instance Variable	`__traverse_options__`	Undocumented
Instance Variable	`adapt_from_selectables`	Undocumented
Instance Variable	`adapt_on_names`	Undocumented
Instance Variable	`equivalents`	Undocumented
Instance Variable	`exclude_fn`	Undocumented
Instance Variable	`include_fn`	Undocumented
Instance Variable	`selectable`	Undocumented
Method	`_corresponding_column`	Undocumented

Inherited from CloningExternalTraversal (via ReplacingExternalTraversal):

Method copy_and_process Apply cloned traversal to the given list of elements, and return the new list.

Inherited from ExternalTraversal (via ReplacingExternalTraversal, CloningExternalTraversal):

Method	`chain`	'Chain' an additional ExternalTraversal onto this ExternalTraversal
Method	`iterate`	Traverse the given expression structure, returning an iterator of all elements.
Method	`traverse_single`	Undocumented
Property	`visitor_iterator`	Iterate through this visitor and each 'chained' visitor.
Method	`_memoized_attr__visitor_dict`	Undocumented
Class Variable	`_next`	Undocumented

Inherited from MemoizedSlots (via ReplacingExternalTraversal, CloningExternalTraversal, ExternalTraversal):

Method	`__getattr__`	Undocumented
Method	`_fallback_getattr`	Undocumented

def __init__(self, selectable: Selectable, equivalents: Optional[_EquivalentColumnMap] = None, include_fn: Optional[Callable[[ClauseElement], bool]] = None, exclude_fn: Optional[Callable[[ClauseElement], bool]] = None, adapt_on_names: bool = False, anonymize_labels: bool = False, adapt_from_selectables: Optional[AbstractSet[FromClause]] = None): (source) ¶

overridden in sqlalchemy.sql.util.ColumnAdapter

Undocumented

@util.preload_module('sqlalchemy.sql.functions')
def replace(self, col: _ET, _include_singleton_constants: bool = False) -> Optional[_ET]: (source) ¶

overrides sqlalchemy.sql.visitors.ReplacingExternalTraversal.replace

Receive pre-copied elements during a cloning traversal. If the method returns a new element, the element is used instead of creating a simple copy of the element. Traversal will halt on the newly returned element if it is re-encountered.

@overload

def traverse(self, obj: Literal[None]):

@overload

def traverse(self, obj: _ET) -> _ET:

(source) ¶

overrides sqlalchemy.sql.visitors.ReplacingExternalTraversal.traverse

overridden in sqlalchemy.sql.util.ColumnAdapter

Traverse and visit the given expression structure.

__slots__: tuple[str, ...] = (source) ¶

overrides sqlalchemy.sql.visitors.ReplacingExternalTraversal.__slots__

overridden in sqlalchemy.sql.util.ColumnAdapter

Undocumented