Common Parameter: dataSourceOptions

CASL Syntax

Expand all Collapse all

Parameters for ADLS_NOREQ

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

bucket="string"

specifies the Google Cloud Storage bucket to write data files

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"

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

kmsKey="string"

specifies the path to a key file resource within a project

Aliases	kmsPath
	kms_key
	kms_path

location="string"

specifies the location to use in queries

max_binary_len=integer

specifies the maximum length for BINARY data types.

max_char_len=integer

specifies the maximum length for CHAR and VARCHAR data types.

mode="PERFORMANCE" | "STANDARD"

specifies whether certain performance options are set by default

Default	STANDARD

PERFORMANCE

specifies that certain performance options will be set by default

STANDARD

specifies that no performance options will be set by default

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

qualifier="string"

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

Alias	table_qualifier

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

readMode="STANDARD" | "STORAGE"

specifies the read mode to use for loadTable

Default	STANDARD

STANDARD

specifies a standard read mode for BigQuery loadTable

STORAGE

specifies that BigQuery should use the Storage API for reading data in loadTable

scanStringColumns=TRUE | FALSE

when set to TRUE, the data connector issues a query to scan all VARCHAR and VARBINARY columns for their max length.

Default	FALSE

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

threadedLoad=TRUE | FALSE

when set to TRUE, the data connector uses multiple threads to load a table.

Default	FALSE

uid="string"

Aliases	user
Aliases	username

Parameters for CAS_NOREQ

password="string"

user="string"

Parameters for CLOUDDEX

authenticationDomain="string"

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

Alias	authDomain

casTypes="ALL" | "BASIC"

specifies how data types are converted between the data source and data types for SAS Cloud Analytic Services.

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

charMultiplier=double

Default	1
Range	1–5

dataOnReaderNodesOnly=TRUE | FALSE

Default	FALSE

dbmsWhere="where-expression"

specifies a database SQL WHERE clause that is used for row filtering.

descending={integer-1 <, integer-2, ...>}

specifies to sort columns in ascending/descending order with a list of {0, 1, ...}

domainCredsRequired=TRUE | FALSE

Default	TRUE

metaCatalog="string"

metaSchema="string"

metaTable="string"

ncharMultiplier=double

Default	3
Range	1–5

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1

orderBy={"string-1" <, "string-2", ...>}

specifies to sort the loaded table by orderby variable list

partition={"string-1" <, "string-2", ...>}

specifies to partition the loaded table

pwd="string"

specifies the password.

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	rowArraySize

schema="string"

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

splitColumn="string"

splitRange=double

Default	0

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

useMetaTable=TRUE | FALSE

Default	TRUE

useMinMaxToSplit=TRUE | FALSE

Default	FALSE

Parameters for DB2

authenticationDomain="string"

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

Alias	authDomain

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for DNFS

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 ESP

oauthtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port="string"

specifies the network port number that the server listens on.

server="string"

specifies the host name of the SAS Event Stream Processing (ESP) server.

servicename="string"

specifies the Kerberos service name.

username="string"

specifies the user name to use for authenticating to the server.

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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for GCS_NOREQ

AuthDomain="string"

bucket="string"

gcsAuthFile="string"

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certficiats 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, 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.

Default	"/tmp"

httpPath="string"

The path component of the JDBC URL

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

krbAuthType=integer

specifies the Hive Kerberos authentication type.

krbHostFqdn="string"

specifies the Hive Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Hive Kerberos realm.

krbServiceName="string"

specifies the Hive 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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

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

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Default	MAPRED

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with Hive 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
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

specifies the name of the Hive schema.

Alias	database

scratchDB="string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

sslKeyStore="string"

specifies the Hive SSL key store.

Alias	ssl_key_store

sslKeyStorePwd="string"

specifies the Hive 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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for IMPALA

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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.

bulkunload=TRUE | FALSE

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

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

conopts="string"

dbmax_text=integer

specifies the maximum length for character data type columns.

Default	32767
Minimum value	1

login_timeout=integer

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

Minimum value	0

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

query_timeout=integer

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

Minimum value	0

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

conopts="string"

max_char_len=integer

specifies the maximum length for CHAR and VARCHAR data types.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for MYSQL

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

basedir="string"

Alias	base_dir

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

socket="string"

uid="string"

Aliases	user
Aliases	username

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

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

dm_unicode="string"

specifies to override the default driver manager Unicode setting. DataDirect defaults to UTF-8 on UNIX. UnixODBC based drivers use UCS-2. Specify UCS2 for unixODBC based drivers.

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=TRUE | FALSE

when set to TRUE, the data connector issues a query to scan long columns for max length. Which column types are scanned is based on the DBMS.

Default	FALSE

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for ORACLE

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

ora_encoding="string"

specifies the Oracle encoding type. Specify UNICODE if you use non-latin1 data.

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=TRUE | FALSE

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

Default	FALSE

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for PATH

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 POSTGRES

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.

bulkunload=TRUE | FALSE

when set to TRUE, use PostgreSQL utility to load data into CAS. Default to FALSE.

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for REDSHIFT

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"

specifies the format for the data file, Delimited or Parquet. Default is Delimited.

Default	DELIMITED

