catalog join

Join two catalog entries into a new cataloged entry.

Resolves both entries to expressions, joins them, builds the result, and registers it in the catalog.

Usage

xorq catalog join LEFT_ENTRY RIGHT_ENTRY [OPTIONS]

Arguments

  • LEFT_ENTRY—Name or alias of the left catalog entry.
  • RIGHT_ENTRY—Name or alias of the right catalog entry.

Options

Option Default Description
--on none Comma-separated column(s) present in both entries to join on.
--left-on none Comma-separated left-entry columns (paired with –right-on).
--right-on none Comma-separated right-entry columns (paired with –left-on).
--how inner Join method.
--lname `| Rename format string for overlapping left columns. | |–rname|{name}_right| Rename format string for overlapping right columns. | |–sync/–no-sync|–sync| Push the catalog to its remotes after the operation. | |-a,–alias| none | Also register this alias for the cataloged entry. | |–cache-dir|$XORQ_CACHE_DIRor~/.cache/xorq| Directory for parquet cache files. | |–ignore-venv-mismatch| off | Proceed even if the entries' wheel requirements or Python minor differ. | |–rebind-backends/–no-rebind-backends|–rebind-backends` In multi-root mode, rebind same-profile backend sources to one backend before execution. Never transfers table data.

Examples

# Inner-join two entries on a shared column and alias the result
xorq catalog join orders customers --on customer_id --alias enriched-orders