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 dh.EVENT_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 Table, or null if the key does not exist.

hasListeners

• hasListeners(name): boolean

• Checks whether any event listeners are registered for the given event name.

  Parameters

  • name: string

    The event name.

  Returns boolean

  true if there is at least one listener registered for name; false otherwise.

nextEvent

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

• Returns a promise that resolves the next time the named event occurs, with the value of the event's detail. If a timeout is specified and occurs before the event takes place, the promise will reject, otherwise waits indefinitely.

  Type Parameters

  • T

    The type of the event detail.

  Parameters

  • eventName: string

    The event name.

  • Optional timeoutInMillis: number

    Optional timeout in milliseconds.

  Returns Promise<Event<T>>

  A promise that resolves with the next matching event.

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