DELIMITED

specifies that the data file is to be in a delimited format

PARQUET

specifies that the data file is to be in Parquet format

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.

bulkunload=TRUE | FALSE

when set to TRUE, data is read from Redshift from S3 data files created using the UNLOAD command.

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

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.

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.

key="string"

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

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable 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
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

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.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

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
Aliases	username

useSSL=TRUE | FALSE

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

Default	FALSE

Parameters for S3

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

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"

deleteDataFiles=TRUE | FALSE

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

Default	TRUE

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=TRUE | FALSE

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

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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.

Default	FALSE

bulkRefresh=integer

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

Minimum value	0

bulkTimeout=integer

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

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for SINGLESTORE_STANDARD

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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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

azureSAS="string"

Azure Shared Access Signature for connecting to azure storage.

blNumReadThreads=integer

specifies the number of threads to use for uploading files.

Range	0–10

bulkunload=TRUE | FALSE

when set to TRUE, data is read from Snowflake utility to load data into CAS. Default to FALSE.

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

compress=TRUE | FALSE

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

Default	FALSE

conopts="string"

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

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

fileSystem="string"

Azure storage file system

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

role="string"

specifies the role for this Snowflake connection

scanStringColumns=TRUE | FALSE

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

Default	FALSE

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

timeout=integer

Azure storage operation timeout value in seconds

Default	60
Minimum value	0

uid="string"

Aliases	user
Aliases	username

warehouse="string"

specifies the Snowflake warehouse

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certficiats 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, 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.

Default	"/tmp"

httpPath="string"

The path component of the JDBC URL

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

krbAuthType=integer

specifies the Hive Kerberos authentication type.

krbHostFqdn="string"

specifies the Hive Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Hive Kerberos realm.

krbServiceName="string"

specifies the Hive 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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

ncharMultiplier=double

Default	3
Range	1–5

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

specifies the password.

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

specifies the name of the Hive schema.

Alias	database

scratchDB="string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

sslKeyStore="string"

specifies the Hive SSL key store.

Alias	ssl_key_store

sslKeyStorePwd="string"

specifies the Hive 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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

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

specifies the type of encryption to be used on created SPDE tables.

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.

masterPW="string"

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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

Default	3
Range	1–5

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	0
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Default	MAPRED

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with Hive 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
Aliases	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

transcodeFail="ERROR" | "IGNORE" | "WARNING"

specifies the desired behavior when transcoding issues occur.

ERROR

An error is logged and processing is halted.

IGNORE

Any errors are silently ignored.

WARNING

A warning is logged and processing continues.

uid="string"

specifies the user name.

Alias	username

writePW="string"

specifies the password to use for Write access.

Parameters for SQLSERVER

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

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for SS_NOREQ

aggregatePushdown=TRUE | FALSE

When set to true aggregate pushdown is enabled

Default	FALSE

backingStore="CASDISKCACHE" | "INPLACEPREFERRED" | "INHERIT"

'INPLACEPREFERRED' to keep table in SingleStore, 'CASDISKCACHE' to load into CAS, 'INHERIT' to get from caslib

Default	INHERIT

CASDISKCACHE

Load into CAS disk cache

INPLACEPREFERRED

Keep table in SingleStore

INHERIT

Inherit load behavior from caslib

createMultipassColumn="ONDEMAND" | "ONLOAD"

specifies when to create the multipass column required for multipass processing.

Default	ONDEMAND

ONDEMAND

create the multipass column on demand.

ONLOAD

create the multipass column at table load time.

createViewSnapshot="NEVER" | "ONLOAD"

specifies when to create a snapshot copy of a SingleStore view.

Default	NEVER

NEVER

do not create a view snapshot.

ONLOAD

create a view snapshot at table load time.

epProperties={"string-1" <, "string-2", ...>}

List of property strings passed to the SAS Embedded Process.

multipassMemory="CACHE" | "STREAM"

Specifies whether a memory cache is used for multipass operations.

Default	CACHE

saveMultipassColumn=TRUE | FALSE

When set to TRUE, an auto-increment column for multipass processing is added to the saved table.

Default	FALSE

* 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

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

database="string"

specifies the Teradata database to connect to.

Alias	db

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

ncharMultiplier=double

Default	3
Range	1–5

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Unused

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=TRUE | FALSE

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

Default	FALSE

schema="string"

Unused

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

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

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Lua Syntax

Expand all Collapse all

Parameters for ADLS_NOREQ

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

bucket="string"

specifies the Google Cloud Storage bucket to write data files

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

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

kmsKey="string"

specifies the path to a key file resource within a project

Aliases	kmsPath
	kms_key
	kms_path

location="string"

specifies the location to use in queries

max_binary_len=integer

specifies the maximum length for BINARY data types.

max_char_len=integer

specifies the maximum length for CHAR and VARCHAR data types.

mode="PERFORMANCE" | "STANDARD"

specifies whether certain performance options are set by default

Default	STANDARD

PERFORMANCE

specifies that certain performance options will be set by default

STANDARD

specifies that no performance options will be set by default

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

qualifier="string"

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

Alias	table_qualifier

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

readMode="STANDARD" | "STORAGE"

