deephaven.experimental.outer_joins¶
This module allows users to perform SQL-style left outer and full outer joins on tables.
- full_outer_join(l_table, r_table, on=None, joins=None, reserve_bits=None)[source]¶
The full_outer_join function creates a new table containing rows that have matching values in both tables. If there are multiple matches between a row from the left table and rows from the right table, all matching combinations will be included. Additionally, non-matching rows from both tables will also be included in the new table. If no columns to match (on) are specified, then every combination of left and right table rows is included.
- Parameters:
l_table (Table) – the left table
r_table (Table) – the right table
on (Optional[Union[str, Sequence[str]]]) – the column(s) to match, can be a common name or an equal expression, i.e. “col_a = col_b” for different column names; default is None
joins (Optional[Union[str, Sequence[str]]]) – the column(s) to be added from right table to the result table, can be renaming expressions, i.e. “new_col = col”; default is None, meaning all the columns from the right table
reserve_bits (Optional[int]) – the number of bits to reserve for the right row; default is None, meaning the configured value is used, which is 10 bits by default.
- Return type:
- Returns:
a new Table
- Raises:
DHError –
- left_outer_join(l_table, r_table, on=None, joins=None, reserve_bits=None)[source]¶
The left_outer_join function creates a new table containing rows that have matching values in both tables. If there are multiple matches between a row from the left table and rows from the right table, all matching combinations will be included. Additionally, non-matching rows from the left tables will also be included in the new table. If no columns to match (on) are specified, then every combination of left and right table rows is included.
- Parameters:
l_table (Table) – the left table
r_table (Table) – the right table
on (Optional[Union[str, Sequence[str]]]) – the column(s) to match, can be a common name or an equal expression, i.e. “col_a = col_b” for different column names
joins (Optional[Union[str, Sequence[str]]]) – the column(s) to be added from right table to the result table, can be renaming expressions, i.e. “new_col = col”; default is None, meaning all the columns from the right table
reserve_bits (Optional[int]) – the number of bits to reserve for the right row; default is None, meaning the configured value is used, which is 10 bits by default.
- Return type:
- Returns:
a new Table
- Raises:
DHError –