Home > extract-pg-schema > TableColumn

TableColumn interface

Column in a table.

Signature:

export interface TableColumn

Properties

Property	Modifiers	Type	Description
comment		string | null	Comment on the column.
defaultValue		any	Default value of the column.
dimensions		number	Number of dimensions of the array type. 0 if not an array.
expandedType		string	Expanded type name. If the type is an array, brackets will be appended to the type name.
generated		"ALWAYS" | "NEVER" | "BY DEFAULT"	Behavior of the generated column. "ALWAYS" if always generated, "NEVER" if never generated, "BY DEFAULT" if generated when value is not provided.
indices		Index[]
informationSchemaValue		InformationSchemaColumn	Information schema value for the column.
isArray		boolean	Whether the column is an array.
isIdentity		boolean	Whether the column is an identity column.
isNullable		boolean	Whether the column is nullable.
isPrimaryKey		boolean	Whether the column is a primary key.
isUpdatable		boolean	Whether the column is updatable.
maxLength		number | null	Maximum length of the column.
name		string	Column name.
ordinalPosition		number	Ordinal position of the column in the table. Starts from 1.
reference		ColumnReference | null
references		ColumnReference[]	Array of references from this column.
type		TableColumnType	Type information.