Learn R Programming
civis (version 2.1.0)

imports_put_syncs: Update a sync

Description

Update a sync

Usage

imports_put_syncs(id, sync_id, source, destination,
  advanced_options = NULL)

Arguments

id

integer required. The ID of the import to fetch.

sync_id

integer required. The ID of the sync to fetch.

source

list required. A list containing the following elements:

  • path string, The path of the dataset to sync from; for a database source, schema.tablename. If you are doing a Google Sheet export, this can be blank. This is a legacy parameter, it is recommended you use one of the following: databaseTable, file, googleWorksheet, salesforce

  • databaseTable object,

  • file object,

  • googleWorksheet object,

  • salesforce object,

destination

list required. A list containing the following elements:

  • path string, The schema.tablename to sync to. If you are doing a Google Sheet export, this is the spreadsheet and sheet name separated by a period. i.e. if you have a spreadsheet named "MySpreadsheet" and a sheet called "Sheet1" this field would be "MySpreadsheet.Sheet1". This is a legacy parameter, it is recommended you use one of the following: databaseTable, googleWorksheet

  • databaseTable object,

  • googleWorksheet object,

advanced_options

list optional. A list containing the following elements:

  • maxErrors integer,

  • existingTableRows string,

  • diststyle string,

  • distkey string,

  • sortkey1 string,

  • sortkey2 string,

  • columnDelimiter string,

  • columnOverrides object, Hash used for overriding auto-detected names and types, with keys being the index of the column being overridden.

  • escaped boolean, If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false.

  • identityColumn string,

  • rowChunkSize integer,

  • wipeDestinationTable boolean,

  • truncateLongLines boolean,

  • invalidCharReplacement string,

  • verifyTableRowCounts boolean,

  • partitionColumnName string,

  • partitionSchemaName string,

  • partitionTableName string,

  • partitionTablePartitionColumnMinName string,

  • partitionTablePartitionColumnMaxName string,

  • lastModifiedColumn string,

  • mysqlCatalogMatchesSchema boolean,

  • chunkingMethod string, The method used to break the data into smaller chunks for transfer. The value can be set to sorted_by_identity_columns or if not set the chunking method will be choosen automatically.

  • firstRowIsHeader boolean,

  • exportAction string, The kind of export action you want to have the export execute. Set to "newsprsht" if you want a new worksheet inside a new spreadsheet. Set to "newwksht" if you want a new worksheet inside an existing spreadsheet. Set to "updatewksht" if you want to overwrite an existing worksheet inside an existing spreadsheet. Set to "appendwksht" if you want to append to the end of an existing worksheet inside an existing spreadsheet.

  • sqlQuery string, If you are doing a Google Sheet export, this is your SQL query.

  • contactLists string,

  • soqlQuery string,

Value

A list containing the following elements:

id

integer,

source

list, A list containing the following elements:

  • id integer, The ID of the table or file, if available.

  • path string, The path of the dataset to sync from; for a database source, schema.tablename. If you are doing a Google Sheet export, this can be blank. This is a legacy parameter, it is recommended you use one of the following: databaseTable, file, googleWorksheet, salesforce

  • databaseTable object,

  • file object,

  • googleWorksheet object,

  • salesforce object,

destination

list, A list containing the following elements:

  • path string, The schema.tablename to sync to. If you are doing a Google Sheet export, this is the spreadsheet and sheet name separated by a period. i.e. if you have a spreadsheet named "MySpreadsheet" and a sheet called "Sheet1" this field would be "MySpreadsheet.Sheet1". This is a legacy parameter, it is recommended you use one of the following: databaseTable, googleWorksheet

  • databaseTable object,

  • googleWorksheet object,

advancedOptions

list, A list containing the following elements:

  • maxErrors integer,

  • existingTableRows string,

  • diststyle string,

  • distkey string,

  • sortkey1 string,

  • sortkey2 string,

  • columnDelimiter string,

  • columnOverrides object, Hash used for overriding auto-detected names and types, with keys being the index of the column being overridden.

  • escaped boolean, If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false.

  • identityColumn string,

  • rowChunkSize integer,

  • wipeDestinationTable boolean,

  • truncateLongLines boolean,

  • invalidCharReplacement string,

  • verifyTableRowCounts boolean,

  • partitionColumnName string,

  • partitionSchemaName string,

  • partitionTableName string,

  • partitionTablePartitionColumnMinName string,

  • partitionTablePartitionColumnMaxName string,

  • lastModifiedColumn string,

  • mysqlCatalogMatchesSchema boolean,

  • chunkingMethod string, The method used to break the data into smaller chunks for transfer. The value can be set to sorted_by_identity_columns or if not set the chunking method will be choosen automatically.

  • firstRowIsHeader boolean,

  • exportAction string, The kind of export action you want to have the export execute. Set to "newsprsht" if you want a new worksheet inside a new spreadsheet. Set to "newwksht" if you want a new worksheet inside an existing spreadsheet. Set to "updatewksht" if you want to overwrite an existing worksheet inside an existing spreadsheet. Set to "appendwksht" if you want to append to the end of an existing worksheet inside an existing spreadsheet.

  • sqlQuery string, If you are doing a Google Sheet export, this is your SQL query.

  • contactLists string,

  • soqlQuery string,