mammoth view
Generated from mammoth-cli 2.4.2, released 2026-11-02:
mammoth schema list,mammoth capability listand the CLI's own--help. Do not edit by hand; runnpm run docs:capabilities.
Transform, query, and publish data views. 146 commands.
Every command also takes the global flags (--output, --yes, --confirm, --dry-run, --input, --profile, ...), which are not repeated below. --input takes a JSON or YAML document of the input fields; mammoth schema get COMMAND_ID prints a command's full input schema.
Confirmation. Commands marked --yes --confirm TARGET or --yes always need those flags, even at a terminal: they never prompt. Commands marked "--yes or prompt" ask at an interactive terminal (table output, no --no-input) and otherwise need --yes. --dry-run skips confirmation and sends nothing.
Summary
| Command | What it does | Effect | Confirmation |
|---|---|---|---|
view analyze | List pipeline steps that can be dropped or moved without changing the result (read-only). | Read | — |
view bulk-delete | Permanently delete several dataviews by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
view compare | Compare dataviews pairwise: rows, column differences and checksums (read-only). | Read | — |
view create | Create a view from a dataset. Dataset id is positional; name/clone_from optional. | Benign mutation | — |
view delete | Permanently delete one view by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
view get | Get one view by id, optionally scoped to an exact dataset parent. | Read | — |
view impact | List what deleting a pipeline task or this whole view would affect (read-only). | Read | — |
view list | List dataviews for a dataset, or every dataset in the active project. | Read | — |
view optimize | Apply the safe pipeline findings, then wait for the rerun it queued. | Reversible pipeline step | --yes or prompt |
view parameter-context | Get a dataview's parameter context. | Read | — |
view preview | Preview a dataview's rows and columns. | Read | — |
view restore | Restore a trashed dataview. | Benign mutation | — |
view summary | What a view has had done to it and where it goes: steps, actions, exports, dashboards. | Read | — |
view trash | Move one dataview to the project trash (reversible). | Benign mutation | — |
view update | Rename a view from the name input field; any other patch is refused. | Benign mutation | — |
view active-user list | List the active users on a dataview. | Read | — |
view active-user mark | Mark the caller as an active user on a dataview. | Benign mutation | — |
view ai generate-data | Generate synthetic data for a dataview with an AI prompt. 'prompt' required. | Benign mutation | — |
view ai generation-info | Get the status/info of an AI data-generation run for a dataview. | Read | — |
view ai profile | Generate an AI profile for a dataview. | Benign mutation | — |
view checkpoint create | Create a checkpoint on a dataview. 'body' is required. | Benign mutation | — |
view checkpoint delete | Delete one checkpoint by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
view checkpoint get | Get one checkpoint by id. | Read | — |
view checkpoint list | List checkpoints on a dataview, with optional filters from '--input'. | Read | — |
view checkpoint update | Update one checkpoint by id. 'body' is required. | Benign mutation | — |
view column format set | Set how columns display (date or number format; a view display setting, not a task). | Benign mutation | — |
view conditional-format create | Colour cells in many columns by one threshold in a single command (columns + operator + value + color): each cell is judged by its own value. applies_to=row colours whole rows when any/all of the columns match. | Benign mutation | — |
view conditional-format delete-all | Delete a conditional-format rule on a dataview. Prompt or '--yes'. | Destructive | --yes or prompt |
view conditional-format list | List conditional-format rules on a dataview. | Read | — |
view conditional-format replace | Replace every conditional-format rule on a view with new ones in one call. | Destructive | --yes or prompt |
view conditional-format update | Update a conditional-format rule on a dataview. 'rule' is required. | Benign mutation | — |
view data aggregate | 'view data aggregate' as the user reads it: floats rounded (2 decimals; 4 below 1). | Read | — |
view data compare | Compare the same PIVOT/METRIC aggregate across two views, joined by key. | Read | — |
view data drivers | Explain a measure's change between two periods: totals, volume vs value, top contributors. | Read | — |
view data explore | Read one column's values: top values, distribution, trend over time, date range (read-only; this is not an Explore card, it opens and changes no card in the UI, that is 'view explore-panel set'): DATE counts per 'level' bucket (AUTO, SECOND to MILLENNIUM), NUMERIC per power-of-10 'level', TEXT top values ('limit' 20), each with 'count' and 'percentage'; 'metric' (a column plus SUM/AVG/MIN/MAX/STDDEV/COUNT/DISTINCT_COUNT) adds a per-bucket value, 'percentage_of' "metric" shares by it, 'sort' count_/value_/metric_ + asc/desc, 'condition' filters first (include, exclude, blanks, range, contains; an exclude drops blank rows the card keeps, so or it with IS_EMPTY; drill down = finer 'level' + 'condition' on the bucket), 'limit'/'offset' page, 'range' true adds the exact earliest and latest value, 'cumulative' a running total; '-o csv' saves the values; to put it on a dashboard say it in words to 'dashboard chat edit'. | Read | — |
view data forecast | Forecast a measure's next months, quarters or weeks: linear trend with a 95% range. | Read | — |
view data get | Fetch a dataview's data, waiting for the backing job to complete. | Read | — |
view data profile | Profile a view's columns over all its rows; 'target' ranks columns against an outcome. | Read | — |
view data query | Query a dataview's data with optional filtering, sorting, and paging. | Read | — |
view data-check create | Create a data check on a dataview. 'body' is required. | Benign mutation | — |
view data-check delete | Delete one data check by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
view data-check get | Get one data check by id. | Read | — |
view data-check list | List data checks on a dataview, with optional filters from '--input'. | Read | — |
view data-check update | Update one data check by id. 'body' is required. | Benign mutation | — |
view derivative create | Create a derivative on a dataview. 'body' is required. | Benign mutation | — |
view derivative data | Fetch data for one derivative by id. 'body' is required. | Benign mutation | — |
view derivative delete | Delete one derivative by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
view derivative list | List derivatives on a dataview. | Read | — |
view derivative update | Update one derivative by id. 'body' is required. | Benign mutation | — |
view draft auto-run | Set whether a view's draft pipeline auto-runs. 'enabled' is required. | Reversible pipeline step | — |
view draft command | Run a release-valid draft operation against a dataview. | Benign mutation | — |
view draft discard | Discard a view's draft pipeline changes. Prompt or '--yes' required. | Destructive | --yes or prompt |
view draft enter | Enter draft mode on a view's pipeline. | Reversible pipeline step | — |
view draft status | Report whether a view's pipeline is currently in draft mode. | Read | — |
view draft submit | Submit a view's draft pipeline changes. | Reversible pipeline step | — |
view explore-panel add-to-dashboard | Put an Explore card on a dashboard as a figure, like the card menu's Add to dashboard. | Benign mutation | — |
view explore-panel edit | Change Explore cards as the card menus do; the result carries the panel read back. | Benign mutation | — |
view explore-panel export-image | Write one open Explore card as an SVG image file (a bar chart or a table of its rows). | Read | — |
view explore-panel get | Read the Explore panel the caller saved on a view (empty when none is saved). | Read | — |
view explore-panel set | Replace the caller's saved Explore panel; the result carries the panel read back after. | Benign mutation | — |
view export azure-blob | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export bigquery | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export create | Create an export for a dataview. 'export_spec' required. Always '--yes'. | External effect | --yes |
view export csv | Export a dataview to a local CSV file. | Benign mutation | — |
view export dataset | Run one of the SDK's typed 'View.export' destination helpers. | Benign mutation | — |
view export delete | Delete one export by id. Always requires '--yes'. | External effect | --yes |
view export download | Download a dataview to a local file as csv, xlsx, json, ndjson, xml, yaml or parquet. | Benign mutation | — |
view export elasticsearch | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export email | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export ftp | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export get | Get one export by id. | Read | — |
view export list | List exports for a dataview, with optional filters from '--input'. | Read | — |
view export live-link | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export managed-s3 | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export mssql | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export mysql | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export onedrive | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export postgres | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export powerbi | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export publish-db | Publish a dataview to a database endpoint. Always requires '--yes'. | External effect | --yes |
view export publish-db-update | Patch a dataview's published database endpoint. Always requires '--yes'. | External effect | --yes |
view export redshift | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export rest | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export rest-fill | Propose REST API export settings from an API docs page. Always requires '--yes'. | External effect | --yes |
view export runs | Get the run history of one export, newest first: when, rows, destination, errors. | Read | — |
view export sftp | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export sharepoint | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export tableau | Run one of the SDK's typed 'View.export' destination helpers. | External effect | --yes |
view export update | Edit an export: a merge over the stored one, still pinned to the pipeline end. | External effect | --yes |
view exportable-config apply | Apply exactly one exportable config or clipboard item list. | Reversible pipeline step | --yes --confirm TARGET |
view exportable-config get | Get a dataview's exportable pipeline configuration. | Read | — |
view pipeline edit | Apply JSON Patch operations to a dataview's pipeline. 'patches' required. | Benign mutation | — |
view pipeline get | Get a dataview's full pipeline. | Read | — |
view pipeline items | List a dataview's pipeline items, with optional filters from '--input'. | Read | — |
view pipeline items-all | Read all pipeline items through bounded, exact-parent pagination. | Read | — |
view pipeline rerun | Rerun a dataview's pipeline, optionally from a given sequence. | Benign mutation | — |
view pipeline wait | Wait for a dataview's pipeline to finish running. | Read | — |
view task add | Add a pipeline task to a dataview. 'task_spec' is required. | Reversible pipeline step | — |
view task delete | Delete one pipeline task by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
view task get | Get one pipeline task by id. | Read | — |
view task list | List a dataview's pipeline tasks. | Read | — |
view task preview | Preview the effect of a pipeline task without persisting it. 'task_spec' required. | Read | — |
view task preview-cancel | Cancel a task preview job that newer settings of the task replaced. | Benign mutation | — |
view task update | Update one pipeline task by id. 'task_spec' is required. | Reversible pipeline step | — |
view transform add-column | Add a new column. 'name' is required; 'column_type' is optional. | Reversible pipeline step | — |
view transform add-sql | Add a column via a raw SQL expression. 'query' is required. | Reversible pipeline step | — |
view transform ai | Generate a column with an AI prompt. 'prompt'/'context_columns' required. | Reversible pipeline step | — |
view transform batch | Add several transforms in one request. 'steps' is required. | Reversible pipeline step | — |
view transform bulk-replace | Bulk-replace values. 'columns'/'mapping' required. | Reversible pipeline step | — |
view transform combine-columns | Combine columns into one. 'sources' is required. | Reversible pipeline step | — |
view transform convert-type | Convert column types. 'conversions' is required. | Reversible pipeline step | — |
view transform copy-columns | Copy columns. 'copies' is required. | Reversible pipeline step | — |
view transform crosstab | Build a crosstab into a new dataset. 'rows'/'pivot_column'/'select'/ | Reversible pipeline step | — |
view transform date-diff | Compute the difference between two dates. 'component'/'start'/'end' required. | Reversible pipeline step | — |
view transform delete-columns | Delete columns. 'columns' is required. Prompt or '--yes' required. | Reversible pipeline step | --yes or prompt |
view transform discard-duplicates | Discard duplicate rows. 'ignore_columns' or 'key_columns' is optional. | Reversible pipeline step | — |
view transform extract-date | Extract a date component into a column. 'column'/'component' required. | Reversible pipeline step | — |
view transform fill-missing | Fill missing values. 'column'/'direction' required. | Reversible pipeline step | — |
view transform filter | Filter rows. 'condition' is required. | Reversible pipeline step | — |
view transform first-name | Extract the first word of a text column, in one call. 'column' is required. | Reversible pipeline step | — |
view transform generate-sql | Generate a SQL query from a natural-language intent. 'intent' is required. | Reversible pipeline step | — |
view transform increment-date | Increment a date column. 'column'/'delta' required. | Reversible pipeline step | — |
view transform join | Join another view. 'foreign_view'/'join_type'/'on'/'select' required. | Reversible pipeline step | — |
view transform json-extract | Extract fields from a JSON column. 'column' is required. | Reversible pipeline step | — |
view transform limit-rows | Limit the row count. 'n' (or its alias 'limit') is required. | Reversible pipeline step | — |
view transform lookup | Look up values from another view. 'source'/'lookup_view_id'/'key'/ | Reversible pipeline step | — |
view transform math | Evaluate a math expression into a column. 'expression' is required. | Reversible pipeline step | — |
view transform pivot | Pivot with aggregations. 'group_by'/'aggregations' required. | Reversible pipeline step | — |
view transform rename-columns | Rename columns (a view display setting, not a task). 'renames' is required. | Benign mutation | — |
view transform repeat-rows | Repeat every row. Exactly one of 'times', 'values' or 'series' is required. | Reversible pipeline step | — |
view transform replace | Find and replace values. 'columns'/'find'/'replace' required. | Reversible pipeline step | — |
view transform set-values | Set values conditionally. 'values' is required. | Reversible pipeline step | — |
view transform small-large | Compute a small/large-N function. 'function'/'columns' required. | Reversible pipeline step | — |
view transform sort | Set the view's row order (a display setting, not a task). 'order_by' is required. | Benign mutation | — |
view transform split | Split a column. 'column'/'delimiter'/'new_columns' required. | Reversible pipeline step | — |
view transform substring | Extract a substring. 'column' is required. | Reversible pipeline step | — |
view transform text | Apply text transforms. 'columns' is required. | Reversible pipeline step | — |
view transform unnest | Unnest columns into label/value rows. 'columns' is required. | Reversible pipeline step | — |
view transform update-column | Overwrite a column with a math expression in one call; 'column', 'expression' required. | Reversible pipeline step | — |
view transform window | Compute a window function. 'function' is required. | Reversible pipeline step | — |
view variants create | Create one view per value of a column: each a clone of 'from_view' filtered to it. | Benign mutation | — |
view version apply | Apply one pipeline version by id. | Benign mutation | — |
view version delete | Delete one pipeline version by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
view version get | Get one pipeline version by id. | Read | — |
view version list | List pipeline versions on a dataview, with optional filters from '--input'. | Read | — |
view version update | Update one pipeline version by id. 'body' is required. | Benign mutation | — |
view commands
mammoth view analyze
List pipeline steps that can be dropped or moved without changing the result (read-only).
mammoth view analyze 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | str | ID of the view to analyze; join several with commas (5000,5001) for one result with all of them. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. Lists pipeline steps that can be dropped or moved without changing the result: findings of {rule, seqs, detail, proposed_order, safe}. Rules: drop_suspended, drop_duplicate, drop_noop_filter, hoist_filter. Only a safe finding is applied by view optimize. Also returns the view (name, dataset, rows, columns, state) and its pipeline step count, so no view get or task list follows. VIEW_ID may be several ids joined by commas: one result with an analysis per id, and an entry in errors for an id that failed.
- Id:
view.analyze· Result:ViewAnalyzeResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.analysis, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/analysis(GetAnalysis)
mammoth view bulk-delete
Permanently delete several dataviews by id. Prompt or '--yes' required.
mammoth view bulk-delete 123 --input '{"dataview_ids": [1]}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATASET_ID | positional | yes | — | int | ID of the dataset. |
dataview_ids | --input field | yes | — | list[int] | str |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: DATASET_ID.
- Id:
view.bulk-delete· Result:ViewBulkDeleteResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.bulk_delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews(DeleteMultipleDataviews)
mammoth view compare
Compare dataviews pairwise: rows, column differences and checksums (read-only).
mammoth view compare --input '{"pairs": [[1, 2]]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
pairs | --input field | yes | — | list[list[int]] |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. Pass pairs in --input as [[view_a, view_b], ...] (1 to 20 pairs). Each result has status ok, not_ready (a view's latest data is not built; see problem_views) or not_comparable (a view has duplicate column names), then rows_a, rows_b, columns_only_in_a, columns_only_in_b, checksum_a, checksum_b, equal and mismatched_columns. Columns match by display name; floats are rounded to 6 places.
- Id:
view.compare· Result:ViewCompareResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.compare, APIPOST /workspaces/{workspace_id}/dataviews/compare(CompareDataviews)
mammoth view create
Create a view from a dataset. Dataset id is positional; name/clone_from optional.
mammoth view create 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATASET_ID | positional | yes | — | int | ID of the dataset. |
name | --input field | no | View | str | |
clone_from | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: To work on a dataset's changes without touching its own views, create a working view; clone_from (a view id of the same dataset) carries that view's steps. A dataset's own view is the default_view of view list, never the newest or an agent-made view: read it, or clone it with clone_from when steps are needed; edit it in place only when asked to change that view.
- Id:
view.create· Result:ViewCreateResult· Backed by: SDKmammoth.client.ViewsResource.create, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews(AddDataview)
mammoth view delete
Permanently delete one view by id. Prompt or '--yes' required.
mammoth view delete 123 456 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Immutable view-ID confirmation. Supplying dataset_id uses the exact nested endpoint and skips parent discovery; omitting it retains legacy parent discovery.
- Id:
view.delete· Result:ViewDeleteResult· Backed by: SDKmammoth.client.ViewsResource.delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}(DeleteDataview)
mammoth view get
Get one view by id, optionally scoped to an exact dataset parent.
mammoth view get 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view. |
DATASET_ID | positional | no | — | int | Optional exact parent dataset ID; omit to retain legacy discovery. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none - Id:
view.get· Result:ViewGetResult· Backed by: SDKmammoth.client.ViewsResource.get, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}(GetDataviewInformationIndividual)
mammoth view impact
List what deleting a pipeline task or this whole view would affect (read-only).
mammoth view impact 123 456 --input '{"scope": "view"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
scope | --input field | yes | — | str | |
task_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. What deleting a pipeline task (scope task, with task_id) or the whole view (scope view) would affect: dashboards, exports, dependent views and automations. Pass scope in --input. Run it before view task delete or view trash, and say what it lists before asking to go ahead.
- Id:
view.impact· Result:ViewImpactResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.delete_impact, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/impact(GetDataviewDeleteImpact)
mammoth view list
List dataviews for a dataset, or every dataset in the active project.
mammoth view list 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATASET_ID | positional | no | — | int | ID of the dataset. Omit it to list dataviews across every dataset in the active project instead (paged; see the 'dataset_offset' input field and the 'next_dataset_offset' result field). Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
limit | --input field | no | 100 | int | |
sort | --input field | no | (created_at:desc) | str | |
offset | --input field | no | 0 | int | |
full | --input field | no | false | bool | |
dataset_offset | --input field | no | 0 | int | |
all_columns | --input field | no | false | bool |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: B01. Each view names its dataset (dataset_id and dataset_name) and carries rows and cols, created and updated time, the dataset's source kind, its column names with types and stored per-column sample_values (one stored-stats read per listed view, all made at once, no query), plus built_from and feeds (the view ids it reads and the ones that read it), pipeline_status when not ready, and in_sync false when its data is stale; cut to fit the agent tool output cap (next_dataset_offset and views_omitted say where the rest is). Newest first. full true returns the raw records.
- Id:
view.list· Result:ViewListResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.list, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews(ListDataviews)
mammoth view optimize
Apply the safe pipeline findings, then wait for the rerun it queued.
mammoth view optimize 123 456 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Optional parent dataset ID. Leave it out and the CLI looks up the view's dataset. A value that is not the view's dataset is refused before the write. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
apply_rules | --input field | no | — | list[str] |
- Effect: Reversible pipeline step, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal · Waits: starts a job; waits or returns it depending on input - Preconditions: VIEW_ID is the only id needed; the CLI looks up the dataset. If DATASET_ID is given it comes second (the SDK method takes them the other way round) and must be the dataset of that view. Writes the pipeline: applies the safe findings of view analyze (all of them, or only the rules in the apply_rules input field: drop_suspended, drop_duplicate, drop_noop_filter, hoist_filter) and reruns the view. Waits for the rerun job and adds job_state and job_result. The result lists applied, skipped (rule, seqs, reason), before_steps and after_steps. Run view analyze first and say what it found before asking to go ahead.
- Id:
view.optimize· Result:ViewOptimizeResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.optimize, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/optimize(OptimizePipeline)
mammoth view parameter-context
Get a dataview's parameter context.
mammoth view parameter-context 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID.
- Id:
view.parameter-context· Result:ViewParameterContextResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.parameter_context, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/parameter-context(GetParameterContext)
mammoth view preview
Preview a dataview's rows and columns.
mammoth view preview 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
rows | --input field | no | — | int | |
cols | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID.
- Id:
view.preview· Result:ViewPreviewResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.preview, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/preview(GetDataviewPreview)
mammoth view restore
Restore a trashed dataview.
mammoth view restore 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID.
- Id:
view.restore· Result:ViewRestoreResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.restore, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/restore(RestoreDataview)
mammoth view summary
What a view has had done to it and where it goes: steps, actions, exports, dashboards.
mammoth view summary 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
DATASET_ID | positional | no | — | int | Optional parent dataset ID; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
view.summary· Result:ViewSummaryResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.summary, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/summary(GetPanelSummary)
mammoth view trash
Move one dataview to the project trash (reversible).
mammoth view trash 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID.
- Id:
view.trash· Result:ViewTrashResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.trash, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/trash(TrashDataview)
mammoth view update
Rename a view from the name input field; any other patch is refused.
mammoth view update 123 456 --input '{"name": "Revenue report"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
name | --input field | yes | — | str |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Only the typed rename is offered (--input {"name": ...}); any other patch is refused with B09 DATAVIEW_INPUT_UNTYPED because patch_data is an arbitrary dictionary.
- Id:
view.update· Result:ViewUpdateResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}(Patch)
view active-user
mammoth view active-user list
List the active users on a dataview.
mammoth view active-user list 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: VIEW_ID.
- Id:
view.active-user.list· Result:ViewActiveUserListResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.active_users, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/activities(GetActiveUsers)
mammoth view active-user mark
Mark the caller as an active user on a dataview.
mammoth view active-user mark 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID.
- Id:
view.active-user.mark· Result:ViewActiveUserMarkResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.mark_active, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/activities(MarkActiveUser)
view ai
mammoth view ai generate-data
Generate synthetic data for a dataview with an AI prompt. 'prompt' required.
mammoth view ai generate-data 123 --input '{"prompt": "Summarize revenue by region"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
prompt | --input field | yes | — | str | |
no_of_rows | --input field | no | 10 | int | |
columns | --input field | no | — | list[str] | |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Preview operation per the pinned OpenAPI document; must not claim that it writes generated rows to the view. Rows accepted 1-100.
- Id:
view.ai.generate-data· Result:ViewAiGenerateDataResult· Backed by: SDKmammoth.api.ai.AIAPI.generate_data, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data/generate(Preview)
mammoth view ai generation-info
Get the status/info of an AI data-generation run for a dataview.
mammoth view ai generation-info 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
view.ai.generation-info· Result:ViewAiGenerationInfoResult· Backed by: SDKmammoth.api.ai.AIAPI.get_data_gen_info, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data/generate(GetValidationInfo)
mammoth view ai profile
Generate an AI profile for a dataview.
mammoth view ai profile 123 --input '{"dataset_id": 456, "action": "insights"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
dataset_id | --input field | no | — | int | |
action | --input field | no | insights | str |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
view.ai.profile· Result:ViewAiProfileResult· Backed by: SDKmammoth.api.ai.AIAPI.generate_profile, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/profile_generation(GenerateProfile)
view checkpoint
mammoth view checkpoint create
Create a checkpoint on a dataview. 'body' is required.
mammoth view checkpoint create 123 456 --input '{"body": {"checkpoint_name": "Revenue report", "checkpoint_type": "alert", "pinned_to_end": true}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID.
- Id:
view.checkpoint.create· Result:ViewCheckpointCreateResult· Backed by: SDKmammoth.api.checkpoints.CheckpointsAPI.create, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/checkpoints(AddCheckpoint)
mammoth view checkpoint delete
Delete one checkpoint by id. Prompt or '--yes' required.
mammoth view checkpoint delete 123 456 789 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
CHECKPOINT_ID | positional | yes | — | int | ID of the checkpoint. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: VIEW_ID, CHECKPOINT_ID.
- Id:
view.checkpoint.delete· Result:ViewCheckpointDeleteResult· Backed by: SDKmammoth.api.checkpoints.CheckpointsAPI.delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/checkpoints/{checkpoint_id}(DeleteCheckpoint)
mammoth view checkpoint get
Get one checkpoint by id.
mammoth view checkpoint get 123 456 789
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
CHECKPOINT_ID | positional | yes | — | int | ID of the checkpoint. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID, CHECKPOINT_ID.
- Id:
view.checkpoint.get· Result:ViewCheckpointGetResult· Backed by: SDKmammoth.api.checkpoints.CheckpointsAPI.get, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/checkpoints/{checkpoint_id}(GetPipelineCheckpoint)
mammoth view checkpoint list
List checkpoints on a dataview, with optional filters from '--input'.
mammoth view checkpoint list 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str | |
sort | --input field | no | — | str | |
sequence | --input field | no | — | str | |
status | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: VIEW_ID.
- Id:
view.checkpoint.list· Result:ViewCheckpointListResult· Backed by: SDKmammoth.api.checkpoints.CheckpointsAPI.list, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/checkpoints(GetPipelineCheckpoints)
mammoth view checkpoint update
Update one checkpoint by id. 'body' is required.
mammoth view checkpoint update 123 456 789 --input '{"body": {"patches": [{"op": "command", "path": "approve", "value": null}]}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
CHECKPOINT_ID | positional | yes | — | int | ID of the checkpoint. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID, CHECKPOINT_ID.
- Id:
view.checkpoint.update· Result:ViewCheckpointUpdateResult· Backed by: SDKmammoth.api.checkpoints.CheckpointsAPI.update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/checkpoints/{checkpoint_id}(EditPatches)
view column
mammoth view column format set
Set how columns display (date or number format; a view display setting, not a task).
mammoth view column format set 123 --input '{"formats": {"Admitted": {"date_format": "%d-%b-%Y"}, "Revenue": {"decimal_spec": 2}}, "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
formats | --input field | yes | — | dict[str, dict[str, any]] | |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: A view display setting (the web grid's column format menu), not a pipeline task: it changes how values show, not the stored values, and adds no task. Date columns take date_format (python style, %d-%b-%Y) or postgres_date_format (DD-Mon-YYYY); numeric columns take decimal_spec (decimal places), currency_symbol, is_percentage, thousands_separator, decimal_separator. Keys given replace the same keys of the column's format; the rest are kept. To change how TEXT is read as a date, use view transform convert-type.
- Id:
view.column.format.set· Result:ViewColumnFormatSetResult
view conditional-format
mammoth view conditional-format create
Colour cells in many columns by one threshold in a single command (columns + operator + value + color): each cell is judged by its own value. applies_to=row colours whole rows when any/all of the columns match.
mammoth view conditional-format create 123 456 --input '{"columns": ["Q1", "Q2", "Q3"], "operator": "<", "value": 55, "color": "red"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
rule | --input field | no | — | dict[str, any] | |
columns | --input field | no | — | list[str] | |
operator | --input field | no | — | str | |
value | --input field | no | — | any | |
color | --input field | no | — | str | |
name | --input field | no | — | str | |
applies_to | --input field | no | — | Literal['row', 'columns'] | One of row, columns. |
match | --input field | no | — | Literal['any', 'all'] | One of any, all. |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: columns + operator + value + color colour each cell by its own value: one RULE per column, created in this one call (applies_to columns, the default). applies_to row makes one rule over any/all (match) of the columns. A raw rule body ({"cf_type": "RULE"|"COLOR_SCALE", "payload": {...}}) still works instead; applies_to must be row or columns.
- Id:
view.conditional-format.create· Result:ViewConditionalFormatCreateResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.conditional_format_create, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format(CreateConditionalFormat)
mammoth view conditional-format delete-all
Delete a conditional-format rule on a dataview. Prompt or '--yes'.
mammoth view conditional-format delete-all 123 456 --input '{"rule_id": "bca0ff33bd6f8ed1"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
rule_id | --input field | no | — | str | int | None |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Exact phrase DELETE ALL CONDITIONAL FORMATS required.
- Id:
view.conditional-format.delete-all· Result:ViewConditionalFormatDeleteAllResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.conditional_format_delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format(DeleteConditionalFormat)
mammoth view conditional-format list
List conditional-format rules on a dataview.
mammoth view conditional-format list 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: VIEW_ID.
- Id:
view.conditional-format.list· Result:ViewConditionalFormatListResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.conditional_format_list, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format(GetConditionalFormat)
mammoth view conditional-format replace
Replace every conditional-format rule on a view with new ones in one call.
mammoth view conditional-format replace 123 456 --input '{"columns": ["Q1", "Q2", "Q3"], "operator": "<", "value": 55, "color": "red"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
rule | --input field | no | — | dict[str, any] | |
columns | --input field | no | — | list[str] | |
operator | --input field | no | — | str | |
value | --input field | no | — | any | |
color | --input field | no | — | str | |
name | --input field | no | — | str | |
applies_to | --input field | no | — | Literal['row', 'columns'] | One of row, columns. |
match | --input field | no | — | Literal['any', 'all'] | One of any, all. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Same input as view conditional-format create (typed fields or a raw rule). Deletes every existing rule of the view, then creates the new ones, in one call; a refused rule leaves the rules created so far and the error names deleted_rule_ids and created_rule_ids. To add a rule beside the others use create.
- Id:
view.conditional-format.replace· Result:ViewConditionalFormatReplaceResult
mammoth view conditional-format update
Update a conditional-format rule on a dataview. 'rule' is required.
mammoth view conditional-format update 123 456 --input '{"rule": {"name": "Status"}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
rule | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
view.conditional-format.update· Result:ViewConditionalFormatUpdateResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.conditional_format_update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format(UpdateConditionalFormat)
view data
mammoth view data aggregate
'view data aggregate' as the user reads it: floats rounded (2 decimals; 4 below 1).
mammoth view data aggregate 123 456 --input '{"group_by": ["Channel"], "aggregations": [{"column": "Spend", "function": "SUM", "as_name": "Total Spend"}]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
aggregations | --input field | no | — | list[dict[str, any]] | |
group_by | --input field | no | — | list[str | dict[str, Any]] | |
metric | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | dict[str, any] | |
sequence | --input field | no | — | int | |
limit | --input field | no | — | int | |
timeout | --input field | no | — | int | |
poll_interval | --input field | no | 2 | int | |
order_by | --input field | no | — | list[any] | |
top | --input field | no | — | int | |
text_date_format | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Read-only: computes and returns an aggregated result without adding a task to the view's pipeline or otherwise changing it. Pass exactly one of 'aggregations' (a PIVOT group-by; 'group_by' is optional) or 'metric' (a single METRIC value). 'function' is one of SUM, COUNT, AVG, MIN, MAX, STDDEV, DISTINCT_COUNT, MEDIAN. MEDIAN is exact over a NUMERIC column's non-blank values (median_note counts the blank rows left out) and goes in a read of its own. A group_by item is a column name, or {"column": C, "truncate": DAY|WEEK|MONTH|QUARTER|YEAR} to bucket a DATE (a trend over time), or {"column": C, "resolution": N} to bucket a NUMERIC; grouping by a raw date gives one row per day. A metric is a number: only COUNT and DISTINCT_COUNT work on a DATE or TEXT column. For one column's trend, top values or spread, view data explore is the shorter call. order_by (result labels; a string like 'Total desc' or {column, direction}) with top ranks the groups on the backend; a limit without order_by keeps arbitrary rows and the result says ordered false. A group_by truncate on a TEXT column of dates is bucketed by the CLI: the stored format is detected from the data and stated in text_dates, an ambiguous day/month order (settle it with text_date_format) or an unreadable value fails loud, and a range condition (GT, GTE, LT, LTE, IN_RANGE with a YYYY-MM-DD value) on such a column works the same way. A truncate on a NUMERIC column, or a resolution on a non-NUMERIC one, is refused. To group by the part of a date, give {"column": C, "part": weekday|day|month|quarter|year} on a DATE or TEXT-date column: the groups are named (Monday, January, Q1) and in calendar order. This is the read-only way to answer by-weekday and by-month questions. An empty result carries observed_range: the min and max of the filtered or date column.
- Id:
view.data.aggregate· Result:ViewDataAggregateResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.aggregate, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data/query(ExecuteVolatileQuery)
mammoth view data compare
Compare the same PIVOT/METRIC aggregate across two views, joined by key.
mammoth view data compare 111 222 --input '{"group_by": ["Campaign"], "aggregations": [{"column": "Spend", "function": "SUM", "as_name": "Spend"}]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID_A | positional | yes | — | int | ID of the first view to compare. |
VIEW_ID_B | positional | yes | — | int | ID of the second view to compare. |
aggregations | --input field | no | — | list[any] | |
group_by | --input field | no | — | list[any] | |
metric | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | dict[str, any] | |
sequence | --input field | no | — | int | |
limit | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Every number reported to the user comes from a tool result: use this to compare the same PIVOT/METRIC aggregate across two views (e.g. two platforms' totals per campaign) instead of subtracting two 'view data aggregate' reads by hand -- calc is the tool for a single expression. Takes the exact same --input shape as view data aggregate (aggregations/group_by, or metric); rows are joined on the group-by key (or compared as a single row for a bare metric) using exact Decimal arithmetic. A key present in only one view's result is not an error: 'only_in_first' and 'only_in_second' give its exact count and the first 25 rows, and 'rows' holds the keys both views have.
- Id:
view.data.compare· Result:ViewDataCompareResult
mammoth view data drivers
Explain a measure's change between two periods: totals, volume vs value, top contributors.
mammoth view data drivers 123 --input '{"measure": {"column": "revenue", "function": "SUM"}, "date_column": "sale_date", "compare": ["2026-07", "2026-08"], "by": ["store", "category"]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view whose figures rose or dropped: the change to explain. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. |
measure | --input field | yes | — | dict[str, any] | |
date_column | --input field | yes | — | str | |
compare | --input field | yes | — | list[any] | |
by | --input field | yes | — | list[str] | |
conditions | --input field | no | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. Use this, not a series of view data aggregate reads, for "why did X drop/rise", "what drove the change between July and August", "explain the decline": one call returns the total for each period, the change and its percentage, whether it came from volume (the row count) or value (value per row), and per 'by' column the groups that moved most with their signed share_of_change. --input: "measure" {"column", "function": SUM or COUNT}; "date_column"; "compare" [A, B], each 'YYYY-MM', 'YYYY-Qn', 'YYYY' or {"from": "YYYY-MM-DD", "to": "YYYY-MM-DD"} (the change is read from A to B; any other form is refused); "by" 1 to 3 columns; optional "conditions" in view data aggregate's condition shape. partial_period names a period the data does not cover to its end (or from its start): say it is incomplete, never compare it as a whole period. Answer with the total change first, then the top contributors with their share, then volume vs value. Amounts carry the currency in 'currency'; when it is null give plain numbers and never invent a currency.
- Id:
view.data.drivers· Result:ViewDataDriversResult
mammoth view data explore
Read one column's values: top values, distribution, trend over time, date range (read-only; this is not an Explore card, it opens and changes no card in the UI, that is 'view explore-panel set'): DATE counts per 'level' bucket (AUTO, SECOND to MILLENNIUM), NUMERIC per power-of-10 'level', TEXT top values ('limit' 20), each with 'count' and 'percentage'; 'metric' (a column plus SUM/AVG/MIN/MAX/STDDEV/COUNT/DISTINCT_COUNT) adds a per-bucket value, 'percentage_of' "metric" shares by it, 'sort' count_/value_/metric_ + asc/desc, 'condition' filters first (include, exclude, blanks, range, contains; an exclude drops blank rows the card keeps, so or it with IS_EMPTY; drill down = finer 'level' + 'condition' on the bucket), 'limit'/'offset' page, 'range' true adds the exact earliest and latest value, 'cumulative' a running total; '-o csv' saves the values; to put it on a dashboard say it in words to 'dashboard chat edit'.
mammoth view data explore 123 Status 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
COLUMN | positional | yes | — | str | Display name of the column to explore. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
column_type | --input field | no | — | str | |
level | --input field | no | — | str | |
metric | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | dict[str, any] | |
sequence | --input field | no | — | int | |
limit | --input field | no | — | int | |
offset | --input field | no | — | int | |
sort | --input field | no | — | str | |
cumulative | --input field | no | false | bool | |
percentage_of | --input field | no | — | str | |
timeout | --input field | no | — | int | |
poll_interval | --input field | no | 2 | int | |
text_date_format | --input field | no | — | str | |
range | --input field | no | false | bool |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Read-only: reads one column's value distribution -- trend, distribution, histogram, or top values. It does not open or change any card in the UI; to open Explore cards use 'view explore-panel set'. It reads without adding a task to the view's pipeline (never use 'view transform pivot' just to explore). DATE column: counts per 'level' bucket (AUTO default; SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR, DECADE, CENTURY, MILLENNIUM) for "what's trending", "over time", "by month", "by year". NUMERIC column: counts per 'level' resolution (AUTO default; a power of 10) for a distribution or histogram. TEXT column: top values by count, 'limit' default 20 -- "what's in this column". Every bucket has 'count' and 'percentage' of the total. 'row_count' is the number of unique values (buckets). Options (--input): 'metric' {"column","function"} adds a per-bucket SUM, COUNT, AVG, MIN, MAX, STDDEV or DISTINCT_COUNT over another column (the custom card); 'condition' filters rows first -- include/exclude values, blanks, a date or number range, text contains -- and several cards' selections combine as one AND condition (cross-filter); drill down by re-running at a finer 'level' with a 'condition' on the chosen bucket's range; 'percentage_of' "metric" makes 'percentage' the share of the 'metric' total (default: of the count); 'sort' count_desc, count_asc, value_asc, value_desc, metric_desc or metric_asc (blanks last; the card puts them first); 'limit' and 'offset' page the buckets ("load more"); 'range' true adds the exact earliest and latest value of a DATE or NUMERIC column under the same condition; '-o csv' prints the buckets as CSV; 'sequence' explores at a pipeline step. To exclude a value the way the card does (blank rows stay), use or(NE value, IS_EMPTY on that column): a plain NE, NOT_IN_LIST or not drops blank rows. To put the card on a dashboard, say it in words: 'dashboard chat edit DASHBOARD_ID' (prompt) or 'dashboard v3 generate'. Search several columns for text: or of CONTAINS per text column. Replace all values like this: 'view transform replace'. Related: distinct raw values of a DATE/NUMERIC column, a summary (min/max/sum/avg) or a matching-row count -> 'view data aggregate'; keep the filter as a pipeline step -> 'view transform filter'; save it as a new view -> 'view create' then 'view transform filter' on it; download all rows -> 'view export csv'. A TEXT column of dates takes a level (or column_type DATE): the format is detected from the data and stated in text_dates; ambiguous or unreadable dates fail loud. A column_type that disagrees with the stored type is refused, never dropped. Example: --input '{"level": "MONTH", "condition": {"column": "Results", "operator": "EQ", "value": "Fail"}}'. A figure for a period (year, quarter, month) is one explore of the DATE column with level YEAR, QUARTER or MONTH and a metric {"column": AMOUNT, "function": "SUM"}: it returns one figure per period and the date range the data covers, so no rows need paging. cumulative true adds a running total; keep one year or range with condition, for a year {"column": DATE_COLUMN, "operator": "=", "value": 2017, "component": "year"}. Figures come back rounded to two decimals: quote them as returned.
- Id:
view.data.explore· Result:ViewDataExploreResult
mammoth view data forecast
Forecast a measure's next months, quarters or weeks: linear trend with a 95% range.
mammoth view data forecast 123 --input '{"measure": {"column": "revenue", "function": "SUM"}, "date_column": "sale_date", "unit": "month", "periods": 2}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to forecast from, e.g. to estimate what revenue will be next month or in October. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. |
measure | --input field | yes | — | dict[str, any] | |
date_column | --input field | yes | — | str | |
unit | --input field | no | month | Literal['month', 'quarter', 'week'] | One of month, quarter, week. |
periods | --input field | no | 1 | int | |
conditions | --input field | no | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. Use this for "forecast", "projection", "estimate next month", "what will revenue be in October": never divide a partial period by its days or extend a trend by hand. --input: "measure" {"column", "function"} as view data aggregate takes; "date_column"; "unit" month (default), quarter or week; "periods" 1 to 12 (default 1); optional "conditions" in view data aggregate's condition shape. It reads the measure per period in one aggregate and fits an ordinary least-squares linear trend to the complete periods, adding a seasonal index only with two full cycles (24 months, 8 quarters, 104 weeks; otherwise seasonal is false), with a t-based 95% prediction interval (low, high). A last period the data does not cover to its end is left out of the fit and reported as excluded_partial (its value so far and data_through); it is the first period forecast. The forecast starts after the last period in the data: when the data ends in mid-September and the user asks for October, pass periods 2 and quote October. Fewer than 3 complete periods is refused. Give the estimate with its range, name the method, never present it as certain; amounts carry the currency in 'currency', and when it is null give plain numbers and never invent a currency.
- Id:
view.data.forecast· Result:ViewDataForecastResult
mammoth view data get
Fetch a dataview's data, waiting for the backing job to complete.
Input field raw: true returns DATE values with their time, not the date alone.
mammoth view data get 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
timeout | --input field | no | — | int | |
poll_interval | --input field | no | — | float | |
sequence | --input field | no | — | int | |
raw | --input field | no | false | bool | |
limit | --input field | no | 50 | int | |
offset | --input field | no | 0 | int | |
columns | --input field | no | — | list[str] |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: VIEW_ID.
- Id:
view.data.get· Result:ViewDataGetResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.get_data, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data(GetDataviewData)
mammoth view data profile
Profile a view's columns over all its rows; 'target' ranks columns against an outcome.
mammoth view data profile 123 --input '{"target": "Churn"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
target | --input field | no | — | str | |
columns | --input field | no | — | list[str] | |
top | --input field | no | 5 | int | |
limit | --input field | no | 50 | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only profile of the WHOLE view (every row, not a page of 50): per column the blank count, distinct count, min and max (NUMERIC and DATE) and top values; a "summary" of constant, all-blank and mostly-blank columns; "spelling_variants" per TEXT column -- spellings of one value that differ by case, punctuation or legal form (Ltd = Limited, Inc = Incorporated ...) -- with a ready "bulk_replace" input and the full "command" to merge them. Use it to explore, understand or profile a dataset, find blanks, duplicates and dirty categories. Blanks, distinct counts and min/max come from the stats the backend stored for the view when their row count equals the view row count now; otherwise (stale after a pipeline step, or none stored) they are queried in a few multi-column pivots. The "sources" block says which, and that the backend records no as-of time; each column "from" says stored or query. Top values, spelling variants and the target comparison are always queried. --input: "target" (a column with 2-20 values, e.g. churn) adds the target distribution (positive_rate of its rarest class) and "association": "categorical" columns ranked by cramers_v (one grouped count per column) and "numeric" columns ranked by standardized_difference (two multi-column pivots) -- the churn drivers; "columns" (names) profiles only those; "top" values per column (default 5); "limit" columns shown in detail (default 50; the summary always covers all). A column with more than 5000 distinct values gets counts and min/max but no value list. Example: --input '{"target": "CHURN", "limit": 20}'.
- Id:
view.data.profile· Result:ViewDataProfileResult
mammoth view data query
Query a dataview's data with optional filtering, sorting, and paging.
Input field raw: true returns DATE values with their time, not the date alone.
mammoth view data query 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
sequence | --input field | no | — | int | |
offset | --input field | no | 1 | int | |
limit | --input field | no | 400 | int | |
columns | --input field | no | — | list[str] | |
condition | --input field | no | — | dict[str, any] | |
sort | --input field | no | — | str | |
raw | --input field | no | false | bool | |
text_date_format | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) · Pages:offset - Preconditions: B11 QUERY_OFFSET_SEMANTICS: one-indexed (offset=1) with no proven continuation; --all is blocked.
- Id:
view.data.query· Result:ViewDataQueryResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.query_data, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data(GetDataviewDataPost)
view data-check
mammoth view data-check create
Create a data check on a dataview. 'body' is required.
mammoth view data-check create 123 456 --input '{"body": {"checks": [{"check_type": "null_percentage", "config": {"column": "Status", "condition": "lt"}}], "name": "Revenue report", "pinned_to_end": true}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: body needs a placement: pinned_to_end true or a task_sequence (4GENR007 "Either task_sequence or pinned_to_end must be set" otherwise). An alert the user asks for ("tell me when late deliveries go above 10") is a data check: pinned_to_end true, fail_behavior "flag_and_continue" (the default "halt" stops the pipeline), and one row_count check with condition "lte" and value 10 whose config condition_sql filters the rows to count, e.g. "\"Status\" = 'Late'" (column display names). It is re-tested after every pipeline run and source refresh, and its owner gets an in-app notice when it starts failing (once, not on every failing run). Say it fires when the count goes above the value, not below.
- Id:
view.data-check.create· Result:ViewDataCheckCreateResult· Backed by: SDKmammoth.api.data_checks.DataChecksAPI.create, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/data-checks(AddDataCheck)
mammoth view data-check delete
Delete one data check by id. Prompt or '--yes' required.
mammoth view data-check delete 123 456 789 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATA_CHECK_ID | positional | yes | — | int | ID of the data check. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: VIEW_ID, DATA_CHECK_ID.
- Id:
view.data-check.delete· Result:ViewDataCheckDeleteResult· Backed by: SDKmammoth.api.data_checks.DataChecksAPI.delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/data-checks/{data_check_id}(DeleteDataCheck)
mammoth view data-check get
Get one data check by id.
mammoth view data-check get 123 456 789
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATA_CHECK_ID | positional | yes | — | int | ID of the data check. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID, DATA_CHECK_ID.
- Id:
view.data-check.get· Result:ViewDataCheckGetResult· Backed by: SDKmammoth.api.data_checks.DataChecksAPI.get, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/data-checks/{data_check_id}(GetPipelineDataCheck)
mammoth view data-check list
List data checks on a dataview, with optional filters from '--input'.
mammoth view data-check list 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str | |
sort | --input field | no | — | str | |
sequence | --input field | no | — | str | |
status | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: VIEW_ID.
- Id:
view.data-check.list· Result:ViewDataCheckListResult· Backed by: SDKmammoth.api.data_checks.DataChecksAPI.list, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/data-checks(GetPipelineDataChecks)
mammoth view data-check update
Update one data check by id. 'body' is required.
mammoth view data-check update 123 456 789 --input '{"body": {"patches": [{"op": "command", "path": "disable", "value": null}]}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATA_CHECK_ID | positional | yes | — | int | ID of the data check. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: patches are {op: command, path: enable|disable, value: null} or {op: replace, path: spec, value: AddDataCheckSpec}, the same body the web app sends. On release the PATCH returns HTTP 500 (outcome_unknown) from backend validation that runs after the change is committed; read the check back with view data-check get before retrying.
- Id:
view.data-check.update· Result:ViewDataCheckUpdateResult· Backed by: SDKmammoth.api.data_checks.DataChecksAPI.update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/data-checks/{data_check_id}(EditDatacheck)
view derivative
mammoth view derivative create
Create a derivative on a dataview. 'body' is required.
mammoth view derivative create 123 456 --input '{"body": {"param": {"METRIC": {"AS": "total", "EXPRESSION": [{"TYPE": "FUNCTION", "VALUE": {"ARGUMENT": "column_1", "FUNCTION": "SUM"}}]}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: ARGUMENT and any column reference in the METRIC expression are internal names (metadata[].internal_name from view get, e.g. column_1), not display names; a display name makes the backend fail with HTTP 500. The result is {"id": N, "card": bool}; read the value with view derivative data. A METRIC shows as an explore-panel card only through display_properties; when it is absent or null the CLI defaults it to the metric card (type metric, info.title = the AS name); pass display_properties to override. card says whether a card exists (verify.card mirrors it).
- Id:
view.derivative.create· Result:ViewDerivativeCreateResult· Backed by: SDKmammoth.api.derivatives.DerivativesAPI.create, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/derivatives(CreateDerivative)
mammoth view derivative data
Fetch data for one derivative by id. 'body' is required.
mammoth view derivative data 123 456 789 --input '{"body": {"limit": null}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DERIVATIVE_ID | positional | yes | — | int | ID of the derivative. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: body is {"condition": CONDITION_OR_NULL, "limit": null}, the same document the web app posts; {"limit": null} is the minimal accepted body and an empty body is rejected (4GENR007). Returns STATUS, the metric row(s) under data and their metadata.
- Id:
view.derivative.data· Result:ViewDerivativeDataResult· Backed by: SDKmammoth.api.derivatives.DerivativesAPI.data, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/derivatives/{derivative_id}/data(FetchDerivativeData)
mammoth view derivative delete
Delete one derivative by id. Prompt or '--yes' required.
mammoth view derivative delete 123 456 789 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DERIVATIVE_ID | positional | yes | — | int | ID of the derivative. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: VIEW_ID, DERIVATIVE_ID.
- Id:
view.derivative.delete· Result:ViewDerivativeDeleteResult· Backed by: SDKmammoth.api.derivatives.DerivativesAPI.delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/derivatives/{derivative_id}(DeleteDerivative)
mammoth view derivative list
List derivatives on a dataview.
mammoth view derivative list 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: VIEW_ID.
- Id:
view.derivative.list· Result:ViewDerivativeListResult· Backed by: SDKmammoth.api.derivatives.DerivativesAPI.list, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/derivatives(ListDerivatives)
mammoth view derivative update
Update one derivative by id. 'body' is required.
mammoth view derivative update 123 456 789 --input '{"body": {"patches": [{"op": "replace", "path": "param", "value": {"METRIC": {"AS": "Total revenue", "EXPRESSION": [{"TYPE": "FUNCTION", "VALUE": {"FUNCTION": "SUM"}}]}}}]}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DERIVATIVE_ID | positional | yes | — | int | ID of the derivative. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID, DERIVATIVE_ID.
- Id:
view.derivative.update· Result:ViewDerivativeUpdateResult· Backed by: SDKmammoth.api.derivatives.DerivativesAPI.update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/derivatives/{derivative_id}(EditDerivative)
view draft
mammoth view draft auto-run
Set whether a view's draft pipeline auto-runs. 'enabled' is required.
mammoth view draft auto-run 123 --input '{"enabled": true, "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
enabled | --input field | yes | — | bool | |
dataset_id | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Requires exactly one of --enabled/--disabled, no implicit default.
- Id:
view.draft.auto-run· Result:ViewDraftAutoRunResult
mammoth view draft command
Run a release-valid draft operation against a dataview.
mammoth view draft command 123 --input '{"command": "enter", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
command | --input field | yes | — | str | |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
view.draft.command· Result:ViewDraftCommandResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.command, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/draft-mode(ExecutePipelineDraftCommand)
mammoth view draft discard
Discard a view's draft pipeline changes. Prompt or '--yes' required.
mammoth view draft discard 123 --input '{"dataset_id": 456}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
dataset_id | --input field | no | — | int |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Prompt or --yes because queued tasks are deleted.
- Id:
view.draft.discard· Result:ViewDraftDiscardResult
mammoth view draft enter
Enter draft mode on a view's pipeline.
mammoth view draft enter 123 --input '{"dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
dataset_id | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Idempotent only when server state proves it is already active.
- Id:
view.draft.enter· Result:ViewDraftEnterResult
mammoth view draft status
Report whether a view's pipeline is currently in draft mode.
mammoth view draft status 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Server-backed draft-status seam used by 'view draft status'.
- Id:
view.draft.status· Result:ViewDraftStatusResult
mammoth view draft submit
Submit a view's draft pipeline changes.
mammoth view draft submit 123 --input '{"dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
dataset_id | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Requires server draft state before mutation.
- Id:
view.draft.submit· Result:ViewDraftSubmitResult
view explore-panel
mammoth view explore-panel add-to-dashboard
Put an Explore card on a dashboard as a figure, like the card menu's Add to dashboard.
mammoth view explore-panel add-to-dashboard 123 --input '{"card": "Region", "new_dashboard_title": "Regions"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Optional parent dataset ID. Leave it out and the CLI looks up the view's dataset. A value that is not the view's dataset is refused before the write. Or the dataset_id input field. |
card | --input field | yes | — | str | |
new_dashboard_title | --input field | no | — | str | |
page | --input field | no | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Puts one open Explore card on a dashboard as a figure, like the card menu's Add to dashboard. Input {"card": COLUMN NAME} and either "dashboard_id" (an existing board of this view) or "new_dashboard_title" (a new blank board; a title the project already has is refused); "page": {"id": N} or {"new_title": "..."} goes with dashboard_id. The card becomes the figure the web app makes: a text list a top 10 bar (donut top 7, treemap top 24), a date a bar or line by year or month, a number a bar over fixed ranges. The result carries the figure, "notes" (what does not carry over: top N, date unit, fixed ranges, filters left off), dashboard_id and created_dashboard. A filter card (search, scatter, ask), a card whose column is gone and a card with a value the dashboard cannot show are refused with the web app's reason. Wait for the bake with job wait.
- Id:
view.explore-panel.add-to-dashboard· Result:ViewExplorePanelAddToDashboardResult
mammoth view explore-panel edit
Change Explore cards as the card menus do; the result carries the panel read back.
mammoth view explore-panel edit 123 456 --input '{"edits": [{"op": "metric", "card": "Region", "agg": "SUM", "of": "Amount"}]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Optional parent dataset ID. Leave it out and the CLI looks up the view's dataset. A value that is not the view's dataset is refused before the write. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
edits | --input field | yes | — | list[dict[str, any]] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Changes the Explore cards the way the card menus do, with display names and no card JSON, and writes the panel once. The card must be open (view explore-panel set). Input {"edits": [...]}, applied in order; each edit is {"op", "card": COLUMN NAME, ...}. metric: {"agg": COUNT} or {"agg": SUM|AVG|MIN|MAX|STDDEV|DISTINCT_COUNT, "of": NUMERIC COLUMN} (DISTINCT_COUNT takes any column). sort: {"by": metric|value, "direction": ASC|DESC}, list views only. view: {"view": list|columns|timeline|donut|treemap}, which depends on the column type. level: {"level": a date level or a number bucket width}. filter / exclude: {"values": [...]} for text, {"from", "to"} for ranges, {"blanks": true} for blanks; clear: the filter off; remove: the card off. Query cards: {"op": "search", "text": "...", "columns": [...]}, {"op": "scatter", "x": NUMERIC, "y": NUMERIC, "box": {...}} and {"op": "ask", "question": "..."} (the question goes to the same suggestions call the web app makes and its condition is kept). An unknown column, a column of the wrong type or a value outside the web app's options is refused with the valid choices. The result carries "panel", the panel read back. It is a per-user preference: it does not change the view or what other users see.
- Id:
view.explore-panel.edit· Result:ViewExplorePanelEditResult
mammoth view explore-panel export-image
Write one open Explore card as an SVG image file (a bar chart or a table of its rows).
mammoth view explore-panel export-image 123 --input '{"card": "Region", "output_path": "card.svg", "style_id": null}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
style_id | --input field | no | — | str | |
card | --input field | yes | — | str | |
output_path | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Writes the open Explore card "card" (its column display name) as an SVG file at "output_path" (default explore-card-VIEW_ID.svg). The backend has no rasterizer, so this writes SVG only; the web app's PNG is a browser screenshot. A bar card becomes a bar chart (one bar per group, its value the card's metric); a list card becomes a table of its rows. The rows are read as view data explore reads them, so the list is the top values the backend returns (TEXT: 20). "style_id" optionally renders with a saved style. The card must be open (view explore-panel set). Not available inside the Mammoth app: it writes a file on the host. It is a per-user preference read; it does not change the view or the panel.
- Id:
view.explore-panel.export-image· Result:ViewExplorePanelExportImageResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.render_figure_svg, APIPOST /dashboards/v3/render/svg(RenderFigureSvg)
mammoth view explore-panel get
Read the Explore panel the caller saved on a view (empty when none is saved).
mammoth view explore-panel get 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. Returns the Explore panel the caller saved on this view, {height, cards}, or {} when none is saved. It is a per-user preference: other users do not see it. VIEW_ID is the only id needed.
- Id:
view.explore-panel.get· Result:ViewExplorePanelGetResult
mammoth view explore-panel set
Replace the caller's saved Explore panel; the result carries the panel read back after.
mammoth view explore-panel set 123 456 --input '{"panel": {"columns": "all"}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | Optional parent dataset ID. Leave it out and the CLI looks up the view's dataset. A value that is not the view's dataset is refused before the write. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
panel | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Saves the Explore cards of the calling user for a view; it shows nothing by itself. Open a card per column with {"panel": {"columns": "all"}} or {"panel": {"columns": ["Region", "Amount"]}}: each named column that has no card gets one and the saved cards stay. To replace the whole panel, run view explore-panel get first and write back {"panel": {"cards": [...]}}. A panel with no cards list is refused, because the web app shows only cards. The result carries "panel", the panel read back after the write (what get returns): check its cards to see which are open. It is a per-user preference: it does not change the view or what other users see.
- Id:
view.explore-panel.set· Result:ViewExplorePanelSetResult
view export
mammoth view export azure-blob
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export azure-blob 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
storage_account_name | --input field | yes | — | str | |
tenant_id | --input field | yes | — | str | |
client_id | --input field | yes | — | str | |
client_secret | --input field | yes | — | str | |
container_name | --input field | yes | — | str | |
folder_path | --input field | no | — | str | |
file_name | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Required inputs: VIEW_ID.
- Id:
view.export.azure-blob· Result:ViewExportAzureBlobResult
mammoth view export bigquery
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export bigquery 123 456 --input '{"selected_profile": {}, "selected_identity": {}, "table": "exports"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
selected_profile | --input field | yes | — | dict[str, any] | |
selected_identity | --input field | yes | — | dict[str, any] | |
table | --input field | yes | — | str | |
export_type | --input field | no | REPLACE | BigQueryExportType | One of REPLACE, COMBINE, UPSERT. |
upsert_keys | --input field | no | — | list[dict[str, any]] | |
partition | --input field | no | — | dict[str, any] | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any | |
replace_table | --input field | no | false | bool |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Require upsert keys for UPSERT and type both partition variants. With export_type REPLACE (the default) it drops and recreates the destination table on this export and on every later run of the view's pipeline; refused unless the input sets replace_table to true (replace_table_not_acknowledged). The result carries refreshes_on_pipeline_run and a note saying so.
- Id:
view.export.bigquery· Result:ViewExportBigqueryResult
mammoth view export create
Create an export for a dataview. 'export_spec' required. Always '--yes'.
mammoth view export create 123 --input '{"export_spec": {"DATAVIEW_ID": 1, "handler_type": "postgres", "trigger_type": "none", "run_immediately": true}}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
export_spec | --input field | yes | — | AddExportSpec | |
dataset_id | --input field | no | — | int |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Replace open destination dictionaries with the typed destination union.
- Id:
view.export.create· Result:ViewExportCreateResult· Backed by: SDKmammoth.api.exports.ExportsAPI.create, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports(AddExport)
mammoth view export csv
Export a dataview to a local CSV file.
mammoth view export csv 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
output_path | --input field | no | — | str | Path | None | |
timeout | --input field | no | 300 | int | |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: SDK target for view export csv VIEW_ID; uses partial file, fsync, atomic rename, and explicit --overwrite; an existing output file is refused with file_exists unless --overwrite is given.
- Id:
view.export.csv· Result:ViewExportCsvResult
mammoth view export dataset
Run one of the SDK's typed 'View.export' destination helpers.
Omit dataset_name unless the user gave one; the product default 'Result Dataset' is used.
mammoth view export dataset 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID of the SOURCE view being exported -- not the destination. Required for this command: pass it here or as the 'dataset_id' input field. To write into an existing destination dataset instead of creating one, use the 'target_ds_id' input field, not this positional. Or the dataset_id input field. |
dataset_name | --input field | no | — | str | |
target_ds_id | --input field | no | — | int | |
save_as_mode | --input field | no | REPLACE_IN_DS | SaveAsDatasetMode | One of REPLACE_IN_DS, APPEND_TO_DS. |
column_mapping | --input field | no | — | dict[str, str] | |
label_ids | --input field | no | — | list[int] | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
timeout | --input field | no | — | int | |
target_project_id | --input field | no | — | int | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
blank_columns | --input field | no | — | list[str] |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Mutation class dynamic: benign_mutation for a new target, destructive when replacing an existing target. Omit dataset_name unless the user gave one; the product default 'Result Dataset' is used (never invent a name such as the view's name). The export is appended to the source pipeline (end_of_pipeline) and re-runs with it; target_project_id sends the dataset into another project (cross-project branch-out, proven on release). Result: {dataset_id, project_id, source_view_id, next}. Not a plain copy: this leaves a live export on the source and the new dataset refreshes from the source view, so keep that working view and name it as the new dataset's source. For an independent copy of a dataset use dataset create with ds_creation_type clone. Writing into an existing dataset (target_ds_id, save_as_mode APPEND_TO_DS or REPLACE_IN_DS; both run the same backend append code, so both get these guards): omit column_mapping and every column is mapped by name; a non-empty column_mapping is used as-is, so it must map every source column to an existing target column, and a partial mapping or an unknown destination is refused (append_mapping_incomplete) before anything is written. A target column that nothing fills (a column the source view lacks and column_mapping does not target) would be NULL in every appended row: refused (append_leaves_columns_blank) unless the input lists exactly those column names in blank_columns (a blanket true or a different list is refused); the confirmed blanks are named in row_check.warnings. Do not reshape the source view to dodge this. A mapped pair of different types is reported in row_check.warnings. A new dataset (no target_ds_id) leaves out the view's hidden columns; they are named in row_check.warnings. To stack two datasets (a union, new rows below the old): there is no union step, so export the second dataset's view into the first with save_as_mode APPEND_TO_DS and target_ds_id the first dataset (columns are matched by name). The export stays a step of the source view and runs again when that view's pipeline re-runs, so after a refresh check the target's row count for rows added twice. A real union step needs backend work.
- Id:
view.export.dataset· Result:ViewExportDatasetResult
mammoth view export delete
Delete one export by id. Always requires '--yes'.
mammoth view export delete 123 456 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
EXPORT_ID | positional | yes | — | int | ID of the export. |
skip_validation | --input field | no | — | bool | |
dataset_id | --input field | no | — | int |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: Required inputs: DATAVIEW_ID, EXPORT_ID.
- Id:
view.export.delete· Result:ViewExportDeleteResult· Backed by: SDKmammoth.api.exports.ExportsAPI.delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id}(DeleteExport)
mammoth view export download
Download a dataview to a local file as csv, xlsx, json, ndjson, xml, yaml or parquet.
mammoth view export download 123 --input '{"file_type": "xml"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
output_path | --input field | no | — | str | Path | None | |
file_type | --input field | no | csv | Literal['csv', 'xlsx', 'json', 'ndjson', 'xml', 'yaml', 'parquet'] | One of csv, xlsx, json, ndjson, xml, yaml, parquet. |
timeout | --input field | no | 300 | int | |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: SDK target for view export download VIEW_ID. The format goes in the input, e.g. mammoth view export download 123 --input '{"file_type": "xlsx"}' (csv, xlsx, json, ndjson, xml, yaml or parquet; csv by default). Uses partial file, fsync, atomic rename, and explicit --overwrite; an existing output file is refused with file_exists unless --overwrite is given.
- Id:
view.export.download· Result:ViewExportDownloadResult
mammoth view export elasticsearch
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export elasticsearch 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
host | --input field | yes | — | str | |
username | --input field | yes | — | str | |
password | --input field | yes | — | str | |
index | --input field | yes | — | str | |
port | --input field | no | 9243 | int | |
connection | --input field | no | https | str | |
chunksize | --input field | no | 200 | int | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Validate protocol and positive chunk size.
- Id:
view.export.elasticsearch· Result:ViewExportElasticsearchResult
mammoth view export email
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export email 123 456 --input '{"emails": ["recipient@example.com"]}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
emails | --input field | yes | — | list[str] | |
subject | --input field | no | — | str | |
message | --input field | no | — | str | |
resource | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Outbound email stays contract-only until a dedicated sink and recipient allowlist exist.
- Id:
view.export.email· Result:ViewExportEmailResult
mammoth view export ftp
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export ftp 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
domain | --input field | yes | — | str | |
directory | --input field | yes | — | str | |
file | --input field | yes | — | str | |
username | --input field | yes | — | str | |
password | --input field | yes | — | str | |
port | --input field | no | 21 | int | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Required inputs: VIEW_ID.
- Id:
view.export.ftp· Result:ViewExportFtpResult
mammoth view export get
Get one export by id.
mammoth view export get 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
EXPORT_ID | positional | yes | — | int | ID of the export. |
fields | --input field | no | — | str | |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DATAVIEW_ID, EXPORT_ID.
- Id:
view.export.get· Result:ViewExportGetResult· Backed by: SDKmammoth.api.exports.ExportsAPI.get, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id}(GetPipelineExport)
mammoth view export list
List exports for a dataview, with optional filters from '--input'.
mammoth view export list 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
DATASET_ID | positional | no | — | int | Optional parent dataset ID; avoids parent discovery when supplied. Or the dataset_id input field. |
fields | --input field | no | — | str | |
limit | --input field | no | 50 | int | |
offset | --input field | no | 0 | int | |
sort | --input field | no | — | str | |
sequence | --input field | no | — | int | |
status | --input field | no | — | ExportStatus | One of deleted, executed, executing, edited, added, suspended, suspending. |
reordered | --input field | no | — | bool | |
handler_type | --input field | no | — | HandlerType | One of postgres, csv_file, s3, mysql, mssql, ftp, sftp, email, elasticsearch, powerbi, redshift, bigquery, internal_dataset, publishdb, azure_blob, sharepoint, onedrive, tableau_server, generic_rest_api_export. |
end_of_pipeline | --input field | no | — | bool | |
runnable | --input field | no | — | bool | |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none · Pages:offset - Preconditions: Lists the saved exports of one view (internal datasets, databases, cloud storage, REST); read-only.
- Id:
view.export.list· Result:ViewExportListResult· Backed by: SDKmammoth.api.exports.ExportsAPI.list, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports(GetPipelineExports)
mammoth view export live-link
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export live-link 123 456 --input '{"file_name": "report_share.csv"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
file_name | --input field | no | — | str | |
file_type | --input field | no | csv | ExportFileType | One of csv, json, parquet. |
include_hidden | --input field | no | false | bool | |
timeout | --input field | no | — | int | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Needs a plan that includes live links; the backend's refusal is returned as is.
- Id:
view.export.live-link· Result:ViewExportLiveLinkResult
mammoth view export managed-s3
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export managed-s3 123 456 --input '{"file_name": "report.csv"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
file_name | --input field | no | — | str | |
file_type | --input field | no | csv | ExportFileType | One of csv, json, parquet. |
include_hidden | --input field | no | false | bool | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Alias
view export s3. A download-only destination starts and waits; any other destination sends data outside Mammoth and needs confirmation. - Id:
view.export.managed-s3· Result:ViewExportManagedS3Result
mammoth view export mssql
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export mssql 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
host | --input field | yes | — | str | |
port | --input field | yes | — | int | |
database | --input field | yes | — | str | |
table | --input field | yes | — | str | |
username | --input field | yes | — | str | |
password | --input field | yes | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any | |
replace_table | --input field | no | false | bool |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Drops and recreates the destination table on this export and on every later run of the view's pipeline (any existing table of that name is lost); refused unless the input sets replace_table to true (replace_table_not_acknowledged). The result carries refreshes_on_pipeline_run and a note saying so.
- Id:
view.export.mssql· Result:ViewExportMssqlResult
mammoth view export mysql
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export mysql 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
host | --input field | yes | — | str | |
port | --input field | yes | — | int | |
database | --input field | yes | — | str | |
table | --input field | yes | — | str | |
username | --input field | yes | — | str | |
password | --input field | yes | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any | |
replace_table | --input field | no | false | bool |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Drops and recreates the destination table on this export and on every later run of the view's pipeline (any existing table of that name is lost); refused unless the input sets replace_table to true (replace_table_not_acknowledged). The result carries refreshes_on_pipeline_run and a note saying so. Table names over 60 characters are refused (table_name_too_long): the database export would cut them and write a different table.
- Id:
view.export.mysql· Result:ViewExportMysqlResult
mammoth view export onedrive
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export onedrive 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
tenant_id | --input field | yes | — | str | |
client_id | --input field | yes | — | str | |
client_secret | --input field | yes | — | str | |
user_id | --input field | yes | — | str | |
folder_path | --input field | no | — | str | |
file_name | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Required inputs: VIEW_ID.
- Id:
view.export.onedrive· Result:ViewExportOnedriveResult
mammoth view export postgres
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export postgres 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
host | --input field | yes | — | str | |
port | --input field | yes | — | int | |
database | --input field | yes | — | str | |
table | --input field | yes | — | str | |
username | --input field | yes | — | str | |
password | --input field | yes | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any | |
replace_table | --input field | no | false | bool |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Drops and recreates the destination table on this export and on every later run of the view's pipeline (any existing table of that name is lost); refused unless the input sets replace_table to true (replace_table_not_acknowledged). The result carries refreshes_on_pipeline_run and a note saying so. Table names over 60 characters are refused (table_name_too_long): the database export would cut them and write a different table.
- Id:
view.export.postgres· Result:ViewExportPostgresResult
mammoth view export powerbi
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export powerbi 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
username | --input field | yes | — | str | |
password | --input field | yes | — | str | |
client_id | --input field | yes | — | str | |
dataset | --input field | yes | — | str | |
table | --input field | yes | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Needs the Power BI account username and password, the Azure AD app's client_id, and the target Power BI dataset and table; the password is a secret field, so pass it in the request file, never in argv. Becomes a persistent pipeline step, like 'view export dataset'; the target refreshes automatically every time the source view's pipeline reruns, not just once at call time.
- Id:
view.export.powerbi· Result:ViewExportPowerbiResult
mammoth view export publish-db
Publish a dataview to a database endpoint. Always requires '--yes'.
mammoth view export publish-db 123 --input '{"odbc_type": "postgres", "target_properties": {"name": "Status"}}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
odbc_type | --input field | yes | — | OdbcType | One of postgres, bigquery. |
target_properties | --input field | yes | — | dict[str, any] | |
dataset_id | --input field | no | — | int | |
replace_table | --input field | no | false | bool |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: Becomes a persistent pipeline step, like 'view export dataset'; the published target refreshes automatically every time the source view's pipeline reruns, not just once at call time. It drops and recreates the destination table each time (any existing table of that name is lost), so it is refused unless the input sets replace_table to true (replace_table_not_acknowledged).
- Id:
view.export.publish-db· Result:ViewExportPublishDbResult· Backed by: SDKmammoth.api.exports.ExportsAPI.publish_db, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/publish-to-db(CreatePublishToDb)
mammoth view export publish-db-update
Patch a dataview's published database endpoint. Always requires '--yes'.
mammoth view export publish-db-update 123 --input '{"patch": [{"op": "replace", "path": "credentials", "value": {"odbc_type": "postgres"}}]}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
patch | --input field | yes | — | list[dict[str, any]] | |
dataset_id | --input field | no | — | int |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
view.export.publish-db-update· Result:ViewExportPublishDbUpdateResult· Backed by: SDKmammoth.api.exports.ExportsAPI.publish_db_update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/publish-to-db(UpdatePublishToDb)
mammoth view export redshift
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export redshift 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
host | --input field | yes | — | str | |
port | --input field | yes | — | int | |
database | --input field | yes | — | str | |
table | --input field | yes | — | str | |
username | --input field | yes | — | str | |
password | --input field | yes | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any | |
replace_table | --input field | no | false | bool |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Drops and recreates the destination table on this export and on every later run of the view's pipeline (any existing table of that name is lost); refused unless the input sets replace_table to true (replace_table_not_acknowledged). The result carries refreshes_on_pipeline_run and a note saying so.
- Id:
view.export.redshift· Result:ViewExportRedshiftResult
mammoth view export rest
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export rest 123 456 --input '{"base_url": "https://api.example", "endpoint_path": "/records"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
base_url | --input field | yes | — | str | |
endpoint_path | --input field | yes | — | str | |
auth_type | --input field | no | none | RestAuthType | One of none, api_key, bearer, basic, oauth2_authorization_code. |
http_method | --input field | no | POST | HttpMethod | One of POST, PUT, PATCH. |
wrap_path | --input field | no | records | str | |
batch_size | --input field | no | 1000 | int | |
timeout_seconds | --input field | no | 30 | int | |
ssl_verify | --input field | no | true | bool | |
auth | --input field | no | — | dict[str, any] | |
headers | --input field | no | — | dict[str, str] | |
query_params | --input field | no | — | dict[str, str] | |
extra_body_fields | --input field | no | — | dict[str, any] | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Type all auth variants, reject secrets in static headers/query/body, allow insecure TLS only with --yes.
- Id:
view.export.rest· Result:ViewExportRestResult
mammoth view export rest-fill
Propose REST API export settings from an API docs page. Always requires '--yes'.
mammoth view export rest-fill 123 456 --input '{"docs_url": "https://example.com/data.csv"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
docs_url | --input field | yes | — | str | |
notes | --input field | no | — | str | |
dataset_id | --input field | no | — | int |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Makes Mammoth's server fetch the docs URL and propose REST export settings; nothing is configured or sent. Needs --yes.
- Id:
view.export.rest-fill· Result:ViewExportRestFillResult· Backed by: SDKmammoth.api.exports.ExportsAPI.rest_fill, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/rest-fill(Suggest)
mammoth view export runs
Get the run history of one export, newest first: when, rows, destination, errors.
mammoth view export runs 123 456 789
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
EXPORT_ID | positional | yes | — | int | ID of the export. |
DATASET_ID | positional | no | — | int | Optional parent dataset ID; avoids parent discovery when supplied. Or the dataset_id input field. |
limit | --input field | no | 20 | int | |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DATAVIEW_ID, EXPORT_ID.
- Id:
view.export.runs· Result:ViewExportRunsResult· Backed by: SDKmammoth.api.exports.ExportsAPI.runs, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id}/runs(ListExportRuns)
mammoth view export sftp
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export sftp 123 456 --input '{"host": "sftp.example", "username": "agent"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
host | --input field | yes | — | str | |
username | --input field | yes | — | str | |
password | --input field | no | — | str | |
directory | --input field | no | — | str | |
file_name | --input field | no | — | str | |
port | --input field | no | 22 | int | |
randomize_file_name | --input field | no | false | bool | |
ssh_key_authentication | --input field | no | false | bool | |
private_key | --input field | no | — | str | |
passphrase | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Enforce authentication-mode union (password vs key) and forbid irrelevant secrets.
- Id:
view.export.sftp· Result:ViewExportSftpResult
mammoth view export sharepoint
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export sharepoint 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
tenant_id | --input field | yes | — | str | |
client_id | --input field | yes | — | str | |
client_secret | --input field | yes | — | str | |
site_url | --input field | yes | — | str | |
document_library | --input field | no | Documents | str | |
folder_path | --input field | no | — | str | |
file_name | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Validate site URL.
- Id:
view.export.sharepoint· Result:ViewExportSharepointResult
mammoth view export tableau
Run one of the SDK's typed 'View.export' destination helpers.
mammoth view export tableau 123 456 --input /private/path/request.json --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to export. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
server_url | --input field | yes | — | str | |
token_name | --input field | yes | — | str | |
token_secret | --input field | yes | — | str | |
site_name | --input field | no | — | str | |
project_name | --input field | no | Default | str | |
datasource_name | --input field | no | mammoth_export | str | |
ca_bundle_path | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
trigger_type | --input field | no | — | any | |
run_immediately | --input field | no | — | bool | |
validate_only | --input field | no | — | bool | |
end_of_pipeline | --input field | no | — | bool | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | any |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Prohibit secret in CA bundle file.
- Id:
view.export.tableau· Result:ViewExportTableauResult
mammoth view export update
Edit an export: a merge over the stored one, still pinned to the pipeline end.
mammoth view export update 123 456 --input '{"patches": [{"name": "Status"}]}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
EXPORT_ID | positional | yes | — | int | ID of the export. |
patches | --input field | yes | — | list[dict[str, any]] | |
skip_validation | --input field | no | — | bool | |
dataset_id | --input field | no | — | int | |
save_as_mode | --input field | no | — | str | |
target_properties | --input field | no | — | dict[str, any] | |
additional_properties | --input field | no | — | dict[str, any] | |
condition | --input field | no | — | dict[str, any] | |
trigger_type | --input field | no | — | str | |
handler_type | --input field | no | — | str | |
end_of_pipeline | --input field | no | — | bool | |
sequence | --input field | no | — | int | |
run_immediately | --input field | no | — | bool | |
schedule | --input field | no | — | dict[str, any] | |
send_window | --input field | no | — | dict[str, any] |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: Merge-style: --input is the fields to change (save_as_mode, target_properties, additional_properties, condition, end_of_pipeline, sequence, run_immediately, schedule, send_window) or {"patches": [...]}. A replace of params keeps what it leaves out from the stored export and keeps the export pinned to the end of the pipeline unless it sets end_of_pipeline false (sequence null means pinned; a number unpins, and a sequence without end_of_pipeline false is refused). The stored schedule and send_window are sent back with the edit. A command patch needs no value: {"op":"command","path":"run"} (also suspend, restore, discard).
- Id:
view.export.update· Result:ViewExportUpdateResult· Backed by: SDKmammoth.api.exports.ExportsAPI.update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id}(EditExport)
view exportable-config
mammoth view exportable-config apply
Apply exactly one exportable config or clipboard item list.
mammoth view exportable-config apply 123 456 --input-format json --input '{"config": {"tasks": []}}' --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the dataview. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
items | --input field | no | — | list[dict[str, any]] | |
config | --input field | no | — | dict[str, any] | |
insert_after_sequence | --input field | no | — | int | |
is_paste_mode | --input field | no | false | bool |
- Effect: Reversible pipeline step, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Exactly one of items or config is required; explicit dataset parent is preferred. config must be the full document returned by view exportable-config get (metadata, display_properties, dependencies, tasks, checkpoints, derivatives, data_checks) with your edits applied; the job rejects a bare {"tasks": []} (verified on release 2026-09-19). Round-trip get -> edit -> apply.
- Id:
view.exportable-config.apply· Result:ViewExportableConfigApplyResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.apply_exportable_config, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/exportable-config(ApplyExportableConfig)
mammoth view exportable-config get
Get a dataview's exportable pipeline configuration.
mammoth view exportable-config get 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the dataview. |
DATASET_ID | positional | no | — | int | Optional parent dataset ID; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: View-centric read; dataset_id may be supplied as the explicit parent.
- Id:
view.exportable-config.get· Result:ViewExportableConfigGetResult· Backed by: SDKmammoth.api.dataviews.DataviewsAPI.get_exportable_config, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/exportable-config(GetExportableConfig)
view pipeline
mammoth view pipeline edit
Apply JSON Patch operations to a dataview's pipeline. 'patches' required.
mammoth view pipeline edit 123 --input '{"patches": [{"op": "replace", "path": "auto_run", "value": true}]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
patches | --input field | yes | — | list[dict[str, any]] | |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Strict nonempty patches; each allowed path has a discriminated model and its own safety class (operation-dependent).
- Id:
view.pipeline.edit· Result:ViewPipelineEditResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.edit_pipeline, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline(EditPipeline)
mammoth view pipeline get
Get a dataview's full pipeline.
mammoth view pipeline get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
view.pipeline.get· Result:ViewPipelineGetResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.get_pipeline, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline(GetPipeline)
mammoth view pipeline items
List a dataview's pipeline items, with optional filters from '--input'.
mammoth view pipeline items 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str | |
limit | --input field | no | — | int | |
offset | --input field | no | — | int | |
sort | --input field | no | — | str | |
sequence | --input field | no | — | int | |
status | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Requires the exact parent dataset_id through --input; follow and validate every next-page URL before counting saved task definitions. The CLI does not paginate automatically.
- Id:
view.pipeline.items· Result:ViewPipelineItemsResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.items, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/items(GetPipelineItems)
mammoth view pipeline items-all
Read all pipeline items through bounded, exact-parent pagination.
mammoth view pipeline items-all 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID; pass it via the 'dataset_id' input field. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str | |
limit | --input field | no | 100 | int | |
sort | --input field | no | — | str | |
sequence | --input field | no | — | int | |
status | --input field | no | — | str | |
max_pages | --input field | no | 1000 | int |
- Effect: Read, scope
project· Confirmation: none · Pages:offset - Preconditions: Reuses the exact-parent items route with bounded offset pagination; rejects repeated/non-advancing pages and excessive page counts. The CLI view.pipeline.items command remains single-page.
- Id:
view.pipeline.items-all· Result:ViewPipelineItemsAllResult
mammoth view pipeline rerun
Rerun a dataview's pipeline, optionally from a given sequence.
mammoth view pipeline rerun 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
from_sequence | --input field | no | — | int | |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: A rerun fires every end-of-pipeline export of the view again (database, email, REST, dataset); the result lists them in exports_fired (export_id, handler_type, target) so the external effect is visible. --dry-run returns the same exports_fired without running. An internal_dataset export that appends or replaces into an existing dataset also carries blank_columns: the sorted destination column names the write would leave NULL ([] when none).
- Id:
view.pipeline.rerun· Result:ViewPipelineRerunResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.rerun, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/rerun(RerunFromSequence)
mammoth view pipeline wait
Wait for a dataview's pipeline to finish running.
mammoth view pipeline wait 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
dataset_id | --input field | no | — | int | |
timeout | --input field | no | — | float | |
poll_interval | --input field | no | 0.5 | float |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Global --pipeline-timeout supplies timeout; do not expose poll_interval in v1.
- Id:
view.pipeline.wait· Result:ViewPipelineWaitResult
view task
mammoth view task add
Add a pipeline task to a dataview. 'task_spec' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view task add 123 --input '{"task_spec": {"DATAVIEW_ID": 123, "SEQUENCE_NUMBER": 1, "COPY": [{"SOURCE": "column_1", "AS": {"COLUMN": "Copy of column 1", "TYPE": "TEXT", "INTERNAL_NAME": "column_9"}}], "VERSION": 2}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
task_spec | --input field | yes | — | dict[str, Any] | list[dict[str, Any]] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Strict task discriminated union only.
- Id:
view.task.add· Result:ViewTaskAddResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.add_task, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks(AddTask)
mammoth view task delete
Delete one pipeline task by id. Prompt or '--yes' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view task delete 123 456 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
TASK_ID | positional | yes | — | int | ID of the task. |
dataset_id | --input field | no | — | int |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Prompt or --yes.
- Id:
view.task.delete· Result:ViewTaskDeleteResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.delete_task, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id}(DeleteTask)
mammoth view task get
Get one pipeline task by id.
mammoth view task get 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
TASK_ID | positional | yes | — | int | ID of the task. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Requires the exact parent dataset_id through --input; do not rely on implicit parent discovery when reconciling saved task definitions.
- Id:
view.task.get· Result:ViewTaskGetResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.get_task, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id}(GetPipelineTask)
mammoth view task list
List a dataview's pipeline tasks.
mammoth view task list 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
dataset_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: single_page until B5; no --all until continuation is proven. Requires the exact parent dataset_id through --input; do not rely on implicit parent discovery for saved-task reads.
- Id:
view.task.list· Result:ViewTaskListResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.list_tasks, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks(GetPipelineTasks)
mammoth view task preview
Preview the effect of a pipeline task without persisting it. 'task_spec' required.
mammoth view task preview 123 --input '{"task_spec": {"DATAVIEW_ID": 123, "SEQUENCE_NUMBER": 1, "COPY": [{"SOURCE": "column_1", "AS": {"COLUMN": "Copy of column 1", "TYPE": "TEXT", "INTERNAL_NAME": "column_9"}}], "VERSION": 2}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
task_spec | --input field | yes | — | dict[str, any] | |
dataset_id | --input field | no | — | int | |
sample_size | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
view.task.preview· Result:ViewTaskPreviewResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.preview_task, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/task_preview(GetTaskPreview)
mammoth view task preview-cancel
Cancel a task preview job that newer settings of the task replaced.
mammoth view task preview-cancel 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
JOB_ID | positional | yes | — | int | ID of the job. |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DATAVIEW_ID, JOB_ID.
- Id:
view.task.preview-cancel· Result:ViewTaskPreviewCancelResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.preview_cancel, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/task_preview/{job_id}(CancelTaskPreview)
mammoth view task update
Update one pipeline task by id. 'task_spec' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view task update 123 456 --input '{"task_spec": {"DATAVIEW_ID": 123, "SEQUENCE_NUMBER": 1, "COPY": [{"SOURCE": "column_1", "AS": {"COLUMN": "Copy of column 1", "TYPE": "TEXT", "INTERNAL_NAME": "column_9"}}], "VERSION": 2}, "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
TASK_ID | positional | yes | — | int | ID of the task. |
task_spec | --input field | no | — | dict[str, any] | |
dataset_id | --input field | no | — | int | |
patches | --input field | no | — | list[dict[str, any]] | |
skip_validation | --input field | no | — | bool |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Strict replacement task union. task_spec may be the params
view task getreturns: the server-written keys (EXECUTION_TIMESTAMP, TASK_NAMESPACE) are dropped before the send and TASK_KEY is kept (the server ignores it). A refusal names the keys sent beyond the envelope. To change a SQL step: get the task, edit task_spec.SQL.QUERY (keep DATAVIEW_ID and SEQUENCE_NUMBER), send it back. - Id:
view.task.update· Result:ViewTaskUpdateResult· Backed by: SDKmammoth.api.pipeline.PipelineAPI.update_task, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id}(EditTask)
view transform
mammoth view transform add-column
Add a new column. 'name' is required; 'column_type' is optional.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform add-column 123 --input '{"name": "Revenue report", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
name | --input field | yes | — | str | |
column_type | --input field | no | TEXT | ColumnType | One of TEXT, NUMERIC, DATE. |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view get VIEW_IDto confirm the new column name is unused and the types of any column it is built from. - Id:
view.transform.add-column· Result:ViewTransformAddColumnResult
mammoth view transform add-sql
Add a column via a raw SQL expression. 'query' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform add-sql 123 --input '{"query": "SELECT region, SUM(revenue) AS revenue FROM \"view:123\" GROUP BY region", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
query | --input field | yes | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Single-view SQL: the only table is "view:VIEW_ID" (the view the task is added to); a second view in FROM or JOIN is rejected (5GENR010 "only one table allowed"), use view transform join for that. UNION ALL over the same view, CASE, DATE_TRUNC, GROUP BY and COUNT(DISTINCT ...) run on release. Result columns must be NUMERIC, TEXT or TIMESTAMPTZ: CAST(x AS DATE) is rejected (5GENR010 "Invalid column type DATE"); CAST(x AS TIMESTAMPTZ) or DATE_TRUNC land as a DATE column. The task replaces every column of the view; run it on a copy (view export dataset) when the source columns are still needed. Read the result back with view data get. Evidence: docs/capability-evidence/ilg-sim-20260919. - Id:
view.transform.add-sql· Result:ViewTransformAddSqlResult
mammoth view transform ai
Generate a column with an AI prompt. 'prompt'/'context_columns' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform ai 123 --input '{"prompt": "Summarize revenue by region", "context_columns": ["Status"], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
prompt | --input field | yes | — | str | |
context_columns | --input field | yes | — | list[str] | |
new_column | --input field | no | AI Result | str | |
assistant_data | --input field | no | — | list[str] | |
context_columns_derivation | --input field | no | — | bool | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Standard transformation policy; record addon and data-processing notice in help (data can be processed by an AI feature). - Id:
view.transform.ai· Result:ViewTransformAiResult
mammoth view transform batch
Add several transforms in one request. 'steps' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
Allowed values: steps[].op: filter, sort, limit-rows, discard-duplicates, fill-missing, bulk-replace, replace, text, substring, extract-date, increment-date, repeat-rows, copy-columns, split, unnest, pivot
mammoth view transform batch 123 --input '{"steps": [{"op": "filter", "input": {"condition": {"column": "Cost", "operator": "GTE", "value": 20}}}, {"op": "sort", "input": {"order_by": [["Cost", "DESC"]]}}, {"op": "limit-rows", "input": {"n": 2}}], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
steps | --input field | yes | — | list[dict[str, any]] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Use when several transforms go on one view in a row (filter, then limit, then a sort): one call, one pipeline run, one verified outcome (row_check, and tasks with each new task's transform_status) instead of one call and one run per step. --input: "steps", a list of {"op", "input"}; op is filter, sort, limit-rows, discard-duplicates, fill-missing, bulk-replace, replace, text, substring, extract-date, increment-date, copy-columns, split, unnest or pivot, and input is exactly what that view transform command takes (display names). unnest and pivot replace the view's columns, so they can only be the last step, and no sort step may come before them. Every step is checked against the view's columns as they are NOW before anything is sent, so a step can use a column an earlier step adds (split, copy-columns, or the new_column of substring, extract-date, increment-date) but no other column that does not exist yet. A sort is the view's row order, not a task: it is set after the tasks have run. A batch skips the per-op no-op check (a filter that matches every row still adds its task). If a task fails the batch's tasks are removed, the view is as before, and the error names steps[i] (batch_step_failed). In draft mode the tasks are staged, not run. - Id:
view.transform.batch· Result:ViewTransformBatchResult
mammoth view transform bulk-replace
Bulk-replace values. 'columns'/'mapping' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform bulk-replace 123 --input '{"columns": ["Status"], "mapping": [{"search": ["N/A"], "replace": "Unknown"}], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
columns | --input field | yes | — | list[str] | |
mapping | --input field | yes | — | list[BulkReplaceMapping] | |
match_case | --input field | no | true | bool | |
match_words | --input field | no | false | bool | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Complete flags/defaults/result/draft/undo/live contract is specified in plan 02's 'Complete bulk-replace command contract'; this appendix does not narrow or replace it. columns must be TEXT (metadata[].type from view get): a NUMERIC or DATE column is stored with a type-mismatch reference error, the view enters ref_error and the CLI answers pipeline_reference_error with the view task delete that removes the task. - Id:
view.transform.bulk-replace· Result:ViewTransformBulkReplaceResult
mammoth view transform combine-columns
Combine columns into one. 'sources' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform combine-columns 123 --input '{"sources": ["Status"], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
sources | --input field | yes | — | list[str] | |
new_column | --input field | no | — | str | |
column_type | --input field | no | TEXT | ColumnType | One of TEXT, NUMERIC, DATE. |
existing_column | --input field | no | — | str | |
separator | --input field | no | | str | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Standard transformation policy; reject the SDK's undocumented __literal__: source escape at the CLI boundary. Exactly one of new_column or existing_column is required; both or neither is refused. - Id:
view.transform.combine-columns· Result:ViewTransformCombineColumnsResult
mammoth view transform convert-type
Convert column types. 'conversions' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform convert-type 123 --input '{"conversions": [{"column": "Status", "to": "TEXT"}], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
conversions | --input field | yes | — | list[ConversionSpec] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view data profile VIEW_IDon the column to count values that will not convert (they become empty). A DATE conversion of a text column takes input_formats (list of the layouts it mixes), output_format (display layout) and input_format_preference (uk or us for day/month ambiguity; strict blanks ambiguous day/month values and converts equal-part dates) on the conversions entry; format (python-style date_format) still works. - Id:
view.transform.convert-type· Result:ViewTransformConvertTypeResult
mammoth view transform copy-columns
Copy columns. 'copies' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform copy-columns 123 --input '{"copies": [{"source": "Status"}], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
copies | --input field | yes | — | list[CopySpec] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view get VIEW_IDto confirm the source columns exist and the new names are unused. - Id:
view.transform.copy-columns· Result:ViewTransformCopyColumnsResult
mammoth view transform crosstab
Build a crosstab into a new dataset. 'rows'/'pivot_column'/'select'/
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform crosstab 123 --input '{"rows": ["Region"], "pivot_column": "Product", "select": {"column": "Revenue", "function": "SUM"}, "dataset_name": "Revenue by region", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
rows | --input field | yes | — | list[str] | |
pivot_column | --input field | yes | — | str | |
select | --input field | yes | — | CrosstabSpec | list[CrosstabSpec] | |
dataset_name | --input field | yes | — | str | |
save_as_mode | --input field | no | REPLACE_IN_DS | SaveAsDatasetMode | One of REPLACE_IN_DS, APPEND_TO_DS. |
target_ds_id | --input field | no | — | int | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
timeout | --input field | no | — | int | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Dynamic safety class: new target needs no confirmation, append needs --yes, replacing an existing target needs --yes --confirm TARGET_DS_ID. The crosstab is a standing export on the source view: it rewrites the output dataset on every pipeline run, and the result says so (refreshes_on_pipeline_run, note). A target the view already exports into, the view's own dataset, and a view held in a draft are refused, as for view export dataset. - Id:
view.transform.crosstab· Result:ViewTransformCrosstabResult
mammoth view transform date-diff
Compute the difference between two dates. 'component'/'start'/'end' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform date-diff 123 --input '{"component": "YEAR", "start": "Order Date", "end": "Ship Date", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
component | --input field | yes | — | DateDiffUnit | One of YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, WEEK, QUARTER. |
start | --input field | yes | — | str | |
end | --input field | yes | — | str | |
new_column | --input field | no | — | str | |
existing_column | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). start/end must both be existing DATE columns; there is no today input here. To diff against the current execution time (e.g. days since order), the server task itself supports it but this typed command does not expose it: use view task add with a raw task_spec: {"DATE_DIFF": {"COMPONENT": "DAY", "MINUEND": {"TYPE": "__TIME__"}, "SUBTRAHEND": {"TYPE": "COLUMN", "VALUE": "INTERNAL_COLUMN_NAME"}, "AS": {"COLUMN": "Days Since Order", "TYPE": "NUMERIC", "INTERNAL_NAME": "column_days_since_order"}}}, where INTERNAL_COLUMN_NAME is that column's internal_name from view get (not its display name -- a raw task skips display-name resolution). MINUEND minus SUBTRAHEND; swap them to flip the sign. Evidence: mvc-service api/api/dataview/helpers/validators/date_diff.py (allowed TYPE values COLUMN/VALUE/SYSTEM_TIME) and CommonConstants/dba_const.py KEYWORDS.SYSTEM_TIME = "__TIME__". - Id:
view.transform.date-diff· Result:ViewTransformDateDiffResult
mammoth view transform delete-columns
Delete columns. 'columns' is required. Prompt or '--yes' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform delete-columns 123 --input '{"columns": ["Status"], "dataset_id": 456}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
columns | --input field | yes | — | list[str] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Standard transformation policy; task deletion restores columns only when the task ID is stable. - Id:
view.transform.delete-columns· Result:ViewTransformDeleteColumnsResult
mammoth view transform discard-duplicates
Discard duplicate rows. 'ignore_columns' or 'key_columns' is optional.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform discard-duplicates 123 --input '{"dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
ignore_columns | --input field | no | — | list[str] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int | |
key_columns | --input field | no | — | list[str] |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view data profile VIEW_ID(orview data aggregatecounting rows grouped by the key columns) to count the duplicate rows this will drop. Edits the view in place: to keep the original,view createa copy first. Input: "key_columns" (only these columns decide a duplicate; every other column is ignored) or "ignore_columns" (these columns are left out of the comparison), not both. A batch step takes ignore_columns only. - Id:
view.transform.discard-duplicates· Result:ViewTransformDiscardDuplicatesResult
mammoth view transform extract-date
Extract a date component into a column. 'column'/'component' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform extract-date 123 --input '{"column": "Status", "component": "year", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
column | --input field | yes | — | str | |
component | --input field | yes | — | DateComponent | One of year, month, day, hour, minute, second, week, quarter, weekday, day_of_year, millisecond, weekday_text, month_text, month_year, year_month, year_month_number, year_month_day, year_month_day_as_date, month_day_year, month_day_year_hour_minute_second, hour_minute_second, hour_minute_second_millisecond. |
new_column | --input field | no | — | str | |
existing_column | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view get VIEW_IDto confirm the column type is DATE (run convert-type first if TEXT) andview data getto check a few values. For a month bucket useyear_month_number("2026-10"), which sorts in time order;year_month("2026, October") sorts alphabetically on a chart axis. - Id:
view.transform.extract-date· Result:ViewTransformExtractDateResult
mammoth view transform fill-missing
Fill missing values. 'column'/'direction' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform fill-missing 123 --input '{"column": "Status", "direction": "FIRST_VALUE", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
column | --input field | yes | — | str | |
direction | --input field | yes | — | FillDirection | One of FIRST_VALUE, LAST_VALUE. |
partition_by | --input field | no | — | str | |
order_by | --input field | no | — | list[list[str | SortDirection]] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view data profile VIEW_IDfor the blank count of the column, so the result can be compared to it. - Id:
view.transform.fill-missing· Result:ViewTransformFillMissingResult
mammoth view transform filter
Filter rows. 'condition' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform filter 123 --input '{"condition": {"column": "Status", "operator": "EQ", "value": "Active"}, "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
condition | --input field | yes | — | Condition | CompoundCondition | NotCondition | |
filter_type | --input field | no | SHOW | FilterType | One of SHOW, REMOVE. |
prompt | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first: count the rows that match withview data aggregateusing the same condition, and the total with no condition. - Id:
view.transform.filter· Result:ViewTransformFilterResult
mammoth view transform first-name
Extract the first word of a text column, in one call. 'column' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform first-name 123 --input '{"column": "Name", "new_column": "First name", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
column | --input field | yes | — | str | |
new_column | --input field | no | — | str | |
existing_column | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Use for "extract the first name" or the first word of a text column. --input: "column" (a TEXT column, required) and exactly one of "new_column" or "existing_column". Takes the text up to the first space. One call: if the view is in draft mode the step is staged (status staged) and the draft stays unsubmitted, whether or not it already held staged steps; run view draft submit when that is intended. Outside draft mode the result waits on this step's own run (run.transform_status DONE), not on the pipeline reading ready. - Id:
view.transform.first-name· Result:ViewTransformFirstNameResult
mammoth view transform generate-sql
Generate a SQL query from a natural-language intent. 'intent' is required.
mammoth view transform generate-sql 123 --input '{"intent": "Summarize revenue by region", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
intent | --input field | yes | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Writes and validates a SQL query from the intent and returns it as data.sql; it does not change the view (release, 2026-09-25: no task was added). Apply the query with view transform add-sql (data.apply is the exact command); add-sql replaces the view's columns with the result.
- Id:
view.transform.generate-sql· Result:ViewTransformGenerateSqlResult
mammoth view transform increment-date
Increment a date column. 'column'/'delta' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform increment-date 123 --input '{"column": "Status", "delta": {}, "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
column | --input field | yes | — | str | |
delta | --input field | yes | — | DateDelta | |
new_column | --input field | no | — | str | |
existing_column | --input field | no | — | str | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view get VIEW_IDto confirm the column type is DATE, andview data getto check a few values. - Id:
view.transform.increment-date· Result:ViewTransformIncrementDateResult
mammoth view transform join
Join another view. 'foreign_view'/'join_type'/'on'/'select' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform join 123 --input '{"foreign_view": 1, "join_type": "INNER", "on": [{"left": "Customer ID", "right": "Customer ID"}], "select": ["Region"], "dataset_id": 456, "foreign_dataset_id": 457}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
foreign_view | --input field | yes | — | int | View | |
join_type | --input field | yes | — | JoinType | One of INNER, LEFT, RIGHT, OUTER. |
on | --input field | yes | — | list[JoinKeySpec] | |
select | --input field | yes | — | list[str | JoinSelectSpec] | |
column_prefix | --input field | no | — | str | |
foreign_dataset_id | --input field | no | — | int | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first: read both key columns (view data get,view data profile) and run this with--dry-runforjoin_preview.match_rate. - Id:
view.transform.join· Result:ViewTransformJoinResult
mammoth view transform json-extract
Extract fields from a JSON column. 'column' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform json-extract 123 --input '{"column": "Status", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
column | --input field | yes | — | str | |
json_type | --input field | no | OBJECT | JsonType | One of OBJECT, LIST. |
keys | --input field | no | — | list[str] | |
extractions | --input field | no | — | list[JsonExtractionSpec] | |
keep_source | --input field | no | false | bool | |
op_type | --input field | no | — | JsonOpType | One of JSON_OBJECT_TO_COLUMNS, JSON_LIST_TO_ROWS. |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). json_type=LIST (JSON_LIST_TO_ROWS) gives one row per list element, landing in an Item column (plus an Index column for its original position); with no keys/extractions this is the default. An object element does not get columns from this call -- run a second json-extract (json_type=OBJECT) on Item to turn its keys into columns. An extraction key is one object key (a string) or a path to a nested value, a non-empty JSON list of keys (strings) and array indexes (integers from 0), for example "key" ["company", "location", "country"] or ["orders", 0, "total"]. A path with no as_name names its column company.location.country. - Id:
view.transform.json-extract· Result:ViewTransformJsonExtractResult
mammoth view transform limit-rows
Limit the row count. 'n' (or its alias 'limit') is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform limit-rows 123 --input '{"n": 1, "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
n | --input field | yes | — | int | |
bottom | --input field | no | false | bool | |
order_by | --input field | no | — | list[list[str | SortDirection]] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view get VIEW_IDfor the current row count, so the row count after can be checked against N.limitis accepted as an alias ofn; give one, not both. - Id:
view.transform.limit-rows· Result:ViewTransformLimitRowsResult
mammoth view transform lookup
Look up values from another view. 'source'/'lookup_view_id'/'key'/
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform lookup 123 --input '{"source": "Customer ID", "lookup_view_id": 1, "key": "Customer ID", "value": "Region", "new_column": "Region", "dataset_id": 456, "lookup_dataset_id": 457}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
source | --input field | yes | — | str | |
lookup_view_id | --input field | yes | — | int | View | |
key | --input field | yes | — | str | |
value | --input field | yes | — | str | |
new_column | --input field | no | — | str | |
new_column_type | --input field | no | TEXT | str | |
existing_column | --input field | no | — | str | |
lookup_dataset_id | --input field | no | — | int | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first: read both key columns (view data get,view data profile); the lookup view must have one row per key. Exactly one of new_column or existing_column is required; both or neither is refused. - Id:
view.transform.lookup· Result:ViewTransformLookupResult
mammoth view transform math
Evaluate a math expression into a column. 'expression' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform math 123 --input '{"expression": "price * quantity", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
expression | --input field | yes | — | str | |
new_column | --input field | no | — | str | |
column_type | --input field | no | NUMERIC | ColumnType | One of TEXT, NUMERIC, DATE. |
existing_column | --input field | no | — | str | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view get VIEW_IDfor the types of the columns in the expression, and run it with--dry-runto validate the expression. Exactly one of new_column or existing_column is required; both or neither is refused. A parameter is written {name} in the expression (a project or workspace parameter of that name; an unknown name is refused): the step uses its value and re-runs when the value changes. - Id:
view.transform.math· Result:ViewTransformMathResult
mammoth view transform pivot
Pivot with aggregations. 'group_by'/'aggregations' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform pivot 123 --input '{"group_by": ["Region"], "aggregations": [{"column": "Revenue", "function": "SUM"}], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
group_by | --input field | yes | — | list[str] | |
aggregations | --input field | yes | — | list[AggregationSpec] | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Replaces the view's columns with the summary, so run it last (export rows first). Every as_name must be a display name that does not already exist on the view (4DTVW018 SAME_DISPLAY_NAME_CANNOT_BE_REUSED): aggregate a joined column under a new name. - Id:
view.transform.pivot· Result:ViewTransformPivotResult
mammoth view transform rename-columns
Rename columns (a view display setting, not a task). 'renames' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform rename-columns 123 --input '{"renames": {"cust_id": "Customer ID"}, "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
renames | --input field | yes | — | dict[str, str] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). A view display setting (the web grid's column rename), not a pipeline task: it changes no data and adds no task. - Id:
view.transform.rename-columns· Result:ViewTransformRenameColumnsResult
mammoth view transform repeat-rows
Repeat every row. Exactly one of 'times', 'values' or 'series' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform repeat-rows 123 --input '{"dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
times | --input field | no | — | int | |
values | --input field | no | — | list[str | int | float] | |
series | --input field | no | — | RepeatSeries | |
new_column | --input field | no | — | str | |
new_column_type | --input field | no | — | ColumnType | One of TEXT, NUMERIC, DATE. |
existing_column | --input field | no | — | str | |
keep_original | --input field | no | — | bool | |
order | --input field | no | — | RepeatOrder | One of GROUPED, INTERLEAVED. |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Adds rows: the view ends with its row count times the copies. Give exactly one of times (2 to 10000 copies, writes no column), values (1 to 1000 unique values; TEXT or NUMERIC) or series (a date range: start, end, delta of one of years, months, weeks, days; or a number range: start, end, step above 0). values and series need exactly one of new_column or existing_column (new_column_type TEXT or NUMERIC for values; a series implies DATE or NUMERIC). keep_original is for values into existing_column only. order (GROUPED or INTERLEAVED) is not for times. A series bound may be {"kind": "START_OF_YEAR"} or {"kind": "EARLIEST", "column": "<date column>"} for start and {"kind": "TODAY"} for end. No condition. Observe first:view get VIEW_IDfor the row count, since the result is limited to 10 million rows. - Id:
view.transform.repeat-rows· Result:ViewTransformRepeatRowsResult
mammoth view transform replace
Find and replace values. 'columns'/'find'/'replace' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform replace 123 --input '{"columns": ["Status"], "find": "N/A", "replace": "Unknown", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
columns | --input field | yes | — | list[str] | |
find | --input field | yes | — | str | |
replace | --input field | yes | — | str | |
match_case | --input field | no | false | bool | |
match_words | --input field | no | false | bool | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). columns must be TEXT (metadata[].type from view get): a NUMERIC or DATE column is stored with a type-mismatch reference error, the view enters ref_error and the CLI answers pipeline_reference_error with the view task delete that removes the task. - Id:
view.transform.replace· Result:ViewTransformReplaceResult
mammoth view transform set-values
Set values conditionally. 'values' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform set-values 123 --input '{"values": [{"value": "Unknown"}], "existing_column": "Status", "condition": {"column": "Status", "operator": "IS_EMPTY"}, "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
values | --input field | yes | — | list[SetValue] | |
new_column | --input field | no | — | str | |
column_type | --input field | no | TEXT | ColumnType | One of TEXT, NUMERIC, DATE. |
existing_column | --input field | no | — | str | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first: count the rows the condition matches withview data aggregateusing the same condition. Exactly one of new_column or existing_column is required; both or neither is refused. - Id:
view.transform.set-values· Result:ViewTransformSetValuesResult
mammoth view transform small-large
Compute a small/large-N function. 'function'/'columns' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform small-large 123 --input '{"function": "SMALL", "columns": ["Status"], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
function | --input field | yes | — | SmallLargeFunction | One of SMALL, LARGE. |
columns | --input field | yes | — | list[str] | |
index | --input field | no | 1 | int | |
constants | --input field | no | — | list[float] | |
new_column | --input field | no | — | str | |
existing_column | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view data profile VIEW_IDon the column to see its type and range. - Id:
view.transform.small-large· Result:ViewTransformSmallLargeResult
mammoth view transform sort
Set the view's row order (a display setting, not a task). 'order_by' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform sort 123 --input '{"order_by": [["Revenue", "DESC"]], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
order_by | --input field | yes | — | list[list[str | SortDirection]] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). A view display setting (the web grid's sort), not a pipeline task: data reads and exports return rows in this order. At most three columns.sort_byis accepted as an alias oforder_by; each entry is [column, ASC|DESC] or a string "column", "column asc" or "column desc". A string ending in asc or desc is read as column plus direction, so for a column whose name ends in asc or desc use the pair form [column, ASC|DESC]. - Id:
view.transform.sort· Result:ViewTransformSortResult
mammoth view transform split
Split a column. 'column'/'delimiter'/'new_columns' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform split 123 --input '{"column": "Status", "delimiter": ",", "new_columns": [{"name": "Revenue report"}], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
column | --input field | yes | — | str | |
delimiter | --input field | yes | — | str | |
new_columns | --input field | yes | — | list[SplitColumnSpec] | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view data get VIEW_IDon the column to see how the separator appears in real values. - Id:
view.transform.split· Result:ViewTransformSplitResult
mammoth view transform substring
Extract a substring. 'column' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform substring 123 --input '{"column": "Status", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
column | --input field | yes | — | str | |
direction | --input field | no | — | SubstringDirection | One of START, END, LEFT, RIGHT. |
num_char | --input field | no | — | int | |
char_position | --input field | no | — | int | |
regex_pattern | --input field | no | — | str | |
regex_invert | --input field | no | false | bool | |
new_column | --input field | no | — | str | |
existing_column | --input field | no | — | str | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view data get VIEW_IDon the column to see the real value lengths and formats. - Id:
view.transform.substring· Result:ViewTransformSubstringResult
mammoth view transform text
Apply text transforms. 'columns' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform text 123 --input '{"columns": ["Status"], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
columns | --input field | yes | — | list[str] | |
case | --input field | no | — | TextCase | One of UPPER, LOWER, TITLE. |
trim | --input field | no | false | bool | |
condition | --input field | no | — | Condition | CompoundCondition | NotCondition | None | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view data profile VIEW_IDon the column to see the current values (case, padding, spelling variants). - Id:
view.transform.text· Result:ViewTransformTextResult
mammoth view transform unnest
Unnest columns into label/value rows. 'columns' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform unnest 123 --input '{"columns": ["Status"], "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
columns | --input field | yes | — | list[str] | |
label_column | --input field | no | Label | str | |
value_column | --input field | no | Value | str | |
value_type | --input field | no | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view data get VIEW_IDon the column to see how the nested values are stored. - Id:
view.transform.unnest· Result:ViewTransformUnnestResult
mammoth view transform update-column
Overwrite a column with a math expression in one call; 'column', 'expression' required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform update-column 123 --input '{"column": "Cost", "expression": "Cost + 5", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
column | --input field | yes | — | str | |
expression | --input field | yes | — | str | |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Use to overwrite a numeric column with an expression over its own values ("add 5 to Cost"). --input: "column" (an existing column, required) and "expression" (required, as in view transform math). Same as view transform math with existing_column set. One call: if the view is in draft mode the step is staged (status staged) and the draft stays unsubmitted, whether or not it already held staged steps; run view draft submit when that is intended. Outside draft mode the result waits on this step's own run (run.transform_status DONE), not on the pipeline reading ready. - Id:
view.transform.update-column· Result:ViewTransformUpdateColumnResult
mammoth view transform window
Compute a window function. 'function' is required.
EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched: mammoth view create SOURCE_DATASET_ID (working view), do the steps on that working view, then mammoth view export dataset WORKING_VIEW_ID (add dataset_name only if the user named it).
mammoth view transform window 123 --input '{"function": "ROW_NUMBER", "dataset_id": 456}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
function | --input field | yes | — | WindowFunction | One of ROW_NUMBER, RANK, DENSE_RANK, LAG, LEAD, SUM, AVG, MIN, MAX, COUNT, FIRST_VALUE, LAST_VALUE, STDDEV, VARIANCE, PERCENT_RANK, NTILE. |
column | --input field | no | — | str | |
new_column | --input field | no | — | str | |
column_type | --input field | no | NUMERIC | ColumnType | One of TEXT, NUMERIC, DATE. |
existing_column | --input field | no | — | str | |
partition_by | --input field | no | — | list[str] | |
order_by | --input field | no | — | list[list[str | SortDirection]] | |
range_type | --input field | no | UNBOUNDED | WindowRange | One of UNBOUNDED, RUNNING. |
dataset_id | --input field | no | — | int | |
expected_task_count | --input field | no | — | int |
- Effect: Reversible pipeline step, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: EDITS THE GIVEN VIEW IN PLACE: this adds a step to the view and changes that view and its dataset's output. To make a NEW dataset and leave the source untouched:
mammoth view create SOURCE_DATASET_ID(working view), do the steps on that working view, thenmammoth view export dataset WORKING_VIEW_ID(add dataset_name only if the user named it). Observe first:view get VIEW_IDfor the column types, andview data profilefor blanks in the partition and order columns. Exactly one of new_column or existing_column is required; both or neither is refused. - Id:
view.transform.window· Result:ViewTransformWindowResult
view variants
mammoth view variants create
Create one view per value of a column: each a clone of 'from_view' filtered to it.
mammoth view variants create 123 --input '{"from_view": 456, "column": "Region", "values": ["East", "West"]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATASET_ID | positional | yes | — | int | ID of the dataset. |
from_view | --input field | yes | — | int | |
column | --input field | yes | — | str | |
values | --input field | yes | — | list[str | int | float] | |
name_template | --input field | no | — | str |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Use when the user wants the same view once per value ("per region", "one view for each segment") and separate views are needed; for one view the viewer filters, use dashboard filter add. --input: "from_view" (a view of DATASET_ID whose steps every variant copies, required), "column" (a column of that view, required), "values" (1 to 50 distinct values, required), optional "name_template" (default "{view} - {value}"; must make distinct names, so keep {value}). Each variant is a new view cloned from from_view, then filtered to column = value. Refuses an unknown column before creating anything. Stops at the first failure with variants_partial_failure, whose details list the views already created, the failed value, the values not attempted and the unfiltered view left by the failed value (delete it, then rerun the rest). Returns view_ids and per-value variants.
- Id:
view.variants.create· Result:ViewVariantsCreateResult
view version
mammoth view version apply
Apply one pipeline version by id.
mammoth view version apply 123 456 789
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
VERSION_ID | positional | yes | — | int | ID of the pipeline version. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: VIEW_ID, VERSION_ID.
- Id:
view.version.apply· Result:ViewVersionApplyResult· Backed by: SDKmammoth.api.pipeline_versions.PipelineVersionsAPI.apply, APIPOST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/versions/{version_id}(ApplyPipelineVersion)
mammoth view version delete
Delete one pipeline version by id. Prompt or '--yes' required.
mammoth view version delete 123 456 789 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
VERSION_ID | positional | yes | — | int | ID of the pipeline version. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: VIEW_ID, VERSION_ID.
- Id:
view.version.delete· Result:ViewVersionDeleteResult· Backed by: SDKmammoth.api.pipeline_versions.PipelineVersionsAPI.delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/versions/{version_id}(DeletePipelineVersion)
mammoth view version get
Get one pipeline version by id.
mammoth view version get 123 456 789
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
VERSION_ID | positional | yes | — | int | ID of the pipeline version. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID, VERSION_ID.
- Id:
view.version.get· Result:ViewVersionGetResult· Backed by: SDKmammoth.api.pipeline_versions.PipelineVersionsAPI.get, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/versions/{version_id}(GetPipelineVersion)
mammoth view version list
List pipeline versions on a dataview, with optional filters from '--input'.
mammoth view version list 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
DATASET_ID | positional | no | — | int | ID of the dataset the view belongs to; resolved from the view when omitted. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
fields | --input field | no | — | str | |
sort | --input field | no | — | str | |
limit | --input field | no | — | int | |
offset | --input field | no | — | int | |
name | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: VIEW_ID.
- Id:
view.version.list· Result:ViewVersionListResult· Backed by: SDKmammoth.api.pipeline_versions.PipelineVersionsAPI.list, APIGET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/versions(GetPipelineVersions)
mammoth view version update
Update one pipeline version by id. 'body' is required.
mammoth view version update 123 456 789 --input '{"body": {"patches": [{"op": "replace", "path": "name"}]}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
VIEW_ID | positional | yes | — | int | ID of the view to act on. |
VERSION_ID | positional | yes | — | int | ID of the pipeline version. |
DATASET_ID | positional | no | — | int | Exact parent dataset ID. Required for this command: pass it here or as the 'dataset_id' input field; only read commands may omit it and discover the parent. Or the dataset_id input field. |
dataset_id | --input field | no | — | int | |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: VIEW_ID, VERSION_ID.
- Id:
view.version.update· Result:ViewVersionUpdateResult· Backed by: SDKmammoth.api.pipeline_versions.PipelineVersionsAPI.update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/versions/{version_id}(EditPipelineVersion)