specifies the read mode to use for loadTable

Default	STANDARD

STANDARD

specifies a standard read mode for BigQuery loadTable

STORAGE

specifies that BigQuery should use the Storage API for reading data in loadTable

scanStringColumns=true | false

when set to TRUE, the data connector issues a query to scan all VARCHAR and VARBINARY columns for their max length.

Default	false

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

threadedLoad=true | false

when set to TRUE, the data connector uses multiple threads to load a table.

Default	false

uid="string"

Aliases	user
Aliases	username

Parameters for CAS_NOREQ

password="string"

user="string"

Parameters for CLOUDDEX

authenticationDomain="string"

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

Alias	authDomain

casTypes="ALL" | "BASIC"

specifies how data types are converted between the data source and data types for SAS Cloud Analytic Services.

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

charMultiplier=double

Default	1
Range	1–5

dataOnReaderNodesOnly=true | false

Default	false

dbmsWhere="where-expression"

specifies a database SQL WHERE clause that is used for row filtering.

descending={integer-1 <, integer-2, ...>}

specifies to sort columns in ascending/descending order with a list of {0, 1, ...}

domainCredsRequired=true | false

Default	true

metaCatalog="string"

metaSchema="string"

metaTable="string"

ncharMultiplier=double

Default	3
Range	1–5

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1

orderBy={"string-1" <, "string-2", ...>}

specifies to sort the loaded table by orderby variable list

partition={"string-1" <, "string-2", ...>}

specifies to partition the loaded table

pwd="string"

specifies the password.

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	rowArraySize

schema="string"

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

splitColumn="string"

splitRange=double

Default	0

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

useMetaTable=true | false

Default	true

useMinMaxToSplit=true | false

Default	false

Parameters for DB2

authenticationDomain="string"

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

Alias	authDomain

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for DNFS

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 ESP

oauthtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port="string"

specifies the network port number that the server listens on.

server="string"

specifies the host name of the SAS Event Stream Processing (ESP) server.

servicename="string"

specifies the Kerberos service name.

username="string"

specifies the user name to use for authenticating to the server.

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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for GCS_NOREQ

AuthDomain="string"

bucket="string"

gcsAuthFile="string"

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certficiats 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, 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.

Default	"/tmp"

httpPath="string"

The path component of the JDBC URL

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

krbAuthType=integer

specifies the Hive Kerberos authentication type.

krbHostFqdn="string"

specifies the Hive Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Hive Kerberos realm.

krbServiceName="string"

specifies the Hive 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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

ncharMultiplier=double

Default	3
Range	1–5

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Default	MAPRED

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with Hive 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
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

specifies the name of the Hive schema.

Alias	database

scratchDB="string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

sslKeyStore="string"

specifies the Hive SSL key store.

Alias	ssl_key_store

sslKeyStorePwd="string"

specifies the Hive 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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for IMPALA

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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.

bulkunload=true | false

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

Default	false

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

conopts="string"

dbmax_text=integer

specifies the maximum length for character data type columns.

Default	32767
Minimum value	1

login_timeout=integer

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

Minimum value	0

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

query_timeout=integer

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

Minimum value	0

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

conopts="string"

max_char_len=integer

specifies the maximum length for CHAR and VARCHAR data types.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for MYSQL

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

basedir="string"

Alias	base_dir

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

socket="string"

uid="string"

Aliases	user
Aliases	username

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

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

dm_unicode="string"

specifies to override the default driver manager Unicode setting. DataDirect defaults to UTF-8 on UNIX. UnixODBC based drivers use UCS-2. Specify UCS2 for unixODBC based drivers.

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=true | false

when set to TRUE, the data connector issues a query to scan long columns for max length. Which column types are scanned is based on the DBMS.

Default	false

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for ORACLE

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

ora_encoding="string"

specifies the Oracle encoding type. Specify UNICODE if you use non-latin1 data.

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=true | false

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

Default	false

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for PATH

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 POSTGRES

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.

bulkunload=true | false

when set to TRUE, use PostgreSQL utility to load data into CAS. Default to FALSE.

Default	false

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for REDSHIFT

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"

specifies the format for the data file, Delimited or Parquet. Default is Delimited.

Default	DELIMITED

DELIMITED

specifies that the data file is to be in a delimited format

PARQUET

specifies that the data file is to be in Parquet format

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.

bulkunload=true | false

when set to TRUE, data is read from Redshift from S3 data files created using the UNLOAD command.

Default	false

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

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.

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.

key="string"

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

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable 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
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

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.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

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
Aliases	username

useSSL=true | false

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

Default	false

Parameters for S3

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

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"

deleteDataFiles=true | false

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

Default	true

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=true | false

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

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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.

Default	false

bulkRefresh=integer

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

Minimum value	0

bulkTimeout=integer

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

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for SINGLESTORE_STANDARD

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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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

azureSAS="string"

Azure Shared Access Signature for connecting to azure storage.

blNumReadThreads=integer

specifies the number of threads to use for uploading files.

Range	0–10

bulkunload=true | false

when set to TRUE, data is read from Snowflake utility to load data into CAS. Default to FALSE.

Default	false

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

compress=true | false

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

Default	false

