component.json

{
  "title": "Database",
  "description": "Database JDBC connector",
  "version": "2.5.7",
  "credentials": {
    "verifier": "io.elastic.jdbc.JdbcCredentialsVerifier",
    "fields": {
      "dbEngine": {
        "viewClass": "SelectView",
        "label": "DB Engine",
        "required": true,
        "model": {
          "mysql": "MySQL",
          "postgresql": "PostgreSQL",
          "oracle": "Oracle",
          "mssql": "MSSQL"
        },
        "note": "Please Select Database Type"
      },
      "host": {
        "viewClass": "TextFieldView",
        "label": "Connection URI (host)",
        "required": true,
        "placeholder": "Connection URI"
      },
      "port": {
        "viewClass": "TextFieldView",
        "label": "Connection port",
        "required": false,
        "placeholder": "Connection port"
      },
      "databaseName": {
        "viewClass": "TextFieldView",
        "label": "Database Name",
        "required": true,
        "placeholder": "Database Name"
      },
      "user": {
        "viewClass": "TextFieldView",
        "label": "User",
        "required": true,
        "placeholder": "User"
      },
      "password": {
        "viewClass": "PasswordFieldView",
        "label": "Password",
        "required": true,
        "placeholder": "Password"
      },
      "configurationProperties": {
        "viewClass": "TextFieldView",
        "label": "Configuration properties",
        "required": false,
        "placeholder": "useUnicode=true&serverTimezone=UTC"
      }
    }
  },
  "triggers": {
    "getRowsPolling": {
      "main": "io.elastic.jdbc.triggers.GetRowsPollingTrigger",
      "title": "Get Rows Polling",
      "description": "Executes an operation that polling potentially multiple rows from the database from last timestamp snapshot",
      "type": "polling",
      "fields": {
        "tableName": {
          "viewClass": "SelectView",
          "note": "Select a Table",
          "label": "Tables List",
          "required": true,
          "model": "io.elastic.jdbc.providers.TableNameProvider"
        },
        "pollingField": {
          "viewClass": "SelectView",
          "note": "Select a Timestamp (or similar) Column",
          "label": "Timestamp (or similar) Column",
          "model": "io.elastic.jdbc.providers.TimeStampColumnNamesProvider",
          "required": true,
          "require": [
            "tableName"
          ]
        },
        "pollingValue": {
          "viewClass": "TextFieldView",
          "label": "Start Polling From",
          "note": "Current date is used if no value is specified",
          "required": false,
          "placeholder": "1970-01-01 00:00:00.000"
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.ColumnNamesProvider"
    },
    "selectTrigger": {
      "main": "io.elastic.jdbc.triggers.SelectTrigger",
      "title": "Select",
      "description": "Executes a SELECT statement that fetches potentially multiple rows from the database",
      "type": "polling",
      "fields": {
        "sqlQuery": {
          "viewClass": "TextAreaView",
          "label": "SQL Query",
          "required": true,
          "placeholder": "SELECT * FROM films WHERE created > '%%EIO_LAST_POLL%%'",
          "note": "Before executing the statement the %%EIO_LAST_POLL%% will be replaced with ISO Date of the last execution"
        },
        "pollingValue": {
          "viewClass": "TextFieldView",
          "label": "Start Polling From (optional)",
          "required": false,
          "placeholder": "1970-01-01 00:00:00.000"
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.ColumnNamesProvider"
    },
    "select": {
      "main": "io.elastic.jdbc.triggers.SelectTriggerOld",
      "title": "SELECT",
      "deprecated": true,
      "description": "DEPRECATED: Please use 'Select' Trigger",
      "type": "polling",
      "fields": {
        "tableName": {
          "viewClass": "SelectView",
          "note": "Select a Table",
          "label": "Tables List",
          "required": true,
          "model": "io.elastic.jdbc.providers.TableNameProviderOld"
        },
        "orderField": {
          "viewClass": "SelectView",
          "note": "Select a field to order rows",
          "label": "Order Column",
          "model": "io.elastic.jdbc.providers.ColumnNamesProviderOld",
          "required": true,
          "require": [
            "tableName"
          ]
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.ColumnNamesProviderOld"
    }
  },
  "actions": {
    "customQuery": {
      "main": "io.elastic.jdbc.actions.CustomQuery",
      "title": "Execute custom query",
      "description": "Executes provided sql query string as is",
      "metadata": {
        "in": {
          "type": "object",
          "required": true,
          "properties": {
            "query": {
              "type": "string",
              "required": true
            }
          }
        },
        "out":{
          "type": "object",
          "required": false,
          "properties": {
            "result": {
              "required": false,
              "type": "array"
            },
            "updated": {
              "required": false,
              "type": "number"
            }
          }
        }
      }
    },
    "lookupRowByPrimaryKey": {
      "main": "io.elastic.jdbc.actions.LookupRowByPrimaryKey",
      "title": "Lookup Row By Primary Key",
      "description": "Executes an operation that should fetch exactly one row from the database by primary key",
      "fields": {
        "tableName": {
          "viewClass": "SelectView",
          "note": "Select a Table",
          "label": "Table",
          "required": true,
          "model": "io.elastic.jdbc.providers.TableNameProvider"
        },
        "nullableResult": {
          "label": "Don`t throw Error on an Empty Result",
          "viewClass": "CheckBoxView"
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.PrimaryColumnNamesProvider"
    },
    "upsertRowByPrimaryKey": {
      "main": "io.elastic.jdbc.actions.UpsertRowByPrimaryKey",
      "title": "Upsert Row By Primary Key",
      "description": "Executes upsert by primary key",
      "fields": {
        "tableName": {
          "viewClass": "SelectView",
          "note": "Select a Table",
          "label": "Table",
          "required": true,
          "model": "io.elastic.jdbc.providers.TableNameProvider"
        },
        "reboundEnabled" : {
          "viewClass": "SelectView",
          "note": "Default is No",
          "label": "Enable Rebound",
          "required": false,
          "model" : {
            "Yes" : "Yes",
            "No" : "No"
          }
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.ColumnNamesWithPrimaryKeyProvider"
    },
    "insert": {
      "main": "io.elastic.jdbc.actions.InsertAction",
      "title": "Insert",
      "description": "Executes insert value",
      "fields": {
        "tableName": {
          "viewClass": "SelectView",
          "note": "Select a Table",
          "label": "Table",
          "required": true,
          "model": "io.elastic.jdbc.providers.TableNameProvider"
        },
        "reboundEnabled" : {
          "viewClass": "SelectView",
          "note": "Default is No",
          "label": "Enable Rebound",
          "required": false,
          "model" : {
            "Yes" : "Yes",
            "No" : "No"
          }
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.ColumnNamesForInsertProvider"
    },
    "deleteRowByPrimaryKey": {
      "main": "io.elastic.jdbc.actions.DeleteRowByPrimaryKey",
      "title": "Delete Row By Primary Key",
      "description": "Executes an operation that should remove exactly one row from the database by primary key",
      "fields": {
        "tableName": {
          "viewClass": "SelectView",
          "note": "Select a Table",
          "label": "Tables",
          "required": true,
          "model": "io.elastic.jdbc.providers.TableNameProvider"
        },
        "nullableResult": {
          "label": "Don`t throw Error on an Empty Result",
          "viewClass": "CheckBoxView"
        },
        "reboundEnabled" : {
          "viewClass": "SelectView",
          "note": "Default is No",
          "label": "Enable Rebound",
          "required": false,
          "model" : {
            "Yes" : "Yes",
            "No" : "No"
          }
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.PrimaryColumnNamesProvider"
    },
    "selectAction": {
      "deprecated": true,
      "main": "io.elastic.jdbc.actions.SelectAction",
      "title": "Select",
      "description": "Executes a SELECT statement that fetches potentially multiple rows from the database",
      "fields": {
        "sqlQuery": {
          "viewClass": "TextAreaView",
          "label": "SQL Query",
          "required": true,
          "placeholder": "SELECT * FROM films WHERE watched = @watched:boolean AND created = @created:date",
          "note": "You can use parameters of message body as <i>@value:type</i>"
        },
        "nullableResult": {
          "label": "Don`t throw Error on an Empty Result",
          "viewClass": "CheckBoxView"
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.QueryColumnNamesProvider"
    },
    "newSelectAction": {
      "main": "io.elastic.jdbc.actions.NewSelectAction",
      "title": "Select Query",
      "description": "Executes a SELECT statement that fetches potentially multiple rows from the database",
      "fields": {
        "sqlQuery": {
          "viewClass": "TextAreaView",
          "label": "SQL Query",
          "required": true,
          "placeholder": "SELECT * FROM films WHERE watched = @watched:boolean AND created = @created:date",
          "note": "You can use parameters of message body as <i>@value:type</i>"
        },
        "emitBehaviour": {
          "label": "Emit Behaviour",
          "viewClass": "SelectView",
          "required": false,
          "prompt": "Default Emit Individually",
          "model": {
            "fetchAll": "Fetch All",
            "emitIndividually": "Emit Individually",
            "expectSingle": "Expect Single"
          }
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.QueryColumnNamesAndAllowsZeroResultsProvider"
    },
    "createOrUpdateRecord": {
      "main": "io.elastic.jdbc.actions.CreateOrUpdateRecord",
      "title": "Create or update record",
      "deprecated": true,
      "description": "DEPRECATED: Please use 'Upsert Row By Primary Key' Action",
      "fields": {
        "tableName": {
          "viewClass": "SelectView",
          "note": "Select a Table",
          "label": "Tables",
          "required": true,
          "model": "io.elastic.jdbc.providers.TableNameProviderOld"
        },
        "idColumn": {
          "viewClass": "SelectView",
          "note": "Select an ID column",
          "label": "ID Column",
          "model": "io.elastic.jdbc.providers.ColumnNamesProviderOld",
          "required": true,
          "require": [
            "tableName"
          ]
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.ColumnNamesProviderOld"
    },
    "executeStoredProcedure": {
      "main": "io.elastic.jdbc.actions.ExecuteStoredProcedure",
      "title": "Execute stored procedure",
      "description": "Executing selected stored procedure from selected DB schema",
      "fields": {
        "schemaName": {
          "viewClass": "SelectView",
          "note": "Select a Schema",
          "label": "DB Schema",
          "required": true,
          "model": "io.elastic.jdbc.providers.SchemasProvider"
        },
        "procedureName": {
          "viewClass": "SelectView",
          "note": "Select a stored procedure name",
          "label": "Stored procedure",
          "model": "io.elastic.jdbc.providers.ProcedureFieldsNameProvider",
          "required": true,
          "require": [
            "schemaName"
          ]
        }
      },
      "dynamicMetadata": "io.elastic.jdbc.providers.ProcedureFieldsNameProvider"
    }
  }
}