column

simetrik column list

List all columns for a resource.

Lists every column defined on a resource. Pass the resource ID with --resource; the command reads the resource's description and returns the columns array, including each column's ID, label, name, data format, and type.

Use this to discover the column IDs you'll need for other commands — for example the --id for simetrik column cast, the --compare-column for simetrik column due, or the partition/order keys for simetrik column uniqueness. To inspect one column's subtype-specific configuration instead of the whole list, use simetrik column describe <column_id>.

See also: column describe, column cast, column update. Requires CLI access. See permissions.

Flags

• -r, --resource <id> — Resource ID
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column list --resource 8821
simetrik column list --resource 8821 --format table

Exit codes

simetrik column update

Update a column's label, name, or position.

Renames or repositions an existing column. Identify the column with --id, then change its display --label, its internal --name (snake_case), or its --position in the column order. If you set --label without --name, the internal name is auto-derived from the label (lowercased, non-alphanumeric characters collapsed to underscores).

Use this to fix a column's presentation after it was created — most create commands accept a --label up front, so reach for column update when you need to adjust one later. It edits metadata only; to change a column's data format use simetrik column cast, and to remove a column use simetrik column delete.

See also: column cast, column delete, column list. Requires the resources · create_edit permission. See permissions.

Flags

• --id <id> — Column ID
• --label <l> — Column display label
• --name <n> — Internal column name (snake_case). If omitted and --label is set, auto-derived from label.
• --position <n> — Column position
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column update --id 4501 --label "Net Amount"
simetrik column update --id 4501 --name net_amount --position 3

Exit codes

simetrik column delete

Delete a column.

Removes a column from its resource. Identify the column with --id. The command prompts for confirmation before deleting; pass --yes to skip the prompt when scripting.

