Skip to main content

Class: ParquetTableData

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:10

Loaded tabular data providing column-wise access

The items of a table are its rows, each of which annotates one item of another data object (see AnnotatedDataSource); the item IDs and names are those of the annotated items, in row order.

Implements

Constructors

Constructor

new ParquetTableData(source, numRows, columns, ids, names): ParquetTableData

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:17

Parameters

source

ParquetSource

numRows

number

columns

string[]

ids

number[] | undefined

names

string[] | undefined

Returns

ParquetTableData

Methods

close()

close(): void

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:96

Releases all resources held by this data object

Returns

void

Implementation of

TableData.close


getIds()

getIds(): number[]

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:31

Returns an array of item IDs

The returned array is owned by this data object: callers must not modify it, and every call returns the very same array (see ItemsData).

Returns

number[]

The item IDs

Implementation of

TableData.getIds


getNames()

getNames(): string[] | undefined

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:43

Returns the item names if available, otherwise undefined

Optional: data types that never carry item names need not implement it.

The returned array is owned by this data object: callers must not modify it, and every call returns the very same array (see ItemsData).

Returns

string[] | undefined

The item names, or undefined if not available

Implementation of

TableData.getNames


getSize()

getSize(): number

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:39

Returns the total number of items

Returns

number

The item count

Implementation of

TableData.getSize


loadUniqueValues()

loadUniqueValues<T>(column, options?): Promise<GenericArray<T>>

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:72

Loads a column's unique values as a typed array-like

Type Parameters

T

T

Element type of the returned array

Parameters

column

string

The column name

options?

Optional abort signal and progress callback

onProgress?

ProgressCallback

signal?

AbortSignal

Returns

Promise<GenericArray<T>>

The unique column values

Implementation of

TableData.loadUniqueValues


loadValueRange()

loadValueRange(column, options?): Promise<[number, number] | undefined>

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:83

Loads a column's minimum and maximum values

Parameters

column

string

The column name

options?

Optional abort signal and progress callback

onProgress?

ProgressCallback

signal?

AbortSignal

Returns

Promise<[number, number] | undefined>

The numeric [min, max] value range of the column, or undefined if not numeric

Implementation of

TableData.loadValueRange


loadValues()

loadValues<T>(column, options?): Promise<GenericArray<T>>

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:59

Loads a column's values as a typed array-like

Type Parameters

T

T

Element type of the returned array

Parameters

column

string

The column name

options?

Optional abort signal and progress callback

onProgress?

ProgressCallback

signal?

AbortSignal

Returns

Promise<GenericArray<T>>

The column values

Implementation of

TableData.loadValues


resolveColumnQuery()

resolveColumnQuery(query): Promise<string | null>

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:54

Resolves a query to an exact column name

Parameters

query

string

The column query

Returns

Promise<string | null>

The resolved column name, or null if no match is found

Implementation of

TableData.resolveColumnQuery


suggestColumnQueries()

suggestColumnQueries(currentQuery): Promise<string[]>

Defined in: @tissuumaps-storage/src/parquet/ParquetTableData.ts:47

Returns column name suggestions matching the current query

Parameters

currentQuery

string

The partial column name to autocomplete

Returns

Promise<string[]>

A list of suggested column queries matching the current one

Implementation of

TableData.suggestColumnQueries