sqlalchemy.sql.base.Executable

class documentation

class Executable(roles.StatementRole, Generative):

Known subclasses: sqlalchemy.orm.query.Query, sqlalchemy.sql.ddl.DDLElement, sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.elements.TextClause, sqlalchemy.sql.functions.FunctionElement, sqlalchemy.sql.schema.DefaultGenerator, sqlalchemy.sql.selectable.SelectBase, sqlalchemy.orm.query.FromStatement, sqlalchemy.sql.elements._IdentifiedClause

View In Hierarchy

Mark a _expression.ClauseElement as supporting execution.

.Executable is a superclass for all "statement" types of objects, including select, delete, update, insert, text.

Method	`_add_context_option`	Add a context option to this statement.
Method	`_set_compile_options`	Assign the compile options to a new value.
Method	`_update_compile_options`	update the _compile_options with new keys.
Method	`execute`	Compile and execute this `.Executable`.
Method	`execution_options`	Set non-SQL options for the statement which take effect during execution.
Method	`get_execution_options`	Get the non-SQL options which will take effect during execution.
Method	`options`	Apply options to this statement.
Method	`scalar`	Compile and execute this `.Executable`, returning the result's scalar representation.
Class Variable	`_bind`	Undocumented
Class Variable	`_executable_traverse_internals`	Undocumented
Class Variable	`_with_context_options`	Undocumented
Class Variable	`_with_options`	Undocumented
Class Variable	`is_delete`	Undocumented
Class Variable	`is_dml`	Undocumented
Class Variable	`is_insert`	Undocumented
Class Variable	`is_select`	Undocumented
Class Variable	`is_text`	Undocumented
Class Variable	`is_update`	Undocumented
Class Variable	`supports_execution`	Undocumented
Instance Variable	`_compile_options`	Undocumented
Instance Variable	`_execution_options`	Undocumented
Property	`_effective_plugin_target`	Undocumented
Property	`bind`	Returns the `_engine.Engine` or `_engine.Connection` to which this `.Executable` is bound, or None if none found.

Inherited from StatementRole:

Class Variable	`_propagate_attrs`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from SQLRole (via StatementRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from Generative:

Method _generate Undocumented

@_generative
def _add_context_option(self, callable_, cache_args):

Add a context option to this statement.

These are callable functions that will be given the CompileState object upon compilation.

A second argument cache_args is required, which will be combined with the __code__ identity of the function itself in order to produce a cache key.

@_generative
def _set_compile_options(self, compile_options):

Assign the compile options to a new value.

Parameters
compile_options	appropriate CacheableOptions structure

@_generative
def _update_compile_options(self, options):

update the _compile_options with new keys.

@util.deprecated_20(':meth:`.Executable.execute`', alternative='All statement execution in SQLAlchemy 2.0 is performed by the :meth:`_engine.Connection.execute` method of :class:`_engine.Connection`, or in the ORM by the :meth:`.Session.execute` method of :class:`.Session`.')
def execute(self, *multiparams, **params):

overridden in sqlalchemy.sql.ddl.DDLElement, sqlalchemy.sql.functions.FunctionElement, sqlalchemy.sql.schema.DefaultGenerator

Compile and execute this .Executable.

@_generative
def execution_options(self, **kw):

overridden in sqlalchemy.orm.query.Query

Set non-SQL options for the statement which take effect during execution.

Execution options can be set on a per-statement or per _engine.Connection basis. Additionally, the _engine.Engine and ORM ~.orm.query.Query objects provide access to execution options which they in turn configure upon connections.

The execution_options method is generative. A new instance of this statement is returned that contains the options:

statement = select(table.c.x, table.c.y)
statement = statement.execution_options(autocommit=True)

Note that only a subset of possible execution options can be applied to a statement - these include "autocommit" and "stream_results", but not "isolation_level" or "compiled_cache". See _engine.Connection.execution_options for a full list of possible options.