Use this to drop a column you no longer need. Deletion removes the column and its data from the resource — columns that other columns depend on (for example a chained column's parent, or a column referenced by a formula) may be blocked or break downstream logic, so check dependents with simetrik column list first. To rename or reposition a column instead of removing it, use simetrik column update.

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

Flags

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

Examples

simetrik column delete --id 4501
simetrik column delete --id 4501 --yes

Exit codes

simetrik column raw

Create a raw column on a source resource.

Adds one or more raw columns to a source resource — the literal columns that hold the data you load, each with a name and a data_format. Pass --resource (the source must be a NATIVE source you own, not a connected one) and --columns with a JSON array of definitions.

Use this to extend a source's schema after it exists, the same way --columns on simetrik source create defines it at creation time. Add --create-table to (re)build the backing Snowflake table once the columns are added, so the table matches the new schema in one step. For derived columns (formulas, dropdowns, dates) use the type-specific create commands instead of column raw.

See also: source create, column transformation-formula, column list. Requires the resources · create_edit permission. See permissions.

Flags

• -r, --resource <id> — Resource ID (must be NATIVE)
• --columns <json> — JSON array of raw column definitions. Example: [{"name":"amount","data_format":"numeric"}]
• --create-table — Create the Snowflake table after adding columns.
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column raw --resource 8821 --columns '[{"name":"amount","data_format":"numeric"}]'
simetrik column raw --resource 8821 --columns '[{"name":"id","data_format":"string"},{"name":"paid_at","data_format":"date"}]' --create-table

Exit codes

simetrik column comment

Create a comment column.

Creates a comment column on a resource — a manually editable field where analysts can annotate rows (notes, justifications, free-form values) rather than a value computed from the data. Pass --resource and an optional --label; --format-type sets the stored data format and defaults to string.

Use this when you want a writable column for human input alongside the loaded and derived columns. It differs from a dropdown column, which constrains input to a fixed list of options — reach for simetrik column dropdown when the allowed values are known in advance.

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

Flags

• -r, --resource <id> — Resource ID
• --label <l> — Column display label
• --format-type <t> — Output data format (string, numeric, etc.)
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column comment --resource 8821 --label "Analyst note"
simetrik column comment --resource 8821 --label "Adjustment" --format-type string

Exit codes

simetrik column transformation-formula

Create a formula-based transformation column.

Creates a calculated column whose value is computed from a --formula you supply. Pass --resource, the --formula string, and optionally a --label; the output --format-type is inferred from the formula when omitted. On union resources, prefix column references with a segment alias (A., B., ..., following segment order) to disambiguate — e.g. math(A.AMOUNT - B.AMOUNT).

Use this for derived values: arithmetic, string manipulation, conditionals, or cross-segment math on unions. Set --language (en/es/pt) to control how function names are interpreted; the argument separator (;) and decimal separator (.) stay the same across languages. A formula with no column references is rejected (NO_COLUMN_REFERENCES) unless you pass --allow-constant-only, which you use for placeholder or alignment columns. The --wait/--timeout flags are accepted but currently a no-op.

See also: column cast, column chained, column list. Requires the resources · create_edit permission. See permissions.

Flags

• -r, --resource <id> — Resource ID
• --formula <f> — Formula string for the transformation column. In union resources, prefix columns with a table alias (A., B., ...) to disambiguate: "math(A.AMOUNT - B.AMOUNT)". Alias letter follows segment order.
• --label <l> — Column display label
• --format-type <t> — Output data format (inferred from formula if omitted)
• --language <lang> — Formula language (en|es|pt). Controls how function names are interpreted. Argument separator (;) and decimal separator (.) remain universal.
• --allow-constant-only — Allow constant-only formulas (no column references, e.g. '0' or "''"). Bypasses the NO_COLUMN_REFERENCES validation. Use for placeholder/alignment columns.
• -w, --wait — Wait for column computation to complete (no-op)
• -t, --timeout <n> — Max wait time in seconds (with --wait)
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column transformation-formula --resource 8821 --formula "math(AMOUNT * 1.19)" --label "Amount with tax"
simetrik column transformation-formula --resource 8821 --formula "math(A.AMOUNT - B.AMOUNT)" --label "Diff"
simetrik column transformation-formula --resource 8821 --formula "0" --label "Placeholder" --allow-constant-only

Exit codes

simetrik column due

Create a due/expiration-date column computed against another date column.

Creates a due column — a derived date/expiration column computed against an existing date column. Pass --resource and --compare-column (the ID of the column to compare against); add an optional --label. Use simetrik column list to find the ID of the date column you want to reference.

Use this when you need an expiration or aging indicator anchored to another column's date, rather than a free arithmetic formula. For general date math or a fixed current date, see simetrik column today or simetrik column transformation-formula.

See also: column today, column transformation-formula, column list. Requires the resources · create_edit permission. See permissions.

Flags

• -r, --resource <id> — Resource ID
• --compare-column <id> — Column ID to compare against
• --label <l> — Column display label
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column due --resource 8821 --compare-column 4510
simetrik column due --resource 8821 --compare-column 4510 --label "Days to due"

Exit codes

simetrik column uniqueness

Create a uniqueness detection column.

Creates a uniqueness-detection column that flags duplicate rows within a resource. Pass --resource and a --type (e.g. strict, relaxed). Use --partition-keys with a JSON array of column IDs to define the group within which uniqueness is evaluated — you may pass a flat list ([4510,4511]), which the CLI normalizes to the object form the API expects. Use --order-keys to rank rows within a partition; each entry needs a column_id and an optional direction (ASC/DESC, default ASC).

Use this to detect or mark repeated records before reconciling — for example, flagging duplicate transaction IDs so they don't double-match. Each entry in --order-keys must include column_id or the command fails with a usage error. Find column IDs with simetrik column list.

See also: column list, column transformation-formula. Requires the resources · create_edit permission. See permissions.

Flags

• -r, --resource <id> — Resource ID
• --type <t> — Uniqueness type (e.g. strict, relaxed)
• --partition-keys <json> — JSON array of column IDs, e.g. [123, 456]
• --order-keys <json> — JSON array, e.g. [{"column_id": 123, "direction": "DESC"}]
• --label <l> — Column display label
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column uniqueness --resource 8821 --type strict --partition-keys '[4510,4511]'
simetrik column uniqueness --resource 8821 --type relaxed --partition-keys '[4510]' --order-keys '[{"column_id":4512,"direction":"DESC"}]' --label "Dup flag"

Exit codes

simetrik column dropdown

Create a dropdown selector column.

Creates a dropdown selector column — a manually editable column that constrains input to a fixed set of values. Pass --resource and --options with a JSON array of the allowed values; add an optional --label, and --format-type to set the stored data format (defaults to string).

Use this when analysts should pick from a known list (statuses, categories, dispositions) rather than typing free text. It differs from a comment column, which accepts any value — reach for simetrik column comment when the input isn't a closed set.

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

Flags

• -r, --resource <id> — Resource ID
• --options <json> — JSON array of dropdown values
• --label <l> — Column display label
• --format-type <t> — Output data format
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column dropdown --resource 8821 --options '["Approved","Rejected","Pending"]' --label "Status"
simetrik column dropdown --resource 8821 --options '["1","2","3"]' --format-type numeric

Exit codes

simetrik column chained

Create chained (inherited from parent) columns.

Creates chained columns — columns that inherit their values from a parent resource's columns. Pass --resource and --columns with a JSON array; each entry needs a parent_column_id and may include an optional label (omit it to auto-derive the label from the chained column's name).

Use this to pull a parent column through into a downstream resource (for example a group or reconciliation) so its values flow through without redefining them. Find the parent column IDs with simetrik column list against the parent resource. For values computed from a formula rather than inherited, use simetrik column transformation-formula.

See also: column transformation-formula, column list. Requires the resources · create_edit permission. See permissions.

Flags

• -r, --resource <id> — Resource ID
• --columns <json> — JSON array. Each entry: {"parent_column_id": <int>, "label"?: <str>}. Omit label to auto-derive from the chained column name.
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column chained --resource 9120 --columns '[{"parent_column_id":4510}]'
simetrik column chained --resource 9120 --columns '[{"parent_column_id":4510,"label":"Source amount"},{"parent_column_id":4511}]'

Exit codes

simetrik column today

Create a column that resolves to the current date (in a given timezone) for a source group.

Creates a today-date column that resolves to the current date for a source group. Pass --resource; set --timezone to control which zone "today" is evaluated in (defaults to UTC), since the calendar date can differ across zones at day boundaries.

Use this when a row needs the run/processing date — for example to compute age or days-since against a loaded date column. For an expiration anchored to another column use simetrik column due; for arbitrary date arithmetic use simetrik column transformation-formula.

See also: column due, column transformation-formula, column list. Requires the resources · create_edit permission. See permissions.

Flags

• -r, --resource <id> — Resource ID
• --timezone <tz> — Timezone
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column today --resource 8821
simetrik column today --resource 8821 --timezone "America/Bogota"

Exit codes

simetrik column cast

Cast a column to a different data format.

Changes a column's data format — for example reinterpreting a string column as numeric, date, or datetime. Identify the column with --id and the target format with --format-type. For formats that need a pattern (such as a date layout), pass --format-description with a FormatDescription ID, or --custom-format with a CustomFormat ID.

Use this when data loaded as one type needs to be treated as another so downstream formulas, joins, or reconciliations operate correctly. It changes the format only — to rename or reposition a column use simetrik column update. Look up the column's current format with simetrik column describe.

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

Flags

• --id <id> — Column ID to cast
• --format-type <t> — Target data format (e.g. 'date', 'numeric', 'string', 'datetime')
• --format-description <id> — FormatDescription ID for the target format (e.g. date pattern)
• --custom-format <id> — CustomFormat ID to apply
• -f, --format <fmt> — Output format: json|table

Examples

simetrik column cast --id 4510 --format-type numeric
simetrik column cast --id 4510 --format-type date --format-description 17

Exit codes

simetrik column describe

Describe a column with subtype-specific configuration.

Returns the full configuration of a single column, including its subtype-specific settings — for example the formula behind a transformation column, the options of a dropdown, or the partition and order keys of a uniqueness column. Pass the column ID as a positional argument.

Use this to inspect one column in depth before editing or casting it. It complements simetrik column list, which returns every column on a resource but without the per-subtype detail; reach for column describe once you know which column ID you want to examine.

See also: column list, column cast, column update. Requires CLI access. See permissions.

Arguments

• column_id — Column ID

Flags

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

Examples

simetrik column describe 4510
simetrik column describe 4510 --format table

Exit codes