Table of Contents

Connections

Commands

Connections

JDBC

JDBC connector for any JDBC enabled database. Add your .jar files and any dependencies to the connection resources.

Inputs

Input

Type

Detail

Notes

Username

TextField

The username to authenticate with.

Password

TextField

The password to authenticate with.

Connection URL

TextField

The connection url. (e.g. jdbc:postgresql://localhost:5432/sample)

JDBC Drive Class

TextField

The class name of the JDBC jar file containing the driver for the connection. (e.g. for Postgres, the driver is located at 'org.postgresql.Driver')

Path to JDBC Driver

TextField

Optional: If your driver is not attached as a resource to your connection, specify the path to the JDBC driver on your runner's file system

Commands

Execute Create

Execute a CREATE statement

Inputs

Input

Type

Detail

Notes

SQL Text/File

TextField

The SQL text or file to execute

Outputs

Output

Output Type

Notes

SQL Error

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid inputs were given

3

Error

Failed to run the command

Execute Query

Execute a SELECT query and receive the results as a CSV.

Inputs

Input

Type

Detail

Notes

SQL Text/File

TextField

The SQL text or file to execute

Delimiter

DropdownField

The delimiter to use for the CSV file output.

Preview Results

BooleanField

Check this if you would like to see a preview of the returned rows.

Statements

ArrayField

Optional list of statements to be executed before your query

Outputs

Output

Output Type

Notes

Record Count

Integer

Result Set (CSV)

File

SQL Error

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid inputs were given

3

Error

Failed to run the command

Execute SQL

Execute any SQL command. If there is a result set it will be available as a file output.

Inputs

Input

Type

Detail

Notes

SQL Text/File

TextField

The SQL text or file to execute

Statements

ArrayField

Optional list of statements to execute before your query executes

Outputs

Output

Output Type

Notes

Record Count

Integer

Result Set (CSV)

File

Records Updated

Integer

SQL Error

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid inputs were given

3

Error

Failed to run the command

Execute Update

Execute an UPDATE statement

Inputs

Input

Type

Detail

Notes

SQL Text/File

TextField

The SQL text or file to execute

Outputs

Output

Output Type

Notes

Records Updated

Integer

SQL Error

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid inputs were given

3

Error

Failed to run the command

Get Table Definition

Retrieve the details of a table including the columns, primary keys and foreign keys in a JSON format

Inputs

Input

Type

Detail

Notes

Table

TextField

The table of which to retrieve the definition

Outputs

Output

Output Type

Notes

Table Metadata

File

SQL Error

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid inputs were given

3

Error

Failed to run the command

Insert Records

Execute an INSERT statement. The source of the data can either be multi-lined text or a CSV file.

Inputs

Input

Type

Detail

Notes

Table

TextField

The table to insert records into.

CSV Data Source

TextField

The CSV data to insert into the table. The columns in this data must match the same order specified in the columns input.

Delimiter

DropdownField

The delimiter used in the source data.

Is a file

BooleanField

If the data source is a file, check this box.

Includes Headers

BooleanField

Check this box if the source data's first row is the headers.

Columns

ArrayField

The list of columns that your source data will populate. Order is important and should match the CSV data source.

Value Template

ArrayField

Custom values declaration for the insert command. Indicate values with a "?". The number of "?"s should match the number of fields in the Target fields. You can leave this blank and they will be auto-generated.

Outputs

Output

Output Type

Notes

Records Inserted

Integer

SQL Error

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid inputs were given

3

Error

Failed to run the command

Did this answer your question?