Table Action Set: Syntax

Provides actions for accessing and managing data

save Action

Saves a table to a caslib's data source.

See:Saving Tables and Exporting Data
Save a Table to a Caslib as a SASHDAT File
Save a Table to a Caslib as a SAS7BDAT File
table.save <result=results> <status=rc> /
caslib="string",
compress=TRUE | FALSE,
convertInt=TRUE | FALSE,
copies=integer,
dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | fedsvr-parameters | gcs-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss-parameters | teradata-parameters | vednfs-parameters | vehdfs-parameters | vepath-parameters | vertica-parameters | ves3-parameters | yellowbrick-parameters},
exportOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DTA" | "EXCEL" | "JMP" | "ORC" | "PARQUET" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter name="string",
permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer,
replace=TRUE | FALSE,
saveAttrs=TRUE | FALSE,
saveForEP=TRUE | FALSE,
required parameter table
={
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
orderBy
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=TRUE | FALSE,
vars
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression",
whereTable
={
casLib="string"
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
viewAsTable=TRUE | FALSE
;
indicates a required parameter

Summary: Input Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

specifies the table name, caslib, and other common parameters.

Parameter Descriptions

caslib="string"

specifies the target caslib for the table.

compress=TRUE | FALSE

when set to True, applies data compression to the table.

DefaultFALSE

convertInt=TRUE | FALSE

Convert INT32 and INT64 data types to double.

DefaultFALSE

copies=integer

specifies the number of redundant copies to make for the rows. Larger values provide greater fault tolerance for node failures but use more memory. Specifying 0 results in no fault tolerance in the event of a node failure.

Minimum value-1

exportOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DTA" | "EXCEL" | "JMP" | "ORC" | "PARQUET" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for saving a table to a data source.

Aliasexport

The value that you specify for the fileType parameter determines the other parameters that apply.

* name="string"

specifies the table name.

permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer

specifies the host access controls on the saved file. This parameter applies to servers that run Linux only. This parameter applies to saving SASHDAT and CSV files in PATH, and DNFS caslibs. For other data sources and file types, refer to the corresponding documentation.

replace=TRUE | FALSE

when set to True, an existing table with the same name is overwritten.

DefaultFALSE

saveAttrs=TRUE | FALSE

when set to True, attributes are automatically saved in a file that is named table-name.ATTRS.sashdat. The file is saved in the same caslib that is used for saving the table. This parameter applies to path-based caslibs only.

DefaultFALSE

saveForEP=TRUE | FALSE

Save in a form optimized for SAS Embedded Process use

DefaultFALSE

* table={castable}

specifies the table name, caslib, and other common parameters.

Long formtable={name="table-name"}
Shortcut formtable="table-name"

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

AliascompOnDemand
DefaultFALSE
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

AliascompVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

AliascompPgm
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliasesoptions
dataSource
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the variables to use for grouping results.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

groupByMode="NOSORT" | "REDISTRIBUTE"

specifies how to create groups.

DefaultNOSORT
NOSORT

groups the data without sorting on each machine, and then groups the data again on the controller.

REDISTRIBUTE

transfers rows between nodes to guarantee ordering within groups. This method is slower.

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the input table.

orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

singlePass=TRUE | FALSE

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

DefaultFALSE
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={}

specifies data source options.

Aliasesoptions
dataSource
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

viewAsTable=TRUE | FALSE

when set to True and the table parameter identifies a view, the contents of the view are saved. By default, the definition of the view is saved.

DefaultFALSE

Parameters for ADLS

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default0
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkload=TRUE | FALSE

When set to TRUE, data is written to Google BigQuery using the Go Loader.Run function.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=TRUE | FALSE

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

mode="PERFORMANCE" | "STANDARD"

PERFORMANCE

Specifies that certain performance options will be set by default

STANDARD

Specifies that no performance options will be set by default

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

qualifier="string"

Specifies an alternate project ID to be used in table references in SQL queries

Aliastable_qualifier

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for CAS

password="string"

user="string"

Parameters for CLOUDDEX

append=TRUE | FALSE

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

casTypes="ALL" | "BASIC"

ALL

Specifies that data types include CHAR and VARCHAR for text. Numeric columns support INTEGER, 64-bit INTEGER, DATE, DATETIME, and TIME. BINARY and VARBINARY are also available.

BASIC

Specifies that data types are limited to DOUBLE, CHAR, and VARCHAR.

catalog="string"

Specifies the database catalog name.

charCreateMultiplier=double

Default1
Range1–5

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

domainCredsRequired=TRUE | FALSE

DefaultTRUE

dropTableOnFailedSave=TRUE | FALSE

DefaultTRUE

insertbuff=integer

Specifies the number of rows to insert in one write block.

ncharCreateMultiplier=double

Default1
Range1–5

ncharMultiplier=double

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1

pwd="string"

Specifies the password.

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

traceFile="string"

Specifies a name for the trace file.

traceFlags="string"

Specifies flags to use for tracing the database connection.

uid="string"

Specifies the user name.

Aliasusername

useMaxCharLen=TRUE | FALSE

DefaultFALSE

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for DB2

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blAllowReadAccess=TRUE | FALSE

Specifies whether the original table data is still visible to readers during a DB2 LOAD. Default is FALSE.

Aliasbl_allow_read_access
DefaultFALSE

blCopyLocation="string"

Specifies the directory to which DB2 saves a copy of the loaded data.

Aliasbl_copy_location

blCpuParallelism=integer

Specifies the number of processes or threads to use when building table objects.

Aliasesbl_cpuparallelism
bl_cpu_parallelism

blDataBufferSize=integer

Specifies the total amount of memory to allocate for the bulk load utility to use as a buffer for transferring data.

Aliasesbl_databuffersize
bl_data_buffer_size

blDiskParallelism=integer

Specifies the number of processes or threads to use when writing data to disk.

Aliasesbl_diskparallelism
bl_disk_parallelism

blExceptionTable="string"

Specifies the exception table into which rows in error are copied.

Aliasesblexception
bl_exception
bl_exception_table

blIndexingMode="string"

Specifies which scheme the bulk load process should use for index maintenance.

Aliasbl_indexing_mode

blLoadReplace=TRUE | FALSE

Specifies whether to replace existing data in the table. Default is FALSE.

Aliasbl_load_replace
DefaultFALSE

blLog="string"

Specifies a path and file name to which information about the loading process is written.

Aliasbl_log

blOptions="string"

Specifies file type modifiers to be passed to the DB2 LOAD interface.

Aliasesbl_options
blModifiedBy
bl_modified_by

blPortMax=integer

Specifies a positive integer that represents the highest available port number for concurrent uploads.

Aliasesbl_portmax
bl_port_max

blPortMin=integer

Specifies a positive integer that represents the lowest available port number for concurrent uploads.

Aliasesbl_portmin
bl_port_min

blRecoverable=TRUE | FALSE

Specifies whether the bulk load process is recoverable.

Aliasbl_recoverable
DefaultFALSE

blRemoteFile="string"

Specifies the full pathname and base filename to which DB2 appends extensions (such as .log, .msg and .dat files) to create temporary files during load operations.

Aliasbl_remote_file

blWarningCount=integer

Specifies the maximum number of row warnings to allow before the load fails.

Aliasbl_warning_count

bulkload=TRUE | FALSE

When set to TRUE, data is written to DB2 using the CLI LOAD functionality.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for FEDSVR

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for GCS

bucket="string"

Parameters for GREENPLUM

allow_unquoted_names="string"

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

fetch_twfs_as_time=TRUE | FALSE

DefaultTRUE

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

max_active_statements="string"

max_binary_len="string"

max_char_len="string"

max_text_len="string"

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

numbytesperchar="string"

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

stripblanks="string"

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates for the JDBC connection

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. This parameter does not apply to CHAR or VARCHAR columns.

Default32767
Minimum value1

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

httpPath="string"

The path component of the JDBC URL

insertbuff=integer

Specifies the number of rows to insert in one write block.

krbAuthType=integer

specifies the Kerberos authentication type.

krbHostFqdn="string"

specifies the Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Kerberos realm.

krbServiceName="string"

specifies the Kerberos service name.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

mapreduceJobName="string"

Specify the MapReduce job name for SAS queries

mapreduceJobQueueName="string"

Specify the MapReduce queue used for SAS queries

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

platform="DATABRICKS" | "HDINSIGHTSPARK" | "HDINSIGHTSPARKLLAP" | "MAPRED" | "SPARK" | "SYNAPSE"

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with LLAP.

MAPRED

Specifies to run Embedded Process jobs on the Map Reduce platform.

SPARK

Specifies Spark on generic platforms, including Hadoop.

SYNAPSE

Specifies Spark on Synapse.

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

Specifies the password.

Aliasespassword
pass

readbuff=integer

Specifies the number of rows to read in one read block.

Aliasesras
row_array_size

schema="string"

Specifies the name of the schema.

Aliasdatabase

sslKeyStore="string"

specifies the SSL key store.

Aliasssl_key_store

sslKeyStorePwd="string"

specifies the SSL key store password.

Aliasssl_key_store_pwd

sslTrustStore="string"

Specify the trust store for the JDBC driver

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

tezQueueName="string"

Specify the TEZ queue used for SAS queries

trustStorePassword="string"

Specify the JDBC driver trust store password

uid="string"

Specifies the user name.

Aliasusername

useSsl="string"

Specifies whether to connect using SSL or not

zooKeeperNamespace="string"

Specify the ZooKeeper namespace

zooKeeperPort=integer

Specify the ZooKeeper client port

Default2181
Range1–65535

zooKeeperQuorum="string"

Specify the ZooKeeper quorum

Parameters for HANA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for IMPALA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkload=TRUE | FALSE

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for INFORMIX

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blDbaccessPath="string"

Specifies the full-path for the DBACCESS utility.

blDefaultDir="string"

Specifies the full-path for data file, log, temporary sqlhost and configuration file.

blDelDatFile=TRUE | FALSE

When set to TRUE, delete all data, log, configuration and temporary sqlhosts files generated.

DefaultTRUE

blDelimiter="string"

Specifies a column delimiter for the data file.Only accept a single ASCII character.

Default"|"

blEnableLog=TRUE | FALSE

When set to TRUE, the utility generates DBACCESS running log.

DefaultFALSE

blLogDir="string"

Specifies the full-path for DBACCESS running log file.

blNfxSdkPath="string"

Specifies the full-path for the Informix Client SDK.

bulkload=TRUE | FALSE

When set to TRUE, use Informix DBACCESS utility to load data into Informix. Default to FALSE.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for JDBC

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

login_timeout=integer

Specifies the number of seconds to wait for a connection attempt before returning an error.

AliasloginTimeout
Minimum value0

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

query_timeout=integer

Specifies the number of seconds to wait for a query to finish executing before returning an error.

AliasqueryTimeout
Minimum value0

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for MONGODB

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for MYSQL

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDefaultDir="string"

When set, specifies the directory into which file will be written.

bulkload=TRUE | FALSE

When set to TRUE, data is written using the tool.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for NETEZZA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for ODBC

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for ORACLE

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for POSTGRES

allow_unquoted_names=TRUE | FALSE

When set to True, table and column names are not automatically enclosed in quotation marks. This enables you to create and access table and column names in the default lowercase setting.

DefaultFALSE

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDelimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

blEscape="string"

Specifies the character that should appear before a data character that matches the QUOTE value for the data file Or turn it off

blFormat="string"

Specifies the format for data file, CSV or TEXT. Default format is CSV.

blNull="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

blQuote="string"

Specifies the quoting character in data file.

blWriteBuff=integer

Specifies the size of a bulkload write buffer.

Default10000
Minimum value1

bulkload=TRUE | FALSE

When set to TRUE, use PostgreSQL utility to load data into Postgres. Default to FALSE.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for REDSHIFT

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

awsConfig="string"

Specifies the AWS configuration file if different from the default.

blFormat="DELIMITED" | "PARQUET"

DELIMITED

Specifies that a delimited format is used as the staging file format for bulk loading

PARQUET

Specifies that PARQUET is used as the staging file format for bulk loading

blOptions="string"

Specifies any additional COPY options that are added to the end of the COPY command.

AliasbulkloadOptions

bucket="string"

Specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=TRUE | FALSE

When set to TRUE, data is written to Redshift using the COPY command.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=TRUE | FALSE

When set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

credentialsFile="string"

Specifies the AWS credentials file to use.

credentialsProfile="string"

Specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=TRUE | FALSE

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

escape=TRUE | FALSE

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFALSE

iamAssumeRoleARN="string"

Specifies an optional Amazon Resource Name (ARN) that identifies an IAM role. The associated IAM role enables you to get access credentials to S3 via the AssumeRole IAM operation.

iamAssumeRoleName="string"

Specifies an optional AWS IAM role name that enables you to get access credentials to S3 via the AssumeRole IAM operation.

iamRole="string"

Specifies an optional AWS IAM role to use for the COPY command instead of key/secret.

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

key="string"

Specifies the Amazon Web Services access key that is used with key-based access control.

AliasblEncKey

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

Specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

Aliasespassword
pass

region="string"

Specifies the Amazon Web Services region that the Redshift server resides for bulk-load.

s3Config="string"

Specifies an optional S3 configuration file

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Specifies the Amazon Web Services secret access key that is used with key-based access control.

token="string"

Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

useSSL=TRUE | FALSE

When set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFALSE

Parameters for SAPIQ

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blobThreshold=integer

Minimum value0

bulkload=TRUE | FALSE

When set to TRUE, data is written to DBMS using the LOAD TABLE command.

DefaultFALSE

bulkunload=TRUE | FALSE

When set to TRUE, data is read from DBMS using the data extraction facility.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

clientDir="string"

Specifies the client view of folder location that contains DBMS data files for bulk operation.

AliasclientDirectory

compress=TRUE | FALSE

When set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

deleteDataFiles=TRUE | FALSE

Specifies whether to delete all files that are created for bulk operation.

DefaultTRUE

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

scanStringColumns=TRUE | FALSE

When set to TRUE, the data connector issues a query to scan all character columns for their max length.

AliasesscanStrings
scan_string_columns
scan_strings
DefaultFALSE

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

serverDir="string"

Specifies the server view of folder location that contains DBMS data files for bulk operation.

AliasserverDirectory

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

usePipe=TRUE | FALSE

Specifies whether to use a named pipe for data transfer for bulk operation.

DefaultTRUE

Parameters for SFORCE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkApi=TRUE | FALSE

When set to TRUE, data is read from and written to Salesforce using the BULK API.

Aliasbulk_api
DefaultFALSE

bulkRefresh=integer

Specifies the time in milliseconds to wait before rechecking the status of a bulk job

Aliasbulk_refresh
Minimum value0

bulkTimeout=integer

Specifies the time in milliseconds to wait before a bulk job is terminated

Aliasbulk_timeout
Minimum value0

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for SINGLESTORE_STANDARD

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDefaultDir="string"

When set, specifies the directory into which file will be written.

bulkload=TRUE | FALSE

When set to TRUE, data is written using the tool.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for SNOWFLAKE

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

awsConfig="string"

Specifies the AWS configuration file if different from the default.

azureSAS="string"

Azure Shared Access Signature for connecting to azure storage.

blNumDataFiles=integer

Specifies the number of local data files to use when bulkloading.

Range0–100

blOptions="string"

Specifies any additional COPY options that are added to the end of the COPY command.

AliasbulkloadOptions

bucket="string"

Specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=TRUE | FALSE

When set to TRUE, data is written to Snowflake using the COPY INTO command.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=TRUE | FALSE

When set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

credentialsFile="string"

Specifies the AWS credentials file to use.

credentialsProfile="string"

Specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=TRUE | FALSE

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

dnsSuffix="string"

DNS Suffix for Azure storage

Default"dfs.core.windows.net"

escape=TRUE | FALSE

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFALSE

fileSystem="string"

Azure storage file system

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

key="string"

Specifies the Amazon Web Services access key that is used with key-based access control.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

Specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

Aliasespassword
pass

region="string"

Specifies the Amazon Web Services region that the Snowflake server resides for bulk-load.

role="string"

Specifies the role for this Snowflake connection

s3Config="string"

Specifies an optional S3 configuration file

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Specifies the Amazon Web Services secret access key that is used with key-based access control.

stage="string"

Specifies the internal stage including path to use for bulk-load.

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

token="string"

Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

useSSL=TRUE | FALSE

When set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFALSE

warehouse="string"

Specifies the Snowflake warehouse

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates for the JDBC connection

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

connCatalog="string"

Specifies the Databricks Unity Catalog

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. This parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

httpPath="string"

The path component of the JDBC URL

insertbuff=integer

Specifies the number of rows to insert in one write block.

krbAuthType=integer

specifies the Kerberos authentication type.

krbHostFqdn="string"

specifies the Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Kerberos realm.

krbServiceName="string"

specifies the Kerberos service name.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

mapreduceJobName="string"

Specify the MapReduce job name for SAS queries

mapreduceJobQueueName="string"

Specify the MapReduce queue used for SAS queries

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

Specifies the password.

Aliasespassword
pass

readbuff=integer

Specifies the number of rows to read in one read block.

Aliasesras
row_array_size

schema="string"

Specifies the name of the schema.

Aliasdatabase

sslKeyStore="string"

specifies the SSL key store.

Aliasssl_key_store

sslKeyStorePwd="string"

specifies the SSL key store password.

Aliasssl_key_store_pwd

sslTrustStore="string"

Specify the trust store for the JDBC driver

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

tezQueueName="string"

Specify the TEZ queue used for SAS queries

trustStorePassword="string"

Specify the JDBC driver trust store password

uid="string"

Specifies the user name.

Aliasusername

useSsl="string"

Specifies whether to connect using SSL or not

zooKeeperNamespace="string"

Specify the ZooKeeper namespace

zooKeeperPort=integer

Specify the ZooKeeper client port

Default2181
Range1–65535

zooKeeperQuorum="string"

Specify the ZooKeeper quorum

Parameters for SPDE

alterPW="string"

Specifies the password to use for Alter access.

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress="BINARY" | "CHAR" | "NO" | "YES"

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

datapath="string"

Specifies the path to place data files for created SPDE tables.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

encrypt="AES" | "NO" | "YES"

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

Specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

label="string"

Specifies a label to apply to the output data set.

masterPW="string"

Specifies the master password to use for Read/Write/Alter access.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

mdfpath="string"

Specifies the path where SPDE MDF are located.

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteBuffers=integer

Specifies the number of write buffers to use for the pipeline write.

Default10
Range1–100

padCompress=integer

Specifies the size of additional padding to allow for compressed SPDE tables. This enables subsequent updates to perform more efficiently.

partSize=64-bit-integer

Specifies the partition size (in number of MBs) to use for created SPDE tables.

Minimum value16

platform="DATABRICKS" | "HDINSIGHTSPARK" | "HDINSIGHTSPARKLLAP" | "MAPRED" | "SPARK" | "SYNAPSE"

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with LLAP.

MAPRED

Specifies to run Embedded Process jobs on the Map Reduce platform.

SPARK

Specifies Spark on generic platforms, including Hadoop.

SYNAPSE

Specifies Spark on Synapse.

pwd="string"

Specifies the password.

Aliasespassword
pass

readPW="string"

Specifies the password to use for Read access.

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

Specifies the user name.

Aliasusername

writePW="string"

Specifies the password to use for Write access.

Parameters for SQLSERVER

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blAuthDomain="string"

Authentication Domain

blFormat="DELIMITED" | "PARQUET"

DELIMITED

Specifies that a delimited format is used as the staging file format for bulk loading

PARQUET

Specifies that PARQUET is used as the staging file format for bulk loading

blOptions="string"

Specifies any additional COPY options that are added as the WITH clause to the COPY INTO command. Make sure the options are complete and match other options specified, for instance the delimiter needs to be added as FIELDTERMINATOR = 'field_terminator'.

AliasbulkloadOptions

bulkload=TRUE | FALSE

When set to TRUE, data is written to Azure Synapse Analytics using the COPY command.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

clientSecret="string"

Client secret for Azure storage

compress=TRUE | FALSE

When set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=TRUE | FALSE

When set to TRUE (the default), all local data files as well as ADLS objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

dnsSuffix="string"

DNS Suffix for Azure storage

Default"dfs.core.windows.net"

escape=TRUE | FALSE

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFALSE

fileSystem="string"

Azure storage file system

folder="string"

Specifies the folder or file path for the data. The location starts from the container/fileSystem

identity="string"

Authentication method

insertMultiValue=TRUE | FALSE

specifies whether to use multi-value insert emulation for parameterized INSERT statements.

Aliasinsert_multi_value
DefaultFALSE

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

maxErrors=integer

Specifies the maximum number of rejected rows allowed in the load before the COPY command is canceled

Default0
Minimum value0

numDataFiles=integer

specifies the number of streams or data files to use when bulkloading.

Range1–8

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Key for authentication

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

uid="string"

Aliasesuser
username

useLog=TRUE | FALSE

Specifies whether to get reports on rejected rows and the corresponding error file

DefaultFALSE

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for SS

* srcType="SINGLESTORE"

Parameters for TERADATA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

Specifies connection options to use for connecting to the Teradata database.

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

Specifies a Teradata Max Text Size value in chars.

Default32000
Range1–32000

insertbuff=integer

Specifies the number of rows to insert in one write block.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Specifies the password.

Aliasespassword
pass

schema="string"

Unused

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

Specifies the user name.

Aliasusername

Parameters for VEDNFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEHDFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEPATH

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VERTICA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for VES3

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

specifies the AWS Key Management Services encryption context for the cryptographic operation.

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

specifies an encryption key in the form of a 64-digit hexadecimal value.

sseTextKey="string"

specifies a plain-text version of the key to use with server-side encryption.

Parameters for YELLOWBRICK

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO.

Parameters for fileType="BASESAS"

alter="string"

specifies the Alter password for the SAS data set.

compress="BINARY" | "CHAR" | "NO" | "YES"

when set to True, applies data compression to the table.

DefaultNO
encoding="string"

specifies file encoding

encrypt="AES" | "AES2" | "NO" | "YES"

specifies whether to encrypt an output SAS data set

DefaultNO
encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

password="string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

pointobs=TRUE | FALSE

specifies whether SAS creates compressed data sets whose observations can be randomly accessed or sequentially accessed

DefaultTRUE
read="string"

specifies the Read password for the SAS data set.

reuse=TRUE | FALSE

specifies whether new rows can be written to freed space in a compressed SAS data set

DefaultFALSE
write="string"

specifies the Write password for the SAS data set.

Parameters for fileType="CSV" | "DELIMITED"

addbom=TRUE | FALSE

when set to True, the file includes a byte-order mark (BOM) at the beginning of the file. The BOM can help programs such as Microsoft Excel to interpret national characters in text fields correctly. By default, the BOM is not added to the file.

DefaultFALSE

Parameters for fileType="DTA"

No parameters apply when you specify DTA.

Parameters for fileType="EXCEL"

range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="JMP"

No parameters apply when you specify JMP.

Parameters for fileType="ORC"

compress="NO" | "YES" | "ZLIB"

when set to True, applies data compression to the table.

DefaultZLIB

Parameters for fileType="PARQUET"

rowGroupMax=integer

Specifies how many rows are grouped together for columnar file types.

Default0
saveCharAsByteArray=TRUE | FALSE

Save CAS fixed-character columns saved as Parquet ByteArray columns.

DefaultFALSE
trimBlanks=TRUE | FALSE

Remove trailing blanks from fixed-character columns saved as Parquet ByteArray columns.

DefaultTRUE

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS.

Parameters for fileType="XLS"

range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

save Action

Saves a table to a caslib's data source.

See:Saving Tables and Exporting Data
Save a Table to a Caslib as a SASHDAT File
Save a Table to a Caslib as a SAS7BDAT File
results, info = s:table_save{
caslib="string",
compress=true | false,
convertInt=true | false,
copies=integer,
dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | fedsvr-parameters | gcs-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss-parameters | teradata-parameters | vednfs-parameters | vehdfs-parameters | vepath-parameters | vertica-parameters | ves3-parameters | yellowbrick-parameters},
exportOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DTA" | "EXCEL" | "JMP" | "ORC" | "PARQUET" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter name="string",
permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer,
replace=true | false,
saveAttrs=true | false,
saveForEP=true | false,
required parameter table
={
caslib="string",
computedOnDemand=true | false,
computedVars
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
orderBy
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=true | false,
vars
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression",
whereTable
={
casLib="string"
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars
={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
viewAsTable=true | false
}
indicates a required parameter

Summary: Input Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

specifies the table name, caslib, and other common parameters.

Parameter Descriptions

caslib="string"

specifies the target caslib for the table.

compress=true | false

when set to True, applies data compression to the table.

Defaultfalse

convertInt=true | false

Convert INT32 and INT64 data types to double.

Defaultfalse

copies=integer

specifies the number of redundant copies to make for the rows. Larger values provide greater fault tolerance for node failures but use more memory. Specifying 0 results in no fault tolerance in the event of a node failure.

Minimum value-1

exportOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DTA" | "EXCEL" | "JMP" | "ORC" | "PARQUET" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for saving a table to a data source.

Aliasexport

The value that you specify for the fileType parameter determines the other parameters that apply.

* name="string"

specifies the table name.

permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer

specifies the host access controls on the saved file. This parameter applies to servers that run Linux only. This parameter applies to saving SASHDAT and CSV files in PATH, and DNFS caslibs. For other data sources and file types, refer to the corresponding documentation.

replace=true | false

when set to True, an existing table with the same name is overwritten.

Defaultfalse

saveAttrs=true | false

when set to True, attributes are automatically saved in a file that is named table-name.ATTRS.sashdat. The file is saved in the same caslib that is used for saving the table. This parameter applies to path-based caslibs only.

Defaultfalse

saveForEP=true | false

Save in a form optimized for SAS Embedded Process use

Defaultfalse

* table={castable}

specifies the table name, caslib, and other common parameters.

Long formtable={name="table-name"}
Shortcut formtable="table-name"

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=true | false

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

AliascompOnDemand
Defaultfalse
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

AliascompVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

AliascompPgm
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliasesoptions
dataSource
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the variables to use for grouping results.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

groupByMode="NOSORT" | "REDISTRIBUTE"

specifies how to create groups.

DefaultNOSORT
NOSORT

groups the data without sorting on each machine, and then groups the data again on the controller.

REDISTRIBUTE

transfers rows between nodes to guarantee ordering within groups. This method is slower.

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the input table.

orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

singlePass=true | false

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

Defaultfalse
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={}

specifies data source options.

Aliasesoptions
dataSource
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

viewAsTable=true | false

when set to True and the table parameter identifies a view, the contents of the view are saved. By default, the definition of the view is saved.

Defaultfalse

Parameters for ADLS

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default0
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkload=true | false

When set to TRUE, data is written to Google BigQuery using the Go Loader.Run function.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=true | false

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

mode="PERFORMANCE" | "STANDARD"

PERFORMANCE

Specifies that certain performance options will be set by default

STANDARD

Specifies that no performance options will be set by default

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

qualifier="string"

Specifies an alternate project ID to be used in table references in SQL queries

Aliastable_qualifier

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for CAS

password="string"

user="string"

Parameters for CLOUDDEX

append=true | false

Defaultfalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

casTypes="ALL" | "BASIC"

ALL

Specifies that data types include CHAR and VARCHAR for text. Numeric columns support INTEGER, 64-bit INTEGER, DATE, DATETIME, and TIME. BINARY and VARBINARY are also available.

BASIC

Specifies that data types are limited to DOUBLE, CHAR, and VARCHAR.

catalog="string"

Specifies the database catalog name.

charCreateMultiplier=double

Default1
Range1–5

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

domainCredsRequired=true | false

DefaultTRUE

dropTableOnFailedSave=true | false

DefaultTRUE

insertbuff=integer

Specifies the number of rows to insert in one write block.

ncharCreateMultiplier=double

Default1
Range1–5

ncharMultiplier=double

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1

pwd="string"

Specifies the password.

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

traceFile="string"

Specifies a name for the trace file.

traceFlags="string"

Specifies flags to use for tracing the database connection.

uid="string"

Specifies the user name.

Aliasusername

useMaxCharLen=true | false

Defaultfalse

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for DB2

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blAllowReadAccess=true | false

Specifies whether the original table data is still visible to readers during a DB2 LOAD. Default is FALSE.

Aliasbl_allow_read_access
Defaultfalse

blCopyLocation="string"

Specifies the directory to which DB2 saves a copy of the loaded data.

Aliasbl_copy_location

blCpuParallelism=integer

Specifies the number of processes or threads to use when building table objects.

Aliasesbl_cpuparallelism
bl_cpu_parallelism

blDataBufferSize=integer

Specifies the total amount of memory to allocate for the bulk load utility to use as a buffer for transferring data.

Aliasesbl_databuffersize
bl_data_buffer_size

blDiskParallelism=integer

Specifies the number of processes or threads to use when writing data to disk.

Aliasesbl_diskparallelism
bl_disk_parallelism

blExceptionTable="string"

Specifies the exception table into which rows in error are copied.

Aliasesblexception
bl_exception
bl_exception_table

blIndexingMode="string"

Specifies which scheme the bulk load process should use for index maintenance.

Aliasbl_indexing_mode

blLoadReplace=true | false

Specifies whether to replace existing data in the table. Default is FALSE.

Aliasbl_load_replace
Defaultfalse

blLog="string"

Specifies a path and file name to which information about the loading process is written.

Aliasbl_log

blOptions="string"

Specifies file type modifiers to be passed to the DB2 LOAD interface.

Aliasesbl_options
blModifiedBy
bl_modified_by

blPortMax=integer

Specifies a positive integer that represents the highest available port number for concurrent uploads.

Aliasesbl_portmax
bl_port_max

blPortMin=integer

Specifies a positive integer that represents the lowest available port number for concurrent uploads.

Aliasesbl_portmin
bl_port_min

blRecoverable=true | false

Specifies whether the bulk load process is recoverable.

Aliasbl_recoverable
Defaultfalse

blRemoteFile="string"

Specifies the full pathname and base filename to which DB2 appends extensions (such as .log, .msg and .dat files) to create temporary files during load operations.

Aliasbl_remote_file

blWarningCount=integer

Specifies the maximum number of row warnings to allow before the load fails.

Aliasbl_warning_count

bulkload=true | false

When set to TRUE, data is written to DB2 using the CLI LOAD functionality.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for FEDSVR

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for GCS

bucket="string"

Parameters for GREENPLUM

allow_unquoted_names="string"

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

fetch_twfs_as_time=true | false

DefaultTRUE

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

max_active_statements="string"

max_binary_len="string"

max_char_len="string"

max_text_len="string"

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

numbytesperchar="string"

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

stripblanks="string"

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates for the JDBC connection

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=true | false

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. This parameter does not apply to CHAR or VARCHAR columns.

Default32767
Minimum value1

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

httpPath="string"

The path component of the JDBC URL

insertbuff=integer

Specifies the number of rows to insert in one write block.

krbAuthType=integer

specifies the Kerberos authentication type.

krbHostFqdn="string"

specifies the Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Kerberos realm.

krbServiceName="string"

specifies the Kerberos service name.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

mapreduceJobName="string"

Specify the MapReduce job name for SAS queries

mapreduceJobQueueName="string"

Specify the MapReduce queue used for SAS queries

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

platform="DATABRICKS" | "HDINSIGHTSPARK" | "HDINSIGHTSPARKLLAP" | "MAPRED" | "SPARK" | "SYNAPSE"

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with LLAP.

MAPRED

Specifies to run Embedded Process jobs on the Map Reduce platform.

SPARK

Specifies Spark on generic platforms, including Hadoop.

SYNAPSE

Specifies Spark on Synapse.

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

Specifies the password.

Aliasespassword
pass

readbuff=integer

Specifies the number of rows to read in one read block.

Aliasesras
row_array_size

schema="string"

Specifies the name of the schema.

Aliasdatabase

sslKeyStore="string"

specifies the SSL key store.

Aliasssl_key_store

sslKeyStorePwd="string"

specifies the SSL key store password.

Aliasssl_key_store_pwd

sslTrustStore="string"

Specify the trust store for the JDBC driver

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

tezQueueName="string"

Specify the TEZ queue used for SAS queries

trustStorePassword="string"

Specify the JDBC driver trust store password

uid="string"

Specifies the user name.

Aliasusername

useSsl="string"

Specifies whether to connect using SSL or not

zooKeeperNamespace="string"

Specify the ZooKeeper namespace

zooKeeperPort=integer

Specify the ZooKeeper client port

Default2181
Range1–65535

zooKeeperQuorum="string"

Specify the ZooKeeper quorum

Parameters for HANA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for IMPALA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkload=true | false

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for INFORMIX

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blDbaccessPath="string"

Specifies the full-path for the DBACCESS utility.

blDefaultDir="string"

Specifies the full-path for data file, log, temporary sqlhost and configuration file.

blDelDatFile=true | false

When set to TRUE, delete all data, log, configuration and temporary sqlhosts files generated.

DefaultTRUE

blDelimiter="string"

Specifies a column delimiter for the data file.Only accept a single ASCII character.

Default"|"

blEnableLog=true | false

When set to TRUE, the utility generates DBACCESS running log.

Defaultfalse

blLogDir="string"

Specifies the full-path for DBACCESS running log file.

blNfxSdkPath="string"

Specifies the full-path for the Informix Client SDK.

bulkload=true | false

When set to TRUE, use Informix DBACCESS utility to load data into Informix. Default to FALSE.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for JDBC

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

login_timeout=integer

Specifies the number of seconds to wait for a connection attempt before returning an error.

AliasloginTimeout
Minimum value0

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

query_timeout=integer

Specifies the number of seconds to wait for a query to finish executing before returning an error.

AliasqueryTimeout
Minimum value0

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for MONGODB

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for MYSQL

append=true | false

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

Defaultfalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDefaultDir="string"

When set, specifies the directory into which file will be written.

bulkload=true | false

When set to TRUE, data is written using the tool.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for NETEZZA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for ODBC

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for ORACLE

append=true | false

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

Defaultfalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for POSTGRES

allow_unquoted_names=true | false

When set to True, table and column names are not automatically enclosed in quotation marks. This enables you to create and access table and column names in the default lowercase setting.

Defaultfalse

append=true | false

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

Defaultfalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDelimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

blEscape="string"

Specifies the character that should appear before a data character that matches the QUOTE value for the data file Or turn it off

blFormat="string"

Specifies the format for data file, CSV or TEXT. Default format is CSV.

blNull="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

blQuote="string"

Specifies the quoting character in data file.

blWriteBuff=integer

Specifies the size of a bulkload write buffer.

Default10000
Minimum value1

bulkload=true | false

When set to TRUE, use PostgreSQL utility to load data into Postgres. Default to FALSE.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for REDSHIFT

append=true | false

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

Defaultfalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

awsConfig="string"

Specifies the AWS configuration file if different from the default.

blFormat="DELIMITED" | "PARQUET"

DELIMITED

Specifies that a delimited format is used as the staging file format for bulk loading

PARQUET

Specifies that PARQUET is used as the staging file format for bulk loading

blOptions="string"

Specifies any additional COPY options that are added to the end of the COPY command.

AliasbulkloadOptions

bucket="string"

Specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=true | false

When set to TRUE, data is written to Redshift using the COPY command.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=true | false

When set to TRUE, use GZIP compression on data files.

Defaultfalse

conopts="string"

credentialsFile="string"

Specifies the AWS credentials file to use.

credentialsProfile="string"

Specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=true | false

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

escape=true | false

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

Defaultfalse

iamAssumeRoleARN="string"

Specifies an optional Amazon Resource Name (ARN) that identifies an IAM role. The associated IAM role enables you to get access credentials to S3 via the AssumeRole IAM operation.

iamAssumeRoleName="string"

Specifies an optional AWS IAM role name that enables you to get access credentials to S3 via the AssumeRole IAM operation.

iamRole="string"

Specifies an optional AWS IAM role to use for the COPY command instead of key/secret.

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

key="string"

Specifies the Amazon Web Services access key that is used with key-based access control.

AliasblEncKey

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

Specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

Aliasespassword
pass

region="string"

Specifies the Amazon Web Services region that the Redshift server resides for bulk-load.

s3Config="string"

Specifies an optional S3 configuration file

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Specifies the Amazon Web Services secret access key that is used with key-based access control.

token="string"

Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

useSSL=true | false

When set to TRUE, create an SSL connection to S3 when transmitting data files.

Defaultfalse

Parameters for SAPIQ

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blobThreshold=integer

Minimum value0

bulkload=true | false

When set to TRUE, data is written to DBMS using the LOAD TABLE command.

Defaultfalse

bulkunload=true | false

When set to TRUE, data is read from DBMS using the data extraction facility.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

clientDir="string"

Specifies the client view of folder location that contains DBMS data files for bulk operation.

AliasclientDirectory

compress=true | false

When set to TRUE, use GZIP compression on data files.

Defaultfalse

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

deleteDataFiles=true | false

Specifies whether to delete all files that are created for bulk operation.

DefaultTRUE

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

scanStringColumns=true | false

When set to TRUE, the data connector issues a query to scan all character columns for their max length.

AliasesscanStrings
scan_string_columns
scan_strings
Defaultfalse

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

serverDir="string"

Specifies the server view of folder location that contains DBMS data files for bulk operation.

AliasserverDirectory

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

usePipe=true | false

Specifies whether to use a named pipe for data transfer for bulk operation.

DefaultTRUE

Parameters for SFORCE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkApi=true | false

When set to TRUE, data is read from and written to Salesforce using the BULK API.

Aliasbulk_api
Defaultfalse

bulkRefresh=integer

Specifies the time in milliseconds to wait before rechecking the status of a bulk job

Aliasbulk_refresh
Minimum value0

bulkTimeout=integer

Specifies the time in milliseconds to wait before a bulk job is terminated

Aliasbulk_timeout
Minimum value0

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for SINGLESTORE_STANDARD

append=true | false

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

Defaultfalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDefaultDir="string"

When set, specifies the directory into which file will be written.

bulkload=true | false

When set to TRUE, data is written using the tool.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for SNOWFLAKE

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

awsConfig="string"

Specifies the AWS configuration file if different from the default.

azureSAS="string"

Azure Shared Access Signature for connecting to azure storage.

blNumDataFiles=integer

Specifies the number of local data files to use when bulkloading.

Range0–100

blOptions="string"

Specifies any additional COPY options that are added to the end of the COPY command.

AliasbulkloadOptions

bucket="string"

Specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=true | false

When set to TRUE, data is written to Snowflake using the COPY INTO command.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=true | false

When set to TRUE, use GZIP compression on data files.

Defaultfalse

conopts="string"

credentialsFile="string"

Specifies the AWS credentials file to use.

credentialsProfile="string"

Specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=true | false

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

dnsSuffix="string"

DNS Suffix for Azure storage

Default"dfs.core.windows.net"

escape=true | false

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

Defaultfalse

fileSystem="string"

Azure storage file system

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

key="string"

Specifies the Amazon Web Services access key that is used with key-based access control.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

Specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

Aliasespassword
pass

region="string"

Specifies the Amazon Web Services region that the Snowflake server resides for bulk-load.

role="string"

Specifies the role for this Snowflake connection

s3Config="string"

Specifies an optional S3 configuration file

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Specifies the Amazon Web Services secret access key that is used with key-based access control.

stage="string"

Specifies the internal stage including path to use for bulk-load.

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

token="string"

Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

useSSL=true | false

When set to TRUE, create an SSL connection to S3 when transmitting data files.

Defaultfalse

warehouse="string"

Specifies the Snowflake warehouse

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates for the JDBC connection

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=true | false

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

connCatalog="string"

Specifies the Databricks Unity Catalog

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. This parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

httpPath="string"

The path component of the JDBC URL

insertbuff=integer

Specifies the number of rows to insert in one write block.

krbAuthType=integer

specifies the Kerberos authentication type.

krbHostFqdn="string"

specifies the Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Kerberos realm.

krbServiceName="string"

specifies the Kerberos service name.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

mapreduceJobName="string"

Specify the MapReduce job name for SAS queries

mapreduceJobQueueName="string"

Specify the MapReduce queue used for SAS queries

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

Specifies the password.

Aliasespassword
pass

readbuff=integer

Specifies the number of rows to read in one read block.

Aliasesras
row_array_size

schema="string"

Specifies the name of the schema.

Aliasdatabase

sslKeyStore="string"

specifies the SSL key store.

Aliasssl_key_store

sslKeyStorePwd="string"

specifies the SSL key store password.

Aliasssl_key_store_pwd

sslTrustStore="string"

Specify the trust store for the JDBC driver

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

tezQueueName="string"

Specify the TEZ queue used for SAS queries

trustStorePassword="string"

Specify the JDBC driver trust store password

uid="string"

Specifies the user name.

Aliasusername

useSsl="string"

Specifies whether to connect using SSL or not

zooKeeperNamespace="string"

Specify the ZooKeeper namespace

zooKeeperPort=integer

Specify the ZooKeeper client port

Default2181
Range1–65535

zooKeeperQuorum="string"

Specify the ZooKeeper quorum

Parameters for SPDE

alterPW="string"

Specifies the password to use for Alter access.

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress="BINARY" | "CHAR" | "NO" | "YES"

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

datapath="string"

Specifies the path to place data files for created SPDE tables.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

encrypt="AES" | "NO" | "YES"

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

Specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

label="string"

Specifies a label to apply to the output data set.

masterPW="string"

Specifies the master password to use for Read/Write/Alter access.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

mdfpath="string"

Specifies the path where SPDE MDF are located.

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteBuffers=integer

Specifies the number of write buffers to use for the pipeline write.

Default10
Range1–100

padCompress=integer

Specifies the size of additional padding to allow for compressed SPDE tables. This enables subsequent updates to perform more efficiently.

partSize=64-bit-integer

Specifies the partition size (in number of MBs) to use for created SPDE tables.

Minimum value16

platform="DATABRICKS" | "HDINSIGHTSPARK" | "HDINSIGHTSPARKLLAP" | "MAPRED" | "SPARK" | "SYNAPSE"

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with LLAP.

MAPRED

Specifies to run Embedded Process jobs on the Map Reduce platform.

SPARK

Specifies Spark on generic platforms, including Hadoop.

SYNAPSE

Specifies Spark on Synapse.

pwd="string"

Specifies the password.

Aliasespassword
pass

readPW="string"

Specifies the password to use for Read access.

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

Specifies the user name.

Aliasusername

writePW="string"

Specifies the password to use for Write access.

Parameters for SQLSERVER

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blAuthDomain="string"

Authentication Domain

blFormat="DELIMITED" | "PARQUET"

DELIMITED

Specifies that a delimited format is used as the staging file format for bulk loading

PARQUET

Specifies that PARQUET is used as the staging file format for bulk loading

blOptions="string"

Specifies any additional COPY options that are added as the WITH clause to the COPY INTO command. Make sure the options are complete and match other options specified, for instance the delimiter needs to be added as FIELDTERMINATOR = 'field_terminator'.

AliasbulkloadOptions

bulkload=true | false

When set to TRUE, data is written to Azure Synapse Analytics using the COPY command.

Defaultfalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

clientSecret="string"

Client secret for Azure storage

compress=true | false

When set to TRUE, use GZIP compression on data files.

Defaultfalse

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=true | false

When set to TRUE (the default), all local data files as well as ADLS objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

dnsSuffix="string"

DNS Suffix for Azure storage

Default"dfs.core.windows.net"

escape=true | false

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

Defaultfalse

fileSystem="string"

Azure storage file system

folder="string"

Specifies the folder or file path for the data. The location starts from the container/fileSystem

identity="string"

Authentication method

insertMultiValue=true | false

specifies whether to use multi-value insert emulation for parameterized INSERT statements.

Aliasinsert_multi_value
Defaultfalse

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

maxErrors=integer

Specifies the maximum number of rejected rows allowed in the load before the COPY command is canceled

Default0
Minimum value0

numDataFiles=integer

specifies the number of streams or data files to use when bulkloading.

Range1–8

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Key for authentication

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

uid="string"

Aliasesuser
username

useLog=true | false

Specifies whether to get reports on rejected rows and the corresponding error file

Defaultfalse

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for SS

* srcType="SINGLESTORE"

Parameters for TERADATA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

Specifies connection options to use for connecting to the Teradata database.

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

Specifies a Teradata Max Text Size value in chars.

Default32000
Range1–32000

insertbuff=integer

Specifies the number of rows to insert in one write block.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Specifies the password.

Aliasespassword
pass

schema="string"

Unused

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

Specifies the user name.

Aliasusername

Parameters for VEDNFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEHDFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEPATH

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VERTICA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for VES3

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

specifies the AWS Key Management Services encryption context for the cryptographic operation.

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

specifies an encryption key in the form of a 64-digit hexadecimal value.

sseTextKey="string"

specifies a plain-text version of the key to use with server-side encryption.

Parameters for YELLOWBRICK

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=true | false

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
Defaultfalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=true | false

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
Defaultfalse

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO.

Parameters for fileType="BASESAS"

alter="string"

specifies the Alter password for the SAS data set.

compress="BINARY" | "CHAR" | "NO" | "YES"

when set to True, applies data compression to the table.

DefaultNO
encoding="string"

specifies file encoding

encrypt="AES" | "AES2" | "NO" | "YES"

specifies whether to encrypt an output SAS data set

DefaultNO
encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

password="string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

pointobs=true | false

specifies whether SAS creates compressed data sets whose observations can be randomly accessed or sequentially accessed

Defaulttrue
read="string"

specifies the Read password for the SAS data set.

reuse=true | false

specifies whether new rows can be written to freed space in a compressed SAS data set

Defaultfalse
write="string"

specifies the Write password for the SAS data set.

Parameters for fileType="CSV" | "DELIMITED"

addbom=true | false

when set to True, the file includes a byte-order mark (BOM) at the beginning of the file. The BOM can help programs such as Microsoft Excel to interpret national characters in text fields correctly. By default, the BOM is not added to the file.

Defaultfalse

Parameters for fileType="DTA"

No parameters apply when you specify DTA.

Parameters for fileType="EXCEL"

range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="JMP"

No parameters apply when you specify JMP.

Parameters for fileType="ORC"

compress="NO" | "YES" | "ZLIB"

when set to True, applies data compression to the table.

DefaultZLIB

Parameters for fileType="PARQUET"

rowGroupMax=integer

Specifies how many rows are grouped together for columnar file types.

Default0
saveCharAsByteArray=true | false

Save CAS fixed-character columns saved as Parquet ByteArray columns.

Defaultfalse
trimBlanks=true | false

Remove trailing blanks from fixed-character columns saved as Parquet ByteArray columns.

Defaulttrue

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS.

Parameters for fileType="XLS"

range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

save Action

Saves a table to a caslib's data source.

See:Saving Tables and Exporting Data
Save a Table to a Caslib as a SASHDAT File
Save a Table to a Caslib as a SAS7BDAT File
results=s.table.save(
caslib="string",
compress=True | False,
convertInt=True | False,
copies=integer,
dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | fedsvr-parameters | gcs-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss-parameters | teradata-parameters | vednfs-parameters | vehdfs-parameters | vepath-parameters | vertica-parameters | ves3-parameters | yellowbrick-parameters},
exportOptions={"fileType":"AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DTA" | "EXCEL" | "JMP" | "ORC" | "PARQUET" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter name="string",
permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer,
replace=True | False,
saveAttrs=True | False,
saveForEP=True | False,
required parameter table
={
"caslib":"string",
"computedOnDemand":True | False,
"computedVars"
:[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},
"groupBy"
:[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter "name":"table-name",
"orderBy"
:[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"singlePass":True | False,
"vars"
:[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"where":"where-expression",
"whereTable"
:{
"casLib":"string"
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter "name":"table-name"
"vars"
:[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>]
"where":"where-expression"
}
},
viewAsTable=True | False
)
indicates a required parameter

Summary: Input Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

specifies the table name, caslib, and other common parameters.

Parameter Descriptions

caslib="string"

specifies the target caslib for the table.

compress=True | False

when set to True, applies data compression to the table.

DefaultFalse

convertInt=True | False

Convert INT32 and INT64 data types to double.

DefaultFalse

copies=integer

specifies the number of redundant copies to make for the rows. Larger values provide greater fault tolerance for node failures but use more memory. Specifying 0 results in no fault tolerance in the event of a node failure.

Minimum value-1

exportOptions={"fileType":"AUTO" | "BASESAS" | "CSV" | "DTA" | "EXCEL" | "JMP" | "ORC" | "PARQUET" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for saving a table to a data source.

Aliasexport

The value that you specify for the fileType parameter determines the other parameters that apply.

* name="string"

specifies the table name.

permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer

specifies the host access controls on the saved file. This parameter applies to servers that run Linux only. This parameter applies to saving SASHDAT and CSV files in PATH, and DNFS caslibs. For other data sources and file types, refer to the corresponding documentation.

replace=True | False

when set to True, an existing table with the same name is overwritten.

DefaultFalse

saveAttrs=True | False

when set to True, attributes are automatically saved in a file that is named table-name.ATTRS.sashdat. The file is saved in the same caslib that is used for saving the table. This parameter applies to path-based caslibs only.

DefaultFalse

saveForEP=True | False

Save in a form optimized for SAS Embedded Process use

DefaultFalse

* table={castable}

specifies the table name, caslib, and other common parameters.

Long formtable={"name":"table-name"}
Shortcut formtable="table-name"

The castable value can be one or more of the following:

"caslib":"string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

"computedOnDemand":True | False

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

AliascompOnDemand
DefaultFalse
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

AliascompVars

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"computedVarsProgram":"string"

specifies an expression for each computed variable that you include in the computedVars parameter.

AliascompPgm
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Aliasesoptions
dataSource
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the names of the variables to use for grouping results.

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"groupByMode":"NOSORT" | "REDISTRIBUTE"

specifies how to create groups.

DefaultNOSORT
NOSORT

groups the data without sorting on each machine, and then groups the data again on the controller.

REDISTRIBUTE

transfers rows between nodes to guarantee ordering within groups. This method is slower.

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport_

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* "name":"table-name"

specifies the name of the input table.

"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"singlePass":True | False

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

DefaultFalse
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variables to use in the action.

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the input data.

"whereTable":{groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

The groupbytable value can be one or more of the following:

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{}

specifies data source options.

Aliasesoptions
dataSource
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Aliasimport_

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* "name":"table-name"

specifies the name of the filter table.

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the data from the filter table.

viewAsTable=True | False

when set to True and the table parameter identifies a view, the contents of the view are saved. By default, the definition of the view is saved.

DefaultFalse

Parameters for ADLS

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default0
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkload=True | False

When set to TRUE, data is written to Google BigQuery using the Go Loader.Run function.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=True | False

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

mode="PERFORMANCE" | "STANDARD"

PERFORMANCE

Specifies that certain performance options will be set by default

STANDARD

Specifies that no performance options will be set by default

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

qualifier="string"

Specifies an alternate project ID to be used in table references in SQL queries

Aliastable_qualifier

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for CAS

password="string"

user="string"

Parameters for CLOUDDEX

append=True | False

DefaultFalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

casTypes="ALL" | "BASIC"

ALL

Specifies that data types include CHAR and VARCHAR for text. Numeric columns support INTEGER, 64-bit INTEGER, DATE, DATETIME, and TIME. BINARY and VARBINARY are also available.

BASIC

Specifies that data types are limited to DOUBLE, CHAR, and VARCHAR.

catalog="string"

Specifies the database catalog name.

charCreateMultiplier=double

Default1
Range1–5

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

domainCredsRequired=True | False

DefaultTRUE

dropTableOnFailedSave=True | False

DefaultTRUE

insertbuff=integer

Specifies the number of rows to insert in one write block.

ncharCreateMultiplier=double

Default1
Range1–5

ncharMultiplier=double

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1

pwd="string"

Specifies the password.

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

traceFile="string"

Specifies a name for the trace file.

traceFlags="string"

Specifies flags to use for tracing the database connection.

uid="string"

Specifies the user name.

Aliasusername

useMaxCharLen=True | False

DefaultFalse

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for DB2

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blAllowReadAccess=True | False

Specifies whether the original table data is still visible to readers during a DB2 LOAD. Default is FALSE.

Aliasbl_allow_read_access
DefaultFalse

blCopyLocation="string"

Specifies the directory to which DB2 saves a copy of the loaded data.

Aliasbl_copy_location

blCpuParallelism=integer

Specifies the number of processes or threads to use when building table objects.

Aliasesbl_cpuparallelism
bl_cpu_parallelism

blDataBufferSize=integer

Specifies the total amount of memory to allocate for the bulk load utility to use as a buffer for transferring data.

Aliasesbl_databuffersize
bl_data_buffer_size

blDiskParallelism=integer

Specifies the number of processes or threads to use when writing data to disk.

Aliasesbl_diskparallelism
bl_disk_parallelism

blExceptionTable="string"

Specifies the exception table into which rows in error are copied.

Aliasesblexception
bl_exception
bl_exception_table

blIndexingMode="string"

Specifies which scheme the bulk load process should use for index maintenance.

Aliasbl_indexing_mode

blLoadReplace=True | False

Specifies whether to replace existing data in the table. Default is FALSE.

Aliasbl_load_replace
DefaultFalse

blLog="string"

Specifies a path and file name to which information about the loading process is written.

Aliasbl_log

blOptions="string"

Specifies file type modifiers to be passed to the DB2 LOAD interface.

Aliasesbl_options
blModifiedBy
bl_modified_by

blPortMax=integer

Specifies a positive integer that represents the highest available port number for concurrent uploads.

Aliasesbl_portmax
bl_port_max

blPortMin=integer

Specifies a positive integer that represents the lowest available port number for concurrent uploads.

Aliasesbl_portmin
bl_port_min

blRecoverable=True | False

Specifies whether the bulk load process is recoverable.

Aliasbl_recoverable
DefaultFalse

blRemoteFile="string"

Specifies the full pathname and base filename to which DB2 appends extensions (such as .log, .msg and .dat files) to create temporary files during load operations.

Aliasbl_remote_file

blWarningCount=integer

Specifies the maximum number of row warnings to allow before the load fails.

Aliasbl_warning_count

bulkload=True | False

When set to TRUE, data is written to DB2 using the CLI LOAD functionality.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for FEDSVR

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for GCS

bucket="string"

Parameters for GREENPLUM

allow_unquoted_names="string"

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

fetch_twfs_as_time=True | False

DefaultTRUE

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

max_active_statements="string"

max_binary_len="string"

max_char_len="string"

max_text_len="string"

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

numbytesperchar="string"

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

stripblanks="string"

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates for the JDBC connection

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=True | False

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. This parameter does not apply to CHAR or VARCHAR columns.

Default32767
Minimum value1

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

httpPath="string"

The path component of the JDBC URL

insertbuff=integer

Specifies the number of rows to insert in one write block.

krbAuthType=integer

specifies the Kerberos authentication type.

krbHostFqdn="string"

specifies the Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Kerberos realm.

krbServiceName="string"

specifies the Kerberos service name.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

mapreduceJobName="string"

Specify the MapReduce job name for SAS queries

mapreduceJobQueueName="string"

Specify the MapReduce queue used for SAS queries

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

platform="DATABRICKS" | "HDINSIGHTSPARK" | "HDINSIGHTSPARKLLAP" | "MAPRED" | "SPARK" | "SYNAPSE"

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with LLAP.

MAPRED

Specifies to run Embedded Process jobs on the Map Reduce platform.

SPARK

Specifies Spark on generic platforms, including Hadoop.

SYNAPSE

Specifies Spark on Synapse.

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

Specifies the password.

Aliasespassword
pass_

readbuff=integer

Specifies the number of rows to read in one read block.

Aliasesras
row_array_size

schema="string"

Specifies the name of the schema.

Aliasdatabase

sslKeyStore="string"

specifies the SSL key store.

Aliasssl_key_store

sslKeyStorePwd="string"

specifies the SSL key store password.

Aliasssl_key_store_pwd

sslTrustStore="string"

Specify the trust store for the JDBC driver

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

tezQueueName="string"

Specify the TEZ queue used for SAS queries

trustStorePassword="string"

Specify the JDBC driver trust store password

uid="string"

Specifies the user name.

Aliasusername

useSsl="string"

Specifies whether to connect using SSL or not

zooKeeperNamespace="string"

Specify the ZooKeeper namespace

zooKeeperPort=integer

Specify the ZooKeeper client port

Default2181
Range1–65535

zooKeeperQuorum="string"

Specify the ZooKeeper quorum

Parameters for HANA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for IMPALA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkload=True | False

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for INFORMIX

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blDbaccessPath="string"

Specifies the full-path for the DBACCESS utility.

blDefaultDir="string"

Specifies the full-path for data file, log, temporary sqlhost and configuration file.

blDelDatFile=True | False

When set to TRUE, delete all data, log, configuration and temporary sqlhosts files generated.

DefaultTRUE

blDelimiter="string"

Specifies a column delimiter for the data file.Only accept a single ASCII character.

Default"|"

blEnableLog=True | False

When set to TRUE, the utility generates DBACCESS running log.

DefaultFalse

blLogDir="string"

Specifies the full-path for DBACCESS running log file.

blNfxSdkPath="string"

Specifies the full-path for the Informix Client SDK.

bulkload=True | False

When set to TRUE, use Informix DBACCESS utility to load data into Informix. Default to FALSE.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for JDBC

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

login_timeout=integer

Specifies the number of seconds to wait for a connection attempt before returning an error.

AliasloginTimeout
Minimum value0

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

query_timeout=integer

Specifies the number of seconds to wait for a query to finish executing before returning an error.

AliasqueryTimeout
Minimum value0

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for MONGODB

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for MYSQL

append=True | False

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDefaultDir="string"

When set, specifies the directory into which file will be written.

bulkload=True | False

When set to TRUE, data is written using the tool.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for NETEZZA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for ODBC

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for ORACLE

append=True | False

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for POSTGRES

allow_unquoted_names=True | False

When set to True, table and column names are not automatically enclosed in quotation marks. This enables you to create and access table and column names in the default lowercase setting.

DefaultFalse

append=True | False

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDelimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

blEscape="string"

Specifies the character that should appear before a data character that matches the QUOTE value for the data file Or turn it off

blFormat="string"

Specifies the format for data file, CSV or TEXT. Default format is CSV.

blNull="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

blQuote="string"

Specifies the quoting character in data file.

blWriteBuff=integer

Specifies the size of a bulkload write buffer.

Default10000
Minimum value1

bulkload=True | False

When set to TRUE, use PostgreSQL utility to load data into Postgres. Default to FALSE.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for REDSHIFT

append=True | False

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

awsConfig="string"

Specifies the AWS configuration file if different from the default.

blFormat="DELIMITED" | "PARQUET"

DELIMITED

Specifies that a delimited format is used as the staging file format for bulk loading

PARQUET

Specifies that PARQUET is used as the staging file format for bulk loading

blOptions="string"

Specifies any additional COPY options that are added to the end of the COPY command.

AliasbulkloadOptions

bucket="string"

Specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=True | False

When set to TRUE, data is written to Redshift using the COPY command.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=True | False

When set to TRUE, use GZIP compression on data files.

DefaultFalse

conopts="string"

credentialsFile="string"

Specifies the AWS credentials file to use.

credentialsProfile="string"

Specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=True | False

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

escape=True | False

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFalse

iamAssumeRoleARN="string"

Specifies an optional Amazon Resource Name (ARN) that identifies an IAM role. The associated IAM role enables you to get access credentials to S3 via the AssumeRole IAM operation.

iamAssumeRoleName="string"

Specifies an optional AWS IAM role name that enables you to get access credentials to S3 via the AssumeRole IAM operation.

iamRole="string"

Specifies an optional AWS IAM role to use for the COPY command instead of key/secret.

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

key="string"

Specifies the Amazon Web Services access key that is used with key-based access control.

AliasblEncKey

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

Specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

Aliasespassword
pass_

region="string"

Specifies the Amazon Web Services region that the Redshift server resides for bulk-load.

s3Config="string"

Specifies an optional S3 configuration file

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Specifies the Amazon Web Services secret access key that is used with key-based access control.

token="string"

Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

useSSL=True | False

When set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFalse

Parameters for SAPIQ

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blobThreshold=integer

Minimum value0

bulkload=True | False

When set to TRUE, data is written to DBMS using the LOAD TABLE command.

DefaultFalse

bulkunload=True | False

When set to TRUE, data is read from DBMS using the data extraction facility.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

clientDir="string"

Specifies the client view of folder location that contains DBMS data files for bulk operation.

AliasclientDirectory

compress=True | False

When set to TRUE, use GZIP compression on data files.

DefaultFalse

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

deleteDataFiles=True | False

Specifies whether to delete all files that are created for bulk operation.

DefaultTRUE

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

scanStringColumns=True | False

When set to TRUE, the data connector issues a query to scan all character columns for their max length.

AliasesscanStrings
scan_string_columns
scan_strings
DefaultFalse

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

serverDir="string"

Specifies the server view of folder location that contains DBMS data files for bulk operation.

AliasserverDirectory

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

usePipe=True | False

Specifies whether to use a named pipe for data transfer for bulk operation.

DefaultTRUE

Parameters for SFORCE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkApi=True | False

When set to TRUE, data is read from and written to Salesforce using the BULK API.

Aliasbulk_api
DefaultFalse

bulkRefresh=integer

Specifies the time in milliseconds to wait before rechecking the status of a bulk job

Aliasbulk_refresh
Minimum value0

bulkTimeout=integer

Specifies the time in milliseconds to wait before a bulk job is terminated

Aliasbulk_timeout
Minimum value0

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for SINGLESTORE_STANDARD

append=True | False

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFalse

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDefaultDir="string"

When set, specifies the directory into which file will be written.

bulkload=True | False

When set to TRUE, data is written using the tool.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for SNOWFLAKE

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

awsConfig="string"

Specifies the AWS configuration file if different from the default.

azureSAS="string"

Azure Shared Access Signature for connecting to azure storage.

blNumDataFiles=integer

Specifies the number of local data files to use when bulkloading.

Range0–100

blOptions="string"

Specifies any additional COPY options that are added to the end of the COPY command.

AliasbulkloadOptions

bucket="string"

Specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=True | False

When set to TRUE, data is written to Snowflake using the COPY INTO command.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=True | False

When set to TRUE, use GZIP compression on data files.

DefaultFalse

conopts="string"

credentialsFile="string"

Specifies the AWS credentials file to use.

credentialsProfile="string"

Specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=True | False

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

dnsSuffix="string"

DNS Suffix for Azure storage

Default"dfs.core.windows.net"

escape=True | False

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFalse

fileSystem="string"

Azure storage file system

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

key="string"

Specifies the Amazon Web Services access key that is used with key-based access control.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

Specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

Aliasespassword
pass_

region="string"

Specifies the Amazon Web Services region that the Snowflake server resides for bulk-load.

role="string"

Specifies the role for this Snowflake connection

s3Config="string"

Specifies an optional S3 configuration file

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Specifies the Amazon Web Services secret access key that is used with key-based access control.

stage="string"

Specifies the internal stage including path to use for bulk-load.

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

token="string"

Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

useSSL=True | False

When set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFalse

warehouse="string"

Specifies the Snowflake warehouse

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates for the JDBC connection

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=True | False

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

connCatalog="string"

Specifies the Databricks Unity Catalog

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. This parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

httpPath="string"

The path component of the JDBC URL

insertbuff=integer

Specifies the number of rows to insert in one write block.

krbAuthType=integer

specifies the Kerberos authentication type.

krbHostFqdn="string"

specifies the Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Kerberos realm.

krbServiceName="string"

specifies the Kerberos service name.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

mapreduceJobName="string"

Specify the MapReduce job name for SAS queries

mapreduceJobQueueName="string"

Specify the MapReduce queue used for SAS queries

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

Specifies the password.

Aliasespassword
pass_

readbuff=integer

Specifies the number of rows to read in one read block.

Aliasesras
row_array_size

schema="string"

Specifies the name of the schema.

Aliasdatabase

sslKeyStore="string"

specifies the SSL key store.

Aliasssl_key_store

sslKeyStorePwd="string"

specifies the SSL key store password.

Aliasssl_key_store_pwd

sslTrustStore="string"

Specify the trust store for the JDBC driver

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

tezQueueName="string"

Specify the TEZ queue used for SAS queries

trustStorePassword="string"

Specify the JDBC driver trust store password

uid="string"

Specifies the user name.

Aliasusername

useSsl="string"

Specifies whether to connect using SSL or not

zooKeeperNamespace="string"

Specify the ZooKeeper namespace

zooKeeperPort=integer

Specify the ZooKeeper client port

Default2181
Range1–65535

zooKeeperQuorum="string"

Specify the ZooKeeper quorum

Parameters for SPDE

alterPW="string"

Specifies the password to use for Alter access.

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress="BINARY" | "CHAR" | "NO" | "YES"

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

datapath="string"

Specifies the path to place data files for created SPDE tables.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

encrypt="AES" | "NO" | "YES"

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

Specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

label="string"

Specifies a label to apply to the output data set.

masterPW="string"

Specifies the master password to use for Read/Write/Alter access.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

mdfpath="string"

Specifies the path where SPDE MDF are located.

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteBuffers=integer

Specifies the number of write buffers to use for the pipeline write.

Default10
Range1–100

padCompress=integer

Specifies the size of additional padding to allow for compressed SPDE tables. This enables subsequent updates to perform more efficiently.

partSize=64-bit-integer

Specifies the partition size (in number of MBs) to use for created SPDE tables.

Minimum value16

platform="DATABRICKS" | "HDINSIGHTSPARK" | "HDINSIGHTSPARKLLAP" | "MAPRED" | "SPARK" | "SYNAPSE"

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with LLAP.

MAPRED

Specifies to run Embedded Process jobs on the Map Reduce platform.

SPARK

Specifies Spark on generic platforms, including Hadoop.

SYNAPSE

Specifies Spark on Synapse.

pwd="string"

Specifies the password.

Aliasespassword
pass_

readPW="string"

Specifies the password to use for Read access.

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

Specifies the user name.

Aliasusername

writePW="string"

Specifies the password to use for Write access.

Parameters for SQLSERVER

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blAuthDomain="string"

Authentication Domain

blFormat="DELIMITED" | "PARQUET"

DELIMITED

Specifies that a delimited format is used as the staging file format for bulk loading

PARQUET

Specifies that PARQUET is used as the staging file format for bulk loading

blOptions="string"

Specifies any additional COPY options that are added as the WITH clause to the COPY INTO command. Make sure the options are complete and match other options specified, for instance the delimiter needs to be added as FIELDTERMINATOR = 'field_terminator'.

AliasbulkloadOptions

bulkload=True | False

When set to TRUE, data is written to Azure Synapse Analytics using the COPY command.

DefaultFalse

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

clientSecret="string"

Client secret for Azure storage

compress=True | False

When set to TRUE, use GZIP compression on data files.

DefaultFalse

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=True | False

When set to TRUE (the default), all local data files as well as ADLS objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

dnsSuffix="string"

DNS Suffix for Azure storage

Default"dfs.core.windows.net"

escape=True | False

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFalse

fileSystem="string"

Azure storage file system

folder="string"

Specifies the folder or file path for the data. The location starts from the container/fileSystem

identity="string"

Authentication method

insertMultiValue=True | False

specifies whether to use multi-value insert emulation for parameterized INSERT statements.

Aliasinsert_multi_value
DefaultFalse

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

maxErrors=integer

Specifies the maximum number of rejected rows allowed in the load before the COPY command is canceled

Default0
Minimum value0

numDataFiles=integer

specifies the number of streams or data files to use when bulkloading.

Range1–8

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Key for authentication

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

uid="string"

Aliasesuser
username

useLog=True | False

Specifies whether to get reports on rejected rows and the corresponding error file

DefaultFalse

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for SS

* srcType="SINGLESTORE"

Parameters for TERADATA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

Specifies connection options to use for connecting to the Teradata database.

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

Specifies a Teradata Max Text Size value in chars.

Default32000
Range1–32000

insertbuff=integer

Specifies the number of rows to insert in one write block.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Specifies the password.

Aliasespassword
pass_

schema="string"

Unused

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

Specifies the user name.

Aliasusername

Parameters for VEDNFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEHDFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEPATH

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VERTICA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for VES3

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

specifies the AWS Key Management Services encryption context for the cryptographic operation.

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

specifies an encryption key in the form of a 64-digit hexadecimal value.

sseTextKey="string"

specifies a plain-text version of the key to use with server-side encryption.

Parameters for YELLOWBRICK

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=True | False

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFalse

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass_

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=True | False

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFalse

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO.

Parameters for fileType="BASESAS"

"alter":"string"

specifies the Alter password for the SAS data set.

"compress":"BINARY" | "CHAR" | "NO" | "YES"

when set to True, applies data compression to the table.

DefaultNO
"encoding":"string"

specifies file encoding

"encrypt":"AES" | "AES2" | "NO" | "YES"

specifies whether to encrypt an output SAS data set

DefaultNO
"encryptionPassword":"string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

"password":"string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

"pointobs":True | False

specifies whether SAS creates compressed data sets whose observations can be randomly accessed or sequentially accessed

DefaultTrue
"read":"string"

specifies the Read password for the SAS data set.

"reuse":True | False

specifies whether new rows can be written to freed space in a compressed SAS data set

DefaultFalse
"write":"string"

specifies the Write password for the SAS data set.

Parameters for fileType="CSV" | "DELIMITED"

"addbom":True | False

when set to True, the file includes a byte-order mark (BOM) at the beginning of the file. The BOM can help programs such as Microsoft Excel to interpret national characters in text fields correctly. By default, the BOM is not added to the file.

DefaultFalse

Parameters for fileType="DTA"

No parameters apply when you specify DTA.

Parameters for fileType="EXCEL"

"range":"string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

"sheet":"string"

specifies the name of the worksheet to import.

Parameters for fileType="JMP"

No parameters apply when you specify JMP.

Parameters for fileType="ORC"

"compress":"NO" | "YES" | "ZLIB"

when set to True, applies data compression to the table.

DefaultZLIB

Parameters for fileType="PARQUET"

"rowGroupMax":integer

Specifies how many rows are grouped together for columnar file types.

Default0
"saveCharAsByteArray":True | False

Save CAS fixed-character columns saved as Parquet ByteArray columns.

DefaultFalse
"trimBlanks":True | False

Remove trailing blanks from fixed-character columns saved as Parquet ByteArray columns.

DefaultTrue

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS.

Parameters for fileType="XLS"

"range":"string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

"sheet":"string"

specifies the name of the worksheet to import.

save Action

Saves a table to a caslib's data source.

See:Saving Tables and Exporting Data
Save a Table to a Caslib as a SASHDAT File
Save a Table to a Caslib as a SAS7BDAT File
results <– cas.table.save(s,
caslib="string",
compress=TRUE | FALSE,
convertInt=TRUE | FALSE,
copies=integer,
dataSourceOptions=list(adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | fedsvr-parameters | gcs-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss-parameters | teradata-parameters | vednfs-parameters | vehdfs-parameters | vepath-parameters | vertica-parameters | ves3-parameters | yellowbrick-parameters),
exportOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DTA" | "EXCEL" | "JMP" | "ORC" | "PARQUET" | "SPSS" | "XLS", fileType-specific-parameters),
required parameter name="string",
permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer,
replace=TRUE | FALSE,
saveAttrs=TRUE | FALSE,
saveForEP=TRUE | FALSE,
required parameter table
=list(
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars
=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),
groupBy
=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters),
required parameter name="table-name",
orderBy
=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
singlePass=TRUE | FALSE,
vars
=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
where="where-expression",
whereTable
=list(
casLib="string"
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
required parameter name="table-name"
vars
=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>)
where="where-expression"
)
),
viewAsTable=TRUE | FALSE
)
indicates a required parameter

Summary: Input Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

specifies the table name, caslib, and other common parameters.

Parameter Descriptions

caslib="string"

specifies the target caslib for the table.

compress=TRUE | FALSE

when set to True, applies data compression to the table.

DefaultFALSE

convertInt=TRUE | FALSE

Convert INT32 and INT64 data types to double.

DefaultFALSE

copies=integer

specifies the number of redundant copies to make for the rows. Larger values provide greater fault tolerance for node failures but use more memory. Specifying 0 results in no fault tolerance in the event of a node failure.

Minimum value-1

exportOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DTA" | "EXCEL" | "JMP" | "ORC" | "PARQUET" | "SPSS" | "XLS", fileType-specific-parameters)

specifies the settings for saving a table to a data source.

Aliasexport

The value that you specify for the fileType parameter determines the other parameters that apply.

* name="string"

specifies the table name.

permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer

specifies the host access controls on the saved file. This parameter applies to servers that run Linux only. This parameter applies to saving SASHDAT and CSV files in PATH, and DNFS caslibs. For other data sources and file types, refer to the corresponding documentation.

replace=TRUE | FALSE

when set to True, an existing table with the same name is overwritten.

DefaultFALSE

saveAttrs=TRUE | FALSE

when set to True, attributes are automatically saved in a file that is named table-name.ATTRS.sashdat. The file is saved in the same caslib that is used for saving the table. This parameter applies to path-based caslibs only.

DefaultFALSE

saveForEP=TRUE | FALSE

Save in a form optimized for SAS Embedded Process use

DefaultFALSE

* table=list(castable)

specifies the table name, caslib, and other common parameters.

Long formtable=list(name="table-name")
Shortcut formtable="table-name"

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

AliascompOnDemand
DefaultFALSE
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

AliascompVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

AliascompPgm
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

specifies data source options.

Aliasesoptions
dataSource
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the names of the variables to use for grouping results.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

groupByMode="NOSORT" | "REDISTRIBUTE"

specifies how to create groups.

DefaultNOSORT
NOSORT

groups the data without sorting on each machine, and then groups the data again on the controller.

REDISTRIBUTE

transfers rows between nodes to guarantee ordering within groups. This method is slower.

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Aliasimport

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the input table.

orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

singlePass=TRUE | FALSE

when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.

DefaultFALSE
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variables to use in the action.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable=list(groupbytable)

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions=list()

specifies data source options.

Aliasesoptions
dataSource
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Aliasimport

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the filter table.

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

viewAsTable=TRUE | FALSE

when set to True and the table parameter identifies a view, the contents of the view are saved. By default, the definition of the view is saved.

DefaultFALSE

Parameters for ADLS

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default0
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkload=TRUE | FALSE

When set to TRUE, data is written to Google BigQuery using the Go Loader.Run function.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=TRUE | FALSE

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

mode="PERFORMANCE" | "STANDARD"

PERFORMANCE

Specifies that certain performance options will be set by default

STANDARD

Specifies that no performance options will be set by default

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

qualifier="string"

Specifies an alternate project ID to be used in table references in SQL queries

Aliastable_qualifier

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for CAS

password="string"

user="string"

Parameters for CLOUDDEX

append=TRUE | FALSE

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

casTypes="ALL" | "BASIC"

ALL

Specifies that data types include CHAR and VARCHAR for text. Numeric columns support INTEGER, 64-bit INTEGER, DATE, DATETIME, and TIME. BINARY and VARBINARY are also available.

BASIC

Specifies that data types are limited to DOUBLE, CHAR, and VARCHAR.

catalog="string"

Specifies the database catalog name.

charCreateMultiplier=double

Default1
Range1–5

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

domainCredsRequired=TRUE | FALSE

DefaultTRUE

dropTableOnFailedSave=TRUE | FALSE

DefaultTRUE

insertbuff=integer

Specifies the number of rows to insert in one write block.

ncharCreateMultiplier=double

Default1
Range1–5

ncharMultiplier=double

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1

pwd="string"

Specifies the password.

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

traceFile="string"

Specifies a name for the trace file.

traceFlags="string"

Specifies flags to use for tracing the database connection.

uid="string"

Specifies the user name.

Aliasusername

useMaxCharLen=TRUE | FALSE

DefaultFALSE

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for DB2

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blAllowReadAccess=TRUE | FALSE

Specifies whether the original table data is still visible to readers during a DB2 LOAD. Default is FALSE.

Aliasbl_allow_read_access
DefaultFALSE

blCopyLocation="string"

Specifies the directory to which DB2 saves a copy of the loaded data.

Aliasbl_copy_location

blCpuParallelism=integer

Specifies the number of processes or threads to use when building table objects.

Aliasesbl_cpuparallelism
bl_cpu_parallelism

blDataBufferSize=integer

Specifies the total amount of memory to allocate for the bulk load utility to use as a buffer for transferring data.

Aliasesbl_databuffersize
bl_data_buffer_size

blDiskParallelism=integer

Specifies the number of processes or threads to use when writing data to disk.

Aliasesbl_diskparallelism
bl_disk_parallelism

blExceptionTable="string"

Specifies the exception table into which rows in error are copied.

Aliasesblexception
bl_exception
bl_exception_table

blIndexingMode="string"

Specifies which scheme the bulk load process should use for index maintenance.

Aliasbl_indexing_mode

blLoadReplace=TRUE | FALSE

Specifies whether to replace existing data in the table. Default is FALSE.

Aliasbl_load_replace
DefaultFALSE

blLog="string"

Specifies a path and file name to which information about the loading process is written.

Aliasbl_log

blOptions="string"

Specifies file type modifiers to be passed to the DB2 LOAD interface.

Aliasesbl_options
blModifiedBy
bl_modified_by

blPortMax=integer

Specifies a positive integer that represents the highest available port number for concurrent uploads.

Aliasesbl_portmax
bl_port_max

blPortMin=integer

Specifies a positive integer that represents the lowest available port number for concurrent uploads.

Aliasesbl_portmin
bl_port_min

blRecoverable=TRUE | FALSE

Specifies whether the bulk load process is recoverable.

Aliasbl_recoverable
DefaultFALSE

blRemoteFile="string"

Specifies the full pathname and base filename to which DB2 appends extensions (such as .log, .msg and .dat files) to create temporary files during load operations.

Aliasbl_remote_file

blWarningCount=integer

Specifies the maximum number of row warnings to allow before the load fails.

Aliasbl_warning_count

bulkload=TRUE | FALSE

When set to TRUE, data is written to DB2 using the CLI LOAD functionality.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for FEDSVR

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for GCS

bucket="string"

Parameters for GREENPLUM

allow_unquoted_names="string"

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

fetch_twfs_as_time=TRUE | FALSE

DefaultTRUE

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

max_active_statements="string"

max_binary_len="string"

max_char_len="string"

max_text_len="string"

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

numbytesperchar="string"

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

stripblanks="string"

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates for the JDBC connection

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. This parameter does not apply to CHAR or VARCHAR columns.

Default32767
Minimum value1

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

httpPath="string"

The path component of the JDBC URL

insertbuff=integer

Specifies the number of rows to insert in one write block.

krbAuthType=integer

specifies the Kerberos authentication type.

krbHostFqdn="string"

specifies the Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Kerberos realm.

krbServiceName="string"

specifies the Kerberos service name.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

mapreduceJobName="string"

Specify the MapReduce job name for SAS queries

mapreduceJobQueueName="string"

Specify the MapReduce queue used for SAS queries

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

platform="DATABRICKS" | "HDINSIGHTSPARK" | "HDINSIGHTSPARKLLAP" | "MAPRED" | "SPARK" | "SYNAPSE"

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with LLAP.

MAPRED

Specifies to run Embedded Process jobs on the Map Reduce platform.

SPARK

Specifies Spark on generic platforms, including Hadoop.

SYNAPSE

Specifies Spark on Synapse.

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

Specifies the password.

Aliasespassword
pass

readbuff=integer

Specifies the number of rows to read in one read block.

Aliasesras
row_array_size

schema="string"

Specifies the name of the schema.

Aliasdatabase

sslKeyStore="string"

specifies the SSL key store.

Aliasssl_key_store

sslKeyStorePwd="string"

specifies the SSL key store password.

Aliasssl_key_store_pwd

sslTrustStore="string"

Specify the trust store for the JDBC driver

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

tezQueueName="string"

Specify the TEZ queue used for SAS queries

trustStorePassword="string"

Specify the JDBC driver trust store password

uid="string"

Specifies the user name.

Aliasusername

useSsl="string"

Specifies whether to connect using SSL or not

zooKeeperNamespace="string"

Specify the ZooKeeper namespace

zooKeeperPort=integer

Specify the ZooKeeper client port

Default2181
Range1–65535

zooKeeperQuorum="string"

Specify the ZooKeeper quorum

Parameters for HANA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for IMPALA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkload=TRUE | FALSE

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for INFORMIX

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blDbaccessPath="string"

Specifies the full-path for the DBACCESS utility.

blDefaultDir="string"

Specifies the full-path for data file, log, temporary sqlhost and configuration file.

blDelDatFile=TRUE | FALSE

When set to TRUE, delete all data, log, configuration and temporary sqlhosts files generated.

DefaultTRUE

blDelimiter="string"

Specifies a column delimiter for the data file.Only accept a single ASCII character.

Default"|"

blEnableLog=TRUE | FALSE

When set to TRUE, the utility generates DBACCESS running log.

DefaultFALSE

blLogDir="string"

Specifies the full-path for DBACCESS running log file.

blNfxSdkPath="string"

Specifies the full-path for the Informix Client SDK.

bulkload=TRUE | FALSE

When set to TRUE, use Informix DBACCESS utility to load data into Informix. Default to FALSE.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for JDBC

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

login_timeout=integer

Specifies the number of seconds to wait for a connection attempt before returning an error.

AliasloginTimeout
Minimum value0

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

query_timeout=integer

Specifies the number of seconds to wait for a query to finish executing before returning an error.

AliasqueryTimeout
Minimum value0

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for MONGODB

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for MYSQL

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDefaultDir="string"

When set, specifies the directory into which file will be written.

bulkload=TRUE | FALSE

When set to TRUE, data is written using the tool.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for NETEZZA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for ODBC

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for ORACLE

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for POSTGRES

allow_unquoted_names=TRUE | FALSE

When set to True, table and column names are not automatically enclosed in quotation marks. This enables you to create and access table and column names in the default lowercase setting.

DefaultFALSE

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDelimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

blEscape="string"

Specifies the character that should appear before a data character that matches the QUOTE value for the data file Or turn it off

blFormat="string"

Specifies the format for data file, CSV or TEXT. Default format is CSV.

blNull="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

blQuote="string"

Specifies the quoting character in data file.

blWriteBuff=integer

Specifies the size of a bulkload write buffer.

Default10000
Minimum value1

bulkload=TRUE | FALSE

When set to TRUE, use PostgreSQL utility to load data into Postgres. Default to FALSE.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for REDSHIFT

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

awsConfig="string"

Specifies the AWS configuration file if different from the default.

blFormat="DELIMITED" | "PARQUET"

DELIMITED

Specifies that a delimited format is used as the staging file format for bulk loading

PARQUET

Specifies that PARQUET is used as the staging file format for bulk loading

blOptions="string"

Specifies any additional COPY options that are added to the end of the COPY command.

AliasbulkloadOptions

bucket="string"

Specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=TRUE | FALSE

When set to TRUE, data is written to Redshift using the COPY command.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=TRUE | FALSE

When set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

credentialsFile="string"

Specifies the AWS credentials file to use.

credentialsProfile="string"

Specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=TRUE | FALSE

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

escape=TRUE | FALSE

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFALSE

iamAssumeRoleARN="string"

Specifies an optional Amazon Resource Name (ARN) that identifies an IAM role. The associated IAM role enables you to get access credentials to S3 via the AssumeRole IAM operation.

iamAssumeRoleName="string"

Specifies an optional AWS IAM role name that enables you to get access credentials to S3 via the AssumeRole IAM operation.

iamRole="string"

Specifies an optional AWS IAM role to use for the COPY command instead of key/secret.

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

key="string"

Specifies the Amazon Web Services access key that is used with key-based access control.

AliasblEncKey

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

Specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

Aliasespassword
pass

region="string"

Specifies the Amazon Web Services region that the Redshift server resides for bulk-load.

s3Config="string"

Specifies an optional S3 configuration file

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Specifies the Amazon Web Services secret access key that is used with key-based access control.

token="string"

Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

useSSL=TRUE | FALSE

When set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFALSE

Parameters for SAPIQ

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

blobThreshold=integer

Minimum value0

bulkload=TRUE | FALSE

When set to TRUE, data is written to DBMS using the LOAD TABLE command.

DefaultFALSE

bulkunload=TRUE | FALSE

When set to TRUE, data is read from DBMS using the data extraction facility.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

clientDir="string"

Specifies the client view of folder location that contains DBMS data files for bulk operation.

AliasclientDirectory

compress=TRUE | FALSE

When set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

deleteDataFiles=TRUE | FALSE

Specifies whether to delete all files that are created for bulk operation.

DefaultTRUE

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

scanStringColumns=TRUE | FALSE

When set to TRUE, the data connector issues a query to scan all character columns for their max length.

AliasesscanStrings
scan_string_columns
scan_strings
DefaultFALSE

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

serverDir="string"

Specifies the server view of folder location that contains DBMS data files for bulk operation.

AliasserverDirectory

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

usePipe=TRUE | FALSE

Specifies whether to use a named pipe for data transfer for bulk operation.

DefaultTRUE

Parameters for SFORCE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bulkApi=TRUE | FALSE

When set to TRUE, data is read from and written to Salesforce using the BULK API.

Aliasbulk_api
DefaultFALSE

bulkRefresh=integer

Specifies the time in milliseconds to wait before rechecking the status of a bulk job

Aliasbulk_refresh
Minimum value0

bulkTimeout=integer

Specifies the time in milliseconds to wait before a bulk job is terminated

Aliasbulk_timeout
Minimum value0

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for SINGLESTORE_STANDARD

append=TRUE | FALSE

When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.

DefaultFALSE

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blDefaultDir="string"

When set, specifies the directory into which file will be written.

bulkload=TRUE | FALSE

When set to TRUE, data is written using the tool.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for SNOWFLAKE

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

awsConfig="string"

Specifies the AWS configuration file if different from the default.

azureSAS="string"

Azure Shared Access Signature for connecting to azure storage.

blNumDataFiles=integer

Specifies the number of local data files to use when bulkloading.

Range0–100

blOptions="string"

Specifies any additional COPY options that are added to the end of the COPY command.

AliasbulkloadOptions

bucket="string"

Specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=TRUE | FALSE

When set to TRUE, data is written to Snowflake using the COPY INTO command.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=TRUE | FALSE

When set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

credentialsFile="string"

Specifies the AWS credentials file to use.

credentialsProfile="string"

Specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=TRUE | FALSE

When set to TRUE (the default), all local data files as well as S3 objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

dnsSuffix="string"

DNS Suffix for Azure storage

Default"dfs.core.windows.net"

escape=TRUE | FALSE

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFALSE

fileSystem="string"

Azure storage file system

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

key="string"

Specifies the Amazon Web Services access key that is used with key-based access control.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

Specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

Aliasespassword
pass

region="string"

Specifies the Amazon Web Services region that the Snowflake server resides for bulk-load.

role="string"

Specifies the role for this Snowflake connection

s3Config="string"

Specifies an optional S3 configuration file

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Specifies the Amazon Web Services secret access key that is used with key-based access control.

stage="string"

Specifies the internal stage including path to use for bulk-load.

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

token="string"

Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

useSSL=TRUE | FALSE

When set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFALSE

warehouse="string"

Specifies the Snowflake warehouse

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates for the JDBC connection

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

connCatalog="string"

Specifies the Databricks Unity Catalog

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. This parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

httpPath="string"

The path component of the JDBC URL

insertbuff=integer

Specifies the number of rows to insert in one write block.

krbAuthType=integer

specifies the Kerberos authentication type.

krbHostFqdn="string"

specifies the Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Kerberos realm.

krbServiceName="string"

specifies the Kerberos service name.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

mapreduceJobName="string"

Specify the MapReduce job name for SAS queries

mapreduceJobQueueName="string"

Specify the MapReduce queue used for SAS queries

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

Specifies the password.

Aliasespassword
pass

readbuff=integer

Specifies the number of rows to read in one read block.

Aliasesras
row_array_size

schema="string"

Specifies the name of the schema.

Aliasdatabase

sslKeyStore="string"

specifies the SSL key store.

Aliasssl_key_store

sslKeyStorePwd="string"

specifies the SSL key store password.

Aliasssl_key_store_pwd

sslTrustStore="string"

Specify the trust store for the JDBC driver

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

tezQueueName="string"

Specify the TEZ queue used for SAS queries

trustStorePassword="string"

Specify the JDBC driver trust store password

uid="string"

Specifies the user name.

Aliasusername

useSsl="string"

Specifies whether to connect using SSL or not

zooKeeperNamespace="string"

Specify the ZooKeeper namespace

zooKeeperPort=integer

Specify the ZooKeeper client port

Default2181
Range1–65535

zooKeeperQuorum="string"

Specify the ZooKeeper quorum

Parameters for SPDE

alterPW="string"

Specifies the password to use for Alter access.

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress="BINARY" | "CHAR" | "NO" | "YES"

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

datapath="string"

Specifies the path to place data files for created SPDE tables.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

encrypt="AES" | "NO" | "YES"

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

Specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

Specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

label="string"

Specifies a label to apply to the output data set.

masterPW="string"

Specifies the master password to use for Read/Write/Alter access.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

mdfpath="string"

Specifies the path where SPDE MDF are located.

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteBuffers=integer

Specifies the number of write buffers to use for the pipeline write.

Default10
Range1–100

padCompress=integer

Specifies the size of additional padding to allow for compressed SPDE tables. This enables subsequent updates to perform more efficiently.

partSize=64-bit-integer

Specifies the partition size (in number of MBs) to use for created SPDE tables.

Minimum value16

platform="DATABRICKS" | "HDINSIGHTSPARK" | "HDINSIGHTSPARKLLAP" | "MAPRED" | "SPARK" | "SYNAPSE"

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with LLAP.

MAPRED

Specifies to run Embedded Process jobs on the Map Reduce platform.

SPARK

Specifies Spark on generic platforms, including Hadoop.

SYNAPSE

Specifies Spark on Synapse.

pwd="string"

Specifies the password.

Aliasespassword
pass

readPW="string"

Specifies the password to use for Read access.

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

Specifies the user name.

Aliasusername

writePW="string"

Specifies the password to use for Write access.

Parameters for SQLSERVER

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

blAuthDomain="string"

Authentication Domain

blFormat="DELIMITED" | "PARQUET"

DELIMITED

Specifies that a delimited format is used as the staging file format for bulk loading

PARQUET

Specifies that PARQUET is used as the staging file format for bulk loading

blOptions="string"

Specifies any additional COPY options that are added as the WITH clause to the COPY INTO command. Make sure the options are complete and match other options specified, for instance the delimiter needs to be added as FIELDTERMINATOR = 'field_terminator'.

AliasbulkloadOptions

bulkload=TRUE | FALSE

When set to TRUE, data is written to Azure Synapse Analytics using the COPY command.

DefaultFALSE

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

clientSecret="string"

Client secret for Azure storage

compress=TRUE | FALSE

When set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

defaultDir="string"

Specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

AliasdefaultDirectory

deleteDataFiles=TRUE | FALSE

When set to TRUE (the default), all local data files as well as ADLS objects are deleted after the COPY command completes.

DefaultTRUE

delimiter="string"

Specifies a column delimiter for the data file. Either a single ASCII character or an octal sequence.

dnsSuffix="string"

DNS Suffix for Azure storage

Default"dfs.core.windows.net"

escape=TRUE | FALSE

When set to TRUE, any restricted characters in string data are escaped to allow processing with COPY.

DefaultFALSE

fileSystem="string"

Azure storage file system

folder="string"

Specifies the folder or file path for the data. The location starts from the container/fileSystem

identity="string"

Authentication method

insertMultiValue=TRUE | FALSE

specifies whether to use multi-value insert emulation for parameterized INSERT statements.

Aliasinsert_multi_value
DefaultFALSE

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

maxErrors=integer

Specifies the maximum number of rejected rows allowed in the load before the COPY command is canceled

Default0
Minimum value0

numDataFiles=integer

specifies the number of streams or data files to use when bulkloading.

Range1–8

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

Key for authentication

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

uid="string"

Aliasesuser
username

useLog=TRUE | FALSE

Specifies whether to get reports on rejected rows and the corresponding error file

DefaultFALSE

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for SS

* srcType="SINGLESTORE"

Parameters for TERADATA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

authenticationScope="string"

Specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope

authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"

AUTO

Specifies that the authentication type is determined based on other connection options

KERBEROS

Specifies that Kerberos authentication is used for connection

LDAP

Specifies that LDAP authentication is used for connection

OAUTH2

Specifies that OAUTH2 authentication is used for connection

PASSWORD

Specifies that user/password credentials are used for connection

bufferSize=64-bit-integer

Specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

Specifies connection options to use for connecting to the Teradata database.

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

Specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

Specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

Specifies to perform a serial load.

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

Specifies a Teradata Max Text Size value in chars.

Default32000
Range1–32000

insertbuff=integer

Specifies the number of rows to insert in one write block.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

Specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Specifies the password.

Aliasespassword
pass

schema="string"

Unused

statusInterval=integer

Specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

Specifies the user name.

Aliasusername

Parameters for VEDNFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEHDFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEPATH

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VERTICA

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for VES3

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

specifies the AWS Key Management Services encryption context for the cryptographic operation.

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

specifies an encryption key in the form of a 64-digit hexadecimal value.

sseTextKey="string"

specifies a plain-text version of the key to use with server-side encryption.

Parameters for YELLOWBRICK

authenticationDomain="string"

Specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain

catalog="string"

Specifies the database catalog name.

charMultiplier=double

Specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbType="string"

Allows you to specify the column types to use

insertSQL=TRUE | FALSE

When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.

Aliasinsert_sql
DefaultFALSE

insertbuff=integer

Specifies the number of rows to insert in one write block.

numWriteNodes=integer

Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

Aliasespassword
pass

schema="string"

Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

Aliasesuser
username

useNarrowCharacterTypes=TRUE | FALSE

When set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasesuseNCT
useNarrowCharTypes
DefaultFALSE

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO.

Parameters for fileType="BASESAS"

alter="string"

specifies the Alter password for the SAS data set.

compress="BINARY" | "CHAR" | "NO" | "YES"

when set to True, applies data compression to the table.

DefaultNO
encoding="string"

specifies file encoding

encrypt="AES" | "AES2" | "NO" | "YES"

specifies whether to encrypt an output SAS data set

DefaultNO
encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

password="string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

pointobs=TRUE | FALSE

specifies whether SAS creates compressed data sets whose observations can be randomly accessed or sequentially accessed

DefaultTRUE
read="string"

specifies the Read password for the SAS data set.

reuse=TRUE | FALSE

specifies whether new rows can be written to freed space in a compressed SAS data set

DefaultFALSE
write="string"

specifies the Write password for the SAS data set.

Parameters for fileType="CSV" | "DELIMITED"

addbom=TRUE | FALSE

when set to True, the file includes a byte-order mark (BOM) at the beginning of the file. The BOM can help programs such as Microsoft Excel to interpret national characters in text fields correctly. By default, the BOM is not added to the file.

DefaultFALSE

Parameters for fileType="DTA"

No parameters apply when you specify DTA.

Parameters for fileType="EXCEL"

range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="JMP"

No parameters apply when you specify JMP.

Parameters for fileType="ORC"

compress="NO" | "YES" | "ZLIB"

when set to True, applies data compression to the table.

DefaultZLIB

Parameters for fileType="PARQUET"

rowGroupMax=integer

Specifies how many rows are grouped together for columnar file types.

Default0
saveCharAsByteArray=TRUE | FALSE

Save CAS fixed-character columns saved as Parquet ByteArray columns.

DefaultFALSE
trimBlanks=TRUE | FALSE

Remove trailing blanks from fixed-character columns saved as Parquet ByteArray columns.

DefaultTRUE

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS.

Parameters for fileType="XLS"

range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Last updated: July 15, 2026