join#
- astropy.table.join(left, right, keys=None, join_type='inner', *, keys_left=None, keys_right=None, keep_order=False, uniq_col_name='{col_name}_{table_name}', table_names=['1', '2'], metadata_conflicts='warn', join_funcs=None)[source]#
Perform a join of the left table with the right table on specified keys.
- Parameters:
- left
Table
astropy:-likeobject
Left side table in the join. If not a Table, will call
Table(left)
- right
Table
astropy:-likeobject
Right side table in the join. If not a Table, will call
Table(right)
- keys
str
orlist
ofstr
Name(s) of column(s) used to match rows of left and right tables. Default is to use all columns which are common to both tables.
- join_type
str
Join type (‘inner’ | ‘outer’ | ‘left’ | ‘right’ | ‘cartesian’), default is ‘inner’
- keys_left
str
orlist
ofstr
orlist
of column-like, optional Left column(s) used to match rows instead of
keys
arg. This can be be a single left table column name or list of column names, or a list of column-like values with the same lengths as the left table.- keys_right
str
orlist
ofstr
orlist
of column-like, optional Same as
keys_left
, but for the right side of the join.- keep_order: bool, optional
By default, rows are sorted by the join keys. If True, preserve the order of rows from the left table for “inner” or “left” joins, or from the right table for “right” joins. For other join types this argument is ignored except that a warning is issued if
keep_order=True
.- uniq_col_name
str
orNone
String generate a unique output column name in case of a conflict. The default is ‘{col_name}_{table_name}’.
- table_names
list
ofstr
orNone
Two-element list of table names used when generating unique output column names. The default is [‘1’, ‘2’].
- metadata_conflicts
str
- How to proceed with metadata conflicts. This should be one of:
'silent'
: silently pick the last conflicting meta-data value'warn'
: pick the last conflicting meta-data value, but emit a warning (default)'error'
: raise an exception.
- join_funcs
dict
,None
Dict of functions to use for matching the corresponding key column(s). See
join_skycoord
for an example and details.
- left
- Returns: