Class STRUCT

Base class for all data types

Hierarchy (View Summary)

AbstractDataType
- STRUCT

Index

Constructors

Properties

Methods

toSQL toSql equals serialize toSqlString getFields

Constructors

constructor

new STRUCT(fields: Record<string, AbstractDataType>): STRUCT
Create a STRUCT data type
Parameters
- fields: Record<string, AbstractDataType>
  A map of field name -> field data type
Returns STRUCT
Example
```
// DuckDB: STRUCT(x INTEGER, y INTEGER)
point: DataTypes.STRUCT({ x: DataTypes.INTEGER, y: DataTypes.INTEGER })
```
Overrides AbstractDataType.constructor
- Defined in models/data-types.ts:1638

Properties

key

key: "STRUCT" = ...

fields

fields: Record<string, AbstractDataType>

The named fields of the struct, in insertion order

Methods

toSQL

toSQL(): string
Returns string
Inherited from AbstractDataType.toSQL
- Defined in models/data-types.ts:18

toSql

toSql(): string
Returns string
Inherited from AbstractDataType.toSql
- Defined in models/data-types.ts:23

equals

equals(other: DataTypeAbstract): boolean
Compare this DataType with another DataType for equality
Parameters
- other: DataTypeAbstract
  The DataType to compare with
Returns boolean
true if the types are equal, false otherwise
Inherited from AbstractDataType.equals
- Defined in models/data-types.ts:32

serialize

serialize(value: unknown): unknown
Serialize a value for storage based on this DataType
Parameters
- value: unknown
  The value to serialize
Returns unknown
The serialized value
Inherited from AbstractDataType.serialize
- Defined in models/data-types.ts:44

toSqlString

toSqlString(dialect?: string): string
Get the SQL string representation based on the dialect DuckDB: native STRUCT(field TYPE, ...) syntax Other dialects: falls back to JSON or TEXT
Parameters
- Optionaldialect: string
Returns string
Overrides AbstractDataType.toSqlString
- Defined in models/data-types.ts:1648

getFields

getFields(): Record<string, AbstractDataType>
Get the struct's fields

Returns Record<string, AbstractDataType>
- Defined in models/data-types.ts:1671