SimetrikDocs
ReferenceSources & data

source

Subcommands of simetrik source.

simetrik source list

List source resources in the workspace.

Lists the sources in your workspace. A source is one type of Simetrik resource; this is the source-specific counterpart to the generic simetrik describe (which spans all resource types) — use it when you already know you're after sources and want a focused list with their IDs and names.

Filter by name with --search and cap the result set with --limit. To see a single source's columns, follow up with simetrik source describe <resource_id>.

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 source list
simetrik source list --search ventas --limit 20
simetrik source list --format json

simetrik source create

Create a source resource.

Creates a source — one of Simetrik's resource types (alongside reconciliations, transforms, and others). A source is a table you load data into. Reach for this when you're onboarding a new dataset.

Define the schema up front by passing --columns with a JSON array of column definitions, or create the source bare and add columns later. Add --create-table to also build the backing table in the same step. Pass --id-only when scripting, so the command prints just the new resource ID to capture in a variable.

To change a source's name or description afterward use simetrik source update; to inspect its columns use simetrik source describe; to load data into it use simetrik file upload.

Requires the resources · create_edit permission. See permissions.

Arguments

  • name — Source name

Flags

  • -d, --description <desc> — Description
  • --folder <id> — Folder ID
  • --columns <json> — JSON array of inline column definitions
  • --create-table — Create the Snowflake table after adding columns
  • --id-only — Print only the created resource ID
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik source create "Ventas Q1" --folder fld_123
simetrik source create "Cuentas" --columns '[{"name":"id","type":"STRING"},{"name":"amount","type":"NUMBER"}]' --create-table
simetrik source create "Pagos" --id-only

Exit codes

CodeMeaning
0Source created
2Invalid input — missing name, or malformed --columns JSON
4Authentication required — run simetrik login

simetrik source update

Update a source resource.

Updates a source'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 change the source's schema or data. To inspect the current columns use simetrik source describe; to load data use simetrik file upload.

Requires the resources · create_edit permission. See permissions.

Arguments

  • resource_id — Resource ID

Flags

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

Examples

simetrik source update res_abc123 --name "Ventas Q1 (revisado)"
simetrik source update res_abc123 --description "Carga diaria de ventas"

Exit codes

CodeMeaning
0Source updated
2Invalid input — unknown resource_id or no fields to update
4Authentication required — run simetrik login

simetrik source describe

Describe a source with columns.

Shows a single source in detail, including its columns. Reach for this before you load data or wire the source into a reconciliation, to confirm the schema is what you expect.

This is the deep view; the generic simetrik describe gives you the cross-resource list without columns. To read the actual rows, use simetrik data query.

Requires CLI access to the workspace. See permissions.

Arguments

  • resource_id — Resource ID

Flags

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

Examples

simetrik source describe res_abc123
simetrik source describe res_abc123 --format json

simetrik source upload

[DEPRECATED] Upload a file to a source (use: file upload).

Deprecated

source upload is kept only for backward compatibility. Use simetrik file upload instead — it takes one or more files, auto-detects content type, uploads concurrently, and registers each file in a single step.

Uploads a single file to a source. It predates the file * commands and lacks their multi-file and concurrency handling. New scripts should call simetrik file upload.

Requires the resources · create_edit permission. See permissions.

Arguments

  • file_path — Local file path

Flags

  • -s, --source <id> — Source ID
  • --run-reconcile — Trigger reconciliation after upload
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik file upload data.csv --source src_abc123

On this page