Arrow.dom | Apache Arrow

Index

Namespaces

Enumerations

Classes

Type Aliases

StructRowProxy

Functions

Type Aliases

StructRowProxy

StructRowProxy<T>: StructRow<T> & { [ P in keyof T]: T[P]["TValue"] } & {}

Type Parameters

T extends TypeMap = any

Functions

builderThroughAsyncIterable

builderThroughAsyncIterable<T, TNull>(options: IterableBuilderOptions<T, TNull>): ThroughAsyncIterable<T, TNull>

- Defined in factories.ts:256
Transform an AsyncIterable of arbitrary JavaScript values into a sequence of Arrow Vector following the chunking semantics defined in the supplied options argument.
This function returns a function that accepts an AsyncIterable of values to transform. When called, this function returns an AsyncIterator of Vector<T>.

The resulting AsyncIterator<Vector<T>> yields Vectors based on the queueingStrategy and highWaterMark specified in the options argument.
- If queueingStrategy is "count" (or omitted), The AsyncIterator<Vector<T>> will flush the underlying Builder (and yield a new Vector<T>) once the Builder's length reaches or exceeds the supplied highWaterMark.
- If queueingStrategy is "bytes", the AsyncIterator<Vector<T>> will flush the underlying Builder (and yield a new Vector<T>) once its byteLength reaches or exceeds the supplied highWaterMark.
nocollapse
Type Parameters
- T extends DataType<Type, any, T> = any
- TNull = any
Parameters
- options: IterableBuilderOptions<T, TNull>
  
  An object of properties which determine the Builder to create and the chunking semantics to use.
Returns ThroughAsyncIterable<T, TNull>
A function which accepts a JavaScript AsyncIterable of values to write, and returns an AsyncIterator that yields Vectors according to the chunking semantics defined in the options argument.

builderThroughIterable

builderThroughIterable<T, TNull>(options: IterableBuilderOptions<T, TNull>): ThroughIterable<T, TNull>

- Defined in factories.ts:210
Transform a synchronous Iterable of arbitrary JavaScript values into a sequence of Arrow Vector following the chunking semantics defined in the supplied options argument.
This function returns a function that accepts an Iterable of values to transform. When called, this function returns an Iterator of Vector<T>.

The resulting Iterator<Vector<T>> yields Vectors based on the queueingStrategy and highWaterMark specified in the options argument.
- If queueingStrategy is "count" (or omitted), The Iterator<Vector<T>> will flush the underlying Builder (and yield a new Vector<T>) once the Builder's length reaches or exceeds the supplied highWaterMark.
- If queueingStrategy is "bytes", the Iterator<Vector<T>> will flush the underlying Builder (and yield a new Vector<T>) once its byteLength reaches or exceeds the supplied highWaterMark.
nocollapse
Type Parameters
- T extends DataType<Type, any, T> = any
- TNull = any
Parameters
- options: IterableBuilderOptions<T, TNull>
  
  An object of properties which determine the Builder to create and the chunking semantics to use.
Returns ThroughIterable<T, TNull>
A function which accepts a JavaScript Iterable of values to write, and returns an Iterator that yields Vectors according to the chunking semantics defined in the options argument.

makeBuilder

makeBuilder<T, TNull>(options: BuilderOptions<T, TNull>): BuilderType<T, TNull>

- Defined in factories.ts:30
Type Parameters
- T extends DataType<Type, any, T> = any
- TNull = any
Parameters
- options: BuilderOptions<T, TNull>
Returns BuilderType<T, TNull>

makeData

