Class Table

lib/sqlalchemy/sql/schema.py:328–1767

r"""Represent a table in a database. e.g.:: from sqlalchemy import Table, MetaData, Integer, String, Column metadata = MetaData() mytable = Table( "mytable", metadata, Column("mytable_id", Integer, primary_key=True), Col

class Table(
    DialectKWArgs,
    HasSchemaAttr,
    TableClause[_ColCC_co],
    inspection.Inspectable[class="st">"Table"],
):
    rclass="st">"""Represent a table in a database.

    e.g.::

        from sqlalchemy import Table, MetaData, Integer, String, Column

        metadata = MetaData()

        mytable = Table(
            class="st">"mytable",
            metadata,
            Column(class="st">"mytable_id", Integer, primary_key=True),
            Column(class="st">"value", String(50)),
        )

    The :class:`_schema.Table`
    object constructs a unique instance of itself based
    on its name and optional schema name within the given
    :class:`_schema.MetaData` object. Calling the :class:`_schema.Table`
    constructor with the same name and same :class:`_schema.MetaData` argument
    a second time will return the *same* :class:`_schema.Table`
    object - in this way
    the :class:`_schema.Table` constructor acts as a registry function.

    May also be defined as class="st">"typed table" by passing a subclass of
    :class:`_schema.TypedColumns` as the 3rd argument::

        from sqlalchemy import TypedColumns, select


        class user_cols(TypedColumns):
            id = Column(Integer, primary_key=True)
            name: Column[str]
            age: Column[int]
            middle_name: Column[str | None]

            class="cm"># optional, used to infer the select types when selecting the table
            __row_pos__: tuple[int, str, int, str | None]


        user = Table(class="st">"user", metadata, user_cols)

        class="cm"># the columns are typed: the statement has type Select[int, str]
        stmt = sa.select(user.c.id, user.c.name).where(user.c.age > 30)

        class="cm"># Inferred as Select[int, str, int, str | None] thanks to __row_pos__
        stmt1 = user.select()
        stmt2 = sa.select(user)

    The :attr:`sqlalchemy.sql._annotated_cols.HasRowPos.__row_pos__`
    annotation is optional, and it&class="cm">#x27;s used to infer the types in a
    :class:`_sql.Select` when selecting the complete table.