5️⃣
Cinchy Platform Documentation
Cinchy v5.8
Cinchy v5.8
  • Data Collaboration Overview
  • Release notes
    • Release notes
      • 5.9 release notes
      • 5.8 Release Notes
      • 5.7 Release Notes
      • 5.6 Release Notes
      • 5.5 Release Notes
      • 5.4 Release Notes
      • 5.3 Release Notes
      • 5.2 Release Notes
      • 5.1 Release Notes
      • 5.0 Release Notes
  • Support
  • Glossary
  • FAQ
  • Deployment guide
    • Deploying Cinchy
      • Plan your deployment
        • Deployment architecture
          • Kubernetes architecture
          • IIS architecture
        • Deployment prerequisites
          • Single Sign-On (SSO) integration
            • Enable TLS 1.2
            • Configure ADFS
            • AD Group Integration
      • Kubernetes
        • Disable your Kubernetes applications
        • Change your file storage configuration
        • Configure AWS IAM for Connections
        • Use Self-Signed SSL Certs (Kubernetes)
        • Deploy the CLI (Kubernetes)
      • IIS
  • Upgrade guide
    • Upgrade Cinchy
      • Cinchy Upgrade Utility
      • Kubernetes upgrades
        • v5.1 (Kubernetes)
        • v5.2 (Kubernetes)
        • v5.3 (Kubernetes)
        • v5.4 (Kubernetes)
        • v5.5 (Kubernetes)
        • v5.6 (Kubernetes)
        • v5.7 (Kubernetes)
        • v5.8 (Kubernetes)
        • Upgrade AWS EKS Kubernetes version
        • Update the Kubernetes Image Registry
        • Upgrade Azure Kubernetes Service (AKS)
      • IIS upgrades
        • v4.21 (IIS)
        • v4.x to v5.x (IIS)
        • v5.1 (IIS)
        • v5.2 (IIS)
        • v5.3 (IIS)
        • v5.4 (IIS)
        • v5.5 (IIS)
        • v5.6 (IIS)
        • v5.7 (IIS)
        • v5.8 (IIS)
      • Upgrading from v4 to v5
  • Guides for using Cinchy
    • User Guide
      • Data Browser overview
      • The Admin panel
      • User preferences
        • Personal access tokens
      • Table features
      • Data management
      • Queries
      • Version management
        • Versioning best practices
      • Commentary
    • Builder Guide
      • Best practices
      • Create tables
        • Attach files
        • Columns
        • Data controls
          • Data entitlements
          • Data erasure
          • Data compression
        • Formatting rules
        • Indexing & partitioning
        • Linking data
        • Table and column GUIDs
        • System tables
      • Delete tables
        • Restore tables, columns, and rows
      • Saved queries
      • CinchyDXD
        • Overview
        • DXD workflow
        • Package the data experience
        • Install the data experience
        • Release package
        • Changelog
        • References
          • Cinchy DXD CLI reference
          • Data Experience Definitions table
          • Data Experience Reference table
      • Multilingual support
      • Integration guides
    • Administrator Guide
    • Additional guides
      • Monitor and Log on Kubernetes
        • Grafana
        • OpenSearch dashboards
          • Set up Alerts
        • Monitor via ArgoCD
      • Maintenance
      • Cinchy Secrets Manager
      • GraphQL (Beta)
      • System properties
      • Enable Data At Rest Encryption (DARE)
      • Application experiences
        • Network map
          • Custom node results
          • Custom results in the Network Map
        • Set up experiences
  • API Guide
    • API overview
      • API authentication
      • API saved queries
      • ExecuteCQL
      • Webhook ingestion
  • CQL
    • Overview
      • CQL examples
      • CQL statements overview
        • Cinchy DML statements
        • Cinchy DDL statements
      • Cinchy supported functions
        • Cinchy functions
        • Cinchy system values
        • Cinchy User Defined Functions (UDFs)
          • Table-valued functions
          • Scalar-valued functions
        • Conversion functions
        • Date and Time types and functions
          • Return System Date and Time values
          • Return Date and Time parts
          • Return Date and Time values from their parts
          • Return Date and Time difference values
          • Modify Date and Time values
          • Validate Date and Time values
        • Logical functions
        • Math functions
        • String functions
        • Geometry and Geography data type and functions
          • OGC methods on Geometry & Geography instances
          • Extended methods on Geometry & Geography instances
        • Full Text Search functions
        • Connections functions
        • JSON functions
    • CQL functions reference list
  • Meta-Forms
    • Introduction
    • Install Meta-Forms
      • Deploy Meta-Forms (Kubernetes)
      • Deploy Meta-Forms (IIS)
    • Forms data types
    • Meta-Forms Builder Guide
      • Create a dynamic meta-form with tables
      • Create a dynamic meta-form example with Form Designer
      • Add links to a form
      • Rich text editing in forms
  • Data syncs
    • Get started with data syncs
    • IIS installation
      • Install Connections
      • Install the Worker/Listener
      • Install the Connections CLI
    • Build data syncs
      • Data sync types
      • Design patterns
      • Sync actions
      • Columns and mappings
        • Calculated column examples
      • Advanced settings
        • Filters
        • Variables
        • Auth requests
        • Request headers
        • Post sync scripts
        • Pagination
      • Batch data sync example
      • Real-time sync example
      • Schedule a data sync
      • Connection functions
    • Data sync sources
      • Cinchy Event Broker/CDC
        • Cinchy Event Broker/CDC XML config example
      • Cinchy Table
        • Cinchy Table XML config example
      • Cinchy Query
        • Cinchy Query XML config example
      • Copper
      • DB2 (query and table)
      • Dynamics 2015
      • Dynamics
      • DynamoDB
      • File-based sources
        • Binary file
        • Delimited file
        • Excel
        • Fixed width file
        • Parquet
      • Kafka Topic
        • Kafka Topic example config
        • Apache AVRO data format
      • LDAP
      • MongoDB collection
        • MongoDB collection source example
      • Mongo event
      • MongoDB collection (Cinchy event)
      • MS SQL Server (query and table)
      • ODBC Query
      • Oracle (query and table)
      • Polling event
        • Polling event example config
      • REST API
      • REST API (Cinchy event)
      • SAP SuccessFactors
      • Salesforce Object (Bulk API)
      • Salesforce platform event
      • Salesforce push topic
      • Snowflake
        • Snowflake source example config
      • SOAP 1.2 web service
      • SOAP 1.2 web service (Cinchy Event Triggered)
    • Data sync destinations
      • Cinchy Table
      • DB2 table
      • Dynamics
      • Kafka Topic
      • MongoDB collection
      • MS SQL Server table
      • Oracle table
      • REST API
      • Salesforce
      • Snowflake table
      • SOAP 1.2 web service
    • Real-time sync stream sources
      • The Listener Config table
      • Cinchy Event Broker/CDC
      • Data Polling
      • Kafka Topic
      • MongoDB
      • Salesforce Push Topic
      • Salesforce Platform Event
    • CLI commands list
    • Troubleshooting
  • Other Resources
    • Angular SDK
    • JavaScript SQK
Powered by GitBook
On this page
  • Overview
  • Global command list
  • Parameters
  • SyncData parameters
  • ExportData parameters
  • Encrypt Parameters
  1. Data syncs

CLI commands list

PreviousSalesforce Platform EventNextTroubleshooting

Last updated 1 year ago

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,

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

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

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 name of the feed configuration as defined in Cinchy.

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

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

ensure that you have installed the CLI.