makeData<T>(props: NullDataProps<T>): Data<T>
makeData<T>(props: IntDataProps<T>): Data<T>
makeData<T>(props: DictionaryDataProps<T>): Data<T>
makeData<T>(props: FloatDataProps<T>): Data<T>
makeData<T>(props: BoolDataProps<T>): Data<T>
makeData<T>(props: DecimalDataProps<T>): Data<T>
makeData<T>(props: Date_DataProps<T>): Data<T>
makeData<T>(props: TimeDataProps<T>): Data<T>
makeData<T>(props: TimestampDataProps<T>): Data<T>
makeData<T>(props: IntervalDataProps<T>): Data<T>
makeData<T>(props: FixedSizeBinaryDataProps<T>): Data<T>
makeData<T>(props: BinaryDataProps<T>): Data<T>
makeData<T>(props: Utf8DataProps<T>): Data<T>
makeData<T>(props: ListDataProps<T>): Data<T>
makeData<T>(props: FixedSizeListDataProps<T>): Data<T>
makeData<T>(props: StructDataProps<T>): Data<T>
makeData<T>(props: Map_DataProps<T>): Data<T>
makeData<T>(props: SparseUnionDataProps<T>): Data<T>
makeData<T>(props: DenseUnionDataProps<T>): Data<T>
makeData<T>(props: UnionDataProps<T>): Data<T>
makeData<T>(props: DataProps_<T>): Data<T>

- Defined in data.ts:416
Type Parameters
- T extends Null<T>
Parameters
- props: NullDataProps<T>
Returns Data<T>
- Defined in data.ts:417
Type Parameters
- T extends Int_<Ints, T>
Parameters
- props: IntDataProps<T>
Returns Data<T>
- Defined in data.ts:418
Type Parameters
- T extends Dictionary<any, TKeys, T>
Parameters
- props: DictionaryDataProps<T>
Returns Data<T>
- Defined in data.ts:419
Type Parameters
- T extends Float<Floats, T>
Parameters
- props: FloatDataProps<T>
Returns Data<T>
- Defined in data.ts:420
Type Parameters
- T extends Bool<T>
Parameters
- props: BoolDataProps<T>
Returns Data<T>
- Defined in data.ts:421
Type Parameters
- T extends Decimal<T>
Parameters
- props: DecimalDataProps<T>
Returns Data<T>
- Defined in data.ts:422
Type Parameters
- T extends Date_<Dates, T>
Parameters
- props: Date_DataProps<T>
Returns Data<T>
- Defined in data.ts:423
Type Parameters
- T extends Time_<Times, T>
Parameters
- props: TimeDataProps<T>
Returns Data<T>
- Defined in data.ts:424
Type Parameters
- T extends Timestamp_<Timestamps, T>
Parameters
- props: TimestampDataProps<T>
Returns Data<T>
- Defined in data.ts:425
Type Parameters
- T extends Interval_<Intervals, T>
Parameters
- props: IntervalDataProps<T>
Returns Data<T>
- Defined in data.ts:426
Type Parameters
- T extends FixedSizeBinary<T>
Parameters
- props: FixedSizeBinaryDataProps<T>
Returns Data<T>
- Defined in data.ts:427
Type Parameters
- T extends Binary<T>
Parameters
- props: BinaryDataProps<T>
Returns Data<T>
- Defined in data.ts:428
Type Parameters
- T extends Utf8<T>
Parameters
- props: Utf8DataProps<T>
Returns Data<T>
- Defined in data.ts:429
Type Parameters
- T extends List<any, T>
Parameters
- props: ListDataProps<T>
Returns Data<T>
- Defined in data.ts:430
Type Parameters
- T extends FixedSizeList<any, T>
Parameters
- props: FixedSizeListDataProps<T>
Returns Data<T>
- Defined in data.ts:431
Type Parameters
- T extends Struct<any, T>
Parameters
- props: StructDataProps<T>
Returns Data<T>
- Defined in data.ts:432
Type Parameters
- T extends Map_<any, any, T>
Parameters
- props: Map_DataProps<T>
Returns Data<T>
- Defined in data.ts:433
Type Parameters
- T extends SparseUnion<T>
Parameters
- props: SparseUnionDataProps<T>
Returns Data<T>
- Defined in data.ts:434
Type Parameters
- T extends DenseUnion<T>
Parameters
- props: DenseUnionDataProps<T>
Returns Data<T>
- Defined in data.ts:435
Type Parameters
- T extends Union_<Unions, T>
Parameters
- props: UnionDataProps<T>
Returns Data<T>
- Defined in data.ts:436
Type Parameters
- T extends DataType<Type, any, T>
Parameters
- props: DataProps_<T>
Returns Data<T>

makeTable

makeTable<I>(input: I): Table<{ [ P in keyof I]: TypedArrayDataType<I[P]> }>

- Defined in table.ts:412
Creates a new Table from an object of typed arrays.
example
```
const table = makeTable({
  a: new Int8Array([1, 2, 3]),
})
```
Type Parameters
- I extends Record<string | number | symbol, TypedArray>
Parameters
- input: I
  
  Input an object of typed arrays.
Returns Table<{ [ P in keyof I]: TypedArrayDataType<I[P]> }>
A new Table.

makeVector

makeVector<T>(data: T | readonly T[]): Vector<TypedArrayDataType<T>>
makeVector<T>(data: T | readonly T[]): Vector<dtypes.Int8>
makeVector<T>(data: Data<T> | readonly Data<T>[]): Vector<T>
makeVector<T>(data: Vector<T> | readonly Vector<T>[]): Vector<T>
makeVector<T>(data: DataProps<T> | readonly DataProps<T>[]): Vector<T>

- Defined in vector.ts:440
Creates a Vector without data copies.
example
```
const vector = makeVector(new Int32Array([1, 2, 3]));
```
Type Parameters
- T extends TypedArray | BigIntArray
Parameters
- data: T | readonly T[]
Returns Vector<TypedArrayDataType<T>>
- Defined in vector.ts:441
Type Parameters
- T extends DataView
Parameters
- data: T | readonly T[]
Returns Vector<dtypes.Int8>
- Defined in vector.ts:442
Type Parameters
- T extends DataType<Type, any, T>
Parameters
- data: Data<T> | readonly Data<T>[]
Returns Vector<T>
- Defined in vector.ts:443
Type Parameters
- T extends DataType<Type, any, T>
Parameters
- data: Vector<T> | readonly Vector<T>[]
Returns Vector<T>
- Defined in vector.ts:444
Type Parameters
- T extends DataType<Type, any, T>
Parameters
- data: DataProps<T> | readonly DataProps<T>[]
Returns Vector<T>

tableFromArrays

tableFromArrays<I>(input: I): Table<{ [ P in keyof I]: ArrayDataType<I[P]> }>

- Defined in table.ts:436
Creates a new Table from an object of typed arrays or JavaScript arrays.
example
```
const table = tableFromArrays({
  a: [1, 2, 3],
  b: new Int8Array([1, 2, 3]),
})
```
Type Parameters
- I extends Record<string | number | symbol, readonly unknown[] | TypedArray | BigIntArray>
Parameters
- input: I
  
  Input an object of typed arrays or JavaScript arrays.
Returns Table<{ [ P in keyof I]: ArrayDataType<I[P]> }>
A new Table.

tableFromIPC

tableFromIPC<T>(source: ArrowJSONLike | FromArg2): Table<T>
tableFromIPC<T>(source: FromArg1): Promise<Table<T>>
tableFromIPC<T>(source: FromArg3 | FromArg4 | FromArg5): Promise<Table<T>>
tableFromIPC<T>(source: RecordBatchReaders<T>): Table<T>
tableFromIPC<T>(source: AsyncRecordBatchReaders<T>): Promise<Table<T>>
tableFromIPC<T>(source: RecordBatchReader<T>): Table<T> | Promise<Table<T>>

- Defined in ipc/serialization.ts:36
Deserialize the IPC format into a Table. This function is a convenience wrapper for RecordBatchReader. Opposite of tableToIPC.

Type Parameters
- T extends TypeMap = any
Parameters
- source: ArrowJSONLike | FromArg2
Returns Table<T>
- Defined in ipc/serialization.ts:37
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg1
Returns Promise<Table<T>>
- Defined in ipc/serialization.ts:38
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg3 | FromArg4 | FromArg5
Returns Promise<Table<T>>
- Defined in ipc/serialization.ts:39
Type Parameters
- T extends TypeMap = any
Parameters
- source: RecordBatchReaders<T>
Returns Table<T>
- Defined in ipc/serialization.ts:40
Type Parameters
- T extends TypeMap = any
Parameters
- source: AsyncRecordBatchReaders<T>
Returns Promise<Table<T>>
- Defined in ipc/serialization.ts:41
Type Parameters
- T extends TypeMap = any
Parameters
- source: RecordBatchReader<T>
Returns Table<T> | Promise<Table<T>>

tableFromJSON

tableFromJSON<T>(array: T[]): Table<{ [ P in keyof T]: JavaScriptDataType<T[P]> }>

- Defined in factories.ts:100
Creates a Table from an array of objects.

Type Parameters
- T extends Record<string, unknown>
Parameters
- array: T[]
  
  A table of objects.
Returns Table<{ [ P in keyof T]: JavaScriptDataType<T[P]> }>

tableToIPC

tableToIPC<T>(table: Table<any>, type?: "file" | "stream"): Uint8Array

- Defined in ipc/serialization.ts:61
Serialize a Table to the IPC format. This function is a convenience wrapper for {@link RecordBatchStreamWriter} and {@link RecordBatchFileWriter}. Opposite of tableFromIPC.

Type Parameters
- T extends TypeMap = any
Parameters
- table: Table<any>
  
  The Table to serialize.
- type: "file" | "stream" = 'stream'
  
  Whether to serialize the Table as a file or a stream.
Returns Uint8Array

vectorFromArray

vectorFromArray(values: readonly (undefined | null)[], type?: Null): Vector<dtypes.Null>
vectorFromArray(values: readonly (undefined | null | boolean)[], type?: Bool): Vector<dtypes.Bool>
vectorFromArray<T>(values: readonly (undefined | null | string)[], type?: T): Vector<T>
vectorFromArray<T>(values: readonly (undefined | null | Date)[], type?: T): Vector<T>
vectorFromArray<T>(values: readonly (undefined | null | number)[], type: T): Vector<T>
vectorFromArray<T>(values: readonly (undefined | null | bigint)[], type?: T): Vector<T>
vectorFromArray<T>(values: readonly (undefined | null | number)[], type?: T): Vector<T>
vectorFromArray<T>(values: readonly unknown[], type: T): Vector<T>
vectorFromArray<T>(values: T): Vector<JavaScriptArrayDataType<T>>
vectorFromArray<T>(data: T): Vector<TypedArrayDataType<T>>
vectorFromArray<T>(data: Data<T>): Vector<T>
vectorFromArray<T>(data: Vector<T>): Vector<T>
vectorFromArray<T>(data: DataProps<T>): Vector<T>
vectorFromArray<T>(data: T): Vector<ArrayDataType<T>>

