/AWS1/CL_GLUICEBERGSTRUCTFIELD¶
Defines a single field within an Iceberg table schema, including its identifier, name, data type, nullability, and documentation.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_id TYPE /AWS1/GLUINTEGER /AWS1/GLUINTEGER¶
The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.
iv_name TYPE /AWS1/GLUCOLUMNNAMESTRING /AWS1/GLUCOLUMNNAMESTRING¶
The name of the field as it appears in the table schema and query operations.
io_type TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT¶
The data type definition for this field, specifying the structure and format of the data it contains.
iv_required TYPE /AWS1/GLUBOOLEAN /AWS1/GLUBOOLEAN¶
Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.
Optional arguments:¶
iv_doc TYPE /AWS1/GLUCOMMENTSTRING /AWS1/GLUCOMMENTSTRING¶
Optional documentation or description text that provides additional context about the purpose and usage of this field.
io_initialdefault TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT¶
Default value used to populate the field's value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.
io_writedefault TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT¶
Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value. This can be changed through schema evolution.
Queryable Attributes¶
Id¶
The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID |
Name¶
The name of the field as it appears in the table schema and query operations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Type¶
The data type definition for this field, specifying the structure and format of the data it contains.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
Required¶
Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REQUIRED() |
Getter for REQUIRED |
Doc¶
Optional documentation or description text that provides additional context about the purpose and usage of this field.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOC() |
Getter for DOC, with configurable default |
ASK_DOC() |
Getter for DOC w/ exceptions if field has no value |
HAS_DOC() |
Determine if DOC has a value |
InitialDefault¶
Default value used to populate the field's value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INITIALDEFAULT() |
Getter for INITIALDEFAULT, with configurable default |
ASK_INITIALDEFAULT() |
Getter for INITIALDEFAULT w/ exceptions if field has no valu |
HAS_INITIALDEFAULT() |
Determine if INITIALDEFAULT has a value |
WriteDefault¶
Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value. This can be changed through schema evolution.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WRITEDEFAULT() |
Getter for WRITEDEFAULT, with configurable default |
ASK_WRITEDEFAULT() |
Getter for WRITEDEFAULT w/ exceptions if field has no value |
HAS_WRITEDEFAULT() |
Determine if WRITEDEFAULT has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_ICEBERGSTRUCTFIELDLIST¶
TYPES TT_ICEBERGSTRUCTFIELDLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GLUICEBERGSTRUCTFIELD WITH DEFAULT KEY
.