Interface JoinableTable

Represents a table that can be joined to another table. Current implementations are Table and TotalsTable.

Hierarchy

Implemented by

Methods

asOfJoin crossJoin exactJoin freeze join naturalJoin snapshot

Methods

asOfJoin

  • Performs an inexact timeseries join, where rows in this table will have columns added from the closest matching row from the right table.

    The `asOfMatchRule` value can be one of:

    • LESS_THAN_EQUAL
    • LESS_THAN
    • GREATER_THAN_EQUAL
    • GREATER_THAN

    Parameters

    • rightTable: JoinableTable

      The table to match to values in this table.

    • columnsToMatch: string[]

      The columns that should match, according to the asOfMatchRole.

    • Optional columnsToAdd: string[]

      Columns from the right table to add to the resulting table, empty/null/absent to add all columns.

    • Optional asOfMatchRule: string

      The match rule to use, see above.

    Returns Promise<Table>

    A promise that will resolve to the joined table.

crossJoin

  • A promise that will be resolved with the newly created table holding the results of the specified cross join operation. The columnsToAdd parameter is optional, not specifying it will result in all columns from the right table being added to the output. The reserveBits optional parameter lets the client control how the key space is distributed between the rows in the two tables, see the Java Table class for details.

    Parameters

    • rightTable: JoinableTable

      The table to match to values in this table.

    • columnsToMatch: string[]

      The columns that should match exactly.

    • Optional columnsToAdd: string[]

      Columns from the right table to add to the resulting table, empty/null/absent to add all columns.

    • Optional reserveBits: number

      The number of bits of key-space to initially reserve per group, null/absent will let the server select a value.

    Returns Promise<Table>

    A promise that will resolve to the joined table.

exactJoin

  • A promise that will be resolved with the newly created table holding the results of the specified exact join operation. The columnsToAdd parameter is optional, not specifying it will result in all columns from the right table being added to the output.

    Parameters

    • rightTable: JoinableTable

      The table to match to values in this table.

    • columnsToMatch: string[]

      The columns that should match exactly.

    • Optional columnsToAdd: string[]

      Columns from the right table to add to the resulting table, empty/null/absent to add all columns.

    Returns Promise<Table>

    A promise that will resolve to the joined table.

freeze

join

  • Joins this table to the provided table, using one of the specified join types:

    • `AJ`, `ReverseAJ` (or `RAJ`) - Inexact timeseries joins, based on the provided matching rule.
    • `CROSS_JOIN` (or `Join`) - Cross join of all rows that have matching values in both tables.
    • `EXACT_JOIN` (or `ExactJoin`) - Matches values in exactly one row in the right table, with errors if there is not exactly one.
    • `NATURAL_JOIN` (or `Natural`) - Matches values in at most one row in the right table, with nulls if there is no match or errors if there are multiple matches.

    Note that Left join is not supported here, unlike DHE.

    See the Choose a join method document for more guidance on picking a join operation.

    Parameters

    • joinType: string

      The type of join to perform, see the list above.

    • rightTable: JoinableTable

      The table to match to values in this table.

    • columnsToMatch: string[]

      Columns that should match.

    • Optional columnsToAdd: string[]

      Columns from the right table to add to the result - empty/null/absent to add all columns.

    • Optional asOfMatchRule: string

      If joinType is AJ/RAJ/ReverseAJ, the match rule to use.

    Returns Promise<Table>

    A promise that will resolve to the joined table.

    Deprecated

    Instead, call the specific method for the join type.

naturalJoin

  • A promise that will be resolved with the newly created table holding the results of the specified natural join operation. The columnsToAdd parameter is optional, not specifying it will result in all columns from the right table being added to the output.

    Parameters

    • rightTable: JoinableTable

      The table to match to values in this table.

    • columnsToMatch: string[]

      The columns that should match exactly.

    • Optional columnsToAdd: string[]

      Columns from the right table to add to the resulting table. Empty/null/absent to add all columns.

    Returns Promise<Table>

    A promise that will resolve to the joined table.

snapshot

  • Creates a server-side snapshot of baseTable when this table updates.

    Parameters

    • baseTable: Table

      The table to snapshot.

    • Optional doInitialSnapshot: boolean

      Whether to create an initial snapshot immediately.

    • Optional stampColumns: string[]

      Optional list of column names to include in the result.

    Returns Promise<Table>

    A promise that resolves to the snapshot table.

Settings

Member Visibility

Theme

On This Page