Skip to main content

Schema

This documentation reflects Arrow JS v4.0. Needs to be updated for the new Arrow API in v9.0 +.

Sequence of arrow::Field objects describing the columns of a record batch or table data structure

Accessors

fields : Field[] (readonly)

Return the list of fields (columns) in the schema.

metadata (readonly)

The custom key-value metadata, if any. metadata may be null.

dictionaries (readonly)

TBD - List of dictionaries (each dictionary is associated with a column that is dictionary encoded).

dictionaryFields (readonly)

TBD - List of fields

Methods

constructor(fields: Field[], metadata?: Object, dictionaries?: Object, dictionaryFields?: Object)

Creates a new schema instance.

select(columnNames) : Schema

Returns a new Schema with the Fields indicated by the column names.