vlookup

simetrik vlookup create

Create a VLookup configuration.

Creates a VLookup — a Simetrik resource that enriches one resource with columns pulled from another, matching rows by key, much like a spreadsheet VLOOKUP. The resource named by --resource is the target that receives the fetched values; --lookup-resource is the origin the values are read from.

Reach for this when you set up the configuration the first time. Pass --rules as a JSON array of matching keys ({"matching_key_source":10,"matching_key_lookup":20}) that pair a column in the target with a column in the origin; supply the columns to bring across with --columns as {"column_id":...} objects (the preferred shape), or inline a single fetched_column on a rule. The command transforms and deduplicates rules and columns before sending them, so repeated entries are collapsed.

--rules also accepts the raw API shape ({"column_a_id":...,"column_b_id":...}); that form does not carry a fetched_column, so pass --columns separately. To change an existing VLookup later use simetrik vlookup update, and to inspect one use simetrik vlookup describe.

See also: vlookup update, vlookup describe. Requires the resources · create_edit permission. See permissions.

Arguments

• name — VLookup name

Flags

• --resource <id> — Resource ID
• --lookup-resource <id> — Origin resource ID
• --rules <json> — JSON array of rules
• --columns <json> — JSON array of {column_id} objects (fetched columns)
• -f, --format <fmt> — Output format: json|table

Examples

simetrik vlookup create "Enrich payments" --resource 100 --lookup-resource 200 --rules '[{"matching_key_source":10,"matching_key_lookup":20}]' --columns '[{"column_id":30},{"column_id":31}]'
simetrik vlookup create "Map merchants" --resource 100 --lookup-resource 200 --rules '[{"matching_key_source":10,"matching_key_lookup":20,"fetched_column":30}]'
simetrik vlookup create "By code" --resource 100 --lookup-resource 200 --rules '[{"column_a_id":10,"column_b_id":20}]' --columns '[{"column_id":31}]'

Exit codes

simetrik vlookup update

Update a VLookup configuration.

Updates an existing VLookup configuration identified by <vlookup_id>. It's a partial update: pass --name to rename it, --rules to replace its matching rules, or both; fields you omit stay as they are.

Unlike simetrik vlookup create, this command sends --rules as-is with no transformation or deduplication, so it expects the raw API shape — a JSON array of {"column_a_id":...,"column_b_id":...} objects. Use it to adjust an existing VLookup rather than to set one up; to create one use simetrik vlookup create, and to see its current rules and column mappings use simetrik vlookup describe.

See also: vlookup create, vlookup describe. Requires the resources · create_edit permission. See permissions.

Arguments

• vlookup_id — VLookup ID

Flags

• --name <n> — New name
• --rules <json> — JSON array of rules (sent as-is, no transform)
• -f, --format <fmt> — Output format: json|table

Examples

simetrik vlookup update 4567 --name "Enrich payments (v2)"
simetrik vlookup update 4567 --rules '[{"column_a_id":10,"column_b_id":20}]'

Exit codes

simetrik vlookup describe

Describe a VLookup with rules and column mappings inline.

Shows a single VLookup in detail, identified by <vlookup_id>, with its matching rules and column mappings inline. Use it to confirm how a VLookup is wired — which keys it matches on and which columns it fetches — before you depend on it or edit it.

This is read-only. To change the configuration use simetrik vlookup update, and to create a new one use simetrik vlookup create. Pass --format table for a human-readable view or keep the default json for scripting.

See also: vlookup create, vlookup update. Requires CLI access to the workspace. See permissions.

Arguments

• vlookup_id — VLookup ID

Flags

• -f, --format <fmt> — Output format: json|table

Examples

simetrik vlookup describe 4567
simetrik vlookup describe 4567 --format table

Exit codes