sqlalchemy.engine.cursor.LegacyCursorResult

class documentation

class LegacyCursorResult(CursorResult):

Known subclasses: sqlalchemy.engine.cursor.BufferedColumnResultProxy, sqlalchemy.engine.cursor.BufferedRowResultProxy, sqlalchemy.engine.cursor.FullyBufferedResultProxy

View In Hierarchy

Legacy version of .CursorResult.

This class includes connection "connection autoclose" behavior for use with "connectionless" execution, as well as delivers rows using the .LegacyRow row implementation.

New in version 1.4.

Method	`_soft_close`	Soft close this `_engine.CursorResult`.
Method	`close`	Close this `_engine.LegacyCursorResult`.
Class Variable	`_autoclose_connection`	Undocumented

Inherited from CursorResult:

Method	`_fetchall_impl`	Undocumented
Method	`_fetchiter_impl`	Undocumented
Method	`_fetchmany_impl`	Undocumented
Method	`_fetchone_impl`	Undocumented
Method	`_raw_row_iterator`	Return a safe iterator that yields raw row data.
Method	`merge`	Merge this `.Result` with other compatible result objects.
Method	`yield_per`	Configure the row-fetching strategy to fetch num rows at a time.
Instance Variable	`_yield_per`	Undocumented

Inherited from BaseCursorResult (via CursorResult):

Method	`__init__`	Undocumented
Method	`_init_metadata`	Undocumented
Method	`last_inserted_params`	Return the collection of inserted parameters from this execution.
Method	`last_updated_params`	Return the collection of updated parameters from this execution.
Method	`lastrow_has_defaults`	Return `lastrow_has_defaults()` from the underlying `.ExecutionContext`.
Method	`postfetch_cols`	Return `postfetch_cols()` from the underlying `.ExecutionContext`.
Method	`prefetch_cols`	Return `prefetch_cols()` from the underlying `.ExecutionContext`.
Method	`supports_sane_multi_rowcount`	Return `supports_sane_multi_rowcount` from the dialect.
Method	`supports_sane_rowcount`	Return `supports_sane_rowcount` from the dialect.
Class Variable	`out_parameters`	Undocumented
Instance Variable	`_echo`	Undocumented
Instance Variable	`_metadata`	Undocumented
Instance Variable	`_row_logging_fn`	Undocumented
Instance Variable	`_soft_closed`	Undocumented
Instance Variable	`closed`	Undocumented
Instance Variable	`connection`	Undocumented
Instance Variable	`context`	Undocumented
Instance Variable	`cursor`	Undocumented
Instance Variable	`cursor_strategy`	Undocumented
Instance Variable	`dialect`	Undocumented
Property	`inserted_primary_key`	Return the primary key for the row just inserted.
Property	`inserted_primary_key_rows`	Return the value of `_engine.CursorResult.inserted_primary_key` as a row contained within a list; some dialects may support a multiple row form as well.
Property	`is_insert`	True if this `_engine.CursorResult` is the result of a executing an expression language compiled `_expression.insert` construct.
Property	`lastrowid`	Return the 'lastrowid' accessor on the DBAPI cursor.
Property	`returned_defaults`	Return the values of default columns that were fetched using the `.ValuesBase.return_defaults` feature.
Property	`returned_defaults_rows`	Return a list of rows each containing the values of default columns that were fetched using the `.ValuesBase.return_defaults` feature.
Property	`returns_rows`	True if this `_engine.CursorResult` returns zero or more rows.
Property	`rowcount`	Return the 'rowcount' for this result.

Inherited from Result (via CursorResult):

Method	`__init__`	Undocumented
Method	`__iter__`	Undocumented
Method	`__next__`	Undocumented
Method	`_getter`	return a callable that will retrieve the given key from a `.Row`.
Method	`_tuple_getter`	return a callable that will retrieve the given keys from a `.Row`.
Method	`all`	Return all rows in a list.
Method	`columns`	Establish the columns that should be returned in each row.
Method	`fetchall`	A synonym for the `_engine.Result.all` method.
Method	`fetchmany`	Fetch many rows.
Method	`fetchone`	Fetch one row.
Method	`first`	Fetch the first row or None if no row is present.
Method	`freeze`	Return a callable object that will produce copies of this `.Result` when invoked.
Method	`mappings`	Apply a mappings filter to returned rows, returning an instance of `_result.MappingResult`.
Method	`next`	Undocumented
Method	`one`	Return exactly one row or raise an exception.
Method	`one_or_none`	Return at most one result or raise an exception.
Method	`partitions`	Iterate through sub-lists of rows of the size given.
Method	`scalar`	Fetch the first column of the first row, and close the result set.
Method	`scalar_one`	Return exactly one scalar result or raise an exception.
Method	`scalar_one_or_none`	Return exactly one or no scalar result.
Method	`scalars`	Return a `_result.ScalarResult` filtering object which will return single elements rather than `_row.Row` objects.
Method	`unique`	Apply unique filtering to the objects returned by this `_engine.Result`.
Class Variable	`_attributes`	Undocumented
Class Variable	`_row_logging_fn`	Undocumented
Class Variable	`_source_supports_scalars`	Undocumented
Instance Variable	`_metadata`	Undocumented
Instance Variable	`_unique_filter_state`	Undocumented

Inherited from _WithKeys (via CursorResult, Result):

Method keys Return an iterable view which yields the string keys that would be represented by each .Row.

Inherited from ResultInternal (via CursorResult, Result):

Method	`_allrows`	Undocumented
Method	`_column_slices`	Undocumented
Method	`_iter_impl`	Undocumented
Method	`_iterator_getter`	Undocumented
Method	`_manyrow_getter`	Undocumented
Method	`_next_impl`	Undocumented
Method	`_onerow_getter`	Undocumented
Method	`_only_one_row`	Undocumented
Method	`_raw_all_rows`	Undocumented
Method	`_row_getter`	Undocumented
Method	`_unique_strategy`	Undocumented
Class Variable	`_post_creational_filter`	Undocumented
Class Variable	`_real_result`	Undocumented
Instance Variable	`_generate_rows`	Undocumented

Inherited from InPlaceGenerative (via CursorResult, Result, ResultInternal):

Method _generate Undocumented

def _soft_close(self, hard=False):

overrides sqlalchemy.engine.cursor.BaseCursorResult._soft_close

Soft close this _engine.CursorResult.

This releases all DBAPI cursor resources, but leaves the CursorResult "open" from a semantic perspective, meaning the fetchXXX() methods will continue to return empty results.

This method is called automatically when:

all result rows are exhausted using the fetchXXX() methods.
cursor.description is None.

This method is not public, but is documented in order to clarify the "autoclose" process used.

New in version 1.0.0.