pyarrow.acero.HashJoinNodeOptions

class pyarrow.acero.HashJoinNodeOptions(join_type, left_keys, right_keys, left_output=None, right_output=None, output_suffix_for_left='', output_suffix_for_right='')

Bases: _HashJoinNodeOptions

Make a node which implements join operation using hash join strategy.

This is the option class for the “hashjoin” node factory.

Parameters:

join_typestr

Type of join. One of “left semi”, “right semi”, “left anti”, “right anti”, “inner”, “left outer”, “right outer”, “full outer”.

left_keysstr, Expression or list

Key fields from left input. Each key can be a string column name or a field expression, or a list of such field references.

right_keysstr, Expression or list

Key fields from right input. See left_keys for details.

left_outputlist, optional

List of output fields passed from left input. If left and right output fields are not specified, all valid fields from both left and right input will be output. Each field can be a string column name or a field expression.

right_outputlist, optional

List of output fields passed from right input. If left and right output fields are not specified, all valid fields from both left and right input will be output. Each field can be a string column name or a field expression.

output_suffix_for_leftstr

Suffix added to names of output fields coming from left input (used to distinguish, if necessary, between fields of the same name in left and right input and can be left empty if there are no name collisions).

output_suffix_for_rightstr

Suffix added to names of output fields coming from right input, see output_suffix_for_left for details.

__init__(self, join_type, left_keys, right_keys, left_output=None, right_output=None, output_suffix_for_left='', output_suffix_for_right='')

Methods

__init__(self, join_type, left_keys, right_keys)