join

simetrik join list

List resource joins.

Lists the resource joins in your workspace. A resource join is a type of Simetrik resource that links two segments on matching columns; this command is the join-specific counterpart to the generic simetrik describe, so reach for it when you already know you're after joins and want a focused list with their IDs and names.

Filter by name with --search and cap the result set with --limit. To inspect a single join's size, follow up with simetrik join counts <resource_join_id>.

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

Flags

• -s, --search <query> — Search by name
• -l, --limit <n> — Max results
• -f, --format <fmt> — Output format: table|json

Examples

simetrik join list
simetrik join list --search ventas --limit 20
simetrik join list --format json

simetrik join create

Create a resource join.

Creates a resource join — a Simetrik resource that links two segments (A and B) so their rows can be matched. You must name the join and supply both sides: --segment-a and --segment-b plus the columns each side contributes via --columns-a and --columns-b (comma-separated column IDs).

Use this to set up a new join from scratch. Pass --clauses with a JSON array of {"column_a":<id>,"column_b":<id>} pairs to define the match conditions inline, and add --auto-execute to run the join immediately after it's created instead of executing it later. To run an existing join use simetrik join execute; to rename one use simetrik join update.

See also: join execute, join update, join configuration add. Requires the resources · create_edit permission. See permissions.

Arguments

• name — Resource join name

Flags

• --segment-a <id> — Segment A ID
• --columns-a <ids> — Column IDs for A (comma-separated)
• --segment-b <id> — Segment B ID
• --columns-b <ids> — Column IDs for B (comma-separated)
• --clauses <json> — JSON array of join clauses
• --auto-execute — Automatically execute join after creation
• -f, --format <fmt> — Output format: table|json

Examples

simetrik join create "Ventas x Pagos" --segment-a 101 --columns-a 1,2 --segment-b 202 --columns-b 5,6
simetrik join create "Conciliación previa" --segment-a 101 --columns-a 1 --segment-b 202 --columns-b 5 --clauses '[{"column_a":1,"column_b":5}]' --auto-execute

Exit codes

simetrik join update

Update a resource join.

Updates a resource join's metadata — its name and/or description. It's a partial update: pass only the flags you want to change and the rest stay as they are.

This command does not touch the join's segments, columns, or match clauses. To change which segments or columns are linked use simetrik join segment update or simetrik join configuration update; to re-run the join after changes use simetrik join execute.

See also: join configuration update, join segment update, join execute. Requires the resources · create_edit permission. See permissions.

Arguments

• resource_join_id — Resource Join ID

Flags

• --name <name> — New name
• -d, --description <desc> — New description
• -f, --format <fmt> — Output format: table|json

Examples

simetrik join update 4521 --name "Ventas x Pagos (revisado)"
simetrik join update 4521 --description "Cruce diario de ventas contra pagos"

Exit codes

simetrik join execute

Execute a resource join.

Runs a resource join, materializing the matched output from its current configuration. By default it fires the execution and returns immediately; pass --wait to block until the task finishes, with --timeout (seconds, default 120) bounding how long it polls.

Use this after creating or reconfiguring a join (or instead of --auto-execute on simetrik join create when you want to run it on demand). With --wait, the command exits non-zero if the task ends in a failed state, so it's safe to chain in scripts; without --wait a 0 only means the run was accepted, not that it succeeded.

See also: join create, join counts, join configuration update. Requires the resources · create_edit permission. See permissions.

Arguments

• resource_join_id — Resource join ID

Flags

• -w, --wait — Wait for execution to complete
• -t, --timeout <secs> — Timeout in seconds
• -f, --format <fmt> — Output format: table|json

Examples

simetrik join execute 4521
simetrik join execute 4521 --wait
simetrik join execute 4521 --wait --timeout 300

Exit codes

simetrik join counts

Get counts (segments + child columns) for a resource join.

Returns the counts for a resource join — the number of segments it links and the child columns under it. Use it to sanity-check a join's shape before or after executing it, without pulling the full output.

This is read-only and reports structure, not match results. To see the joins available use simetrik join list; to run the join and produce data use simetrik join execute.

See also: join list, join execute. Requires CLI access to the workspace. See permissions.

Arguments

• resource_join_id — Resource Join ID

Flags

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

Examples

simetrik join counts 4521
simetrik join counts 4521 --format json

