sqlalchemy.sql.expression.Insert

class documentation

class Insert(ValuesBase):

Represent an INSERT construct.

The _expression.Insert object is created using the _expression.insert() function.

Method	`__init__`	Construct an `_expression.Insert` object.
Method	`from_select`	Return a new `_expression.Insert` construct which represents an `INSERT...FROM SELECT` statement.
Method	`inline`	Make this `_expression.Insert` construct "inline" .
Class Variable	`__visit_name__`	Undocumented
Class Variable	`_supports_multi_parameters`	Undocumented
Class Variable	`_traverse_internals`	Undocumented
Class Variable	`is_insert`	Undocumented
Instance Variable	`_bind`	Undocumented
Instance Variable	`_inline`	Undocumented
Instance Variable	`_return_defaults`	Undocumented
Instance Variable	`_return_defaults_columns`	Undocumented
Instance Variable	`_returning`	Undocumented
Instance Variable	`_select_names`	Undocumented
Instance Variable	`include_insert_from_select_defaults`	Undocumented
Instance Variable	`select`	Undocumented

Inherited from ValuesBase:

Method	`return_defaults`	Make use of a :term:`RETURNING` clause for the purpose of fetching server-side expressions and defaults.
Method	`values`	Specify a fixed VALUES clause for an INSERT statement, or the SET clause for an UPDATE.
Class Variable	`_multi_values`	Undocumented
Class Variable	`_post_values_clause`	Undocumented
Class Variable	`_preserve_parameter_order`	Undocumented
Class Variable	`_values`	Undocumented
Instance Variable	`_ordered_values`	Undocumented
Instance Variable	`table`	Undocumented

Inherited from UpdateBase (via ValuesBase):

Class Method	`_constructor_20_deprecations`	Undocumented
Method	`_generate_fromclause_column_proxies`	Undocumented
Method	`_set_bind`	Undocumented
Method	`_validate_dialect_kwargs_deprecated`	Undocumented
Method	`bind`	Return a 'bind' linked to this `.UpdateBase` or a `_schema.Table` associated with it.
Method	`params`	Set the parameters for the statement.
Method	`returning`	Add a :term:`RETURNING` or equivalent clause to this statement.
Method	`with_dialect_options`	Add dialect options to this INSERT/UPDATE/DELETE object.
Method	`with_hint`	Add a table hint for a single table to this INSERT/UPDATE/DELETE statement.
Class Variable	`_execution_options`	Undocumented
Class Variable	`is_dml`	Undocumented
Class Variable	`named_with_column`	Undocumented
Instance Variable	`_hints`	Undocumented
Property	`_all_selected_columns`	A sequence of column expression objects that represents the "selected" columns of this `_expression.ReturnsRows`.
Property	`exported_columns`	Return the RETURNING columns as a column collection for this statement.

Inherited from StatementRole (via ValuesBase, UpdateBase, DMLRole):

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

Inherited from SQLRole (via ValuesBase, UpdateBase, DMLRole, StatementRole):

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

Inherited from HasCTE (via ValuesBase, UpdateBase):

Method	`add_cte`	Add a `_sql.CTE` to this statement object that will be independently rendered even if not referenced in the statement otherwise.
Method	`cte`	Return a new `_expression.CTE`, or Common Table Expression instance.
Class Variable	`_has_ctes_traverse_internals`	Undocumented
Class Variable	`_independent_ctes`	Undocumented

Inherited from ReturnsRowsRole (via ValuesBase, UpdateBase, HasCTE, HasCTERole):

Class Variable _role_name Undocumented

Inherited from SQLRole (via ValuesBase, UpdateBase, HasCTE, HasCTERole, ReturnsRowsRole):

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

Inherited from HasCompileState (via ValuesBase, UpdateBase):

Class Variable	`_attributes`	Undocumented
Class Variable	`_compile_state_plugin`	Undocumented

Inherited from Generative (via ValuesBase, UpdateBase, HasCompileState):

Method _generate Undocumented

Inherited from DialectKWArgs (via ValuesBase, UpdateBase):

Class Method	`argument_for`	Add a new kind of dialect-specific keyword argument for this class.
Method	`_kw_reg_for_dialect_cls`	Undocumented
Method	`_validate_dialect_kwargs`	Undocumented
Class Variable	`_dialect_kwargs_traverse_internals`	Undocumented
Class Variable	`_kw_registry`	Undocumented
Property	`dialect_kwargs`	A collection of keyword arguments specified as dialect-specific options to this construct.
Property	`dialect_options`	A collection of keyword arguments specified as dialect-specific options to this construct.
Property	`kwargs`	A synonym for `.DialectKWArgs.dialect_kwargs`.

Inherited from HasPrefixes (via ValuesBase, UpdateBase):

