Class PartitionedTable

Static Readonly EVENT_DISCONNECT

Static Readonly EVENT_KEYADDED

Static Readonly EVENT_RECONNECT

Static Readonly EVENT_RECONNECTFAILED

columns

• get columns(): Column[]

• An array of the columns in the tables that can be retrieved from this partitioned table, including both key and non-key columns.

  Returns Column[]

  Array of Column

keyColumns

• get keyColumns(): Column[]

• An array of all the key columns that the tables are partitioned by.

  Returns Column[]

  Array of Column

size

• get size(): number

• The count of known keys.

  Returns number

  int

addEventListener

• addEventListener<T>(name, callback): (() => void)

• Listen for events on this object.

  Type Parameters

  • T

    the type of the data that the event will provide

  Parameters

  • name: string

    the name of the event to listen for

  • callback: ((e) => void)

    a function to call when the event occurs

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns (() => void)

  Returns a cleanup function.

  • • (): void

    • Listen for events on this object.

      Returns void

      Returns a cleanup function.

close

• close(): void

• Indicates that this PartitionedTable will no longer be used, removing subcriptions to updated keys, etc. This will not affect tables in use.

  Returns void

getBaseTable

• getBaseTable(): Promise<Table>

• Fetch the underlying base table of the partitioned table.

  Returns Promise<Table>

  Promise of a Table

getKeyTable

• getKeyTable(): Promise<Table>

• Fetch a table containing all the valid keys of the partitioned table.

  Returns Promise<Table>

  Promise of a Table

  Deprecated

getKeys

• getKeys(): Set<object>

• The set of all currently known keys. This is kept up to date, so getting the list after adding an event listener for keyadded will ensure no keys are missed.

  Returns Set<object>

  Set of Object

getMergedTable

• getMergedTable(): Promise<Table>

• Open a new table that is the result of merging all constituent tables. See io.deephaven.engine.table.PartitionedTable.merge for details.

  Returns Promise<Table>

  A merged representation of the constituent tables.

getTable

• getTable(key): Promise<Table>

• Fetch the table with the given key. If the key does not exist, returns null.

  Parameters

  • key: object

    The key to fetch. An array of values for each key column, in the same order as the key columns are.

  Returns Promise<Table>

  Promise of dh.Table, or null if the key does not exist.

hasListeners

• hasListeners(name): boolean

• Parameters

  • name: string

  Returns boolean

nextEvent

• nextEvent<T>(eventName, timeoutInMillis?): Promise<any>

• Type Parameters

  • T

  Parameters

  • eventName: string

  • Optional timeoutInMillis: number

  Returns Promise<any>

removeEventListener

• removeEventListener<T>(name, callback): boolean

• Removes an event listener added to this table.

  Type Parameters

  • T

  Parameters

  • name: string

  • callback: ((e) => void)

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns boolean