Exit codes

simetrik join configuration add

Add a join configuration to a resource join.

Adds a join configuration to an existing resource join — a new pairing of two segments at the given positions, with the match clauses that link them. Identify the join by <resource_join_id> and supply both sides: --segment-a/--position-a and --segment-b/--position-b.

Use this to extend a join with an additional segment pairing rather than creating a separate join. Pass --clauses with {"column_a":<id>,"column_b":<id>} pairs to define the match conditions, and --new-columns-a/--new-columns-b (comma-separated column IDs) to bring extra columns from each segment into the join. To change the clauses of a configuration that already exists, use simetrik join configuration update.

See also: join configuration update, join segment update, join execute. Requires the resources · create_edit permission. See permissions.

Arguments

• resource_join_id — Resource Join ID

Flags

• --segment-a <id> — Segment A ID
• --position-a <n> — Segment A position
• --segment-b <id> — Segment B ID
• --position-b <n> — Segment B position
• --clauses <json> — JSON array of {column_a, column_b}
• --new-columns-a <ids> — Comma-separated column IDs from segment A
• --new-columns-b <ids> — Comma-separated column IDs from segment B
• -f, --format <fmt> — Output format: table|json

Examples

simetrik join configuration add 4521 --segment-a 101 --position-a 0 --segment-b 202 --position-b 1
simetrik join configuration add 4521 --segment-a 101 --position-a 0 --segment-b 202 --position-b 1 --clauses '[{"column_a":1,"column_b":5}]' --new-columns-a 3 --new-columns-b 7

Exit codes

simetrik join configuration update

Update join clauses of a configuration.

Updates the match clauses of an existing join configuration. Identify both the join and the configuration with <resource_join_id> and <configuration_id>, then pass --clauses with a JSON array of {"id":<clause_id>,"column_a":<id>,"column_b":<id>} objects — the id targets the clause being changed, so this edits clauses in place rather than appending them.

Use this to retune how two segments match within a configuration you already added with simetrik join configuration add. To add a brand-new segment pairing use configuration add; to change which columns a segment contributes use simetrik join segment update.

See also: join configuration add, join segment update, join execute. Requires the resources · create_edit permission. See permissions.

Arguments

• resource_join_id — Resource Join ID
• configuration_id — Configuration ID

Flags

• --clauses <json> — JSON array of {id, column_a, column_b}
• -f, --format <fmt> — Output format: table|json

Examples

simetrik join configuration update 4521 88 --clauses '[{"id":12,"column_a":1,"column_b":5}]'

Exit codes

simetrik join segment update

Update segment + columns of a join segment.

Replaces the segment and columns of one side of a resource join. Identify the join and the side with <resource_join_id> and <join_segment_id>, then pass --segment with the new segment ID and --columns with the comma-separated column IDs that side should contribute.

Use this to repoint a join at a different segment or to change which of its columns participate, without recreating the whole join. To change the match conditions between segments instead, use simetrik join configuration update; to remove a side entirely, use simetrik join segment delete.

See also: join configuration update, join segment delete, join execute. Requires the resources · create_edit permission. See permissions.

Arguments

• resource_join_id — Resource Join ID
• join_segment_id — Join Segment ID

Flags

• --segment <id> — New segment ID
• --columns <ids> — Comma-separated column IDs
• -f, --format <fmt> — Output format: table|json

Examples

simetrik join segment update 4521 77 --segment 303 --columns 1,2,3

Exit codes

simetrik join segment delete

Delete a join segment.

Removes one segment from a resource join. Identify it with <resource_join_id> and <join_segment_id>; the command prompts for confirmation first, which you can skip with --yes for non-interactive use.

Deleting a segment drops that side of the join and any clauses that referenced it, so the join's output changes on the next run — there's no undo. Use this to take a segment out of a join; to swap a segment for a different one instead of removing it, prefer simetrik join segment update.

See also: join segment update, join configuration update, join execute. Requires the resources · create_edit permission. See permissions.

Arguments

• resource_join_id — Resource Join ID
• join_segment_id — Join Segment ID

Flags

• -y, --yes — Skip confirmation
• -f, --format <fmt> — Output format: table|json

Examples

simetrik join segment delete 4521 77
simetrik join segment delete 4521 77 --yes

Exit codes