Database
Create Multi Objects
Validates the input objects and, if validated, creates the list of objects in
the database. It runs when all the input link points are active. If successful,
triggers the newly created list of objects (if return top model object enabled,
triggers the updated top-level object in a list); otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| input | list | List of input objects that will be created in the database |
Output link points
| Name | Type | Description |
|---|
| created | list | List of newly created objects |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Created objects model | required | The model of the objects that will be created in the database |
| Return top level model object | optional | Flag to specify whether to return the updated top-level parent object or the newly created sub-model child object. Please note that this parameter is visible only if a child sub-model is selected for "Created object model". |
| Parent object id | optional | The id of the parent object under which the sub-object(s) will be created. Required when the created objects are sub-model objects. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Create Single Object
Validates the input object and, if validated, creates the object in the
database. If caching is enabled, it also caches the newly created object (if
return top model object enabled, caches the updated top-level object) using its
id as the cache key. It runs when all the input link points are active. If
successful, triggers the newly created object (if return top model object
enabled, triggers the updated top-level object); otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| input | object | Input object that will be created in the database |
Output link points
| Name | Type | Description |
|---|
| created | object | Newly created object |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Created object model | required | The model of the object that will be created in the database |
| Return top level model object | optional | Flag to specify whether to return the updated top-level parent object or the newly created sub-model child object. Please note that this parameter is visible only if a child sub-model is selected for "Created object model". |
| Parent object id | optional | The id of the parent object under which the sub-object(s) will be created. Required when the created object is a sub-model object. |
| Cache created object | optional | Specify whether to cache the created object using its id as the cache key or not. If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache. |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Delete Multi Objects by Query
Deletes the objects matching the selection query in the database. It runs when
all the input link points are active. If successful, triggers the deleteInfo
otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| input | object | Input object of the node, mainly used to specify the select query |
Output link points
| Name | Type | Description |
|---|
| deleteInfo | object | Delete operation info object, which holds total query match and total deleted objects count information |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Deleted object model | required | The model of the object that will be deleted from the database |
| Select query | required | The select query expression to find the objects that will be deleted |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Delete Single Object by Id
Deletes the object in the database with the provided object id. If remove from
cache selected, it removes the deleted object (if return top model object
enabled, removes the updated top-level object) from the cache using its id as
the cache key. It runs when all the input link points are active. If successful,
it triggers success and updated object (if return top model object enabled);
otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| input | object | Input object of the node, mainly used to specify object id |
Output link points
| Name | Type | Description |
|---|
| success | trigger | Successful delete operation trigger |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Deleted object model | required | The model of the object that will be deleted from the database |
| Return top level model object | optional | Flag to specify whether to return the updated top-level parent object or the newly created sub-model child object. Please note that this parameter is visible only if a child sub-model is selected for "Deleted object model". |
| Object id | required | The id of the object that will be deleted in the database. |
| Remove from cache | optional | Remove deleted object from cache using deleted object id as the cache key |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Get Aggregate Results by Grouping
Retrieves a list of objects from the database matching the selection query, then
groups these selected objects by the grouping expressions and performs the
specified calculations on the grouped objects. It runs when all the input link
points are active. If successful, triggers the result (computed expressions for
each group) otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| inputObject | object | Input object of the node, mainly used to specify input parameters of the node |
Output link points
| Name | Type | Description |
|---|
| result | list | Results of the grouping operation. For each group, an object with the computed fields is returned. |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Grouped object model | required | The model of the object that will be retrieved from the database for grouping |
| Select query | optional | The select query expression to retrieve the list of objects from the database. |
| Group by | required | The grouping method to apply on input objects for computations |
| Computations | required | The computation expressions that will be applied on each group |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Get Multi Objects by Query
Retrieves a list of objects from the database matching the selection query. It
runs when all the input link points are active. If successful, triggers the
result and countInfo (if selected) otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| inputObject | object | Input object of the node, mainly used to specify selection filter |
Output link points
| Name | Type | Description |
|---|
| result | list | List of objects retrieved from the database |
| countInfo | object | Query result count info object, which holds total objects count matching the query condition, total pages, current page and page size information |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Retrieved object model | required | The model of the object that will be retrieved from the database |
| Select query | optional | The select query expression to retrieve the list of objects from the database. |
| Sort expression | optional | The sort fields expression enables you to specify the sort direction as a parameter. If the sort expression is specified, it overrides the values specified in the sort fields below. This expression should either returns a text value (e.g., "fieldName:asc") or an array of text values (e.g., ["fieldName1:asc", "fieldName2:desc"]). |
| Sort fields | optional | The list of model fields to use for sorting the query results |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Page number | optional | Page number to paginate query results. |
| Page size | optional | Maximum number of items to fetch per page. |
| Return count info | optional | Flag to show/hide count info output link point. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Get Multi Objects by Text Search
Retrieves a list of objects from the database running first the text search and
then applying the filter query to narrow down the results. The retrieved objects
are sorted automatically in terms of the scores of the text search results. It
runs when all the input link points are active. If successful, triggers the
result and countInfo (if selected) otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| inputObject | object | Input object of the node, mainly used to specify selection filter |
Output link points
| Name | Type | Description |
|---|
| result | list | List of objects retrieved from the database |
| countInfo | object | Query result count info object, which holds total objects count matching the query condition, total pages, current page and page size information |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Retrieved object model | required | The model of the object that will be retrieved from the database |
| Search text | required | A string of terms that are used to query the data model objects. This node performs a logical OR search of the terms unless specified as a phrase. |
| Additional select query | optional | Following the search of model objects in database, the select query expression is used to further filter the list of objects retrieved from the database. |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Page number | optional | Page number to paginate query results. |
| Page size | optional | Maximum number of items to fetch per page. |
| Return count info | optional | Flag to show/hide count info output link point. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Get Multi Objects & Count by Query
Retrieves a list of objects from the database matching the selection query and
their count info (e.g., pagination data). It runs when all the input link points
are active. If successful, triggers the result and countInfo otherwise triggers
errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| inputObject | object | Input object of the node, mainly used to specify selection filter |
Output link points
| Name | Type | Description |
|---|
| result | list | List of objects retrieved from the database |
| countInfo | object | Query result count info object, which holds total objects count matching the query condition, total pages, current page and page size information |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Retrieved object model | required | The model of the object that will be retrieved from the database |
| Select query | optional | The select query expression to retrieve the list of objects from the database. |
| Select query text expression | optional | The select query text expression enables you to specify the select query as a parameter. If the select query text expression is specified, it overrides the values specified in the select query below. This expression should return a text value that is used as the query expression. |
| Sort expression | optional | The sort fields expression enables you to specify the sort direction as a parameter. If the sort expression is specified, it overrides the values specified in the sort fields below. This expression should either returns a text value (e.g., "fieldName:asc") or an array of text values (e.g., ["fieldName1:asc", "fieldName2:desc"]). |
| Sort fields | optional | The list of model fields to use for sorting the query results |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Page number | optional | Page number to paginate query results. |
| Page size | optional | Maximum number of items to fetch per page. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Get Multi Objects Randomly
Retrieves the specified number of objects from the database randomly. It runs
when the input link point is active. If successful, triggers the output list.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| inputObject | object | Input object of the node, mainly used to specify size parameter |
Output link points
| Name | Type | Description |
|---|
| output | list | List of objects randomly retrieved from the database |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Retrieved object model | required | The model of the objects that will be randomly retrieved from the database |
| Select query | optional | The select query expression to retrieve the list of objects from the database. |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Size | optional | Number of items to randomly select. If not specified randomly selected 20 items are returned. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Get Single Object by Id
Retrieves a single object from the database matching the object id. If caching
is enabled first checks the cache using the id of the object as the cache key
and if an object is found in the cache, returns the cached object. If no cached
object is found, then returns the object from the database and caches the
retrieved object. It runs when all the input link points are active. If
successful, triggers found otherwise triggers notFound.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| inputObject | object | Input object of the node, mainly used to specify selection filter |
Output link points
| Name | Type | Description |
|---|
| found | object | Object retrieved from the database |
| notFound | object | Object not found trigger, returns the input object |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Retrieved object model | required | The model of the object that will be retrieved from the database |
| Object id | required | The object id expression to retrieve the object from the database. |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Cache retrieved object | optional | Specify whether to cache the retrieved object using its id as the cache key or not. If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Get Single Object by Query
Retrieves a single object from the database matching the selection query. If
caching is enabled, it also caches the retrieved object using the object id as
the cache key. It runs when all the input link points are active. If successful,
triggers the found otherwise triggers notFound.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| inputObject | object | Input object of the node, mainly used to specify selection filter |
Output link points
| Name | Type | Description |
|---|
| found | object | Object retrieved from the database |
| notFound | object | Object not found trigger, returns the input object |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Retrieved object model | required | The model of the object that will be retrieved from the database |
| Select query | required | The select query expression to retrieve the object from the database. If the selection query results in multiple matches, then the first entry is returned. |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Cache retrieved object | optional | Specify whether to cache the retrieved object using its id as the cache key or not. If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Update Multi Objects by Query
Validates the input and updates the objects matching the selection query in the
database with values provided in the input. It runs when all the input link
points are active. If successful, triggers the updateInfo otherwise triggers
errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| input | object | The updates that will be performed on the object in the database |
Output link points
| Name | Type | Description |
|---|
| updateInfo | object | Update operation info object, which holds total query match and total updated objects count information |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Updated object model | required | The model of the object that will be updated in the database |
| Select query | required | The select query expression to find the objects that will be updated |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Update Object Fields by Id
Validates the provided field values and object id and if validated, updates the
object with the provided object id in the database with new field values. Either
sets the new values, unsets existing values, for numerical values increments,
decrements, multiplies existing values, or takes the min or max of values and
for basic values list arrays adds or removes elements to the list. If caching is
enabled, also caches the updated object (if return top model object enabled,
caches the updated top-level object) using its id as the cache key. It runs when
all the input link points are active. If successful, it triggers the updated
object (f return top model object enabled, triggers the updated top-level
object); otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
No fixed input link points, all inputs are dynamic.
Output link points
| Name | Type | Description |
|---|
| updated | object | Updated object |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Updated object model | required | The model of the object that will be updated in the database |
| Return top level model object | optional | Flag to specify whether to return the updated top-level parent object or the newly created sub-model child object. Please note that this parameter is visible only if a child sub-model is selected for "Updated object model". |
| Object id | required | The id of the object that will be updated in the database. |
| Field value updates | required | The list of fields and their new values to be updated in the database. |
| Cache updated object | optional | Specify whether to cache the updated object using its id as the cache key or not. If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Update Object Fields by Query
Validates the provided field values and updates the objects matching the
selection query in the database with new field values. It runs when all the
input link points are active. If successful, triggers the updateInfo otherwise
triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
No fixed input link points, all inputs are dynamic.
Output link points
| Name | Type | Description |
|---|
| updateInfo | object | Update operation info object, which holds total query match and total updated objects count information |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Updated object model | required | The model of the object that will be updated in the database |
| Select query | required | The select query expression to find the objects that will be updated |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Field value updates | required | The list of fields and their new values to be updated in the database. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Update Single Object by Id
Validates the input and object id and, if validated, updates the object with the
provided id in the database with values provided in the input. If caching is
enabled, it also caches the updated object (if return top model object enabled,
caches the updated top-level object) using its id as the cache key. It runs when
all the input link points are active. If successful, triggers the updated object
(if return top model object enabled, triggers the updated top-level object);
otherwise triggers errors.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| input | object | The updates that will be performed on the object in the database |
Output link points
| Name | Type | Description |
|---|
| updated | object | Updated object |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Updated object model | required | The model of the object that will be updated in the database |
| Return top level model object | optional | Flag to specify whether to return the updated top-level parent object or the newly created sub-model child object. Please note that this parameter is visible only if a child sub-model is selected for "Updated object model". |
| Object id | required | The id of the object that will be updated in the database. |
| Cache updated object | optional | Specify whether to cache the updated object using its id as the cache key or not. If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache. |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Create Object Iterator
Retrieves objects from the database matching the selection query and creates an
iterator (cursor) to iterate through the query results. It runs when all the
input link points are active. If successful, triggers the iterator object.
| |
|---|
| Multi input | ✔️ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| inputObject | object | Input object of the node, mainly used to specify selection filter |
Output link points
| Name | Type | Description |
|---|
| iterator | object | Iterator (cursor) object |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Retrieved object model | required | The model of the object that will be retrieved from the database |
| Select query | optional | The select query expression to retrieve the list of objects from the database. |
| Sort expression | optional | The sort fields expression enables you to specify the sort direction as a parameter. If the sort expression is specified, it overrides the values specified in the sort fields below. This expression should either returns a text value (e.g., "fieldName:asc") or an array of text values (e.g., ["fieldName1:asc", "fieldName2:desc"]). |
| Sort fields | optional | The list of model fields to use for sorting the query results |
| Lookup fields | optional | The referenced object fields to perform a left outer join for processing |
| Database transaction | optional | Transaction context that this database operation will execute in |
| Apply rules | optional | Enable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache. |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Iterate to Next Object
Gets the next available object from the iterator. It runs when the trigger and
iterator are active. If successful, triggers found otherwise triggers notFound.
| |
|---|
| Multi input | ❌ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| trigger | trigger | Trigger of the node |
| iterator | object | Iterator object to iterate over query results |
Output link points
| Name | Type | Description |
|---|
| found | object | Next object retrieved from the iterator |
| notFound | trigger | Object not found trigger |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Abort Transaction
Aborts the active transaction. It runs when the trigger link point is active.
| |
|---|
| Multi input | ❌ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| trigger | trigger | Trigger of the node |
Output link points
| Name | Type | Description |
|---|
| success | trigger | Output trigger of successful execution of the node |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Database transaction | required | Transaction object that will be aborted |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Commit Transaction
Commits the active transaction. It runs when the trigger link point is active.
| Title | Title |
|---|
| Multi input | ❌ |
| Multi output | ❌ |
| Name | Type | Description |
|---|
| trigger | trigger | Trigger of the node |
Output link points
| Name | Type | Description |
|---|
| success | trigger | Output trigger of successful execution of the node |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|
| Database transaction | required | Transaction object that will be committed |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |