Skip to main content
interface CreateTypeRequest
label: string;
options?: Record<string, string>;
properties?: Record<string, string[]>;
type_definition: string;
label: string

A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.

options?: Record<string, string>

Optional parameters.

properties?: Record<string, string[]>

[DEPRECATED—please use these property values in the type_definition directly, as described at the top, instead] Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column’s data type).

type_definition: string

JSON string defining the columns of the type to be registered, as described above.