conopts="string"

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

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

fileSystem="string"

Azure storage file system

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

role="string"

specifies the role for this Snowflake connection

scanStringColumns=true | false

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

Default	false

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

timeout=integer

Azure storage operation timeout value in seconds

Default	60
Minimum value	0

uid="string"

Aliases	user
Aliases	username

warehouse="string"

specifies the Snowflake warehouse

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certficiats 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, 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.

Default	"/tmp"

httpPath="string"

The path component of the JDBC URL

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

krbAuthType=integer

specifies the Hive Kerberos authentication type.

krbHostFqdn="string"

specifies the Hive Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Hive Kerberos realm.

krbServiceName="string"

specifies the Hive 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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

ncharMultiplier=double

Default	3
Range	1–5

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

specifies the password.

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

specifies the name of the Hive schema.

Alias	database

scratchDB="string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

sslKeyStore="string"

specifies the Hive SSL key store.

Alias	ssl_key_store

sslKeyStorePwd="string"

specifies the Hive 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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

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

specifies the type of encryption to be used on created SPDE tables.

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.

masterPW="string"

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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

Default	3
Range	1–5

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	0
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Default	MAPRED

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with Hive 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
Aliases	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

transcodeFail="ERROR" | "IGNORE" | "WARNING"

specifies the desired behavior when transcoding issues occur.

ERROR

An error is logged and processing is halted.

IGNORE

Any errors are silently ignored.

WARNING

A warning is logged and processing continues.

uid="string"

specifies the user name.

Alias	username

writePW="string"

specifies the password to use for Write access.

Parameters for SQLSERVER

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

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Parameters for SS_NOREQ

aggregatePushdown=true | false

When set to true aggregate pushdown is enabled

Default	false

backingStore="CASDISKCACHE" | "INPLACEPREFERRED" | "INHERIT"

'INPLACEPREFERRED' to keep table in SingleStore, 'CASDISKCACHE' to load into CAS, 'INHERIT' to get from caslib

Default	INHERIT

CASDISKCACHE

Load into CAS disk cache

INPLACEPREFERRED

Keep table in SingleStore

INHERIT

Inherit load behavior from caslib

createMultipassColumn="ONDEMAND" | "ONLOAD"

specifies when to create the multipass column required for multipass processing.

Default	ONDEMAND

ONDEMAND

create the multipass column on demand.

ONLOAD

create the multipass column at table load time.

createViewSnapshot="NEVER" | "ONLOAD"

specifies when to create a snapshot copy of a SingleStore view.

Default	NEVER

NEVER

do not create a view snapshot.

ONLOAD

create a view snapshot at table load time.

epProperties={"string-1" <, "string-2", ...>}

List of property strings passed to the SAS Embedded Process.

multipassMemory="CACHE" | "STREAM"

Specifies whether a memory cache is used for multipass operations.

Default	CACHE

saveMultipassColumn=true | false

When set to TRUE, an auto-increment column for multipass processing is added to the saved table.

Default	false

* 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

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

database="string"

specifies the Teradata database to connect to.

Alias	db

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

ncharMultiplier=double

Default	3
Range	1–5

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Unused

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=true | false

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

Default	false

schema="string"

Unused

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

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

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions={"string-1" <, "string-2", ...>}

uid="string"

Aliases	user
Aliases	username

Python Syntax

Expand all Collapse all

Parameters for ADLS_NOREQ

"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

"bucket":"string"

specifies the Google Cloud Storage bucket to write data files

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"conopts":"string"

"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

"kmsKey":"string"

specifies the path to a key file resource within a project

Aliases	kmsPath
	kms_key
	kms_path

"location":"string"

specifies the location to use in queries

"max_binary_len":integer

specifies the maximum length for BINARY data types.

"max_char_len":integer

specifies the maximum length for CHAR and VARCHAR data types.

"mode":"PERFORMANCE" | "STANDARD"

specifies whether certain performance options are set by default

Default	STANDARD

PERFORMANCE

specifies that certain performance options will be set by default

STANDARD

specifies that no performance options will be set by default

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"qualifier":"string"

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

Alias	table_qualifier

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"readMode":"STANDARD" | "STORAGE"

specifies the read mode to use for loadTable

Default	STANDARD

STANDARD

specifies a standard read mode for BigQuery loadTable

STORAGE

specifies that BigQuery should use the Storage API for reading data in loadTable

"scanStringColumns":True | False

when set to TRUE, the data connector issues a query to scan all VARCHAR and VARBINARY columns for their max length.

Default	False

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"threadedLoad":True | False

when set to TRUE, the data connector uses multiple threads to load a table.

Default	False

"uid":"string"

Aliases	user
Aliases	username

Parameters for CAS_NOREQ

"password":"string"

"user":"string"

Parameters for CLOUDDEX

"authenticationDomain":"string"

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

Alias	authDomain

"casTypes":"ALL" | "BASIC"

specifies how data types are converted between the data source and data types for SAS Cloud Analytic Services.

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

"charMultiplier":double

Default	1
Range	1–5

"dataOnReaderNodesOnly":True | False

Default	False

"dbmsWhere":"where-expression"

specifies a database SQL WHERE clause that is used for row filtering.

