v5.0 - v5.5 Data Sync Documentation
  • Overview
  • Release Notes
    • V4.5
    • V4.6
    • v4.7
    • v4.8
    • v4.9
    • v4.10
    • v4.12
    • v4.13
  • v4 Connections Installation Guide
    • v5 Connections and CLI Installation Guide
  • v4 Worker/Listener Installation Guide
    • v5 Worker/Listener Installation Guide
  • Upgrades & Config Changes
  • Builder Guide
    • Overview
    • Types of Data Syncs
    • Subscribing to Event Streams
      • Supported Stream Sources
        • Amazon Simple Queue Service (SQS)
        • Cinchy Change Data Capture
        • Data Polling
        • Kafka Topic
        • MongoDB
        • Salesforce
          • Push Topic
          • Platform Event
    • Configuring a Data Sync
      • Connections Experience & XML Config Reference
        • Info
          • Parameters
            • String Escape
        • Source Config Reference
          • Schema Columns
            • Calculated Column Examples
          • Auth Requests
          • Request Headers
          • Pagination
          • Source Filter
        • Target Destination Config Reference
          • Column Mappings
          • Target Destination Filter
        • Sync Behaviour
        • Post Sync
        • Permissions
        • Jobs
        • Connections Usage Example
      • Data Validation
      • Transformations
        • StringReplacement
      • Supported Data Sources
        • File Based Source
          • Binary File
            • Binary File Data Source Example
          • Delimited File
            • Delimited File Data Source XML Example
          • Fixed Width File
          • Excel
            • Excel Source XML Example
        • Cinchy Event Broker/CDC
          • Cinchy Event Broker/CDC XML Config Example
        • Cinchy Table
          • Cinchy Table XML Config Example
        • Cinchy Query
          • Cinchy Query Data Source Example
        • Copper
        • DB2
        • Dynamics 2015
        • Dynamics
        • DynamoDB
        • Kafka Topic
          • Apache AVRO Data Format
          • Kafka Topic Source Example
        • LDAP
        • MongoDB Collection
          • MongoDB Collection Source XML Example
        • MongoDB Collection (Cinchy Event Triggered)
        • MS SQL Server Query
        • MS SQL Server Table
        • ODBC Table
        • ODBC Query
        • Oracle Table
        • Oracle Query
        • Parquet
        • Polling Event
          • Polling Event Example
        • REST API (Cinchy Event Triggered)
        • REST API
          • REST API XML Example
        • SAP SuccessFactors
        • Salesforce Object (Bulk API)
        • Salesforce Platform Event
        • Salesforce Push Topic
        • Snowflake
          • Snowflake Source XML Example
        • SOAP 1.2 Web Service
      • Supported Sync Targets
        • Cinchy Table
        • DB2 Table
        • Dynamics
        • Kafka Topic
        • MongoDB Collection (Column Based)
        • MS SQL Server Table
        • Oracle Table
        • REST API
        • Salesforce
        • Salesforce Object
        • Snowflake Table
          • Snowflake Table Target XML Example
        • SOAP 1.2 Web Service
    • Common Design Patterns
    • Testing a Data Sync
    • Promoting a Data Sync
    • Scheduling a Data Sync
    • CLI Command List
    • Connections Functions
    • Monitoring
  • Cinchy Platform Documentation
Powered by GitBook
On this page
  • Global Command List
  • Parameters

Was this helpful?

  1. Builder Guide

CLI Command List

Global Command List

Command

Description

syncdata

Update a target dataset (e.g. a Cinchy table, a database table, etc.) with data from an input source (e.g. a delimited file, Salesforce, etc.) using a defined key to match records View the parameters for this command below.

exportdata

Exports the results of a saved query to a delimited file.

View the parameters for this command below. Ex:

matchdata

Matches data across sources to create a master record in Cinchy

appdiff

Generates a report outlining the differences between the physical implementation of an application across Cinchy environments

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

Parameters

SyncData Parameters
  • -h, -https: Flag indicating connections to Cinchy should be over https.

  • -s, --server: Required. The full path to the Cinchy server without the protocol (e.g. 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 name of the feed configuration as defined in Cinchy.

  • -d, --tempdirectory: Only applies to Cinchy v4. Required. The path to a directory that the CLI can use for storing temporary files to support the sync (e.g. error files).

  • -b, --batchsize: (Default: 5000) The number of rows to sync per batch (within a partition) when executing inserts/updates.

  • -z, --retrievalbatchsize: (Default: 5000) The max number of rows to retrieve in a single batch from Cinchy when downloading data.

  • -v, --param-values: Job parameter values defined as one or more name value pairs delimited by a colon (i.e. -v name1:value1 name2:value2).

  • --file: Works exactly as -v but it is for parameters that are files.

  • --help: Displays the help screen with the options.

  • -w, --writetofile: Write the data from Cinchy to disk, required for large data sets exceeding 2GB.

ExportData Parameters
  • -h, -https: Flag indicating connections to Cinchy should be over https.

  • -s, --server: Required. The full path to the Cinchy server without the protocol (e.g. 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. The delimiter to used in the output. This can be either COMMA, PIPE, or TAB. This defaults to COMMA if you do not set the parameter.

  • -i, --includeheaders. A flag to include headers in the output file.

  • -e, --encoding. The encoding to use for the output file, either ASCII, UTF8, or UTF16. This defaults to UTF16 if you do not set the parameter.

  • -t, --commandtimeout. The wait time in seconds before terminating the query execution. This defaults to 30 seconds if you do not set the parameter.

  • -g, --progressbatchsize. 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 do not set the parameter.

  • -r, --overwriteoutput. A flag indicating whether to overwrite the output file contents if it already exists.

  • -q, --donotescape. Setting this flag prevents text values from being escaped using quotes. This should only be used if you are certain the delimiter will not appear in your data, otherwise output may be invalid.

  • -v, --param-values. Query parameter values defined as one or more name value pairs delimited by a colon (i.e. -v name1:value1 name2:value2)

  • -a, --tls. The TLS protocol version.

Encrypt Parameters
  • -h, -https: Flag indicating connections to Cinchy should be over https.

  • -s, --server: Required. The full path to the Cinchy server without the protocol (e.g. 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. The TLS protocol version.

PreviousScheduling a Data SyncNextConnections Functions

Last updated 2 years ago

Was this helpful?

./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