Skip to navigation

Create actions that modify Sigma table data (Beta)

View as Markdown

This documentation describes one or more public beta features that are in development. Beta features are subject to quick, iterative changes; therefore the current user experience in the Sigma service can differ from the information provided in this page.

This page should not be considered official published documentation until Sigma removes this notice and the beta flag on the corresponding feature(s) in the Sigma service. For the full beta feature disclaimer, see Beta features.

Workbooks support actions that add, update, or delete one or more rows in a Sigma table.

This document explains how to configure the Insert row(s), Update row(s), and Delete row(s) actions for Sigma tables. For more information about actions in Sigma, see Intro to actions.

Sigma tables are currently supported by Snowflake, Databricks, and PostgreSQL connections.

User requirements

The following requirements apply to users who configure actions. Users who access and interact with a workbook can typically trigger all existing actions within it. Any restrictions are noted in this document.

To configure actions that modify Sigma tables:

  • You must be assigned an account type with the Full explore or Create, edit, and publish workbooks permission enabled.

  • You must be the workbook owner or be granted Can explore1 or Can edit access to the workbook.

  • You must have write access on the target Sigma table.

    • On a non-OAuth connection, write access is granted in Sigma as Can write, Can use, write & annotate, or Can own access in the data catalog.
    • On an OAuth connection, write access is granted in the data platform. See Configure access for organization-wide Sigma tables.

1If you’re granted Can explore access to the workbook, you can configure actions in custom, saved, and shared views. Actions saved to views do not apply to the workbook’s published version.

Considerations and limitations

  • Insert row(s) can insert or update rows. If a row with a matching primary key value already exists in the target Sigma table, Sigma updates that row instead of adding a duplicate or returning an error.

  • Insert row(s) cannot target a Sigma table that uses a non-text primary key column.

  • When inserting rows from source data, the source table and target Sigma table must be in the same data platform instance, and you can only insert from an existing table or Sigma table in the workbook. You cannot insert rows from an action variable. Sigma evaluates the source table’s full underlying data and ignores any filter applied to it in the workbook. As a result, the action can insert rows that aren’t currently visible in the source table.

  • Insert row(s) doesn’t support inserting multiple rows from a single multi-value source. To insert multiple rows in one action, use the Source data insert type.

  • Update row(s) and Delete row(s) support targeting rows by Single row or Formula only. There’s no option to target rows where a column value matches specified criteria.

  • You cannot set or change a Sigma table’s primary key column value through these actions.

How bulk edit actions are processed

When a bulk edit action (a single action that inserts, updates, or deletes multiple rows in a Sigma table) executes, Sigma cannot reference primary key values to determine which rows are affected. Instead, Sigma runs a query against your data platform and stages the computed results in a materialized table. Sigma then joins the materialized table with the target Sigma table to apply the bulk edits. Because Sigma runs this query in your data platform, a bulk insert from source data can only read from tables in the same data platform instance as the target Sigma table.

By default, Sigma retains these materialized tables for 15 days, then deletes them as the user or shared identity that triggered the bulk edit action. When Sigma table audit logging is enabled on the connection, audit logs reference the materialized tables, so Sigma retains them for 30 days to provide a longer window to look up row-level edit details. When the 30 days conclude, Sigma uses the shared identity configured on the connection to delete the materialized table from your data platform.

For more information about materialized table references in audit logs, see Audit changes to Sigma tables.

Configure an action that inserts Sigma table rows

Create an action that inserts one or more rows in a target Sigma table. If a row with a matching primary key value already exists, Sigma updates that row instead of inserting a duplicate.

  1. Open the draft, a custom view, or a saved view of a workbook. If you open a saved view, go to the workbook header and click Customize this view to enable changes.

  2. Select the trigger element (the element users must interact with to initiate the action).

    If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.

  3. In the editor panel, open the Actions tab.

  4. Create a new sequence, or locate an existing sequence that you want to modify.

  5. Select the default action (if creating a new sequence), or click Add action to add a new action to the sequence.

  6. In the modal, configure the required fields to define the response:

    ActionIn the Sigma tables section, select Insert row(s).
    Insert typeSelect New data.
    IntoSelect a target Sigma table that the action must modify.
    Insert with value(s)

    For each writable column in the target Sigma table, define the value (or source of the value) that Sigma must pass to the inserted row. The primary key column isn’t available here, since Sigma generates or matches it automatically.

    Depending on the trigger element and workflow, choose from:

    • Static values: Specify a fixed value to pass to the inserted row.
    • Column: Choose a column from the trigger element containing values to pass to the inserted row. Sigma passes the column value for the row selected in the trigger element.
    • Control: Choose a control element from the workbook. Sigma passes the current control value to the inserted row.
    • Formula: Enter a formula to evaluate. Sigma passes the returned value to the inserted row.
    • Form field: Choose a field from the triggering form element. Sigma passes the field value to the inserted row. Available only when the action’s trigger is a form element.
    • Action variable: Choose an action variable produced by an earlier action in the same sequence. Sigma passes the variable’s value to the inserted row. Available only when a preceding action produces a variable.
    • Agent input: Choose an input value from an AI agent. Sigma passes this value to the inserted row. Available only in agent-triggered action sequences.
  7. In the document header, click Publish to apply the action to the published version of the workbook.

  8. If the action is part of a workflow that can be triggered by any user with access to the workbook, confirm that those users have write access on the target Sigma table. See Configure access for organization-wide Sigma tables.

Configure an action that updates Sigma table rows

