Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make lookup verb keys and values optional. #380

Merged
merged 1 commit into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api/verbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -478,13 +478,13 @@ table.join_full(other, (a, b) => op.equal(a.keyL, b.keyR))
```

<hr/><a id="lookup" href="#lookup">#</a>
<em>table</em>.<b>lookup</b>(<i>other</i>, <i>on</i>, <i>...values</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/lookup.js)
<em>table</em>.<b>lookup</b>(<i>other</i>[, <i>on</i>, <i>...values</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/lookup.js)

Lookup values from a secondary table and add them as new columns. A lookup occurs upon matching key values for rows in both tables. If the secondary table has multiple rows with the same key, only the last observed instance will be considered in the lookup. Lookup is similar to [join_left](#join_left), but with a streamlined syntax and the added constraint of allowing at most one match only.
Lookup values from a secondary table (*other*) and add them as new columns. A lookup occurs upon matching key values for rows in both tables. If the secondary table has multiple rows with the same key, only the last observed instance will be considered in the lookup. Lookup is similar to [join_left](#join_left), but with a streamlined syntax and the added constraint of allowing at most one match only.

* *other*: The secondary table to look up values from.
* *on*: A two-element array of lookup keys (column name strings or table expressions) for this table and the secondary table, respectively.
* *values*: The column values to add from the secondary table. Can be column name strings or objects with column names as keys and table expressions as values.
* *on*: A lookup key or two-element array of lookup keys (column name strings or table expressions) for this table and the secondary table, respectively. If a single key value is provided, it is used as the lookup key for both tables. If unspecified, all columns with matching names are compared.
* *values*: The column values to add from the secondary table. Can be column name strings or objects with column names as keys and table expressions as values. If unspecified, includes all columns from the secondary table whose names do no match any column in the primary table.

*Example*

Expand Down
8 changes: 5 additions & 3 deletions src/table/ColumnTable.js
Original file line number Diff line number Diff line change
Expand Up @@ -451,11 +451,13 @@ export class ColumnTable extends Table {
* The secondary table to look up values from.
* @param {import('./types.js').JoinKeys} [on]
* Lookup keys (column name strings or table expressions) for this table
* and the secondary table, respectively.
* @param {...import('./types.js').ExprList} values
* and the secondary table, respectively. If unspecified, the values of
* all columns with matching names are compared.
* @param {...import('./types.js').ExprList} [values]
* The column values to add from the secondary table. Can be column name
* strings or objects with column names as keys and table expressions as
* values.
* values. If unspecified, includes all columns from the secondary table
* whose names do no match any column in the primary table.
* @return {this} A new table with lookup values added.
* @example table.lookup(other, ['key1', 'key2'], 'value1', 'value2')
*/
Expand Down
14 changes: 9 additions & 5 deletions src/verbs/lookup.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
import { not } from '../api.js';
import { columnSet } from '../table/ColumnSet.js';
import concat from '../util/concat.js';
import NULL from '../util/null.js';
import unroll from '../util/unroll.js';
import { rowLookup } from './join/lookup.js';
import { aggregateGet } from './reduce/util.js';
import { inferKeys } from './util/join-keys.js';
import parseKey from './util/parse-key.js';
import parseValues from './util/parse.js';
import { columnSet } from '../table/ColumnSet.js';
import NULL from '../util/null.js';
import concat from '../util/concat.js';
import unroll from '../util/unroll.js';

export function lookup(tableL, tableR, on, ...values) {
on = inferKeys(tableL, tableR, on);
values = values.length === 0
? [not(tableL.columnNames())]
: values.flat();
return _lookup(
tableL,
tableR,
[ parseKey('lookup', tableL, on[0]), parseKey('lookup', tableR, on[1]) ],
parseValues('lookup', tableR, values.flat())
parseValues('lookup', tableR, values)
);
}

Expand Down
47 changes: 47 additions & 0 deletions test/verbs/lookup-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,51 @@ describe('lookup', () => {
v: [2, 0, -2, undefined, 2]
}, 'lookup data');
});

it('retrieves values from lookup table with implicit value rows', () => {
const right = table({
id: [1, 2, 3],
u: ['a', 'b', 'c'],
v: [5, 3, 1]
});

const left = table({
id: [1, 2, 3, 4, 1],
u: [-1, -1, -1, -1, -1]
});

const lt = left.lookup(right, 'id');

assert.equal(lt.numRows(), 5, 'num rows');
assert.equal(lt.numCols(), 3, 'num cols');

tableEqual(lt, {
id: [1, 2, 3, 4, 1],
u: [-1, -1, -1, -1, -1],
v: [5, 3, 1, undefined, 5]
}, 'lookup data');
});

it('retrieves values from lookup table with implicit parameters', () => {
const right = table({
id: [1, 2, 3],
u: ['a', 'b', 'c'],
v: [5, 3, 1]
});

const left = table({
id: [1, 2, 3, 4, 1]
});

const lt = left.lookup(right);

assert.equal(lt.numRows(), 5, 'num rows');
assert.equal(lt.numCols(), 3, 'num cols');

tableEqual(lt, {
id: [1, 2, 3, 4, 1],
u: ['a', 'b', 'c', undefined, 'a'],
v: [5, 3, 1, undefined, 5]
}, 'lookup data');
});
});