Skip to content

Add info about ExecuteDMLStatement to the OQL Module documentation #10909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
passalaqua wants to merge 1 commit into
base: development
Choose a base branch
from
+15 −1
Open

Add info about ExecuteDMLStatement to the OQL Module documentation #10909

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion content/en/docs/marketplace/platform-supported-content/modules/oql-module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ Care should be taken to guarantee that the query is valid and does not expose ap
The OQL module has the following features:

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

* The number of results of executing `statement`

### ExecuteDMLStatement {#executedmlstatement}

This action executes an [OQL Statement](/refguide/oql-statements/) and returns the number of affected rows.

Named parameters are also supported when running OQL statements.

{{% alert color="info" %}}
The `ExecuteDMLStatement` action is only available starting with the OQL Module version 5.0.0 and above.
{{% /alert %}}

### ExportOQLToCSV {#exportoqltocsv}

This action executes an OQL query and saves the result in a CSV file.
Expand Down Expand Up @@ -117,3 +128,6 @@ If you wish to use named parameters inside an OQL query, you must call the follo
{{% alert color="info" %}}
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.
{{% /alert %}}
{{% alert color="info" %}}
The `AddDateTimeParameter` action is not supported in conjunction with the [ExecuteDMLStatement](#executedmlstatement) action.
{{% /alert %}}