merge#
- Catalog.merge(other: Catalog, how: str = 'inner', on: str | list | None = None, left_on: str | list | None = None, right_on: str | list | None = None, left_index: bool = False, right_index: bool = False, suffixes: tuple[str, str] | None = None) NestedFrame[source]#
Performs the merge of two catalog Dataframes
More information about pandas merge is available here.
- Parameters:
- otherCatalog
The right catalog to merge with.
- howstr
How to handle the merge of the two catalogs. One of {‘left’, ‘right’, ‘outer’, ‘inner’, ‘leftsemi’}, default ‘inner’
- onstr | List
Column or index names to join on. Defaults to the intersection of columns in both Dataframes if on is None and not merging on indexes.
- left_onstr | List
Column to join on the left Dataframe. Lists are supported if their length is one.
- right_onstr | List
Column to join on the right Dataframe. Lists are supported if their length is one.
- left_indexbool, default False
Use the index of the left Dataframe as the join key.
- right_indexbool, default False
Use the index of the right Dataframe as the join key.
- suffixestuple[str,str]
A pair of suffixes to be appended to the end of each column name when they are joined. Defaults to using the name of the catalog for the suffix.
- Returns:
- Catalog
A new Dask Dataframe containing the data points that result from the merge of the two catalogs.