JDBC Task

A JDBC task is a system task used to execute or store information in SQL databases.

Definitions

   {
     "name": "jdbc",
     "taskReferenceName": "jdbc_ref",
     "inputParameters": {
       "integrationName": "db-001",
       "statement": "SELECT * FROM tableName WHERE id=?",
       "parameters": [
         "${workflow.input.text}"
       ],
       "type": "SELECT"
     },
     "type": "JDBC",
     "cacheConfig": {
       "ttlInSecond": 3600,
       "key": "key"
     },
     "optional": false
   }

Input Parameters

Attribute	Description
integrationName	Choose the required database integration. You can only choose the integration to which you have access here. Note: If you haven’t configured your database on your Orkes console, navigate to the Integrations tab and configure the integration under “RDBMS > Relational Database”.
type	Indicates the SQL statement type. It can take 2 values: SELECT or UPDATE. SELECT - Used to retrieve data from a database. UPDATE - Used to modify existing data from the database. Expected update count - If you have chosen ‘UPDATE’ as the statement type, provide the number of rows to be updated in the database.
statement	Provide the SQL statement to retrieve data from the SQL database. Example: SELECT * FROM tableName WHERE id=?, a query used to retrieve data from a table in a database. Replace tableName with the actual table name.
parameters	Provide the query parameters to be bound by the SQL statement. It can be a string, number, boolean, or null.
cacheConfig	Enabling this option allows saving the cache output of the task. On enabling, you can provide the following parameters: ttlInSecond - Provide the time to live in seconds. You can also pass this parameter as a variable. key - Provide the cache key, which is a string with parameter substitution based on the task input. You can also pass this parameter as a variable.
optional	Enabling this option renders the task optional. The workflow continues unaffected by the task's outcome, whether it fails or remains incomplete.

Examples

UI

1. Add task type JDBC.
2. Choose the integration name.
3. Choose the Statement Type.
4. Provide the SQL statement & Query parameters.

JSON

   {
     "name": "jdbc",
     "taskReferenceName": "jdbc_ref",
     "inputParameters": {
       "integrationName": "db-001",
       "statement": "SELECT * FROM tableName WHERE id=?",
       "parameters": [
         "${workflow.input.text}"
       ],
       "type": "SELECT"
     },
     "type": "JDBC",
     "cacheConfig": {
       "ttlInSecond": 3600,
       "key": "key"
     },
     "optional": false
   }