sqlalchemy.sql.expression.TableClause

class documentation

class TableClause(roles.DMLTableRole, Immutable, FromClause):

Known subclasses: sqlalchemy.sql.schema.Table

Represents a minimal "table" construct.

This is a lightweight table object that has only a name, a collection of columns, which are typically produced by the _expression.column function, and a schema:

from sqlalchemy import table, column

user = table("user",
        column("id"),
        column("name"),
        column("description"),
)

The _expression.TableClause construct serves as the base for the more commonly used _schema.Table object, providing the usual set of _expression.FromClause services including the .c. collection and statement generation methods.

It does not provide all the additional schema-level services of _schema.Table, including constraints, references to other tables, or support for _schema.MetaData-level services. It's useful on its own as an ad-hoc construct used to generate quick SQL statements when a more fully fledged _schema.Table is not on hand.

Method	`__init__`	Produce a new `_expression.TableClause`.
Method	`delete`	Generate a `_expression.delete` construct against this `_expression.TableClause`.
Method	`insert`	Generate an `_expression.insert` construct against this `_expression.TableClause`.
Method	`update`	Generate an `_expression.update` construct against this `_expression.TableClause`.
Class Variable	`implicit_returning`	`_expression.TableClause` doesn't support having a primary key or column -level defaults, so implicit returning doesn't apply.
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	`__str__`	Undocumented
Method	`_init_collections`	Undocumented
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	`append_column`	Undocumented
Class Variable	`__visit_name__`	Undocumented
Class Variable	`_autoincrement_column`	No PK or default support so no autoincrement column.
Class Variable	`_traverse_internals`	Undocumented
Class Variable	`named_with_column`	Undocumented
Instance Variable	`_columns`	Undocumented
Instance Variable	`fullname`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`schema`	Define the 'schema' attribute for this `_expression.FromClause`.
Property	`_from_objects`	Undocumented
Property	`description`	A brief description of this `_expression.FromClause`.

Inherited from DMLTableRole:

Class Variable _role_name Undocumented

Inherited from FromClauseRole (via DMLTableRole):

Class Variable	`_is_subquery`	Undocumented
Property	`_hide_froms`	Undocumented

Inherited from ColumnsClauseRole (via DMLTableRole, FromClauseRole):

Property _select_iterable Undocumented

Inherited from AllowsLambdaRole (via DMLTableRole, FromClauseRole, ColumnsClauseRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via DMLTableRole, FromClauseRole, ColumnsClauseRole):

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

Inherited from SQLRole (via DMLTableRole, FromClauseRole, ColumnsClauseRole, ColumnListRole):

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

Inherited from AllowsLambdaRole (via DMLTableRole, FromClauseRole, JoinTargetRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via DMLTableRole, FromClauseRole, JoinTargetRole):

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

Inherited from SQLRole (via DMLTableRole, FromClauseRole, JoinTargetRole, StructuralRole):

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

Inherited from Immutable:

Method	`_clone`	Undocumented
Method	`_copy_internals`	Undocumented
Method	`params`	Undocumented
Method	`unique_params`	Undocumented
Class Variable	`_is_immutable`	Undocumented

Inherited from FromClause:

Method	`alias`	Return an alias of this `_expression.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
Method	`_anonymous_fromclause`	Undocumented
Method	`_generate_fromclause_column_proxies`	Undocumented
Method	`_is_lexical_equivalent`	Return `True` if this `_expression.FromClause` and the other represent the same lexical identity.
Method	`_populate_column_collection`	Called on subclasses to establish the .c collection.
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
Property	`_cols_populated`	Undocumented
Property	`columns`	A named-based collection of `_expression.ColumnElement` objects maintained by 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	`lateral`	Return a LATERAL alias of this `_expression.Selectable`.
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_lateral`	Undocumented
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	`_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, name, *columns, **kw):

overridden in sqlalchemy.sql.schema.Table

Produce a new _expression.TableClause.

The object returned is an instance of _expression.TableClause, which represents the "syntactical" portion of the schema-level _schema.Table object. It may be used to construct lightweight table constructs.

Changed in version 1.0.0: _expression.table can now be imported from the plain sqlalchemy namespace like any other SQL element.

Parameters
name	Name of the table.
*columns	A collection of `_expression.column` constructs.
**kw	Undocumented
schema	The schema name for this table. New in version 1.3.18: `_expression.table` can now accept a `schema` argument.

@util.preload_module('sqlalchemy.sql.dml')
def delete(self, whereclause=None, **kwargs):

Generate a _expression.delete construct against this _expression.TableClause.

E.g.:

table.delete().where(table.c.id==7)

See _expression.delete for argument and usage information.

@util.preload_module('sqlalchemy.sql.dml')
def insert(self, values=None, inline=False, **kwargs):

Generate an _expression.insert construct against this _expression.TableClause.

E.g.:

table.insert().values(name='foo')

See _expression.insert for argument and usage information.

@util.preload_module('sqlalchemy.sql.dml')
def update(self, whereclause=None, values=None, inline=False, **kwargs):

Generate an _expression.update construct against this _expression.TableClause.

E.g.:

table.update().where(table.c.id==7).values(name='foo')

See _expression.update for argument and usage information.

implicit_returning: bool =

overridden in sqlalchemy.sql.schema.Table

_expression.TableClause doesn't support having a primary key or column -level defaults, so implicit returning doesn't apply.

foreign_keys: set =

overrides sqlalchemy.sql.expression.FromClause.foreign_keys

overridden in sqlalchemy.sql.schema.Table

Return the collection of _schema.ForeignKey marker objects which this FromClause references.

Each _schema.ForeignKey is a member of a _schema.Table-wide _schema.ForeignKeyConstraint.