sqlalchemy.sql.expression.Values

class documentation

class Values(Generative, FromClause):

Represent a VALUES construct that can be used as a FROM element in a statement.

The _expression.Values object is created from the _expression.values function.

New in version 1.4.

Method	`__init__`	Construct a `_expression.Values` construct.
Method	`alias`	Return a new `_expression.Values` construct that is a copy of this one with the given name.
Method	`data`	Return a new `_expression.Values` construct, adding the given data to the data list.
Method	`lateral`	Return a new `_expression.Values` with the lateral flag set, so that it renders as LATERAL.
Method	`_populate_column_collection`	Called on subclasses to establish the .c collection.
Class Variable	`__visit_name__`	Undocumented
Class Variable	`_data`	Undocumented
Class Variable	`_traverse_internals`	Undocumented
Instance Variable	`_column_args`	Undocumented
Instance Variable	`_is_lateral`	Undocumented
Instance Variable	`literal_binds`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`named_with_column`	Undocumented
Property	`_column_types`	Undocumented
Property	`_from_objects`	Undocumented

Inherited from Generative:

Method _generate Undocumented

Inherited from FromClause:

Method	`is_derived_from`	Return `True` if this `_expression.FromClause` is 'derived' from the given `FromClause`.
Method	`join`	Return a `_expression.Join` from this `_expression.FromClause` to another `FromClause`.
Method	`outerjoin`	No summary
Method	`select`	Return a SELECT of this `_expression.FromClause`.
Method	`table_valued`	Return a `_sql.TableValuedColumn` object for this `_expression.FromClause`.
Method	`tablesample`	Return a TABLESAMPLE alias of this `_expression.FromClause`.
Class Variable	`c`	Undocumented
Class Variable	`schema`	Define the 'schema' attribute for this `_expression.FromClause`.
Instance Variable	`foreign_keys`	Return the collection of `_schema.ForeignKey` marker objects which this FromClause references.
Instance Variable	`primary_key`	Return the iterable collection of `_schema.Column` objects which comprise the primary key of this `_selectable.FromClause`.
Method	`_anonymous_fromclause`	Undocumented
Method	`_generate_fromclause_column_proxies`	Undocumented
Method	`_init_collections`	Undocumented
Method	`_is_lexical_equivalent`	Return `True` if this `_expression.FromClause` and the other represent the same lexical identity.
Method	`_refresh_for_new_column`	Given a column added to the .c collection of an underlying selectable, produce the local version of that column, assuming this selectable ultimately should proxy this column.
Method	`_reset_column_collection`	Reset the attributes linked to the `FromClause.c` attribute.
Class Variable	`_hide_froms`	Undocumented
Class Variable	`_is_from_clause`	Undocumented
Class Variable	`_is_join`	Undocumented
Class Variable	`_select_iterable`	Undocumented
Class Variable	`_use_schema_map`	Undocumented
Class Variable	`is_selectable`	Undocumented
Instance Variable	`_columns`	Undocumented
Property	`_cols_populated`	Undocumented
Property	`columns`	A named-based collection of `_expression.ColumnElement` objects maintained by this `_expression.FromClause`.
Property	`description`	A brief description of this `_expression.FromClause`.
Property	`entity_namespace`	Return a namespace used for name-based access in SQL expressions.
Property	`exported_columns`	A `_expression.ColumnCollection` that represents the "exported" columns of this `_expression.Selectable`.

Inherited from FromClauseRole (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole):

Class Variable	`_is_subquery`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from AllowsLambdaRole (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable	`_post_inspect`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from SQLRole (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, ColumnListRole):

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

Inherited from AllowsLambdaRole (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable	`_post_inspect`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from SQLRole (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole, StructuralRole):

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

Inherited from Selectable (via FromClause):

Method	`corresponding_column`	No summary
Method	`replace_selectable`	Replace all occurrences of `_expression.FromClause` 'old' with the given `_expression.Alias` object, returning a copy of this `_expression.FromClause`.

Inherited from ReturnsRows (via FromClause, Selectable):

Class Variable	`_is_returns_rows`	Undocumented
Class Variable	`_is_select_statement`	Undocumented
Property	`_all_selected_columns`	A sequence of column expression objects that represents the "selected" columns of this `_expression.ReturnsRows`.
Property	`selectable`	Undocumented

Inherited from ReturnsRowsRole (via FromClause, Selectable, ReturnsRows):

Class Variable _role_name Undocumented

Inherited from SQLRole (via FromClause, Selectable, ReturnsRows, ReturnsRowsRole):

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

Inherited from ClauseElement (via FromClause, Selectable, ReturnsRows):

Method	`compare`	Compare this `_expression.ClauseElement` to the given `_expression.ClauseElement`.
Method	`compile`	Compile this SQL expression.
Method	`params`	Return a copy with `_expression.bindparam` elements replaced.
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	`_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	`bind`	Undocumented
Class Variable	`is_clause_element`	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.

Inherited from SQLRole (via FromClause, Selectable, ReturnsRows, ClauseElement):

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

Inherited from SupportsWrappingAnnotations (via FromClause, Selectable, 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 FromClause, Selectable, ReturnsRows, ClauseElement, SupportsWrappingAnnotations):

Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via FromClause, Selectable, ReturnsRows, ClauseElement):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via FromClause, Selectable, 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 FromClause, Selectable, ReturnsRows, ClauseElement):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via FromClause, Selectable, ReturnsRows, ClauseElement):

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

def __init__(self, *columns, **kw):

Construct a _expression.Values construct.

The column expressions and the actual data for _expression.Values are given in two separate steps. The constructor receives the column expressions typically as _expression.column constructs, and the data is then passed via the _expression.Values.data method as a list, which can be called multiple times to add more data, e.g.:

from sqlalchemy import column
from sqlalchemy import values

value_expr = values(
    column('id', Integer),
    column('name', String),
    name="my_values"
).data(
    [(1, 'name1'), (2, 'name2'), (3, 'name3')]
)

Parameters
*columns	column expressions, typically composed using `_expression.column` objects.
**kw	Undocumented
name	the name for this VALUES construct. If omitted, the VALUES construct will be unnamed in a SQL expression. Different backends may have different requirements here.
literal_binds	Defaults to False. Whether or not to render the data values inline in the SQL output, rather than using bound parameters.

@_generative
def alias(self, name, **kw):

overrides sqlalchemy.sql.expression.FromClause.alias

Return a new _expression.Values construct that is a copy of this one with the given name.

This method is a VALUES-specific specialization of the _expression.FromClause.alias method.

Parameters
values	a sequence (i.e. list) of tuples that map to the column expressions given in the `_expression.Values` constructor.