sqlalchemy.engine.cursor

module documentation
(source)

Define cursor-specific result set constructs including :class:`.CursorResult`.

Class BufferedRowCursorFetchStrategy A cursor fetch strategy with row buffering behavior.
Class CursorFetchStrategy Call fetch methods from a DBAPI cursor.
Class CursorResult A Result that is representing state from a DBAPI cursor.
Class CursorResultMetaData Result metadata for DBAPI cursors.
Class FullyBufferedCursorFetchStrategy A cursor strategy that buffers rows fully upon creation.
Class NoCursorDMLFetchStrategy Cursor strategy for a DML result that has no open cursor.
Class NoCursorDQLFetchStrategy Cursor strategy for a DQL result that has no open cursor.
Class NoCursorFetchStrategy Cursor strategy for a result that has no open cursor.
Class ResultFetchStrategy Define a fetching strategy for a result object.
Function null_dml_result Undocumented
Constant MD_INDEX integer index in cursor.description
Constant MD_LOOKUP_KEY string key we usually expect for key-based lookup
Constant MD_OBJECTS other string keys and ColumnElement obj that can match.
Constant MD_PROCESSOR callable to process a result value into a row
Constant MD_RENDERED_NAME name that is usually in cursor.description
Constant MD_RESULT_MAP_INDEX integer index in compiled._result_columns
Constant MD_UNTRANSLATED raw name from cursor.description
Class _NoResultMetaData Undocumented
Constant _DEFAULT_FETCH Undocumented
Constant _NO_CURSOR_DML Undocumented
Constant _NO_CURSOR_DQL Undocumented
Constant _NO_RESULT_METADATA Undocumented
Type Variable _T Undocumented
Type Alias _CursorKeyMapRecType Undocumented
Type Alias _CursorKeyMapType Undocumented
Type Alias _NonAmbigCursorKeyMapRecType Undocumented
def null_dml_result() -> IteratorResult[Any]: (source)

Undocumented

MD_INDEX: Literal[0] = (source)

integer index in cursor.description

Value
0
MD_LOOKUP_KEY: Literal[3] = (source)

string key we usually expect for key-based lookup this comes from compiler.RM_NAME / compiler.ResultColumnsEntry.name

Value
3
MD_OBJECTS: Literal[2] = (source)

other string keys and ColumnElement obj that can match. This comes from compiler.RM_OBJECTS / compiler.ResultColumnsEntry.objects

Value
2
MD_PROCESSOR: Literal[5] = (source)

callable to process a result value into a row

Value
5
MD_RENDERED_NAME: Literal[4] = (source)

name that is usually in cursor.description this comes from compiler.RENDERED_NAME / compiler.ResultColumnsEntry.keyname

Value
4
MD_RESULT_MAP_INDEX: Literal[1] = (source)

integer index in compiled._result_columns

Value
1
MD_UNTRANSLATED: Literal[6] = (source)

raw name from cursor.description

Value
6
_DEFAULT_FETCH = (source)

Undocumented

Value
CursorFetchStrategy()
_NO_CURSOR_DML = (source)

Undocumented

Value
NoCursorDMLFetchStrategy()
_NO_CURSOR_DQL = (source)

Undocumented

Value
NoCursorDQLFetchStrategy()
_NO_RESULT_METADATA = (source)

Undocumented

Value
_NoResultMetaData()
_T = (source)

Undocumented

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

Undocumented

Value
Tuple[Optional[int],
      int,
      List[Any],
      str,
      str,
      Optional['_ResultProcessorType'],
      Optional[str]]
_CursorKeyMapType = (source)

Undocumented

Value
Dict['_KeyType', _CursorKeyMapRecType]
_NonAmbigCursorKeyMapRecType = (source)

Undocumented

Value
Tuple[int, int, List[Any], str, str, Optional['_ResultProcessorType'], str]