"descending":[integer-1 <, integer-2, ...>]

specifies to sort columns in ascending/descending order with a list of {0, 1, ...}

"domainCredsRequired":True | False

Default	True

"metaCatalog":"string"

"metaSchema":"string"

"metaTable":"string"

"ncharMultiplier":double

Default	3
Range	1–5

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1

"orderBy":["string-1" <, "string-2", ...>]

specifies to sort the loaded table by orderby variable list

"partition":["string-1" <, "string-2", ...>]

specifies to partition the loaded table

"pwd":"string"

specifies the password.

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	rowArraySize

"schema":"string"

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

"splitColumn":"string"

"splitRange":double

Default	0

"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

"useMetaTable":True | False

Default	True

"useMinMaxToSplit":True | False

Default	False

Parameters for DB2

"authenticationDomain":"string"

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

Alias	authDomain

"blobThreshold":integer

Minimum value	0

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

"conopts":"string"

"invalidDate":"string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for DNFS

"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 ESP

"oauthtoken":"string"

specifies the OAuth authentication token.

"password":"string"

specifies the password.

"port":"string"

specifies the network port number that the server listens on.

"server":"string"

specifies the host name of the SAS Event Stream Processing (ESP) server.

"servicename":"string"

specifies the Kerberos service name.

"username":"string"

specifies the user name to use for authenticating to the server.

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

Default	1
Range	1–5

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for GCS_NOREQ

"AuthDomain":"string"

"bucket":"string"

"gcsAuthFile":"string"

Parameters for HADOOP

"allowSelfSignedCerts":"string"

Specify whether to allow self-signed certficiats 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

"charMultiplier":double

Default	1
Range	1–5

"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

"dbmaxText":integer

specifies the maximum length for STRING data type columns. For Hive, 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.

Default	"/tmp"

"httpPath":"string"

The path component of the JDBC URL

"invalidDate":"string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

"krbAuthType":integer

specifies the Hive Kerberos authentication type.

"krbHostFqdn":"string"

specifies the Hive Kerberos host fully qualified domain name.

"krbRealm":"string"

specifies the Hive Kerberos realm.

"krbServiceName":"string"

specifies the Hive 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

"maxRows":integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

"ncharMultiplier":double

Default	3
Range	1–5

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Default	MAPRED

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with Hive 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
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

specifies the name of the Hive schema.

Alias	database

"scratchDB":"string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"sslKeyStore":"string"

specifies the Hive SSL key store.

Alias	ssl_key_store

"sslKeyStorePwd":"string"

specifies the Hive 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

Default	1
Range	1–5

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for IMPALA

"authenticationDomain":"string"

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

Alias	authDomain

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

specifies the client encoding type to use when connecting to the data source.

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

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.

"bulkunload":True | False

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

Default	False

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

specifies the client encoding type to use when connecting to the data source.

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

"conopts":"string"

"dbmax_text":integer

specifies the maximum length for character data type columns.

Default	32767
Minimum value	1

"login_timeout":integer

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

Minimum value	0

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"query_timeout":integer

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

Minimum value	0

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

"conopts":"string"

"max_char_len":integer

specifies the maximum length for CHAR and VARCHAR data types.

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for MYSQL

"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

"basedir":"string"

Alias	base_dir

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"socket":"string"

"uid":"string"

Aliases	user
Aliases	username

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

"blobThreshold":integer

Minimum value	0

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

specifies the client encoding type to use when connecting to the data source.

"conopts":"string"

"dm_unicode":"string"

specifies to override the default driver manager Unicode setting. DataDirect defaults to UTF-8 on UNIX. UnixODBC based drivers use UCS-2. Specify UCS2 for unixODBC based drivers.

"invalidDate":"string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"scanStringColumns":True | False

when set to TRUE, the data connector issues a query to scan long columns for max length. Which column types are scanned is based on the DBMS.

Default	False

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for ORACLE

"authenticationDomain":"string"

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

Alias	authDomain

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"conopts":"string"

"invalidDate":"string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"ora_encoding":"string"

specifies the Oracle encoding type. Specify UNICODE if you use non-latin1 data.

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"scanStringColumns":True | False

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

Default	False

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for PATH

"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 POSTGRES

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

"bulkunload":True | False

when set to TRUE, use PostgreSQL utility to load data into CAS. Default to FALSE.

Default	False

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

specifies the client encoding type to use when connecting to the data source.

"conopts":"string"

"invalidDate":"string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for REDSHIFT

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

specifies the format for the data file, Delimited or Parquet. Default is Delimited.

Default	DELIMITED

DELIMITED

specifies that the data file is to be in a delimited format

PARQUET

specifies that the data file is to be in Parquet format

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

"bulkunload":True | False

when set to TRUE, data is read from Redshift from S3 data files created using the UNLOAD command.

Default	False

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

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

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

"key":"string"

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

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable 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
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"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
Aliases	username

"useSSL":True | False

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

Default	False

Parameters for S3

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

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"

"deleteDataFiles":True | False

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

Default	True

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"scanStringColumns":True | False

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

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

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

Default	False

"bulkRefresh":integer

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

Minimum value	0

"bulkTimeout":integer

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

