Skip to main content

# kater chart save

Saves your changes to a saved chart.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

Give the whole chart, its spec with its SQL or its plan, and the revision you read. Kater refuses the save when the chart changed after you read it, and writes nothing when nothing changed.

## Examples

```bash
# Keep the spend_mix chart in a file
kater chart read --request-file spend_mix.json --json > spend_mix_read.json
# Make a save request that draws the pie chart as a donut
jq '{spec: (.definition.spec | .presentation.donut = true), sql: .definition.sql, expected_revision: .definition.revision}' spend_mix_read.json > spend_mix_save.json
# Save the change
kater chart save --request-file spend_mix_save.json
```

## Arguments

<div class="cli-options">

| Argument | Description |
| --- | --- |
| `<path>` | Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names. |

</div>

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | The changed chart, as JSON, with the revision you read. Give `-` to read it from standard input. See [The request](#the-request). |

</div>

It also takes the [global options](https://kater.ai/docs/cli-reference/global-options/) `--json`, `--kater-root`, `--scope` and `--help`.

## The request

| Field | What it holds |
| --- | --- |
| `spec` | The whole chart, as the `spec` of [`kater chart read`](https://kater.ai/docs/cli-reference/chart/read/) holds it, with your changes. |
| `sql` | The SQL that selects the query's columns for the chart. Give `sql` or `plan`, not both. |
| `plan` | The same selection in parts, as [`kater chart plan`](https://kater.ai/docs/cli-reference/chart/plan/) takes it. |
| `expected_revision` | The chart's `revision` from `kater chart read`. |

## Names

A save keeps the chart's name. Kater refuses a save that changes it. A chart takes its name from its label: to rename a chart, send its new label with [`kater invoke label.set`](https://kater.ai/docs/cli-reference/invoke/), with the chart as its `target`. Kater makes the name from the label and renames the chart, and each dashboard tile that shows it, in the same change.

## See also

- [`kater chart`](https://kater.ai/docs/cli-reference/chart/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Arguments
Options
The request
Names
See also

Kater CLI Present and share chart

kater chart save

Saves your changes to a saved chart.

Give the whole chart, its spec with its SQL or its plan, and the revision you read. Kater refuses the save when the chart changed after you read it, and writes nothing when nothing changed.

Examples

# Keep the spend_mix chart in a file
kater chart read --request-file spend_mix.json --json > spend_mix_read.json
# Make a save request that draws the pie chart as a donut
jq '{spec: (.definition.spec | .presentation.donut = true), sql: .definition.sql, expected_revision: .definition.revision}' spend_mix_read.json > spend_mix_save.json
# Save the change
kater chart save --request-file spend_mix_save.json

Arguments

Argument	Description
`<path>`	Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names.

Options

Option	Description
`--request-file <file>`	The changed chart, as JSON, with the revision you read. Give `-` to read it from standard input. See The request.

It also takes the global options --json, --kater-root, --scope and --help.

The request

Field	What it holds
`spec`	The whole chart, as the `spec` of `kater chart read` holds it, with your changes.
`sql`	The SQL that selects the query’s columns for the chart. Give `sql` or `plan`, not both.
`plan`	The same selection in parts, as `kater chart plan` takes it.
`expected_revision`	The chart’s `revision` from `kater chart read`.

Names

A save keeps the chart’s name. Kater refuses a save that changes it. A chart takes its name from its label: to rename a chart, send its new label with kater invoke label.set, with the chart as its target. Kater makes the name from the label and renames the chart, and each dashboard tile that shows it, in the same change.

See also