sqlalchemy.engine.interfaces.ReflectedIdentity

class documentation

class ReflectedIdentity(TypedDict): (source)

View In Hierarchy

represent the reflected IDENTITY structure of a column, corresponding to the :class:`_schema.Identity` construct. The :class:`.ReflectedIdentity` structure is part of the :class:`.ReflectedColumn` structure, which is returned by the :meth:`.Inspector.get_columns` method.

Class Variable always type of identity column
Class Variable cache number of future values in the sequence which are calculated in advance.
Class Variable cycle allows the sequence to wrap around when the maxvalue or minvalue has been reached.
Class Variable increment increment value of the sequence
Class Variable maxvalue the maximum value of the sequence.
Class Variable minvalue the minimum value of the sequence.
Class Variable nomaxvalue no maximum value of the sequence.
Class Variable nominvalue no minimum value of the sequence.
Class Variable on_null indicates ON NULL
Class Variable order if true, renders the ORDER keyword.
Class Variable start starting index of the sequence
always: bool = (source)

type of identity column

cache: Optional[int] = (source)

number of future values in the sequence which are calculated in advance.

cycle: bool = (source)

allows the sequence to wrap around when the maxvalue or minvalue has been reached.

increment: int = (source)

increment value of the sequence

maxvalue: int = (source)

the maximum value of the sequence.

minvalue: int = (source)

the minimum value of the sequence.

nomaxvalue: bool = (source)

no maximum value of the sequence.

nominvalue: bool = (source)

no minimum value of the sequence.

on_null: bool = (source)

indicates ON NULL

order: bool = (source)

if true, renders the ORDER keyword.

start: int = (source)

starting index of the sequence