OneCloud

Postgres Command Reference

❗️

This article has expired. Please visit the OneCloud Knowledge Base for the latest documentation.

Commands

Execute Create

Execute a CREATE statement

Inputs

Input

Type

Detail

SQL Text/File

TextField

The SQL text or file to execute

Outputs

None

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

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.

Outputs

Output

Output Type

Record Count

Integer

Result Set (CSV)

File

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

SQL Text/File

TextField

The SQL text or file to execute

Outputs

Output

Output Type

Record Count

Integer

Result Set (CSV)

File

Records Updated

Integer

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

SQL Text/File

TextField

The SQL text or file to execute

Outputs

Output

Output Type

Records Updated

Integer

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

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

Records Inserted

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Invalid inputs were given

3

Error

Failed to run the command

Updated 8 months ago

Postgres Command Reference


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.