Interacting with document tables in Yandex Managed Service for YDB

Note

Currently, there are two UIs that support Workflows: Yandex Cloud and Yandex AI Studio. In this case, the following applies:

  • Workflows created in the Yandex Cloud UI are automatically available in the AI Studio UI.
  • Workflows created in the AI Studio UI are not available in the Yandex Cloud UI.

Starting September 3, 2026, Workflows will no longer be supported in the Yandex Cloud UI. To create and manage workflows, use the AI Studio UI.

Tip

There is an icon next to some fields in the Yandex AI Studio UI. These fields support templates for dynamic data retrieval from previous workflow steps. To avoid typing a template manually, click and enter {{ in the field.

  1. When creating a new workflow or editing an existing one, select Constructor in the top-right corner of the AI Studio UI.

  2. Click the Add first step section or the icon next to the step you want the new one to follow.

  3. Under Integration steps, select Yandex Cloud Managed Service for YDB.

  4. On the right side of the window:

    1. In the Database field, select a database. Only databases created in Serverless mode are supported.

    2. In the Path to table field, specify the path to the table the workflow will interact with. Only document tables are supported.

    3. Under Action, select:

      • Get to get the contents of an element in the database; in the Key field, specify the value of the DB primary key related to the element in question.

      • Put to write data to the table; in the Attributes field, specify an associative array of attributes in key/value format.

      • Update to update data in the table. Configure the update options:

        1. In the Key field, specify the primary key value of the database element you want to update.
        2. In the Expression for update field, specify an expression describing the update of the element's attributes in the database. Learn more about the UpdateExpression parameter in this Yandex Managed Service for YDB guide.
        3. In the Attribute values field, specify the attribute values used in the expression above. Learn more about the ExpressionAttributeValues parameter in this Yandex Managed Service for YDB guide.
      • Scan to search the database. Configure the search parameters:

        1. In the Key field, specify the value of the primary key of the database element the search will start from.
        2. In the Limit field, set a limit on the maximum number of elements in the list of results.
    4. Optionally, in the Timeout, ms field, set the maximum execution time for the current step.

    5. Optionally, to set a custom retry policy for a step, expand the Retry policy section and click Retry policy. In the form that appears:

      1. Optionally, in the Initial delay, ms field, set the initial value for a delay between step retries.

      2. Optionally, in the Backoff rate field, set the multiplication factor for delay before each step retry.

      3. Optionally, in the Maximum delay, ms field, set the value for a maximum delay between step retries.

      4. In the Errors field, select the errors for which the step will or will not be retried.

        For detailed information about possible errors, see Possible error codes](../concepts/contract.md).

      5. Optionally, in the Maximum number of retries field, set the maximum number of step retry attempts.

      6. In the Error selection mode field, select:

        • INCLUDE: Retry executing a step when errors specified in the Errors field occur.
        • EXCLUDE: To retry executing the step on any errors other than those specified in the Errors field.

      If you want to delete a retry policy you created for the step earlier, click and select Retry policy in the Delete row.

      If no custom retry policy is configured for a step, the retry policy set for the whole workflow will apply.

    6. Optionally, expand the Additional parameters section:

      1. Specify a description for the workflow step.
      2. In the Step input filter field, specify a jq template to filter the workflow state provided to the step.
      3. In the Step output filter field, specify a jq template to filter the step output data added into the workflow state.
  5. Optionally, add an error transition rule for the step you are creating to handle errors you may get during this step.

Useful links