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 |
|---|---|
| Examples: | Save a Table to a Caslib as a SASHDAT File |
| Save a Table to a Caslib as a SAS7BDAT File |
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.
|
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.
| Default | FALSE |
|---|
convertInt=TRUE | FALSE
Convert INT32 and INT64 data types to double.
| Default | FALSE |
|---|
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 |
|---|
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}
specifies data source options.
| Alias | options |
|---|
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.
| Alias | export |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | FALSE |
|---|
saveForEP=TRUE | FALSE
Save in a form optimized for SAS Embedded Process use
| Default | FALSE |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="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.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
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.
| Alias | compVars |
|---|
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.
| Alias | compPgm |
|---|
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| 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"
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.
| Alias | import |
|---|
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.
| Default | FALSE |
|---|
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.
| Aliases | options |
|---|---|
| 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.
| Alias | import |
|---|
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.
| Default | FALSE |
|---|
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
Parameters for BIGQUERY
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkload=TRUE | FALSE
When set to TRUE, data is written to Google BigQuery using the Go Loader.Run function.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
qualifier="string"
Specifies an alternate project ID to be used in table references in SQL queries
| Alias | table_qualifier |
|---|
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for CAS
password="string"
user="string"
Parameters for CLOUDDEX
append=TRUE | FALSE
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 1 |
|---|---|
| Range | 1–5 |
dbCreateTableOpts="string"
Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.
domainCredsRequired=TRUE | FALSE
| Default | TRUE |
|---|
dropTableOnFailedSave=TRUE | FALSE
| Default | TRUE |
|---|
insertbuff=integer
Specifies the number of rows to insert in one write block.
ncharCreateMultiplier=double
| Default | 1 |
|---|---|
| Range | 1–5 |
ncharMultiplier=double
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|
pwd="string"
Specifies the password.
| Aliases | password |
|---|---|
| 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.
| Alias | username |
|---|
useMaxCharLen=TRUE | FALSE
| Default | FALSE |
|---|
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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for DB2
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
blAllowReadAccess=TRUE | FALSE
Specifies whether the original table data is still visible to readers during a DB2 LOAD. Default is FALSE.
| Alias | bl_allow_read_access |
|---|---|
| Default | FALSE |
blCopyLocation="string"
Specifies the directory to which DB2 saves a copy of the loaded data.
| Alias | bl_copy_location |
|---|
blCpuParallelism=integer
Specifies the number of processes or threads to use when building table objects.
| Aliases | bl_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.
| Aliases | bl_databuffersize |
|---|---|
| bl_data_buffer_size |
blDiskParallelism=integer
Specifies the number of processes or threads to use when writing data to disk.
| Aliases | bl_diskparallelism |
|---|---|
| bl_disk_parallelism |
blExceptionTable="string"
Specifies the exception table into which rows in error are copied.
| Aliases | blexception |
|---|---|
| bl_exception | |
| bl_exception_table |
blIndexingMode="string"
Specifies which scheme the bulk load process should use for index maintenance.
| Alias | bl_indexing_mode |
|---|
blLoadReplace=TRUE | FALSE
Specifies whether to replace existing data in the table. Default is FALSE.
| Alias | bl_load_replace |
|---|---|
| Default | FALSE |
blLog="string"
Specifies a path and file name to which information about the loading process is written.
| Alias | bl_log |
|---|
blOptions="string"
Specifies file type modifiers to be passed to the DB2 LOAD interface.
| Aliases | bl_options |
|---|---|
| blModifiedBy | |
| bl_modified_by |
blPortMax=integer
Specifies a positive integer that represents the highest available port number for concurrent uploads.
| Aliases | bl_portmax |
|---|---|
| bl_port_max |
blPortMin=integer
Specifies a positive integer that represents the lowest available port number for concurrent uploads.
| Aliases | bl_portmin |
|---|---|
| bl_port_min |
blRecoverable=TRUE | FALSE
Specifies whether the bulk load process is recoverable.
| Alias | bl_recoverable |
|---|---|
| Default | FALSE |
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.
| Alias | bl_remote_file |
|---|
blWarningCount=integer
Specifies the maximum number of row warnings to allow before the load fails.
| Alias | bl_warning_count |
|---|
bulkload=TRUE | FALSE
When set to TRUE, data is written to DB2 using the CLI LOAD functionality.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for FEDSVR
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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
| Default | TRUE |
|---|
insertSQL=TRUE | FALSE
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
numbytesperchar="string"
pwd="string"
| Aliases | password |
|---|---|
| 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"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
bulkLoad=TRUE | FALSE
Specifies whether Bulk Loading should be used for inserting rows.
| Default | TRUE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 32767 |
|---|---|
| Minimum value | 1 |
hdfsTempDir="string"
Specifies the Hadoop HDFS directory to use to store temporary data.
| Alias | hdfs_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.
| Default | 30 |
|---|---|
| Minimum value | 0 |
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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–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.
| Aliases | password |
|---|---|
| pass |
readbuff=integer
Specifies the number of rows to read in one read block.
| Aliases | ras |
|---|---|
| row_array_size |
schema="string"
Specifies the name of the schema.
| Alias | database |
|---|
sslKeyStore="string"
specifies the SSL key store.
| Alias | ssl_key_store |
|---|
sslKeyStorePwd="string"
specifies the SSL key store password.
| Alias | ssl_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.
| Default | 0 |
|---|
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.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for HANA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for IMPALA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkload=TRUE | FALSE
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for INFORMIX
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for JDBC
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Alias | loginTimeout |
|---|---|
| Minimum value | 0 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
query_timeout=integer
Specifies the number of seconds to wait for a query to finish executing before returning an error.
| Alias | queryTimeout |
|---|---|
| Minimum value | 0 |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for MONGODB
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for MYSQL
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for NETEZZA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for ODBC
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for ORACLE
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Default | FALSE |
|---|
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 10000 |
|---|---|
| Minimum value | 1 |
bulkload=TRUE | FALSE
When set to TRUE, use PostgreSQL utility to load data into Postgres. Default to FALSE.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for REDSHIFT
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Alias | bulkloadOptions |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
compress=TRUE | FALSE
When set to TRUE, use GZIP compression on data files.
| Default | FALSE |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | FALSE |
|---|
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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Alias | blEncKey |
|---|
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
profile="string"
Specifies the AWS profile to use if using an account with multiple profiles.
pwd="string"
| Aliases | password |
|---|---|
| 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"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
useSSL=TRUE | FALSE
When set to TRUE, create an SSL connection to S3 when transmitting data files.
| Default | FALSE |
|---|
Parameters for SAPIQ
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
blobThreshold=integer
| Minimum value | 0 |
|---|
bulkload=TRUE | FALSE
When set to TRUE, data is written to DBMS using the LOAD TABLE command.
| Default | FALSE |
|---|
bulkunload=TRUE | FALSE
When set to TRUE, data is read from DBMS using the data extraction facility.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
clientDir="string"
Specifies the client view of folder location that contains DBMS data files for bulk operation.
| Alias | clientDirectory |
|---|
compress=TRUE | FALSE
When set to TRUE, use GZIP compression on data files.
| Default | FALSE |
|---|
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.
| Default | TRUE |
|---|
insertSQL=TRUE | FALSE
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
scanStringColumns=TRUE | FALSE
When set to TRUE, the data connector issues a query to scan all character columns for their max length.
| Aliases | scanStrings |
|---|---|
| scan_string_columns | |
| scan_strings | |
| Default | FALSE |
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.
| Alias | serverDirectory |
|---|
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
usePipe=TRUE | FALSE
Specifies whether to use a named pipe for data transfer for bulk operation.
| Default | TRUE |
|---|
Parameters for SFORCE
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkApi=TRUE | FALSE
When set to TRUE, data is read from and written to Salesforce using the BULK API.
| Alias | bulk_api |
|---|---|
| Default | FALSE |
bulkRefresh=integer
Specifies the time in milliseconds to wait before rechecking the status of a bulk job
| Alias | bulk_refresh |
|---|---|
| Minimum value | 0 |
bulkTimeout=integer
Specifies the time in milliseconds to wait before a bulk job is terminated
| Alias | bulk_timeout |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for SINGLESTORE_STANDARD
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Range | 0–100 |
|---|
blOptions="string"
Specifies any additional COPY options that are added to the end of the COPY command.
| Alias | bulkloadOptions |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
compress=TRUE | FALSE
When set to TRUE, use GZIP compression on data files.
| Default | FALSE |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | FALSE |
|---|
fileSystem="string"
Azure storage file system
insertSQL=TRUE | FALSE
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
profile="string"
Specifies the AWS profile to use if using an account with multiple profiles.
pwd="string"
| Aliases | password |
|---|---|
| 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
| Default | 60 |
|---|---|
| Minimum value | 0 |
token="string"
Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
useSSL=TRUE | FALSE
When set to TRUE, create an SSL connection to S3 when transmitting data files.
| Default | FALSE |
|---|
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
bulkLoad=TRUE | FALSE
Specifies whether Bulk Loading should be used for inserting rows.
| Default | TRUE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 1024 |
|---|---|
| Minimum value | 1 |
hdfsTempDir="string"
Specifies the Hadoop HDFS directory to use to store temporary data.
| Alias | hdfs_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.
| Default | 30 |
|---|---|
| Minimum value | 0 |
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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–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.
| Aliases | password |
|---|---|
| pass |
readbuff=integer
Specifies the number of rows to read in one read block.
| Aliases | ras |
|---|---|
| row_array_size |
schema="string"
Specifies the name of the schema.
| Alias | database |
|---|
sslKeyStore="string"
specifies the SSL key store.
| Alias | ssl_key_store |
|---|
sslKeyStorePwd="string"
specifies the SSL key store password.
| Alias | ssl_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.
| Default | 0 |
|---|
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.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–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.
| Alias | authDomain |
|---|
bufferSize=64-bit-integer
Specifies the incoming data buffer size, in bytes.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | hdfs_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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteBuffers=integer
Specifies the number of write buffers to use for the pipeline write.
| Default | 10 |
|---|---|
| Range | 1–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 value | 16 |
|---|
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.
| Aliases | password |
|---|---|
| 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.
| Default | 0 |
|---|
uid="string"
Specifies the user name.
| Alias | username |
|---|
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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'.
| Alias | bulkloadOptions |
|---|
bulkload=TRUE | FALSE
When set to TRUE, data is written to Azure Synapse Analytics using the COPY command.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
clientSecret="string"
Client secret for Azure storage
compress=TRUE | FALSE
When set to TRUE, use GZIP compression on data files.
| Default | FALSE |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | FALSE |
|---|
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.
| Alias | insert_multi_value |
|---|---|
| Default | FALSE |
insertSQL=TRUE | FALSE
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
numDataFiles=integer
specifies the number of streams or data files to use when bulkloading.
| Range | 1–8 |
|---|
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| 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
| Default | 60 |
|---|---|
| Minimum value | 0 |
uid="string"
| Aliases | user |
|---|---|
| username |
useLog=TRUE | FALSE
Specifies whether to get reports on rejected rows and the corresponding error file
| Default | FALSE |
|---|
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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for SS
* srcType="SINGLESTORE"
Parameters for TERADATA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 32000 |
|---|---|
| Range | 1–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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
Specifies the password.
| Aliases | password |
|---|---|
| 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.
| Default | 0 |
|---|
uid="string"
Specifies the user name.
| Alias | username |
|---|
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Default | NO |
|---|
encoding="string"
specifies file encoding
encrypt="AES" | "AES2" | "NO" | "YES"
specifies whether to encrypt an output SAS data set
| Default | NO |
|---|
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
| Default | TRUE |
|---|
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
| Default | FALSE |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | ZLIB |
|---|
Parameters for fileType="PARQUET"
rowGroupMax=integer
Specifies how many rows are grouped together for columnar file types.
| Default | 0 |
|---|
saveCharAsByteArray=TRUE | FALSE
Save CAS fixed-character columns saved as Parquet ByteArray columns.
| Default | FALSE |
|---|
trimBlanks=TRUE | FALSE
Remove trailing blanks from fixed-character columns saved as Parquet ByteArray columns.
| Default | TRUE |
|---|
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 |
|---|---|
| Examples: | Save a Table to a Caslib as a SASHDAT File |
| Save a Table to a Caslib as a SAS7BDAT File |
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.
|
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.
| Default | false |
|---|
convertInt=true | false
Convert INT32 and INT64 data types to double.
| Default | false |
|---|
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 |
|---|
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}
specifies data source options.
| Alias | options |
|---|
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.
| Alias | export |
|---|
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.
| Default | false |
|---|
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.
| Default | false |
|---|
saveForEP=true | false
Save in a form optimized for SAS Embedded Process use
| Default | false |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="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.
| Alias | compOnDemand |
|---|---|
| Default | false |
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.
| Alias | compVars |
|---|
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.
| Alias | compPgm |
|---|
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| 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"
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.
| Alias | import |
|---|
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.
| Default | false |
|---|
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.
| Aliases | options |
|---|---|
| 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.
| Alias | import |
|---|
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.
| Default | false |
|---|
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
Parameters for BIGQUERY
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkload=true | false
When set to TRUE, data is written to Google BigQuery using the Go Loader.Run function.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
qualifier="string"
Specifies an alternate project ID to be used in table references in SQL queries
| Alias | table_qualifier |
|---|
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for CAS
password="string"
user="string"
Parameters for CLOUDDEX
append=true | false
| Default | false |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 1 |
|---|---|
| Range | 1–5 |
dbCreateTableOpts="string"
Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.
domainCredsRequired=true | false
| Default | TRUE |
|---|
dropTableOnFailedSave=true | false
| Default | TRUE |
|---|
insertbuff=integer
Specifies the number of rows to insert in one write block.
ncharCreateMultiplier=double
| Default | 1 |
|---|---|
| Range | 1–5 |
ncharMultiplier=double
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|
pwd="string"
Specifies the password.
| Aliases | password |
|---|---|
| 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.
| Alias | username |
|---|
useMaxCharLen=true | false
| Default | false |
|---|
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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for DB2
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
blAllowReadAccess=true | false
Specifies whether the original table data is still visible to readers during a DB2 LOAD. Default is FALSE.
| Alias | bl_allow_read_access |
|---|---|
| Default | false |
blCopyLocation="string"
Specifies the directory to which DB2 saves a copy of the loaded data.
| Alias | bl_copy_location |
|---|
blCpuParallelism=integer
Specifies the number of processes or threads to use when building table objects.
| Aliases | bl_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.
| Aliases | bl_databuffersize |
|---|---|
| bl_data_buffer_size |
blDiskParallelism=integer
Specifies the number of processes or threads to use when writing data to disk.
| Aliases | bl_diskparallelism |
|---|---|
| bl_disk_parallelism |
blExceptionTable="string"
Specifies the exception table into which rows in error are copied.
| Aliases | blexception |
|---|---|
| bl_exception | |
| bl_exception_table |
blIndexingMode="string"
Specifies which scheme the bulk load process should use for index maintenance.
| Alias | bl_indexing_mode |
|---|
blLoadReplace=true | false
Specifies whether to replace existing data in the table. Default is FALSE.
| Alias | bl_load_replace |
|---|---|
| Default | false |
blLog="string"
Specifies a path and file name to which information about the loading process is written.
| Alias | bl_log |
|---|
blOptions="string"
Specifies file type modifiers to be passed to the DB2 LOAD interface.
| Aliases | bl_options |
|---|---|
| blModifiedBy | |
| bl_modified_by |
blPortMax=integer
Specifies a positive integer that represents the highest available port number for concurrent uploads.
| Aliases | bl_portmax |
|---|---|
| bl_port_max |
blPortMin=integer
Specifies a positive integer that represents the lowest available port number for concurrent uploads.
| Aliases | bl_portmin |
|---|---|
| bl_port_min |
blRecoverable=true | false
Specifies whether the bulk load process is recoverable.
| Alias | bl_recoverable |
|---|---|
| Default | false |
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.
| Alias | bl_remote_file |
|---|
blWarningCount=integer
Specifies the maximum number of row warnings to allow before the load fails.
| Alias | bl_warning_count |
|---|
bulkload=true | false
When set to TRUE, data is written to DB2 using the CLI LOAD functionality.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for FEDSVR
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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
| Default | TRUE |
|---|
insertSQL=true | false
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
numbytesperchar="string"
pwd="string"
| Aliases | password |
|---|---|
| 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"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
bulkLoad=true | false
Specifies whether Bulk Loading should be used for inserting rows.
| Default | TRUE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 32767 |
|---|---|
| Minimum value | 1 |
hdfsTempDir="string"
Specifies the Hadoop HDFS directory to use to store temporary data.
| Alias | hdfs_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.
| Default | 30 |
|---|---|
| Minimum value | 0 |
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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–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.
| Aliases | password |
|---|---|
| pass |
readbuff=integer
Specifies the number of rows to read in one read block.
| Aliases | ras |
|---|---|
| row_array_size |
schema="string"
Specifies the name of the schema.
| Alias | database |
|---|
sslKeyStore="string"
specifies the SSL key store.
| Alias | ssl_key_store |
|---|
sslKeyStorePwd="string"
specifies the SSL key store password.
| Alias | ssl_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.
| Default | 0 |
|---|
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.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for HANA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for IMPALA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkload=true | false
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for INFORMIX
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | false |
|---|
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.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for JDBC
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Alias | loginTimeout |
|---|---|
| Minimum value | 0 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
query_timeout=integer
Specifies the number of seconds to wait for a query to finish executing before returning an error.
| Alias | queryTimeout |
|---|---|
| Minimum value | 0 |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for MONGODB
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for MYSQL
append=true | false
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | false |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for NETEZZA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for ODBC
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for ORACLE
append=true | false
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | false |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
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.
| Default | false |
|---|
append=true | false
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | false |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 10000 |
|---|---|
| Minimum value | 1 |
bulkload=true | false
When set to TRUE, use PostgreSQL utility to load data into Postgres. Default to FALSE.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for REDSHIFT
append=true | false
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | false |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Alias | bulkloadOptions |
|---|
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.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
compress=true | false
When set to TRUE, use GZIP compression on data files.
| Default | false |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | false |
|---|
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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Alias | blEncKey |
|---|
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
profile="string"
Specifies the AWS profile to use if using an account with multiple profiles.
pwd="string"
| Aliases | password |
|---|---|
| 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"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
useSSL=true | false
When set to TRUE, create an SSL connection to S3 when transmitting data files.
| Default | false |
|---|
Parameters for SAPIQ
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
blobThreshold=integer
| Minimum value | 0 |
|---|
bulkload=true | false
When set to TRUE, data is written to DBMS using the LOAD TABLE command.
| Default | false |
|---|
bulkunload=true | false
When set to TRUE, data is read from DBMS using the data extraction facility.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
clientDir="string"
Specifies the client view of folder location that contains DBMS data files for bulk operation.
| Alias | clientDirectory |
|---|
compress=true | false
When set to TRUE, use GZIP compression on data files.
| Default | false |
|---|
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.
| Default | TRUE |
|---|
insertSQL=true | false
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
scanStringColumns=true | false
When set to TRUE, the data connector issues a query to scan all character columns for their max length.
| Aliases | scanStrings |
|---|---|
| scan_string_columns | |
| scan_strings | |
| Default | false |
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.
| Alias | serverDirectory |
|---|
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
usePipe=true | false
Specifies whether to use a named pipe for data transfer for bulk operation.
| Default | TRUE |
|---|
Parameters for SFORCE
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkApi=true | false
When set to TRUE, data is read from and written to Salesforce using the BULK API.
| Alias | bulk_api |
|---|---|
| Default | false |
bulkRefresh=integer
Specifies the time in milliseconds to wait before rechecking the status of a bulk job
| Alias | bulk_refresh |
|---|---|
| Minimum value | 0 |
bulkTimeout=integer
Specifies the time in milliseconds to wait before a bulk job is terminated
| Alias | bulk_timeout |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for SINGLESTORE_STANDARD
append=true | false
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | false |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Range | 0–100 |
|---|
blOptions="string"
Specifies any additional COPY options that are added to the end of the COPY command.
| Alias | bulkloadOptions |
|---|
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.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
compress=true | false
When set to TRUE, use GZIP compression on data files.
| Default | false |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | false |
|---|
fileSystem="string"
Azure storage file system
insertSQL=true | false
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
profile="string"
Specifies the AWS profile to use if using an account with multiple profiles.
pwd="string"
| Aliases | password |
|---|---|
| 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
| Default | 60 |
|---|---|
| Minimum value | 0 |
token="string"
Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
useSSL=true | false
When set to TRUE, create an SSL connection to S3 when transmitting data files.
| Default | false |
|---|
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
bulkLoad=true | false
Specifies whether Bulk Loading should be used for inserting rows.
| Default | TRUE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 1024 |
|---|---|
| Minimum value | 1 |
hdfsTempDir="string"
Specifies the Hadoop HDFS directory to use to store temporary data.
| Alias | hdfs_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.
| Default | 30 |
|---|---|
| Minimum value | 0 |
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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–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.
| Aliases | password |
|---|---|
| pass |
readbuff=integer
Specifies the number of rows to read in one read block.
| Aliases | ras |
|---|---|
| row_array_size |
schema="string"
Specifies the name of the schema.
| Alias | database |
|---|
sslKeyStore="string"
specifies the SSL key store.
| Alias | ssl_key_store |
|---|
sslKeyStorePwd="string"
specifies the SSL key store password.
| Alias | ssl_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.
| Default | 0 |
|---|
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.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–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.
| Alias | authDomain |
|---|
bufferSize=64-bit-integer
Specifies the incoming data buffer size, in bytes.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | hdfs_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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteBuffers=integer
Specifies the number of write buffers to use for the pipeline write.
| Default | 10 |
|---|---|
| Range | 1–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 value | 16 |
|---|
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.
| Aliases | password |
|---|---|
| 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.
| Default | 0 |
|---|
uid="string"
Specifies the user name.
| Alias | username |
|---|
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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'.
| Alias | bulkloadOptions |
|---|
bulkload=true | false
When set to TRUE, data is written to Azure Synapse Analytics using the COPY command.
| Default | false |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
clientSecret="string"
Client secret for Azure storage
compress=true | false
When set to TRUE, use GZIP compression on data files.
| Default | false |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | false |
|---|
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.
| Alias | insert_multi_value |
|---|---|
| Default | false |
insertSQL=true | false
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | false |
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
numDataFiles=integer
specifies the number of streams or data files to use when bulkloading.
| Range | 1–8 |
|---|
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| 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
| Default | 60 |
|---|---|
| Minimum value | 0 |
uid="string"
| Aliases | user |
|---|---|
| username |
useLog=true | false
Specifies whether to get reports on rejected rows and the corresponding error file
| Default | false |
|---|
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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
Parameters for SS
* srcType="SINGLESTORE"
Parameters for TERADATA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 32000 |
|---|---|
| Range | 1–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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
Specifies the password.
| Aliases | password |
|---|---|
| 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.
| Default | 0 |
|---|
uid="string"
Specifies the user name.
| Alias | username |
|---|
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | false |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | false |
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.
| Default | NO |
|---|
encoding="string"
specifies file encoding
encrypt="AES" | "AES2" | "NO" | "YES"
specifies whether to encrypt an output SAS data set
| Default | NO |
|---|
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
| Default | true |
|---|
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
| Default | false |
|---|
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.
| Default | false |
|---|
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.
| Default | ZLIB |
|---|
Parameters for fileType="PARQUET"
rowGroupMax=integer
Specifies how many rows are grouped together for columnar file types.
| Default | 0 |
|---|
saveCharAsByteArray=true | false
Save CAS fixed-character columns saved as Parquet ByteArray columns.
| Default | false |
|---|
trimBlanks=true | false
Remove trailing blanks from fixed-character columns saved as Parquet ByteArray columns.
| Default | true |
|---|
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 |
|---|---|
| Examples: | Save a Table to a Caslib as a SASHDAT File |
| Save a Table to a Caslib as a SAS7BDAT File |
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.
|
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.
| Default | False |
|---|
convertInt=True | False
Convert INT32 and INT64 data types to double.
| Default | False |
|---|
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 |
|---|
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}
specifies data source options.
| Alias | options |
|---|
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.
| Alias | export |
|---|
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.
| Default | False |
|---|
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.
| Default | False |
|---|
saveForEP=True | False
Save in a form optimized for SAS Embedded Process use
| Default | False |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
| Long form | table={"name":"table-name"} |
|---|---|
| Shortcut form | table="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.
| Alias | compOnDemand |
|---|---|
| Default | False |
"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.
| Alias | compVars |
|---|
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.
| Alias | compPgm |
|---|
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| 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"
"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.
| Alias | import_ |
|---|
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.
| Default | False |
|---|
"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.
| Aliases | options |
|---|---|
| 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.
| Alias | import_ |
|---|
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.
| Default | False |
|---|
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
Parameters for BIGQUERY
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkload=True | False
When set to TRUE, data is written to Google BigQuery using the Go Loader.Run function.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
qualifier="string"
Specifies an alternate project ID to be used in table references in SQL queries
| Alias | table_qualifier |
|---|
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for CAS
password="string"
user="string"
Parameters for CLOUDDEX
append=True | False
| Default | False |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 1 |
|---|---|
| Range | 1–5 |
dbCreateTableOpts="string"
Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.
domainCredsRequired=True | False
| Default | TRUE |
|---|
dropTableOnFailedSave=True | False
| Default | TRUE |
|---|
insertbuff=integer
Specifies the number of rows to insert in one write block.
ncharCreateMultiplier=double
| Default | 1 |
|---|---|
| Range | 1–5 |
ncharMultiplier=double
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|
pwd="string"
Specifies the password.
| Aliases | password |
|---|---|
| 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.
| Alias | username |
|---|
useMaxCharLen=True | False
| Default | False |
|---|
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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for DB2
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
blAllowReadAccess=True | False
Specifies whether the original table data is still visible to readers during a DB2 LOAD. Default is FALSE.
| Alias | bl_allow_read_access |
|---|---|
| Default | False |
blCopyLocation="string"
Specifies the directory to which DB2 saves a copy of the loaded data.
| Alias | bl_copy_location |
|---|
blCpuParallelism=integer
Specifies the number of processes or threads to use when building table objects.
| Aliases | bl_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.
| Aliases | bl_databuffersize |
|---|---|
| bl_data_buffer_size |
blDiskParallelism=integer
Specifies the number of processes or threads to use when writing data to disk.
| Aliases | bl_diskparallelism |
|---|---|
| bl_disk_parallelism |
blExceptionTable="string"
Specifies the exception table into which rows in error are copied.
| Aliases | blexception |
|---|---|
| bl_exception | |
| bl_exception_table |
blIndexingMode="string"
Specifies which scheme the bulk load process should use for index maintenance.
| Alias | bl_indexing_mode |
|---|
blLoadReplace=True | False
Specifies whether to replace existing data in the table. Default is FALSE.
| Alias | bl_load_replace |
|---|---|
| Default | False |
blLog="string"
Specifies a path and file name to which information about the loading process is written.
| Alias | bl_log |
|---|
blOptions="string"
Specifies file type modifiers to be passed to the DB2 LOAD interface.
| Aliases | bl_options |
|---|---|
| blModifiedBy | |
| bl_modified_by |
blPortMax=integer
Specifies a positive integer that represents the highest available port number for concurrent uploads.
| Aliases | bl_portmax |
|---|---|
| bl_port_max |
blPortMin=integer
Specifies a positive integer that represents the lowest available port number for concurrent uploads.
| Aliases | bl_portmin |
|---|---|
| bl_port_min |
blRecoverable=True | False
Specifies whether the bulk load process is recoverable.
| Alias | bl_recoverable |
|---|---|
| Default | False |
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.
| Alias | bl_remote_file |
|---|
blWarningCount=integer
Specifies the maximum number of row warnings to allow before the load fails.
| Alias | bl_warning_count |
|---|
bulkload=True | False
When set to TRUE, data is written to DB2 using the CLI LOAD functionality.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for FEDSVR
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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
| Default | TRUE |
|---|
insertSQL=True | False
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
numbytesperchar="string"
pwd="string"
| Aliases | password |
|---|---|
| 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"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
bulkLoad=True | False
Specifies whether Bulk Loading should be used for inserting rows.
| Default | TRUE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 32767 |
|---|---|
| Minimum value | 1 |
hdfsTempDir="string"
Specifies the Hadoop HDFS directory to use to store temporary data.
| Alias | hdfs_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.
| Default | 30 |
|---|---|
| Minimum value | 0 |
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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–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.
| Aliases | password |
|---|---|
| pass_ |
readbuff=integer
Specifies the number of rows to read in one read block.
| Aliases | ras |
|---|---|
| row_array_size |
schema="string"
Specifies the name of the schema.
| Alias | database |
|---|
sslKeyStore="string"
specifies the SSL key store.
| Alias | ssl_key_store |
|---|
sslKeyStorePwd="string"
specifies the SSL key store password.
| Alias | ssl_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.
| Default | 0 |
|---|
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.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for HANA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for IMPALA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkload=True | False
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for INFORMIX
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | False |
|---|
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.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for JDBC
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Alias | loginTimeout |
|---|---|
| Minimum value | 0 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
query_timeout=integer
Specifies the number of seconds to wait for a query to finish executing before returning an error.
| Alias | queryTimeout |
|---|---|
| Minimum value | 0 |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for MONGODB
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for MYSQL
append=True | False
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | False |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for NETEZZA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for ODBC
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for ORACLE
append=True | False
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | False |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
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.
| Default | False |
|---|
append=True | False
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | False |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 10000 |
|---|---|
| Minimum value | 1 |
bulkload=True | False
When set to TRUE, use PostgreSQL utility to load data into Postgres. Default to FALSE.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for REDSHIFT
append=True | False
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | False |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Alias | bulkloadOptions |
|---|
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.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
compress=True | False
When set to TRUE, use GZIP compression on data files.
| Default | False |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | False |
|---|
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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Alias | blEncKey |
|---|
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
profile="string"
Specifies the AWS profile to use if using an account with multiple profiles.
pwd="string"
| Aliases | password |
|---|---|
| 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"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
useSSL=True | False
When set to TRUE, create an SSL connection to S3 when transmitting data files.
| Default | False |
|---|
Parameters for SAPIQ
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
blobThreshold=integer
| Minimum value | 0 |
|---|
bulkload=True | False
When set to TRUE, data is written to DBMS using the LOAD TABLE command.
| Default | False |
|---|
bulkunload=True | False
When set to TRUE, data is read from DBMS using the data extraction facility.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
clientDir="string"
Specifies the client view of folder location that contains DBMS data files for bulk operation.
| Alias | clientDirectory |
|---|
compress=True | False
When set to TRUE, use GZIP compression on data files.
| Default | False |
|---|
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.
| Default | TRUE |
|---|
insertSQL=True | False
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
scanStringColumns=True | False
When set to TRUE, the data connector issues a query to scan all character columns for their max length.
| Aliases | scanStrings |
|---|---|
| scan_string_columns | |
| scan_strings | |
| Default | False |
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.
| Alias | serverDirectory |
|---|
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
usePipe=True | False
Specifies whether to use a named pipe for data transfer for bulk operation.
| Default | TRUE |
|---|
Parameters for SFORCE
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkApi=True | False
When set to TRUE, data is read from and written to Salesforce using the BULK API.
| Alias | bulk_api |
|---|---|
| Default | False |
bulkRefresh=integer
Specifies the time in milliseconds to wait before rechecking the status of a bulk job
| Alias | bulk_refresh |
|---|---|
| Minimum value | 0 |
bulkTimeout=integer
Specifies the time in milliseconds to wait before a bulk job is terminated
| Alias | bulk_timeout |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for SINGLESTORE_STANDARD
append=True | False
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | False |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Range | 0–100 |
|---|
blOptions="string"
Specifies any additional COPY options that are added to the end of the COPY command.
| Alias | bulkloadOptions |
|---|
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.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
compress=True | False
When set to TRUE, use GZIP compression on data files.
| Default | False |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | False |
|---|
fileSystem="string"
Azure storage file system
insertSQL=True | False
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
profile="string"
Specifies the AWS profile to use if using an account with multiple profiles.
pwd="string"
| Aliases | password |
|---|---|
| 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
| Default | 60 |
|---|---|
| Minimum value | 0 |
token="string"
Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
useSSL=True | False
When set to TRUE, create an SSL connection to S3 when transmitting data files.
| Default | False |
|---|
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
bulkLoad=True | False
Specifies whether Bulk Loading should be used for inserting rows.
| Default | TRUE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 1024 |
|---|---|
| Minimum value | 1 |
hdfsTempDir="string"
Specifies the Hadoop HDFS directory to use to store temporary data.
| Alias | hdfs_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.
| Default | 30 |
|---|---|
| Minimum value | 0 |
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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–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.
| Aliases | password |
|---|---|
| pass_ |
readbuff=integer
Specifies the number of rows to read in one read block.
| Aliases | ras |
|---|---|
| row_array_size |
schema="string"
Specifies the name of the schema.
| Alias | database |
|---|
sslKeyStore="string"
specifies the SSL key store.
| Alias | ssl_key_store |
|---|
sslKeyStorePwd="string"
specifies the SSL key store password.
| Alias | ssl_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.
| Default | 0 |
|---|
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.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–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.
| Alias | authDomain |
|---|
bufferSize=64-bit-integer
Specifies the incoming data buffer size, in bytes.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | hdfs_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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteBuffers=integer
Specifies the number of write buffers to use for the pipeline write.
| Default | 10 |
|---|---|
| Range | 1–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 value | 16 |
|---|
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.
| Aliases | password |
|---|---|
| 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.
| Default | 0 |
|---|
uid="string"
Specifies the user name.
| Alias | username |
|---|
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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'.
| Alias | bulkloadOptions |
|---|
bulkload=True | False
When set to TRUE, data is written to Azure Synapse Analytics using the COPY command.
| Default | False |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
clientSecret="string"
Client secret for Azure storage
compress=True | False
When set to TRUE, use GZIP compression on data files.
| Default | False |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | False |
|---|
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.
| Alias | insert_multi_value |
|---|---|
| Default | False |
insertSQL=True | False
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | False |
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
numDataFiles=integer
specifies the number of streams or data files to use when bulkloading.
| Range | 1–8 |
|---|
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| 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
| Default | 60 |
|---|---|
| Minimum value | 0 |
uid="string"
| Aliases | user |
|---|---|
| username |
useLog=True | False
Specifies whether to get reports on rejected rows and the corresponding error file
| Default | False |
|---|
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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
Parameters for SS
* srcType="SINGLESTORE"
Parameters for TERADATA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 32000 |
|---|---|
| Range | 1–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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
Specifies the password.
| Aliases | password |
|---|---|
| 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.
| Default | 0 |
|---|
uid="string"
Specifies the user name.
| Alias | username |
|---|
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | False |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | False |
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.
| Default | NO |
|---|
"encoding":"string"
specifies file encoding
"encrypt":"AES" | "AES2" | "NO" | "YES"
specifies whether to encrypt an output SAS data set
| Default | NO |
|---|
"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
| Default | True |
|---|
"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
| Default | False |
|---|
"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.
| Default | False |
|---|
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.
| Default | ZLIB |
|---|
Parameters for fileType="PARQUET"
"rowGroupMax":integer
Specifies how many rows are grouped together for columnar file types.
| Default | 0 |
|---|
"saveCharAsByteArray":True | False
Save CAS fixed-character columns saved as Parquet ByteArray columns.
| Default | False |
|---|
"trimBlanks":True | False
Remove trailing blanks from fixed-character columns saved as Parquet ByteArray columns.
| Default | True |
|---|
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 |
|---|---|
| Examples: | Save a Table to a Caslib as a SASHDAT File |
| Save a Table to a Caslib as a SAS7BDAT File |
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.
|
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.
| Default | FALSE |
|---|
convertInt=TRUE | FALSE
Convert INT32 and INT64 data types to double.
| Default | FALSE |
|---|
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 |
|---|
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)
specifies data source options.
| Alias | options |
|---|
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.
| Alias | export |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | FALSE |
|---|
saveForEP=TRUE | FALSE
Save in a form optimized for SAS Embedded Process use
| Default | FALSE |
|---|
* table=list(castable)
specifies the table name, caslib, and other common parameters.
| Long form | table=list(name="table-name") |
|---|---|
| Shortcut form | table="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.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
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.
| Alias | compVars |
|---|
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.
| Alias | compPgm |
|---|
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
specifies data source options.
| Aliases | options |
|---|---|
| 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"
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.
| Alias | import |
|---|
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.
| Default | FALSE |
|---|
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.
| Aliases | options |
|---|---|
| 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.
| Alias | import |
|---|
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.
| Default | FALSE |
|---|
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
Parameters for BIGQUERY
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkload=TRUE | FALSE
When set to TRUE, data is written to Google BigQuery using the Go Loader.Run function.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
qualifier="string"
Specifies an alternate project ID to be used in table references in SQL queries
| Alias | table_qualifier |
|---|
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for CAS
password="string"
user="string"
Parameters for CLOUDDEX
append=TRUE | FALSE
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 1 |
|---|---|
| Range | 1–5 |
dbCreateTableOpts="string"
Specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.
domainCredsRequired=TRUE | FALSE
| Default | TRUE |
|---|
dropTableOnFailedSave=TRUE | FALSE
| Default | TRUE |
|---|
insertbuff=integer
Specifies the number of rows to insert in one write block.
ncharCreateMultiplier=double
| Default | 1 |
|---|---|
| Range | 1–5 |
ncharMultiplier=double
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|
pwd="string"
Specifies the password.
| Aliases | password |
|---|---|
| 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.
| Alias | username |
|---|
useMaxCharLen=TRUE | FALSE
| Default | FALSE |
|---|
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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for DB2
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
blAllowReadAccess=TRUE | FALSE
Specifies whether the original table data is still visible to readers during a DB2 LOAD. Default is FALSE.
| Alias | bl_allow_read_access |
|---|---|
| Default | FALSE |
blCopyLocation="string"
Specifies the directory to which DB2 saves a copy of the loaded data.
| Alias | bl_copy_location |
|---|
blCpuParallelism=integer
Specifies the number of processes or threads to use when building table objects.
| Aliases | bl_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.
| Aliases | bl_databuffersize |
|---|---|
| bl_data_buffer_size |
blDiskParallelism=integer
Specifies the number of processes or threads to use when writing data to disk.
| Aliases | bl_diskparallelism |
|---|---|
| bl_disk_parallelism |
blExceptionTable="string"
Specifies the exception table into which rows in error are copied.
| Aliases | blexception |
|---|---|
| bl_exception | |
| bl_exception_table |
blIndexingMode="string"
Specifies which scheme the bulk load process should use for index maintenance.
| Alias | bl_indexing_mode |
|---|
blLoadReplace=TRUE | FALSE
Specifies whether to replace existing data in the table. Default is FALSE.
| Alias | bl_load_replace |
|---|---|
| Default | FALSE |
blLog="string"
Specifies a path and file name to which information about the loading process is written.
| Alias | bl_log |
|---|
blOptions="string"
Specifies file type modifiers to be passed to the DB2 LOAD interface.
| Aliases | bl_options |
|---|---|
| blModifiedBy | |
| bl_modified_by |
blPortMax=integer
Specifies a positive integer that represents the highest available port number for concurrent uploads.
| Aliases | bl_portmax |
|---|---|
| bl_port_max |
blPortMin=integer
Specifies a positive integer that represents the lowest available port number for concurrent uploads.
| Aliases | bl_portmin |
|---|---|
| bl_port_min |
blRecoverable=TRUE | FALSE
Specifies whether the bulk load process is recoverable.
| Alias | bl_recoverable |
|---|---|
| Default | FALSE |
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.
| Alias | bl_remote_file |
|---|
blWarningCount=integer
Specifies the maximum number of row warnings to allow before the load fails.
| Alias | bl_warning_count |
|---|
bulkload=TRUE | FALSE
When set to TRUE, data is written to DB2 using the CLI LOAD functionality.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for FEDSVR
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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
| Default | TRUE |
|---|
insertSQL=TRUE | FALSE
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
numbytesperchar="string"
pwd="string"
| Aliases | password |
|---|---|
| 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"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
bulkLoad=TRUE | FALSE
Specifies whether Bulk Loading should be used for inserting rows.
| Default | TRUE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 32767 |
|---|---|
| Minimum value | 1 |
hdfsTempDir="string"
Specifies the Hadoop HDFS directory to use to store temporary data.
| Alias | hdfs_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.
| Default | 30 |
|---|---|
| Minimum value | 0 |
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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–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.
| Aliases | password |
|---|---|
| pass |
readbuff=integer
Specifies the number of rows to read in one read block.
| Aliases | ras |
|---|---|
| row_array_size |
schema="string"
Specifies the name of the schema.
| Alias | database |
|---|
sslKeyStore="string"
specifies the SSL key store.
| Alias | ssl_key_store |
|---|
sslKeyStorePwd="string"
specifies the SSL key store password.
| Alias | ssl_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.
| Default | 0 |
|---|
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.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for HANA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for IMPALA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkload=TRUE | FALSE
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for INFORMIX
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for JDBC
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Alias | loginTimeout |
|---|---|
| Minimum value | 0 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
query_timeout=integer
Specifies the number of seconds to wait for a query to finish executing before returning an error.
| Alias | queryTimeout |
|---|---|
| Minimum value | 0 |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for MONGODB
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for MYSQL
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for NETEZZA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for ODBC
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for ORACLE
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Default | FALSE |
|---|
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 10000 |
|---|---|
| Minimum value | 1 |
bulkload=TRUE | FALSE
When set to TRUE, use PostgreSQL utility to load data into Postgres. Default to FALSE.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for REDSHIFT
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Alias | bulkloadOptions |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
compress=TRUE | FALSE
When set to TRUE, use GZIP compression on data files.
| Default | FALSE |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | FALSE |
|---|
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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Alias | blEncKey |
|---|
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
profile="string"
Specifies the AWS profile to use if using an account with multiple profiles.
pwd="string"
| Aliases | password |
|---|---|
| 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"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
useSSL=TRUE | FALSE
When set to TRUE, create an SSL connection to S3 when transmitting data files.
| Default | FALSE |
|---|
Parameters for SAPIQ
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
blobThreshold=integer
| Minimum value | 0 |
|---|
bulkload=TRUE | FALSE
When set to TRUE, data is written to DBMS using the LOAD TABLE command.
| Default | FALSE |
|---|
bulkunload=TRUE | FALSE
When set to TRUE, data is read from DBMS using the data extraction facility.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
clientDir="string"
Specifies the client view of folder location that contains DBMS data files for bulk operation.
| Alias | clientDirectory |
|---|
compress=TRUE | FALSE
When set to TRUE, use GZIP compression on data files.
| Default | FALSE |
|---|
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.
| Default | TRUE |
|---|
insertSQL=TRUE | FALSE
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
scanStringColumns=TRUE | FALSE
When set to TRUE, the data connector issues a query to scan all character columns for their max length.
| Aliases | scanStrings |
|---|---|
| scan_string_columns | |
| scan_strings | |
| Default | FALSE |
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.
| Alias | serverDirectory |
|---|
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
usePipe=TRUE | FALSE
Specifies whether to use a named pipe for data transfer for bulk operation.
| Default | TRUE |
|---|
Parameters for SFORCE
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
bulkApi=TRUE | FALSE
When set to TRUE, data is read from and written to Salesforce using the BULK API.
| Alias | bulk_api |
|---|---|
| Default | FALSE |
bulkRefresh=integer
Specifies the time in milliseconds to wait before rechecking the status of a bulk job
| Alias | bulk_refresh |
|---|---|
| Minimum value | 0 |
bulkTimeout=integer
Specifies the time in milliseconds to wait before a bulk job is terminated
| Alias | bulk_timeout |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for SINGLESTORE_STANDARD
append=TRUE | FALSE
When set to TRUE, SaveTable will append data to Postgres table. Default to FALSE.
| Default | FALSE |
|---|
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Range | 0–100 |
|---|
blOptions="string"
Specifies any additional COPY options that are added to the end of the COPY command.
| Alias | bulkloadOptions |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
compress=TRUE | FALSE
When set to TRUE, use GZIP compression on data files.
| Default | FALSE |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | FALSE |
|---|
fileSystem="string"
Azure storage file system
insertSQL=TRUE | FALSE
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
profile="string"
Specifies the AWS profile to use if using an account with multiple profiles.
pwd="string"
| Aliases | password |
|---|---|
| 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
| Default | 60 |
|---|---|
| Minimum value | 0 |
token="string"
Specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
useSSL=TRUE | FALSE
When set to TRUE, create an SSL connection to S3 when transmitting data files.
| Default | FALSE |
|---|
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
bulkLoad=TRUE | FALSE
Specifies whether Bulk Loading should be used for inserting rows.
| Default | TRUE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 1024 |
|---|---|
| Minimum value | 1 |
hdfsTempDir="string"
Specifies the Hadoop HDFS directory to use to store temporary data.
| Alias | hdfs_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.
| Default | 30 |
|---|---|
| Minimum value | 0 |
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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–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.
| Aliases | password |
|---|---|
| pass |
readbuff=integer
Specifies the number of rows to read in one read block.
| Aliases | ras |
|---|---|
| row_array_size |
schema="string"
Specifies the name of the schema.
| Alias | database |
|---|
sslKeyStore="string"
specifies the SSL key store.
| Alias | ssl_key_store |
|---|
sslKeyStorePwd="string"
specifies the SSL key store password.
| Alias | ssl_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.
| Default | 0 |
|---|
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.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–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.
| Alias | authDomain |
|---|
bufferSize=64-bit-integer
Specifies the incoming data buffer size, in bytes.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | hdfs_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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteBuffers=integer
Specifies the number of write buffers to use for the pipeline write.
| Default | 10 |
|---|---|
| Range | 1–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 value | 16 |
|---|
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.
| Aliases | password |
|---|---|
| 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.
| Default | 0 |
|---|
uid="string"
Specifies the user name.
| Alias | username |
|---|
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.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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'.
| Alias | bulkloadOptions |
|---|
bulkload=TRUE | FALSE
When set to TRUE, data is written to Azure Synapse Analytics using the COPY command.
| Default | FALSE |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–5 |
clientSecret="string"
Client secret for Azure storage
compress=TRUE | FALSE
When set to TRUE, use GZIP compression on data files.
| Default | FALSE |
|---|
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.
| Alias | defaultDirectory |
|---|
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.
| Default | TRUE |
|---|
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.
| Default | FALSE |
|---|
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.
| Alias | insert_multi_value |
|---|---|
| Default | FALSE |
insertSQL=TRUE | FALSE
When set to TRUE, data is written to the DBMS using a parameterized INSERT statement.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
numDataFiles=integer
specifies the number of streams or data files to use when bulkloading.
| Range | 1–8 |
|---|
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| 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
| Default | 60 |
|---|---|
| Minimum value | 0 |
uid="string"
| Aliases | user |
|---|---|
| username |
useLog=TRUE | FALSE
Specifies whether to get reports on rejected rows and the corresponding error file
| Default | FALSE |
|---|
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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
Parameters for SS
* srcType="SINGLESTORE"
Parameters for TERADATA
authenticationDomain="string"
Specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
Specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
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.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Default | 32000 |
|---|---|
| Range | 1–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.
| Default | 0 |
|---|---|
| Minimum value | 0 |
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.
| Default | 3 |
|---|---|
| Range | 1–5 |
numWriteNodes=integer
Specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
Specifies the password.
| Aliases | password |
|---|---|
| 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.
| Default | 0 |
|---|
uid="string"
Specifies the user name.
| Alias | username |
|---|
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Alias | authDomain |
|---|
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.
| Default | 1 |
|---|---|
| Range | 1–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.
| Alias | insert_sql |
|---|---|
| Default | FALSE |
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.
| Default | 1 |
|---|---|
| Range | 0–32767 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
Specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| 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).
| Aliases | useNCT |
|---|---|
| useNarrowCharTypes | |
| Default | FALSE |
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.
| Default | NO |
|---|
encoding="string"
specifies file encoding
encrypt="AES" | "AES2" | "NO" | "YES"
specifies whether to encrypt an output SAS data set
| Default | NO |
|---|
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
| Default | TRUE |
|---|
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
| Default | FALSE |
|---|
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.
| Default | FALSE |
|---|
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.
| Default | ZLIB |
|---|
Parameters for fileType="PARQUET"
rowGroupMax=integer
Specifies how many rows are grouped together for columnar file types.
| Default | 0 |
|---|
saveCharAsByteArray=TRUE | FALSE
Save CAS fixed-character columns saved as Parquet ByteArray columns.
| Default | FALSE |
|---|
trimBlanks=TRUE | FALSE
Remove trailing blanks from fixed-character columns saved as Parquet ByteArray columns.
| Default | TRUE |
|---|
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.