Method	`_setup_prefixes`	Undocumented
Method	`prefix_with`	Add one or more expressions following the statement keyword, i.e. SELECT, INSERT, UPDATE, or DELETE. Generative.
Class Variable	`_has_prefixes_traverse_internals`	Undocumented
Instance Variable	`_prefixes`	Undocumented

Inherited from ReturnsRows (via ValuesBase, UpdateBase):

Class Variable	`_is_from_clause`	Undocumented
Class Variable	`_is_lateral`	Undocumented
Class Variable	`_is_returns_rows`	Undocumented
Class Variable	`_is_select_statement`	Undocumented
Property	`selectable`	Undocumented

Inherited from ReturnsRowsRole (via ValuesBase, UpdateBase, ReturnsRows):

Class Variable _role_name Undocumented

Inherited from SQLRole (via ValuesBase, UpdateBase, ReturnsRows, ReturnsRowsRole):

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

Inherited from ClauseElement (via ValuesBase, UpdateBase, ReturnsRows):

Method	`compare`	Compare this `_expression.ClauseElement` to the given `_expression.ClauseElement`.
Method	`compile`	Compile this SQL expression.
Method	`self_group`	Apply a 'grouping' to this `_expression.ClauseElement`.
Method	`unique_params`	Return a copy with `_expression.bindparam` elements replaced.
Method	`__bool__`	Undocumented
Method	`__getstate__`	Undocumented
Method	`__invert__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`_clone`	Create a shallow copy of this ClauseElement.
Method	`_cloned_set`	Return the set consisting all cloned ancestors of this ClauseElement.
Method	`_compile_w_cache`	Undocumented
Method	`_compiler`	Return a compiler appropriate for this ClauseElement, given a Dialect.
Method	`_execute_on_connection`	Undocumented
Method	`_negate`	Undocumented
Method	`_negate_in_binary`	a hook to allow the right side of a binary expression to respond to a negation of the binary expression.
Method	`_replace_params`	Undocumented
Method	`_set_propagate_attrs`	Undocumented
Method	`_ungroup`	Return this `_expression.ClauseElement` without any groupings.
Method	`_with_binary_element_type`	in the context of binary expression, convert the type of this object to the one given.
Class Variable	`_cache_key_traversal`	Undocumented
Class Variable	`_from_objects`	Undocumented
Class Variable	`_is_bind_parameter`	Undocumented
Class Variable	`_is_clause_list`	Undocumented
Class Variable	`_is_clone_of`	Undocumented
Class Variable	`_is_from_container`	Undocumented
Class Variable	`_is_immutable`	Undocumented
Class Variable	`_is_lambda_element`	Undocumented
Class Variable	`_is_select_container`	Undocumented
Class Variable	`_is_singleton_constant`	Undocumented
Class Variable	`_is_text_clause`	Undocumented
Class Variable	`_is_textual`	Undocumented
Class Variable	`_order_by_label_element`	Undocumented
Class Variable	`description`	Undocumented
Class Variable	`is_clause_element`	Undocumented
Class Variable	`is_selectable`	Undocumented
Class Variable	`stringify_dialect`	Undocumented
Class Variable	`supports_execution`	Undocumented
Instance Variable	`_propagate_attrs`	like annotations, however these propagate outwards liberally as SQL constructs are built, and are set up at construction time.
Property	`_constructor`	return the 'constructor' for this ClauseElement.
Property	`entity_namespace`	Undocumented

Inherited from SQLRole (via ValuesBase, UpdateBase, ReturnsRows, ClauseElement):

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

Inherited from SupportsWrappingAnnotations (via ValuesBase, UpdateBase, ReturnsRows, ClauseElement):

Method	`_annotate`	return a copy of this ClauseElement with annotations updated by the given dictionary.
Method	`_deannotate`	return a copy of this `_expression.ClauseElement` with annotations removed.
Method	`_with_annotations`	return a copy of this ClauseElement with annotations replaced by the given dictionary.

Inherited from SupportsAnnotations (via ValuesBase, UpdateBase, ReturnsRows, ClauseElement, SupportsWrappingAnnotations):

Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via ValuesBase, UpdateBase, ReturnsRows, ClauseElement):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via ValuesBase, UpdateBase, ReturnsRows, ClauseElement, MemoizedHasCacheKey):

Class Variable	`inherit_cache`	Indicate if this `.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass.
Class Method	`_generate_cache_attrs`	generate cache key dispatcher for a new class.
Class Method	`_generate_cache_key_for_object`	Undocumented
Method	`_gen_cache_key`	return an optional cache key.
Class Variable	`__slots__`	Undocumented
Class Variable	`_hierarchy_supports_caching`	private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses.
Class Variable	`_is_has_cache_key`	Undocumented

Inherited from HasCopyInternals (via ValuesBase, UpdateBase, ReturnsRows, ClauseElement):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via ValuesBase, UpdateBase, ReturnsRows, ClauseElement):