- Defined in factories.ts:65
Creates a Vector from a JavaScript array via a Builder. Use makeVector if you only want to create a vector from a typed array.
example
```
const vf64 = vectorFromArray([1, 2, 3]);
const vi8 = vectorFromArray([1, 2, 3], new Int8);
const vdict = vectorFromArray(['foo', 'bar']);
const vstruct = vectorFromArray([{a: 'foo', b: 42}, {a: 'bar', b: 12}]);
```
Parameters
- values: readonly (undefined | null)[]
- Optional type: Null
Returns Vector<dtypes.Null>
- Defined in factories.ts:66
Parameters
- values: readonly (undefined | null | boolean)[]
- Optional type: Bool
Returns Vector<dtypes.Bool>
- Defined in factories.ts:67
Type Parameters
- T extends Utf8 | Dictionary<Utf8, TKeys> = Dictionary<Utf8, Int32>
Parameters
- values: readonly (undefined | null | string)[]
- Optional type: T
Returns Vector<T>
- Defined in factories.ts:68
Type Parameters
- T extends Date_<Dates, T>
Parameters
- values: readonly (undefined | null | Date)[]
- Optional type: T
Returns Vector<T>
- Defined in factories.ts:69
Type Parameters
- T extends Int_<Ints, T>
Parameters
- values: readonly (undefined | null | number)[]
- type: T
Returns Vector<T>
- Defined in factories.ts:70
Type Parameters
- T extends Int64 | Uint64 = Int64
Parameters
- values: readonly (undefined | null | bigint)[]
- Optional type: T
Returns Vector<T>
- Defined in factories.ts:71
Type Parameters
- T extends Float<Floats, T> = Float64
Parameters
- values: readonly (undefined | null | number)[]
- Optional type: T
Returns Vector<T>
- Defined in factories.ts:72
Type Parameters
- T extends DataType<Type, any, T>
Parameters
- values: readonly unknown[]
- type: T
Returns Vector<T>
- Defined in factories.ts:73
Type Parameters
- T extends readonly unknown[]
Parameters
- values: T
Returns Vector<JavaScriptArrayDataType<T>>
- Defined in factories.ts:75
Creates a Vector from a typed array via makeVector.

Type Parameters
- T extends TypedArray | BigIntArray
Parameters
- data: T
Returns Vector<TypedArrayDataType<T>>
- Defined in factories.ts:77
Type Parameters
- T extends DataType<Type, any, T>
Parameters
- data: Data<T>
Returns Vector<T>
- Defined in factories.ts:78
Type Parameters
- T extends DataType<Type, any, T>
Parameters
- data: Vector<T>
Returns Vector<T>
- Defined in factories.ts:79
Type Parameters
- T extends DataType<Type, any, T>
Parameters
- data: DataProps<T>
Returns Vector<T>
- Defined in factories.ts:80
Type Parameters
- T extends readonly unknown[] | TypedArray | BigIntArray
Parameters
- data: T
Returns Vector<ArrayDataType<T>>

Index

Namespaces

Enumerations

Classes

Type Aliases

Functions

Type Aliases

StructRowProxy

Type Parameters

T extends TypeMap = any

Functions

builderThroughAsyncIterable

Type Parameters

T extends DataType<Type, any, T> = any

TNull = any

Parameters

options: IterableBuilderOptions<T, TNull>

Returns ThroughAsyncIterable<T, TNull>

builderThroughIterable

Type Parameters

T extends DataType<Type, any, T> = any

TNull = any

Parameters

options: IterableBuilderOptions<T, TNull>

Returns ThroughIterable<T, TNull>

makeBuilder

Type Parameters

T extends DataType<Type, any, T> = any

TNull = any

Parameters

options: BuilderOptions<T, TNull>

Returns BuilderType<T, TNull>

makeData

Type Parameters

T extends Null<T>

Parameters

props: NullDataProps<T>

Returns Data<T>

Type Parameters

T extends Int_<Ints, T>

Parameters

props: IntDataProps<T>

Returns Data<T>

Type Parameters

T extends Dictionary<any, TKeys, T>

Parameters

props: DictionaryDataProps<T>

Returns Data<T>

Type Parameters

T extends Float<Floats, T>

Parameters

props: FloatDataProps<T>

Returns Data<T>

Type Parameters

T extends Bool<T>

Parameters

props: BoolDataProps<T>

Returns Data<T>

Type Parameters

T extends Decimal<T>

Parameters

props: DecimalDataProps<T>

Returns Data<T>

Type Parameters

T extends Date_<Dates, T>

Parameters

props: Date_DataProps<T>

Returns Data<T>

Type Parameters

T extends Time_<Times, T>

Parameters

props: TimeDataProps<T>

Returns Data<T>

Type Parameters

T extends Timestamp_<Timestamps, T>

Parameters

props: TimestampDataProps<T>

Returns Data<T>

Type Parameters

T extends Interval_<Intervals, T>