DATABASE_READ
Allows data to be read from external databases. Supported databases include MySQL, SQL and Postgres.
Properties
Database Connection
dbread_connection
A reference to the database connection record that contains the details on how to connect to the remote database service. Database connections can be defined in the project settings view. An empty value enables a custom connection string to be set.
Database Connection Template (Use DB record ID) ${}
dbread_connection_template
When the connection is not set, allows the connection URI to be set as a URI. This field accepts template syntax.
Collection / Table name ${}
dbread_collection
The database table or collection that the action will access once connected to the database.
Sort Key
dbread_sortKey
When provided, this key will be used to sort the results in the query.
Sort Direction
dbread_sortDir
When a sort key is provided, determines the order of the sort for the query.
| valid options | |
|---|---|
| ASC | Results will be sorted in ascending order. |
| DESC | Results will be sorted in descending order. |
Page Size
dbread_pageSize
Specifies the maximum number of results to be returned.
Page Number
dbread_pageNumber
Specifies the "page" of records to retrieve. The number of records in a page is specified by the page size. As an example, a page size of 50 and a page number of 3 will retrieve the 101st to 150th record that matches the query.
Out Key
dbread_outkey
The property that will contain the result of the query.
Record Identifier Template ${}
dbread_recordIdentifierTemplate
An identifier for the query that will be recorded in the Outbound Call Record created. This identifier will be searchable. Please set this to make your logs easier to interpret.
Do Raw Query
dbread_doRawQuery
When enabled a raw query will be sent to the server rather than using the query fields.
Raw Query Value ${}
dbread_rawQuery
Provides the raw query to be sent to the server. Accepts template syntax.
Parse List Values (MSSQL)
dbread_allowListParsing
When enabled, allows the provided raw query to accept an array of values rather than a simple value that will be inserted into the query.
Include these query fields...
queryFields
A set of records that are used to define conditionals for use in database queries.
Input Key
queryFields[].key
The property of the database record to evaluate. Uses dot notation conventions.
Operator
queryFields[].queryOperator
The logical operator that determines how the value of the property will be compared against the value supplied in the condition.
| valid options | |
|---|---|
| Equals $eq | The property must be equal to the condition value. |
| Not Equals $ne | The property must be different from the condition value. |
| Less Than $lt | The property must evaluate to a number and must be less than the condition value which also must evaluate to a number. |
| Greater Than $gt | The property must evaluate to a number and must be greater than the condition value which also must evaluate to a number. |
| Less Than Or Equals $lte | The property must evaluate to a number and must be less than or equal to the condition value which also must evaluate to a number. |
| Greater Than Or Equals $gte | The property must evaluate to a number and must be greater than or equal to the condition value which also must evaluate to a number. |
| In $in | The property must contain the condition value. |
| Not In $nin | The property must exclude the condition value. |
Value ${}
queryFields[].value
The value will be compared against the database using the designated operator.