Create an action that updates the value of one or more rows in a target Sigma table.

  1. Open the draft, a custom view, or a saved view of a workbook. If you open a saved view, go to the workbook header and click Customize this view to enable changes.

  2. Select the trigger element (the element users must interact with to initiate the action).

    If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.

  3. In the editor panel, open the Actions tab.

  4. Create a new sequence, or locate an existing sequence that you want to modify.

  5. Select the default action (if creating a new sequence), or click Add action to add a new action to the sequence.

  6. In the modal, configure the required fields to define the response:

    ActionIn the Sigma tables section, select Update row(s).
    InSelect a target Sigma table that the action must modify.
    Update row(s) by

    Choose an option and define the criteria that determines which row or rows are updated.

    • Single row: Target an individual row based on its primary key column value (or values, for a table with a composite primary key). For each primary key column, define the match value using one of the following:
      • Static values: Specify a fixed value. If the value matches the primary key column value of a row in the target Sigma table, Sigma updates that row.
      • Column: Choose a column from the trigger element. If the column value for the row selected in the trigger element matches the primary key column value of a row in the target Sigma table, Sigma updates that row.
      • Control: Choose a control element from the workbook. If the control value matches the primary key column value of a row in the target Sigma table, Sigma updates that row.
      • Formula: Enter a formula to evaluate. If the expression returns a value that matches the primary key column value of a row in the target Sigma table, Sigma updates that row.
      • Form field: Choose a field from the triggering form element. If the field value matches the primary key column value of a row in the target Sigma table, Sigma updates that row. Available only when the action’s trigger is a form element.
      • Action variable: Choose an action variable produced by an earlier action in the same sequence. If the variable’s value matches the primary key column value of a row in the target Sigma table, Sigma updates that row. Available only when a preceding action produces a variable.
      • Agent input: Choose an input value from an AI agent. If the value matches the primary key column value of a row in the target Sigma table, Sigma updates that row. Available only in agent-triggered action sequences.
    • Formula: Target rows based on a formula that evaluates to True or False. When the expression returns True for one or more rows in the target table, Sigma updates those rows.
    Update with value(s)

    Add one or more writable columns from the target Sigma table and define the value (or source of the value) that Sigma must pass to the row or rows it updates. The primary key column isn’t available.

    Depending on the trigger element and workflow, choose from:

    • Static values: Specify a fixed value to pass to the row or rows it updates.
    • Column: Choose a column from the trigger element containing values to pass to the row or rows it updates. Sigma passes the column value for the row selected in the trigger element.
    • Control: Choose a control element from the workbook. Sigma passes the current control value to the row or rows it updates.
    • Formula: Enter a formula to evaluate. Sigma passes the returned value to the row or rows it updates.
    • Form field: Choose a field from the triggering form element. Sigma passes the field value to the row or rows it updates. Available only when the action’s trigger is a form element.
    • Action variable: Choose an action variable produced by an earlier action in the same sequence. Sigma passes the variable’s value to the row or rows it updates. Available only when a preceding action produces a variable.
    • Agent input: Choose an input value from an AI agent. Sigma passes this value to the row or rows it updates. Available only in agent-triggered action sequences.
  7. In the document header, click Publish to apply the action to the published version of the workbook.

  8. If the action is part of a workflow that can be triggered by any user with access to the workbook, confirm that those users have write access on the target Sigma table. See Configure access for organization-wide Sigma tables.

Configure an action that deletes Sigma table rows

Create an action that deletes one or more rows in a target Sigma table.

  1. Open the draft, a custom view, or a saved view of a workbook. If you open a saved view, go to the workbook header and click Customize this view to enable changes.

  2. Select the trigger element (the element users must interact with to initiate the action).

    If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.

  3. In the editor panel, open the Actions tab.

  4. Create a new sequence, or locate an existing sequence that you want to modify.

  5. Select the default action (if creating a new sequence), or click Add action to add a new action to the sequence.

  6. In the modal, configure the required fields to define the response:

    ActionIn the Sigma tables section, select Delete row(s).
    InSelect a target Sigma table that the action must modify.
    Delete row(s) by

    Choose an option and define the criteria that determines which row or rows are deleted.

    • Single row: Target an individual row based on its primary key column value (or values, for a table with a composite primary key). For each primary key column, define the match value using one of the following:
      • Static values: Specify a fixed value. If the value matches the primary key column value of a row in the target Sigma table, Sigma deletes that row.
      • Column: Choose a column from the trigger element. If the column value for the row selected in the trigger element matches the primary key column value of a row in the target Sigma table, Sigma deletes that row.
      • Control: Choose a control element from the workbook. If the control value matches the primary key column value of a row in the target Sigma table, Sigma deletes that row.
      • Formula: Enter a formula to evaluate. If the expression returns a value that matches the primary key column value of a row in the target Sigma table, Sigma deletes that row.
      • Form field: Choose a field from the triggering form element. If the field value matches the primary key column value of a row in the target Sigma table, Sigma deletes that row. Available only when the action’s trigger is a form element.
      • Action variable: Choose an action variable produced by an earlier action in the same sequence. If the variable’s value matches the primary key column value of a row in the target Sigma table, Sigma deletes that row. Available only when a preceding action produces a variable.
      • Agent input: Choose an input value from an AI agent. If the value matches the primary key column value of a row in the target Sigma table, Sigma deletes that row. Available only in agent-triggered action sequences.
    • Formula: Target rows based on a formula that evaluates to True or False. When the expression returns True for one or more rows in the target table, Sigma deletes those rows.
  7. In the document header, click Publish to apply the action to the published version of the workbook.

  8. If the action is part of a workflow that can be triggered by any user with access to the workbook, confirm that those users have write access on the target Sigma table. See Configure access for organization-wide Sigma tables.