Skip to main content
On this page

Kater CLI Explore and try ideas explore card

kater explore card add

Saves cards to a workspace as queries and charts.

Use it to keep the cards you want and build on them in the workspace. It also saves any queries a card needs, and reuses the queries the workspace already has.

Examples

Terminal window
# Save the cards in add.json to the workspace it names
kater explore card add --request-file add.json
# Run the cards first, to check their charts
kater explore card preview-all --request-file cards.json

Options

OptionDescription
--request-file <file>Required. The cards and where they go, as JSON, from a file. - reads stdin. See What the request holds.

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

What the request holds

  • namespace and cards. 1 to 40 cards, each one time, whose workspace is namespace.
  • destination. The workspace to save them to, such as {"kind": "workspace", "path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}. It must read the cards’ shared model.
  • new_workspace. Or a new workspace to make in the same step: target_path, the folder it goes in, its name and its label. Send destination or new_workspace, not both. Cards from the shared layer need one of them.
  • request_id. Your own id for this add. An id that already names a different set of cards is refused.
  • artifact. chart saves each card as a query and its chart. query saves the query alone. dashboard also puts the chart on the workspace’s dashboard. It is chart unless you send another.
  • dashboard_tab and dashboard_section. With dashboard, where the tiles go. Without a section, they go in the last section that holds tiles on the tab.
  • leave. The fields that the workspace’s filters hold rows by. Each card’s own condition on one of them stays behind, since the chart follows the workspace’s filter.
  • dry_run. Set it to true to check the add and write nothing. A new workspace cannot be a dry run.

Where cards can go

Cards go only to a real workspace that reads their shared model. A workspace copy in a brainstorm folder is refused. Add the cards to one of your workspaces or to a connection workspace, or write the query in the copy.

See also