Minimum value	0

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for SINGLESTORE_STANDARD

"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

Default	1
Range	1–5

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

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

"azureSAS":"string"

Azure Shared Access Signature for connecting to azure storage.

"blNumReadThreads":integer

specifies the number of threads to use for uploading files.

Range	0–10

"bulkunload":True | False

when set to TRUE, data is read from Snowflake utility to load data into CAS. Default to FALSE.

Default	False

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

specifies the client encoding type to use when connecting to the data source.

"compress":True | False

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

Default	False

"conopts":"string"

"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

"dnsSuffix":"string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

"fileSystem":"string"

Azure storage file system

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"role":"string"

specifies the role for this Snowflake connection

"scanStringColumns":True | False

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

Default	False

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"timeout":integer

Azure storage operation timeout value in seconds

Default	60
Minimum value	0

"uid":"string"

Aliases	user
Aliases	username

"warehouse":"string"

specifies the Snowflake warehouse

Parameters for SPARK

"allowSelfSignedCerts":"string"

Specify whether to allow self-signed certficiats 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

"charMultiplier":double

Default	1
Range	1–5

"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

"dbmaxText":integer

specifies the maximum length for STRING data type columns. For Hive, 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.

Default	"/tmp"

"httpPath":"string"

The path component of the JDBC URL

"invalidDate":"string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

"krbAuthType":integer

specifies the Hive Kerberos authentication type.

"krbHostFqdn":"string"

specifies the Hive Kerberos host fully qualified domain name.

"krbRealm":"string"

specifies the Hive Kerberos realm.

"krbServiceName":"string"

specifies the Hive 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

"maxRows":integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

"ncharMultiplier":double

Default	3
Range	1–5

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

specifies the password.

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

specifies the name of the Hive schema.

Alias	database

"scratchDB":"string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"sslKeyStore":"string"

specifies the Hive SSL key store.

Alias	ssl_key_store

"sslKeyStorePwd":"string"

specifies the Hive 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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

"charMultiplier":double

Default	1
Range	1–5

"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

"encrypt":"AES" | "NO" | "YES"

specifies the type of encryption to be used on created SPDE tables.

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.

"masterPW":"string"

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

"maxRows":integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

"mdfpath":"string"

specifies the path where SPDE MDF are located.

"ncharMultiplier":double

Default	3
Range	1–5

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	0
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Default	MAPRED

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with Hive 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
Aliases	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

"transcodeFail":"ERROR" | "IGNORE" | "WARNING"

specifies the desired behavior when transcoding issues occur.

ERROR

An error is logged and processing is halted.

IGNORE

Any errors are silently ignored.

WARNING

A warning is logged and processing continues.

"uid":"string"

specifies the user name.

Alias	username

"writePW":"string"

specifies the password to use for Write access.

Parameters for SQLSERVER

"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

"blobThreshold":integer

Minimum value	0

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

specifies the client encoding type to use when connecting to the data source.

"conopts":"string"

"invalidDate":"string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

Parameters for SS_NOREQ

"aggregatePushdown":True | False

When set to true aggregate pushdown is enabled

Default	False

"backingStore":"CASDISKCACHE" | "INPLACEPREFERRED" | "INHERIT"

'INPLACEPREFERRED' to keep table in SingleStore, 'CASDISKCACHE' to load into CAS, 'INHERIT' to get from caslib

Default	INHERIT

CASDISKCACHE

Load into CAS disk cache

INPLACEPREFERRED

Keep table in SingleStore

INHERIT

Inherit load behavior from caslib

"createMultipassColumn":"ONDEMAND" | "ONLOAD"

specifies when to create the multipass column required for multipass processing.

Default	ONDEMAND

ONDEMAND

create the multipass column on demand.

ONLOAD

create the multipass column at table load time.

"createViewSnapshot":"NEVER" | "ONLOAD"

specifies when to create a snapshot copy of a SingleStore view.

Default	NEVER

NEVER

do not create a view snapshot.

ONLOAD

create a view snapshot at table load time.

"epProperties":["string-1" <, "string-2", ...>]

List of property strings passed to the SAS Embedded Process.

"multipassMemory":"CACHE" | "STREAM"

Specifies whether a memory cache is used for multipass operations.

Default	CACHE

"saveMultipassColumn":True | False

When set to TRUE, an auto-increment column for multipass processing is added to the saved table.

Default	False

* "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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

"charMultiplier":double

Default	1
Range	1–5

"conopts":"string"

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

"database":"string"

specifies the Teradata database to connect to.

Alias	db

"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

"maxRows":integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

"ncharMultiplier":double

Default	3
Range	1–5

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Unused

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"scanStringColumns":True | False

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

Default	False

"schema":"string"

Unused

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

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

Default	1
Range	1–5

"client_encoding":"string"

specifies the client encoding type to use when connecting to the data source.

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

"client_encoding":"string"

specifies the client encoding type to use when connecting to the data source.

"conopts":"string"

"numReadBuffers":integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

"numReadNodes":integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

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

"sliceColumn":"variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

"sliceExpressions":["string-1" <, "string-2", ...>]

"uid":"string"

Aliases	user
Aliases	username

