left_outer_join

left_outer_join joins data from a pair of tables - a left table and a right table - based upon one or more match columns. The match columns establish key identifiers in the source tables from which the tables are joined. Any data type can be used as keys (custom objects must implement consistent equality and hashCode).

The resultant table contains all rows from the left table (the first given) as well as rows from the right table that have matching keys in the identifier column(s).

Note

This table operation is currently experimental. The API may change in the future.

Syntax

left_outer_join(
    l_table: Table,
    r_table: Table,
    on: Union[str, Sequence[str]] = None,
    joins: Union[str, Sequence[str]] = None,
    reserve_bits: int = None,
) -> Table

Parameters

Parameter	Type	Description
l_table	Table	The left table from which data is joined.
r_table	Table	The right table from which data is joined.
on optional	Union[str, Sequence[str]]	Columns from the left and right tables used to join on. `"A = B"` will join when column `A` from the left table matches column `B` from the right table. `"X"` will join on column `X` from both the left and right table. Equivalent to `"X = X"`. `"X, A = B"` will join when column `X` matches from both the left and right tables, and when column `A` from the left table matches column `B` from the right table.
joins optional	Union[str, list[str]]	The columns from the right table to add to the left table based on key. The default value is `None`. `None` will add all columns from the right table to the left table, except right table columns whose names match a left table column in `on`. `"X"` will add column `X` from the right table to the left table as column `X`. `Y = X` will add column `X` from right table to left table and rename it to be `Y`.
reserve_bits optional	int	The number of bits of each result row key to reserve for the right table rows that match a left table row. The default value is `None`, which uses the configured value (10 bits unless configured otherwise).

Returns

A new table containing all rows from the left table and matching rows from the right table. A left table row with no matching right table rows is included once, with null values in the columns from the right table. If there are multiple matches between a row from the left table and rows from the right table, all matching combinations will be included. If no match columns are specified, every combination of left and right table rows is included; if the right table is empty, each left table row is included once with null values in the columns from the right table.

Examples

The following example creates two source tables and performs a left_outer_join on them. It gives no joins columns, so all columns from the right table appear in the result table.

from deephaven.experimental.outer_joins import left_outer_join
from deephaven import empty_table

left = empty_table(10).update(["I = ii % 5 + 1", "A = `left` + ii"])
right = empty_table(10).update(["I = ii % 3", "B = `right` + ii", "C = Math.sin(I)"])

result = left_outer_join(l_table=left, r_table=right, on=["I"])

The following example creates two source tables and performs a left_outer_join on them. It specifies C as the only joins column, so C is the only column from the right table that is added to result.

from deephaven.experimental.outer_joins import left_outer_join
from deephaven import empty_table

left = empty_table(10).update(["I = ii % 5 + 1", "A = `left` + ii"])
right = empty_table(10).update(["I = ii % 3", "B = `right` + ii", "C = Math.sin(I)"])

result = left_outer_join(l_table=left, r_table=right, on=["I"], joins=["C"])

The example below shows how to join tables on match columns with different names and rename appended columns when performing a left_outer_join.

from deephaven.experimental.outer_joins import left_outer_join
from deephaven import empty_table

left = empty_table(10).update(["X1 = ii % 5 + 1", "Y = Math.sin(X1)"])
right = empty_table(10).update(["X2 = ii % 3", "Y = Math.cos(X2)"])

result = left_outer_join(l_table=left, r_table=right, on=["X1 = X2"], joins=["Z = Y"])

left_outer_join

Syntax

Parameters

Returns

Examples

Related documentation