Skip to content

Home > extract-pg-schema > CompositeTypeAttribute

CompositeTypeAttribute interface

Attribute of a composite type.

Signature:

typescript
export interface CompositeTypeAttribute

Properties

Property

Modifiers

Type

Description

comment

string | null

Comment on the attribute.

defaultValue

any

Default value of the attribute.

expandedType

string

Expanded type name. If the type is an array, brackets will be appended to the type name.

fakeInformationSchemaValue

InformationSchemaColumn

The Postgres information_schema views do not contain info about materialized views. This value is the result of a query that matches the one for regular views. Use with caution, not all fields are guaranteed to be meaningful and/or accurate.

generated

"ALWAYS" | "NEVER" | "BY DEFAULT"

Behavior of the generated attribute. "ALWAYS" if always generated, "NEVER" if never generated, "BY DEFAULT" if generated when a value is not provided.

isArray

boolean

Whether the attribute is an array.

isIdentity

boolean

Whether the attribute is an identity attribute.

isNullable

boolean

Whether the attribute is nullable.

isUpdatable

boolean

Whether the attribute is updatable.

maxLength

number | null

Maximum length of the attribute.

name

string

Attribute name.

ordinalPosition

number

Ordinal position of the attribute in the composite type. Starts from 1.

type

AttributeType

Type information.