R Syntax

Expand all Collapse all

Parameters for ADLS_NOREQ

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

bucket="string"

specifies the Google Cloud Storage bucket to write data files

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

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

kmsKey="string"

specifies the path to a key file resource within a project

Aliases	kmsPath
	kms_key
	kms_path

location="string"

specifies the location to use in queries

max_binary_len=integer

specifies the maximum length for BINARY data types.

max_char_len=integer

specifies the maximum length for CHAR and VARCHAR data types.

mode="PERFORMANCE" | "STANDARD"

specifies whether certain performance options are set by default

Default	STANDARD

PERFORMANCE

specifies that certain performance options will be set by default

STANDARD

specifies that no performance options will be set by default

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

qualifier="string"

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

Alias	table_qualifier

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

readMode="STANDARD" | "STORAGE"

specifies the read mode to use for loadTable

Default	STANDARD

STANDARD

specifies a standard read mode for BigQuery loadTable

STORAGE

specifies that BigQuery should use the Storage API for reading data in loadTable

scanStringColumns=TRUE | FALSE

when set to TRUE, the data connector issues a query to scan all VARCHAR and VARBINARY columns for their max length.

Default	FALSE

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

threadedLoad=TRUE | FALSE

when set to TRUE, the data connector uses multiple threads to load a table.

Default	FALSE

uid="string"

Aliases	user
Aliases	username

Parameters for CAS_NOREQ

password="string"

user="string"

Parameters for CLOUDDEX

authenticationDomain="string"

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

Alias	authDomain

casTypes="ALL" | "BASIC"

specifies how data types are converted between the data source and data types for SAS Cloud Analytic Services.

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

charMultiplier=double

Default	1
Range	1–5

dataOnReaderNodesOnly=TRUE | FALSE

Default	FALSE

dbmsWhere="where-expression"

specifies a database SQL WHERE clause that is used for row filtering.

descending=list(integer-1 <, integer-2, ...>)

specifies to sort columns in ascending/descending order with a list of {0, 1, ...}

domainCredsRequired=TRUE | FALSE

Default	TRUE

metaCatalog="string"

metaSchema="string"

metaTable="string"

ncharMultiplier=double

Default	3
Range	1–5

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1

orderBy=list("string-1" <, "string-2", ...>)

specifies to sort the loaded table by orderby variable list

partition=list("string-1" <, "string-2", ...>)

specifies to partition the loaded table

pwd="string"

specifies the password.

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	rowArraySize

schema="string"

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

splitColumn="string"

splitRange=double

Default	0

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

useMetaTable=TRUE | FALSE

Default	TRUE

useMinMaxToSplit=TRUE | FALSE

Default	FALSE

Parameters for DB2

authenticationDomain="string"

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

Alias	authDomain

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for DNFS

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 ESP

oauthtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port="string"

specifies the network port number that the server listens on.

server="string"

specifies the host name of the SAS Event Stream Processing (ESP) server.

servicename="string"

specifies the Kerberos service name.

username="string"

specifies the user name to use for authenticating to the server.

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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for GCS_NOREQ

AuthDomain="string"

bucket="string"

gcsAuthFile="string"

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certficiats 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, 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.

Default	"/tmp"

httpPath="string"

The path component of the JDBC URL

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

krbAuthType=integer

specifies the Hive Kerberos authentication type.

krbHostFqdn="string"

specifies the Hive Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Hive Kerberos realm.

krbServiceName="string"

specifies the Hive 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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

ncharMultiplier=double

Default	3
Range	1–5

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Default	MAPRED

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with Hive 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
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

specifies the name of the Hive schema.

Alias	database

scratchDB="string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

sslKeyStore="string"

specifies the Hive SSL key store.

Alias	ssl_key_store

sslKeyStorePwd="string"

specifies the Hive 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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for IMPALA

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

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.

bulkunload=TRUE | FALSE

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

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

conopts="string"

dbmax_text=integer

specifies the maximum length for character data type columns.

Default	32767
Minimum value	1

login_timeout=integer

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

Minimum value	0

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

query_timeout=integer

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

Minimum value	0

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

conopts="string"

max_char_len=integer

specifies the maximum length for CHAR and VARCHAR data types.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for MYSQL

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

basedir="string"

Alias	base_dir

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

socket="string"

uid="string"

Aliases	user
Aliases	username

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

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

dm_unicode="string"

specifies to override the default driver manager Unicode setting. DataDirect defaults to UTF-8 on UNIX. UnixODBC based drivers use UCS-2. Specify UCS2 for unixODBC based drivers.

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=TRUE | FALSE

when set to TRUE, the data connector issues a query to scan long columns for max length. Which column types are scanned is based on the DBMS.

Default	FALSE

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for ORACLE

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

ora_encoding="string"

specifies the Oracle encoding type. Specify UNICODE if you use non-latin1 data.

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=TRUE | FALSE

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

Default	FALSE

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for PATH

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 POSTGRES

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.

bulkunload=TRUE | FALSE

when set to TRUE, use PostgreSQL utility to load data into CAS. Default to FALSE.

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for REDSHIFT

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"

specifies the format for the data file, Delimited or Parquet. Default is Delimited.

