DB V1 (Deprecated)

Know the component and how to use it.

DB V1 makes SELECT, INSERT, DELETE and UPDATE operations, returning the values to a JSON structure.

Important: be careful with the memory consumption for large datasets. If you prefer, you can use Stream DB instead. To access its article, click here.

Parameters

Take a look at the configuration options for the component:

ParameterDescriptionDefault valueData type

Account

Account to be used by the component.

N/A

N/A

Database URL

Connection string to the database in JDBC format.

N/A

N/A

SQL Statement

SQL statement to be executed.

N/A

N/A

Coalesce

When activated, this option controls if the data objects are coalesced into a string or if an error is generated.

N/A

Boolean

Fail On Error

If the option is enabled, the execution of the pipeline with an error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.

N/A

Boolean

Custom Connection Properties

Specific connection properties defined by the user.

N/A

N/A

Keep Connections

If activated, the option will keep the connections to the database for 30 minutes maximum; otherwise, it will be kept for 5 minutes only.

False

Boolean

Advanced

Advanced configurations.

N/A

N/A

Connection Test Query

SQL statement to be used before each connection is established - this is an optional parameter and must be applied to databases that don't have reliable information about the connection status.

N/A

N/A

Example

{
    "parameters": {
        "field1": {
            "a": "b"
        }
    }
}
  • coalesce = true => field1 = "{\"a\": \"b\"}"

  • coalesce = false => exception

  • coalesce = true => field1 = "{\"a\": \"b\"}"

  • coalesce = false => exception

Messages flow

Input

{
    "parameters": {
        "name": "value"
        ...
    }
}

Output

{
    "data": [
        {"column1":"data1", "column2":"data2", ... }
    ]
    "rowCount": number_of_returned_rows
    "updateCount": number_of_rows_updated
}

Output with error

{
    "data": [
        {"column1":"data1", "column2":"data2", ... }
    ]
    "rowCount": number_of_returned_rows
    "updateCount": number_of_rows_updated
}

To know the functions and uses for databases, click here.

Last updated