group

simetrik group list

List source groups.

Lists the source groups in your workspace. A source group is a type of Simetrik resource that aggregates a segment's rows by grouping columns and computing values; this command is the group-specific counterpart to the generic simetrik describe, so use it when you already know you're after groups and want a focused list with their IDs and names.

Filter by name with --search and cap the result set with --limit. To create one, follow up with simetrik group create.

See also: group create, group 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 group list
simetrik group list --search saldos --limit 20
simetrik group list --format json

simetrik group create

Create a source group.

Creates a source group — a Simetrik resource that aggregates a segment's rows. You must name it and supply the segment with --segment, the grouping --columns (JSON array of column configs), and the aggregated --values (JSON array of value configs); all three are required.

Use this to roll a segment up by key. Pass --folder to file it and --is-accumulative to make it a Cumulative group (the default is --no-is-accumulative, a Non-cumulative group) — accumulative groups carry balances forward across runs. To rename or retype an existing group afterward, use simetrik group update.

See also: group update, group list. Requires the resources · create_edit permission. See permissions.

Arguments

• name — Source group name

Flags

• --segment <id> — Source segment ID
• --columns <json> — JSON array of column configs
• --values <json> — JSON array of value configs
• -d, --description <desc> — Description
• --folder <id> — Folder ID
• --is-accumulative — Create as accumulative (Cumulative type in the UI)
• --no-is-accumulative — Create as non-accumulative (default, Non-cumulative type)
• -f, --format <fmt> — Output format: table|json

Examples

simetrik group create "Saldos por cuenta" --segment 101 --columns '[{"id":1}]' --values '[{"id":2,"operation":"sum"}]'
simetrik group create "Saldos acumulados" --segment 101 --columns '[{"id":1}]' --values '[{"id":2,"operation":"sum"}]' --folder 9 --is-accumulative

Exit codes

simetrik group update

Update a source group.

Updates a source group's name, description, and/or accumulative flag. It's a partial update: pass only the flags you want to change and the rest stay as they are. Use --is-accumulative / --no-is-accumulative to switch the group between Cumulative and Non-cumulative type.

This command does not change the group's segment, grouping columns, or aggregated values — those are set at creation with simetrik group create. To see the groups available use simetrik group list.

See also: group create, group list. Requires the resources · create_edit permission. See permissions.

Arguments

• source_group_id — Source Group ID

Flags

• --name <name> — New name
• -d, --description <desc> — New description
• --is-accumulative — Mark group as accumulative (Cumulative type in the UI)
• --no-is-accumulative — Mark group as non-accumulative (Non-cumulative type)
• -f, --format <fmt> — Output format: table|json

Examples

simetrik group update 7788 --name "Saldos por cuenta (revisado)"
simetrik group update 7788 --description "Agrupación diaria de saldos"
simetrik group update 7788 --is-accumulative

Exit codes