Interface TypeDescriptor

Information about a user-defined type, used when nameOnly is false in ListTypesOptions.

The definition is very similar to CreateTypeDefinition, except for a couple key differences. See ListTypeDefinition for more information.

Field

name - The name of the UDT.

Field

definition - The field definitions for the UDT.

Field

apiSupport - Information about which Data API operations are supported for this UDT.

See

  • ListTypesOptions
  • Db.listTypes
interface TypeDescriptor {
    apiSupport?: TableUnsupportedColumnApiSupport;
    definition?: ListTypeDefinition;
    name: string;
}

Properties

apiSupport? definition? name

Properties

Optional apiSupport

apiSupport?: TableUnsupportedColumnApiSupport

Information about which Data API operations are supported for this UDT.

Optional definition

definition?: ListTypeDefinition

The field definitions for the UDT, if available.

name

name: string

The name of the UDT.

Settings

Member Visibility

Theme

On This Page

apiSupportdefinitionname