Skip to main content
On this page

Kater CLI Present and share dashboard

kater dashboard fill

Puts saved charts on a workspace's dashboard and lays out the whole dashboard again.

Use it to add many charts at one time, each at a size that fits its rows. Kater also places and sizes every tile already on the dashboard, and takes away the empty slots.

Examples

Terminal window
# Put the spend_by_platform chart on the ad_reporting dashboard, and lay it out again
kater dashboard fill --request-file fill_spend_by_platform.json

Arguments

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

Options

OptionDescription
--request-file <file>The workspace and the charts to put on its dashboard, as JSON. Give - to read it from standard input. See The request.

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

The request

FieldWhat it holds
namespaceThe workspace, by its full path.
chartsThe charts to put on the dashboard. Each holds the chart’s name. It can also hold how many rows and columns its run drew, and the most bars that one panel draws, so that Kater sizes its tile.
expected_revisionOptional. The revision from kater dashboard open.
include_inputsOptional, true when you leave it out. False answers faster, without the workspace’s filters.
fill_spend_by_platform.json
{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}, "charts": [{"chart": "spend_by_platform"}]}

Where the tiles go

  • A chart already on the dashboard keeps its region, its tab and its section.
  • A new chart goes on the first tab, in the last section that holds tiles.
  • Every tile gets a place and a size from its kind, its rows and its columns.

New charts

A chart can also hold a definition: a new chart’s spec, and its sql or its plan. Kater saves every new chart first, in one commit, and the answer’s made names them. When a chart of that name reads the same query, Kater uses that chart. When it reads another query, Kater saves the new one as <chart>_chart, then <chart>_chart_2.

See also