Method	`get_children`	Return immediate child `.visitors.Traversible` elements of this `.visitors.Traversible`.
Method	`__class_getitem__`	Undocumented

Inherited from Executable (via ValuesBase, UpdateBase):

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	`_executable_traverse_internals`	Undocumented
Class Variable	`_with_context_options`	Undocumented
Class Variable	`_with_options`	Undocumented
Class Variable	`is_delete`	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
Property	`_effective_plugin_target`	Undocumented

Inherited from StatementRole (via ValuesBase, UpdateBase, Executable):

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

Inherited from SQLRole (via ValuesBase, UpdateBase, Executable, StatementRole):

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

Inherited from Generative (via ValuesBase, UpdateBase, Executable):

Method _generate Undocumented

Inherited from ClauseElement (via ValuesBase, UpdateBase):

Method	`compare`	Compare this `_expression.ClauseElement` to the given `_expression.ClauseElement`.
Method	`compile`	Compile this SQL expression.
Method	`self_group`	Apply a 'grouping' to this `_expression.ClauseElement`.
Method	`unique_params`	Return a copy with `_expression.bindparam` elements replaced.
Method	`__bool__`	Undocumented
Method	`__getstate__`	Undocumented
Method	`__invert__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`_clone`	Create a shallow copy of this ClauseElement.
Method	`_cloned_set`	Return the set consisting all cloned ancestors of this ClauseElement.
Method	`_compile_w_cache`	Undocumented
Method	`_compiler`	Return a compiler appropriate for this ClauseElement, given a Dialect.
Method	`_execute_on_connection`	Undocumented
Method	`_negate`	Undocumented
Method	`_negate_in_binary`	a hook to allow the right side of a binary expression to respond to a negation of the binary expression.
Method	`_replace_params`	Undocumented
Method	`_set_propagate_attrs`	Undocumented
Method	`_ungroup`	Return this `_expression.ClauseElement` without any groupings.
Method	`_with_binary_element_type`	in the context of binary expression, convert the type of this object to the one given.
Class Variable	`_cache_key_traversal`	Undocumented
Class Variable	`_from_objects`	Undocumented
Class Variable	`_is_bind_parameter`	Undocumented
Class Variable	`_is_clause_list`	Undocumented
Class Variable	`_is_clone_of`	Undocumented
Class Variable	`_is_from_clause`	Undocumented
Class Variable	`_is_from_container`	Undocumented
Class Variable	`_is_immutable`	Undocumented
Class Variable	`_is_lambda_element`	Undocumented
Class Variable	`_is_returns_rows`	Undocumented
Class Variable	`_is_select_container`	Undocumented
Class Variable	`_is_select_statement`	Undocumented
Class Variable	`_is_singleton_constant`	Undocumented
Class Variable	`_is_text_clause`	Undocumented
Class Variable	`_is_textual`	Undocumented
Class Variable	`_order_by_label_element`	Undocumented
Class Variable	`description`	Undocumented
Class Variable	`is_clause_element`	Undocumented
Class Variable	`is_selectable`	Undocumented
Class Variable	`stringify_dialect`	Undocumented
Class Variable	`supports_execution`	Undocumented
Instance Variable	`_propagate_attrs`	like annotations, however these propagate outwards liberally as SQL constructs are built, and are set up at construction time.
Property	`_constructor`	return the 'constructor' for this ClauseElement.
Property	`entity_namespace`	Undocumented

Inherited from SQLRole (via ValuesBase, UpdateBase, ClauseElement):

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

Inherited from SupportsWrappingAnnotations (via ValuesBase, UpdateBase, ClauseElement):

Method	`_annotate`	return a copy of this ClauseElement with annotations updated by the given dictionary.
Method	`_deannotate`	return a copy of this `_expression.ClauseElement` with annotations removed.
Method	`_with_annotations`	return a copy of this ClauseElement with annotations replaced by the given dictionary.

Inherited from SupportsAnnotations (via ValuesBase, UpdateBase, ClauseElement, SupportsWrappingAnnotations):

Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via ValuesBase, UpdateBase, ClauseElement):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via ValuesBase, UpdateBase, ClauseElement, MemoizedHasCacheKey):

Class Variable	`inherit_cache`	Indicate if this `.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass.
Class Method	`_generate_cache_attrs`	generate cache key dispatcher for a new class.
Class Method	`_generate_cache_key_for_object`	Undocumented
Method	`_gen_cache_key`	return an optional cache key.
Class Variable	`__slots__`	Undocumented
Class Variable	`_hierarchy_supports_caching`	private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses.
Class Variable	`_is_has_cache_key`	Undocumented

Inherited from HasCopyInternals (via ValuesBase, UpdateBase, ClauseElement):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via ValuesBase, UpdateBase, ClauseElement):

