Chevron Down
Table of Contents
Chevron DownAPI Reference

Data

Untyped storage backing for Vector.

Can be thought of as array of ArrayBuffer instances.

Also contains slice offset (including null bitmaps).

Fields

readonly type: T;

readonly length: Number;

readonly offset: Number;

readonly stride: Number;

readonly childData: Data[];

readonly values: Buffers[BufferType.DATA];

readonly typeIds: Buffers[BufferType.TYPE];

readonly nullBitmap: Buffers[BufferType.VALIDITY];

readonly valueOffsets: Buffers[BufferType.OFFSET];

readonly ArrayType: any;

readonly typeId: T['TType'];

readonly buffers: Buffers;

readonly nullCount: Number;

Static Methods

Convenience methods for creating Data instances for each of the Arrow Vector types.

Data.Null(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer) : Data

Data.Int(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Dictionary(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Float(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Bool(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Decimal(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Date(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Time(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Timestamp(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Interval(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.FixedSizeBinary(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, data: DataBuffer) : Data

Data.Binary(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, valueOffsets: ValueOffsetsBuffer, data: Uint8Array) : Data

Data.Utf8(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, valueOffsets: ValueOffsetsBuffer, data: Uint8Array) : Data

Data.List(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, valueOffsets: ValueOffsetsBuffer, child: Data<T['valueType']> | Vector<T['valueType']>) : Data

Data.FixedSizeList(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, child: Data | Vector) : Data

Data.Struct(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, children: (Data | Vector)[]) : Data

Data.Map(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, children: (Data | Vector)[]) : Data

Data.Union(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, typeIds: TypeIdsBuffer, children: (Data | Vector)[]) : Data

Data.Union(type: T, offset: Number, length: Number, nullCount: Number, nullBitmap: NullBuffer, typeIds: TypeIdsBuffer, valueOffsets: ValueOffsetsBuffer, children: (Data | Vector)[]) : Data

}

Methods

constructor(type: T, offset: Number, length: Number, nullCount?: Number, buffers?: Partial<Buffers> | Data, childData?: (Data | Vector)[]);

clone(type: DataType, offset?: Number, length?: Number, nullCount?: Number, buffers?: Buffers, childData?: (Data | Vector)[]) : Data;

slice(offset: Number, length: Number) : Data