Default	DELIMITED

DELIMITED

specifies that the data file is to be in a delimited format

PARQUET

specifies that the data file is to be in Parquet format

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.

bulkunload=TRUE | FALSE

when set to TRUE, data is read from Redshift from S3 data files created using the UNLOAD command.

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

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.

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.

key="string"

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

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable 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
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

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.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

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
Aliases	username

useSSL=TRUE | FALSE

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

Default	FALSE

Parameters for S3

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

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"

deleteDataFiles=TRUE | FALSE

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

Default	TRUE

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=TRUE | FALSE

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

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

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.

Default	FALSE

bulkRefresh=integer

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

Minimum value	0

bulkTimeout=integer

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

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for SINGLESTORE_STANDARD

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

Default	1
Range	1–5

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

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

azureSAS="string"

Azure Shared Access Signature for connecting to azure storage.

blNumReadThreads=integer

specifies the number of threads to use for uploading files.

Range	0–10

bulkunload=TRUE | FALSE

when set to TRUE, data is read from Snowflake utility to load data into CAS. Default to FALSE.

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

compress=TRUE | FALSE

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

Default	FALSE

conopts="string"

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

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

fileSystem="string"

Azure storage file system

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

role="string"

specifies the role for this Snowflake connection

scanStringColumns=TRUE | FALSE

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

Default	FALSE

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

timeout=integer

Azure storage operation timeout value in seconds

Default	60
Minimum value	0

uid="string"

Aliases	user
Aliases	username

warehouse="string"

specifies the Snowflake warehouse

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certficiats 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, 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.

Default	"/tmp"

httpPath="string"

The path component of the JDBC URL

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

krbAuthType=integer

specifies the Hive Kerberos authentication type.

krbHostFqdn="string"

specifies the Hive Kerberos host fully qualified domain name.

krbRealm="string"

specifies the Hive Kerberos realm.

krbServiceName="string"

specifies the Hive 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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

ncharMultiplier=double

Default	3
Range	1–5

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

specifies the password.

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

specifies the name of the Hive schema.

Alias	database

scratchDB="string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

sslKeyStore="string"

specifies the Hive SSL key store.

Alias	ssl_key_store

sslKeyStorePwd="string"

specifies the Hive 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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

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

specifies the type of encryption to be used on created SPDE tables.

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.

masterPW="string"

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

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

Default	3
Range	1–5

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	0
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Default	MAPRED

DATABRICKS

Specifies Spark on Databricks.

HDINSIGHTSPARK

Specifies Spark on HDInsight.

HDINSIGHTSPARKLLAP

Specifies Spark on HDInsight with Hive 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
Aliases	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

transcodeFail="ERROR" | "IGNORE" | "WARNING"

specifies the desired behavior when transcoding issues occur.

ERROR

An error is logged and processing is halted.

IGNORE

Any errors are silently ignored.

WARNING

A warning is logged and processing continues.

uid="string"

specifies the user name.

Alias	username

writePW="string"

specifies the password to use for Write access.

Parameters for SQLSERVER

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

blobThreshold=integer

Minimum value	0

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Parameters for SS_NOREQ

aggregatePushdown=TRUE | FALSE

When set to true aggregate pushdown is enabled

Default	FALSE

backingStore="CASDISKCACHE" | "INPLACEPREFERRED" | "INHERIT"

'INPLACEPREFERRED' to keep table in SingleStore, 'CASDISKCACHE' to load into CAS, 'INHERIT' to get from caslib

Default	INHERIT

CASDISKCACHE

Load into CAS disk cache

INPLACEPREFERRED

Keep table in SingleStore

INHERIT

Inherit load behavior from caslib

createMultipassColumn="ONDEMAND" | "ONLOAD"

specifies when to create the multipass column required for multipass processing.

Default	ONDEMAND

ONDEMAND

create the multipass column on demand.

ONLOAD

create the multipass column at table load time.

createViewSnapshot="NEVER" | "ONLOAD"

specifies when to create a snapshot copy of a SingleStore view.

Default	NEVER

NEVER

do not create a view snapshot.

ONLOAD

create a view snapshot at table load time.

epProperties=list("string-1" <, "string-2", ...>)

List of property strings passed to the SAS Embedded Process.

multipassMemory="CACHE" | "STREAM"

Specifies whether a memory cache is used for multipass operations.

Default	CACHE

saveMultipassColumn=TRUE | FALSE

When set to TRUE, an auto-increment column for multipass processing is added to the saved table.

Default	FALSE

* 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"

specifies whether to use user/password or access token for authentication

Default	AUTO

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
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

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

database="string"

specifies the Teradata database to connect to.

Alias	db

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

specifies how data is transferred between the database and SAS Cloud Analytic Services.

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.

maxRows=integer

Specify the maximum number of rows to load from the external data source

Alias	max_rows

ncharMultiplier=double

Default	3
Range	1–5

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Unused

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

scanStringColumns=TRUE | FALSE

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

Default	FALSE

schema="string"

Unused

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

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

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

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

Default	1
Range	1–5

client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default	4
Range	1–10

numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)

uid="string"

Aliases	user
Aliases	username

Last updated: November 14, 2025