Skip to content

Commit 561ada7

Browse files
committed
Add info about ExecuteDMLStatement to the OQL Module documentation
1 parent 98f600b commit 561ada7

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

  • content/en/docs/marketplace/platform-supported-content/modules

content/en/docs/marketplace/platform-supported-content/modules/oql-module.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ Care should be taken to guarantee that the query is valid and does not expose ap
2626
The OQL module has the following features:
2727

2828
* Executes an OQL query directly or loads a query from a dataset
29+
* Executes an OQL statement
2930
* Supports running queries with limit and offset
30-
* Supports OQL named query parameters
31+
* Supports queries and statements with OQL named query parameters
3132
* Returns data directly or generates a CSV file
3233
* If you opt to generate a CSV file, this can be created with the following characteristics:
3334
* Compressed in a Zip file
@@ -82,6 +83,16 @@ It returns the following:
8283

8384
* The number of results of executing `statement`
8485

86+
### ExecuteDMLStatement {#executedmlstatement}
87+
88+
This action executes an [OQL Statement](/refguide/oql-statements/) and returns the number of affected rows.
89+
90+
Named parameters are also supported when running OQL statements.
91+
92+
{{% alert color="info" %}}
93+
The `ExecuteDMLStatement` action is only available starting with the OQL Module version 5.0.0 and above.
94+
{{% /alert %}}
95+
8596
### ExportOQLToCSV {#exportoqltocsv}
8697

8798
This action executes an OQL query and saves the result in a CSV file.
@@ -117,3 +128,6 @@ If you wish to use named parameters inside an OQL query, you must call the follo
117128
{{% alert color="info" %}}
118129
If you wish to keep the same parameters across multiple calls to the [ExecuteOQLStatement](#executeoqlstatement) action, you must set `preserveParameters` to `true`. All other OQL actions above will clear all defined parameters after every call.
119130
{{% /alert %}}
131+
{{% alert color="info" %}}
132+
The `AddDateTimeParameter` action is not supported in conjunction with the [ExecuteDMLStatement](#executedmlstatement) action.
133+
{{% /alert %}}

0 commit comments

Comments
 (0)