Method	`get_children`	Return immediate child `.visitors.Traversible` elements of this `.visitors.Traversible`.
Method	`__class_getitem__`	Undocumented

@ValuesBase._constructor_20_deprecations('insert', 'Insert', ['values', 'inline', 'bind', 'prefixes', 'returning', 'return_defaults'])
def __init__(self, table, values=None, inline=False, bind=None, prefixes=None, returning=None, return_defaults=False, **dialect_kw):

overrides sqlalchemy.sql.dml.ValuesBase.__init__

Construct an _expression.Insert object.

E.g.:

from sqlalchemy import insert

stmt = (
    insert(user_table).
    values(name='username', fullname='Full Username')
)

Similar functionality is available via the _expression.TableClause.insert method on _schema.Table.

See Also

:ref:`coretutorial_insert_expressions` - SQL Expression Tutorial

:ref:`inserts_and_updates` - SQL Expression Tutorial

Parameters
table	`_expression.TableClause` which is the subject of the insert.
values	collection of values to be inserted; see `_expression.Insert.values` for a description of allowed formats here. Can be omitted entirely; a `_expression.Insert` construct will also dynamically render the VALUES clause at execution time based on the parameters passed to `_engine.Connection.execute`.
inline	if True, no attempt will be made to retrieve the SQL-generated default values to be provided within the statement; in particular, this allows SQL expressions to be rendered 'inline' within the statement without the need to pre-execute them beforehand; for backends that support "returning", this turns off the "implicit returning" feature for the statement.
bind	Undocumented
prefixes	Undocumented
returning	Undocumented
return_defaults	Undocumented
**dialect_kw	Undocumented

@_generative
def from_select(self, names, select, include_defaults=True):

Return a new _expression.Insert construct which represents an INSERT...FROM SELECT statement.

e.g.:

sel = select(table1.c.a, table1.c.b).where(table1.c.c > 5)
ins = table2.insert().from_select(['a', 'b'], sel)

Changed in version 1.0.0: an INSERT that uses FROM SELECT implies that the :paramref:`_expression.insert.inline` flag is set to True, indicating that the statement will not attempt to fetch the "last inserted primary key" or other defaults. The statement deals with an arbitrary number of rows, so the _engine.CursorResult.inserted_primary_key accessor does not apply.

Parameters
names	a sequence of string column names or `_schema.Column` objects representing the target columns.
select	a `_expression.select` construct, `_expression.FromClause` or other construct which resolves into a `_expression.FromClause`, such as an ORM `_query.Query` object, etc. The order of columns returned from this FROM clause should correspond to the order of columns sent as the `names` parameter; while this is not checked before passing along to the database, the database would normally raise an exception if these column lists don't correspond.
include_defaults	if True, non-server default values and SQL expressions as specified on `_schema.Column` objects (as documented in :ref:`metadata_defaults_toplevel`) not otherwise specified in the list of names will be rendered into the INSERT and SELECT statements, so that these values are also included in the data to be inserted. Note A Python-side default that uses a Python callable function will only be invoked once for the whole statement, and not per row. New in version 1.0.0: - `_expression.Insert.from_select` now renders Python-side and SQL expression column defaults into the SELECT statement for columns otherwise not included in the list of column names.

@_generative
def inline(self):

Make this _expression.Insert construct "inline" .

When set, no attempt will be made to retrieve the SQL-generated default values to be provided within the statement; in particular, this allows SQL expressions to be rendered 'inline' within the statement without the need to pre-execute them beforehand; for backends that support "returning", this turns off the "implicit returning" feature for the statement.

Changed in version 1.4: the :paramref:`_expression.Insert.inline` parameter is now superseded by the _expression.Insert.inline method.

__visit_name__: str =

overrides sqlalchemy.sql.dml.ValuesBase.__visit_name__

Undocumented

_supports_multi_parameters: bool =

overrides sqlalchemy.sql.dml.ValuesBase._supports_multi_parameters

Undocumented

_traverse_internals =

Undocumented

is_insert: bool =

overrides sqlalchemy.sql.base.Executable.is_insert

Undocumented

_bind =

overrides sqlalchemy.sql.dml.UpdateBase._bind

Undocumented

_inline: bool =

Undocumented

_return_defaults: bool =

overrides sqlalchemy.sql.dml.ValuesBase._return_defaults

Undocumented

_return_defaults_columns =

overrides sqlalchemy.sql.dml.ValuesBase._return_defaults_columns

Undocumented

_returning =

overrides sqlalchemy.sql.dml.ValuesBase._returning

Undocumented

_select_names =

overrides sqlalchemy.sql.dml.ValuesBase._select_names

Undocumented

include_insert_from_select_defaults =

Undocumented

select =

overrides sqlalchemy.sql.dml.ValuesBase.select

Undocumented