semi-join

Keep the rows of x that have a match in y, adding no columns.

NoteExperimental

This function is experimental; its interface may change without notice.

Since 0.6.0.

A filtering join: the output is a subset of x (columns unchanged), restricted to rows whose key appears in y. Keys compare by their string form, as in left-join.

Usage

semi-join(
  x,
  y,
  by: none,
)

Parameters

Parameter Default Description
x Dataset to filter (row-store or column-store).
y Dataset whose keys gate x (row-store or column-store).
by none Key columns: none for the common columns, a name, or an array.

Returns

The rows of x with a match in y.

See also

anti-join.

Back to top