# Write Data ## Write Data Actions Most write actions utilize the following event metadata fields: {% tabs %} {% tab title="Table" %} | Field | Definition | Example | Default | | -------------- | -------------------------------------------------- | ---------- | ------- | | Domain | Name of the state manager to read data from | product | - | | Input Element | Json path for the input in request event payload | parameters | - | | Output Element | Json path for the output in response event payload | $.product | - | {% endtab %} {% tab title="JSON Schema" %} ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Write Data action eventMeta fields", "type": "object", "properties": { "eventMeta": { "type": "object", "properties": { "domain": { "type": "string", "definition": "Name of the state manager to read data from", "example": "product" }, "inputElement": { "type": "string", "definition": "Json path for the input in request event payload", "example": "parameters" }, "outputElement": { "type": "string", "definition": "Json path for the output in response event payload", "example": "$.product" } } } } } ``` {% endtab %} {% endtabs %} With event metadata parameters as: {% tabs %} {% tab title="Table" %} | Parameter | Definition | Example | Default | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ------- | | Input Pattern | JMESPath pattern to apply on data input | {id:parameters.id, data:parameters.data} | - | | Output Pattern | JMESPath pattern to apply on data output, before returning response | {id:id, name:data.name, description:data.description} | - | | Use Diff | Whether handler should generate journals keeping only actual updates from current data for the event | true | false | | If Pattern | JMES path pattern evaluating condition on current data to decide whether to execute update | data.status == 'A' | - | | Fail Stale | Whether to fail in case a request with old instance version or offset arrives | false | true | | Return Result | Whether the action should return updated data after the change | false | true | | Immediate | Whether the action should be executed immediately, or can be buffered for bulk execution | false | true | | Keep Impact | Whether the action should also return the impact created on current record | true | false | | Keep Undo | Whether the action should also return the undo action required to revert the impact | true | false | | Structure | Type of input to apply updates for (i.e. [array ](#user-content-fn-1)[^1]or [each ](#user-content-fn-2)[^2]= \[{id, data}, {id, data}], multi[^3] = \[ids: \[id, id], data: {}], single = {id, data}) | array | single | | Data Path | Json path for the data to use in update, when form is "multi" | newData | data | | IDs Path | Json path for the ids to update, when form is "multi" | productids | ids | | Item Path | Json path for the array field to update (for SetElement and RemoveElement) | parameters | - | | Allow Manual ID | When creating a new record, whether IDs can be given manually, if there is already an ID generator | true | false | | {% endtab %} | | | | {% tab title="JSON Schema" %} ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Write Data action eventMeta.parameters", "type": "object", "properties": { "eventMeta": { "type": "object", "properties": { "parameters": { "type": "object", "properties": { "inputPattern": { "type": "string", "definition": "JMESPath pattern to apply on data input", "example": "{id:parameters.id, data:parameters.data}" }, "outputPattern": { "type": "string", "definition": "JMESPath pattern to apply on data output, before returning response", "example": "{id:id, name:data.name, description:data.description}" }, "useDiff": { "type": "boolean", "definition": "Whether handler should generate journals keeping only actual updates from current data for the event", "default": false, "example": true }, "ifPattern": { "type": "string", "definition": "JMES path pattern evaluating condition on current data to decide whether to execute update", "example": "data.status == 'A'" }, "failStale": { "type": "boolean", "definition": "Whether to fail in case a request with old instance version or offset arrives", "default": true, "example": false }, "returnResult": { "type": "boolean", "definition": "Whether the action should return updated data after the change", "default": true, "example": false }, "immediate": { "type": "boolean", "definition": "Whether the action should be executed immediately, or can be buffered for bulk execution", "default": true, "example": false }, "keepImpact": { "type": "boolean", "definition": "Whether the action should also return the impact created on current record", "default": false, "example": true }, "keepUndo": { "type": "boolean", "definition": "Whether the action should also return the undo action required to revert the impact", "default": false, "example": true }, "structure": { "type": "string", "definition": "Type of input to apply updates for (array / each / multi / single)", "default": "single", "example": "array" }, "dataPath": { "type": "string", "definition": "Json path for the data to use in update, when form is \"multi\"", "default": "data", "example": "newData" }, "idsPath": { "type": "string", "definition": "Json path for the ids to update, when form is \"multi\"", "default": "ids", "example": "productids" }, "itemPath": { "type": "string", "definition": "Json path for the array field to update (for SetElement and RemoveElement)", "example": "parameters" }, "allowManualId": { "type": "boolean", "definition": "When creating a new record, whether IDs can be given manually, if there is already an ID generator", "default": false, "example": true } } } } } } } ``` {% endtab %} {% endtabs %}
Example Input ```json { "parameters": { "id": "given-id", "data":{ "name": "Test", "description": "Test Entry" } } } ``` Event Metadata ![](/files/HDNyTTT8QPMg2pDS4Iwq)
### Create Creates a new aggregate on a specific state manager. ### Update Patches an existing aggregate on a specific state manager. ### Set Completely updates an existing aggregate on a specific state manager. ### Upsert Completely updates or creates an aggregate on a specific state manager. ### Delete Marks an aggregate as deleted, hiding it on a specific state manager. ### Undelete Unmarks an aggregate as deleted, making it accessible again on a specific state manager. ### Remove Completely removes an aggregate from a specific state manager. ### SetElement Adds to or sets element of an array field of an aggregate on a specific state manager. ### RemoveElement Removes element of an array field of an aggregate on a specific state manager. ### CallSP This is a special action, which makes calls to stored procedures in state managers which support the functionality (such as Jooq state manager for RDBMS). Special parameters used by this action are: {% tabs %} {% tab title="Table" %} | Parameter | Definition | Example | Default | | -------------- | ---------------------------------------------------------- | ----------------------------------- | ------- | | Command | Procedure call command with parameters | CALL update\_status({0}, {1}) | - | | Input Pattern | JMESPath for transforming input into call parameters array | \[parameters.id, parameters.status] | - | | Output Pattern | JMESPath for transforming procedure call results | - | - | | {% endtab %} | | | | {% tab title="JSON Schema" %} ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Write Data CallSP action eventMeta.parameters", "type": "object", "properties": { "eventMeta": { "type": "object", "properties": { "parameters": { "type": "object", "properties": { "command": { "type": "string", "definition": "Procedure call command with parameters", "example": "CALL update_status({0}, {1})" }, "inputPattern": { "type": "string", "definition": "JMESPath for transforming input into call parameters array", "example": "[parameters.id, parameters.status]" }, "outputPattern": { "type": "string", "definition": "JMESPath for transforming procedure call results" } } } } } } } ``` {% endtab %} {% endtabs %} [^1]: Executes all impacts at once [^2]: Executes each impact entry individually as a loop (typically used when id generator requires previous entries executed first) [^3]: Executes same impact on multiple records at once --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.rierino.com/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/write-data.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.