sqlalchemy.engine.result.ResultMetaData

class documentation

class ResultMetaData: (source)

Known subclasses: sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData, sqlalchemy.engine.cursor._NoResultMetaData

View In Hierarchy

Base for metadata about result rows.

Class Variable __slots__ Undocumented
Property keys Undocumented
Method _for_freeze Undocumented
Method _getter Undocumented
Method _has_key Undocumented
Method _index_for_key Undocumented
Method _indexes_for_keys Undocumented
Method _key_fallback Undocumented
Method _metadata_for_keys Undocumented
Method _raise_for_ambiguous_column_name Undocumented
Method _reduce Undocumented
Method _row_as_tuple_getter Undocumented
Class Variable _keymap Undocumented
Class Variable _keys Undocumented
Class Variable _processors Undocumented
Class Variable _translated_indexes Undocumented
Class Variable _tuplefilter Undocumented
Class Variable _unique_filters Undocumented
__slots__: tuple = (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData, sqlalchemy.engine.cursor._NoResultMetaData

Undocumented

@property
keys: RMKeyView = (source)
overridden in sqlalchemy.engine.cursor._NoResultMetaData

Undocumented

def _for_freeze(self) -> ResultMetaData: (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData

Undocumented

def _getter(self, key: Any, raiseerr: bool = True) -> Optional[Callable[[Row[Any]], Any]]: (source)

Undocumented

def _has_key(self, key: object) -> bool: (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData

Undocumented

def _index_for_key(self, key: _KeyIndexType, raiseerr: bool) -> Optional[int]: (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData, sqlalchemy.engine.cursor._NoResultMetaData

Undocumented

def _indexes_for_keys(self, keys: Sequence[_KeyIndexType]) -> Sequence[int]: (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData

Undocumented

@overload
def _key_fallback(self, key: Any, err: Exception, raiseerr: Literal[True] = ...) -> NoReturn:
@overload
def _key_fallback(self, key: Any, err: Exception, raiseerr: Literal[False] = ...):
@overload
def _key_fallback(self, key: Any, err: Exception, raiseerr: bool = ...) -> Optional[NoReturn]:
(source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData

Undocumented

def _metadata_for_keys(self, keys: Sequence[_KeyIndexType]) -> Iterator[_KeyMapRecType]: (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData, sqlalchemy.engine.cursor._NoResultMetaData

Undocumented

def _raise_for_ambiguous_column_name(self, rec: _KeyMapRecType) -> NoReturn: (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData

Undocumented

def _reduce(self, keys: Sequence[_KeyIndexType]) -> ResultMetaData: (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData, sqlalchemy.engine.cursor._NoResultMetaData

Undocumented

def _row_as_tuple_getter(self, keys: Sequence[_KeyIndexType]) -> _TupleGetterType: (source)

Undocumented

_keymap: _KeyMapType = (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData, sqlalchemy.engine.cursor._NoResultMetaData

Undocumented

_keys: Sequence[str] = (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData

Undocumented

_processors: Optional[_ProcessorsType] = (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData

Undocumented

_translated_indexes: Optional[Sequence[int]] = (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData

Undocumented

_tuplefilter: Optional[_TupleGetterType] = (source)
overridden in sqlalchemy.engine.cursor.CursorResultMetaData, sqlalchemy.engine.result.SimpleResultMetaData

Undocumented

_unique_filters: Optional[Sequence[Callable[[Any], Any]]] = (source)
overridden in sqlalchemy.engine.result.SimpleResultMetaData

Undocumented