CLI commands list
Overview
This page provides a list of the commands you can use in tandem with the Cinchy Command LIne Interface (CLI).
Before attempting to use any of the below commands, ensure that you have installed the CLI.
Global command list
| Command | Description |
|---|---|
| Command | Description |
syncdata | Update a target dataset (a Cinchy table, a database table) with data from an input source (a delimited file, Salesforce) using a defined key to match recordsView the parameters for this command. below. |
exportdata | Exports the results of a saved query to a delimited file. Example: ./Cinchy.Connections.CLI.exe exportdata -h -s sandbox.cinchy.net/dev-aurora-2 -d Sandbox -n "Query With Over 1000" -u admin -p cinchy -o 'C:\Users\MyUser\Downloads\output.csv' -r |
encrypt | Generates an encrypted string for use in other areas of the CLI. View the parameters for this command below. |
version | Outputs the current version of the CLI. |
help | Displays more information about a specific command. |
Parameters
SyncData parameters
| Parameter | Condition | Description |
|---|---|---|
| -h, -HTTPS | Optional | Flag indicating connections to Cinchy should be over HTTPS. |
| -s, --server | Required | The full path to the Cinchy server without the protocol (such as cinchy.co/Cinchy). |
| -u, --userid | Required | The user id to login to Cinchy. |
| -p, --password | Required | The password of the specified user. This can be optionally encrypted using the CLI's encrypt command. |
| -f, --feed | Required | The Connection name from your Cinchy instance. |
| -d, --tempdirectory | Required | Only applies to Cinchy v4.. The path to a directory that the CLI can use for storing temporary files to support the sync (such as error files). |
| -b, --batchsize | Optional | (Default: 5000) The number of rows to sync per batch (within a partition) when executing inserts/updates. |
| -z, --retrievalbatchsize | Optional | (Default: 5000) The max number of rows to retrieve in a single batch from Cinchy when downloading data. |
| -v, --param-values | Optional | Job parameter values defined as one or more name value pairs delimited by a colon. For example, -v name1:value1 name2:value2. |
| --file | Optional | Works exactly as -v but it's for parameters that are files. |
| --help | Optional | Displays the help screen with the options. |
| -w, --writetofile | Optional | Write the data from Cinchy to disk, required for large data sets exceeding 2GB. |
| --l, --pat | Optional | The personal access token of the user you want to run the job as. An alternative to userId/password. |
ExportData parameters
| Parameter | Condition | Description |
|---|---|---|
| -h, -HTTPS | Optional | Flag indicating connections to Cinchy should be over HTTPS. |
| -s, --server | Required | The full path to the Cinchy server without the protocol (cinchy.co/Cinchy). |
| -u, --userid | Required | The user id to login to Cinchy. |
| -p, --password | Required | The password of the specified user. This can be optionally encrypted using the CLI's encrypt command. |
| -d, --domain | Required | The domain where your saved query resides. |
| -n, --name | Required. | The name of your saved query. |
| -o, --outputpath | Required | The full path for the target output file. |
| -l, --delimiter | Optional | The delimiter to used in the output. This can be either COMMA, PIPE, or TAB. This defaults to COMMA if you don't set the parameter. |
| -i, --includeheaders | Optional | A flag to include headers in the output file. |
| -e, --encoding | Optional | The encoding to use for the output file, either ASCII, UTF8, or UTF16. This defaults to UTF16 if you don't set the parameter. |
| -t, --commandtimeout | Optional | The wait time in seconds before terminating the query execution. The maximum timeout allowed is 14400 seconds (4 hours). This defaults to 30 seconds if you don't set the parameter. |
| -g, --progressbatchsize | Optional | When downloading data, this is the number of MB after which progress should be logged. Setting this to 0 prevents any progress messages to the console. This defaults to 10 if you don't set the parameter. |
| -r, --overwriteoutput | Optional | A flag indicating whether to overwrite the output file contents if it already exists. |
| -q, --donotescape | Optional | Setting this flag prevents text values from being escaped using quotes. This should only be used if you are certain the delimiter won't appear in your data, otherwise output may be invalid. |
| -v, --param-values | Optional | Query parameter values defined as one or more name value pairs delimited by a colon (-v name1:value1 name2:value2) |
| -a, --tls | Optional | The TLS protocol version. |
Encrypt Parameters
| Parameter | Condition | Description |
|---|---|---|
| -h, -HTTPS | Optional | Flag indicating connections to Cinchy should be over HTTPS. |
| -s, --server | Required | The full path to the Cinchy server without the protocol (cinchy.co/Cinchy). |
| -u, --userid | Required | The user id to login to Cinchy. |
| -p, --password | Required | The password of the specified user. This can be optionally encrypted using the CLI's encrypt command. |
| -t, --text | Required | The full text that you want to encrypt. |
| -a, --tls | Optional | The TLS protocol version. |