Table Action Set: Syntax

Provides actions for accessing and managing data

addCaslib Action

Adds a new caslib to enable access to a data source.

See:	Working with Caslibs
Examples:	Add an Oracle Caslib
Examples:	Add a File System Path Caslib

CASL Syntax

table.addCaslib <result=results> <status=rc> /

activeOnAdd=TRUE | FALSE,

createDirectory=TRUE | FALSE,

dataSource={srcType="ADLS" | "BIGQUERY" | "CAS" | "CLOUDDEX" | "DB2" | "DEFAULT" | "DNFS" | "ESP" | "FEDSVR" | "GCS" | "GREENPLUM" | "HADOOP" | "HANA" | "HDFS" | "IMPALA" | "JDBC" | "LASR" | "MONGODB" | "MYSQL" | "NETEZZA" | "ODBC" | "ORACLE" | "PATH" | "POSTGRES" | "REDSHIFT" | "S3" | "SFORCE" | "SNOWFLAKE" | "SPARK" | "SPDE" | "SQLSERVER" | "TERADATA" | "VERTICA" | "YELLOWBRICK", srcType-specific-parameters},

description="string",

hidden=TRUE | FALSE,

name="string",

path="string",

session=TRUE | FALSE,

subDirectories=TRUE | FALSE,

transient=TRUE | FALSE

;

indicates a required parameter

Parameter Descriptions

activeOnAdd=TRUE | FALSE

when set to True, the new caslib becomes the active caslib.

Default	TRUE

createDirectory=TRUE | FALSE

when set to True, the caslib directory will be created.

Alias	createDir
Default	FALSE

dataSource={srcType="ADLS" | "BIGQUERY" | "CAS" | "CLOUDDEX" | "DB2" | "DEFAULT" | "DNFS" | "ESP" | "FEDSVR" | "GCS" | "GREENPLUM" | "HADOOP" | "HANA" | "HDFS" | "IMPALA" | "JDBC" | "LASR" | "MONGODB" | "MYSQL" | "NETEZZA" | "ODBC" | "ORACLE" | "PATH" | "POSTGRES" | "REDSHIFT" | "S3" | "SFORCE" | "SNOWFLAKE" | "SPARK" | "SPDE" | "SQLSERVER" | "TERADATA" | "VERTICA" | "YELLOWBRICK", srcType-specific-parameters}

specifies the data source type and type-specific parameters.

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

description="string"

specifies a description of the caslib.

hidden=TRUE | FALSE

when set to True, the caslib will be a hidden caslib.

Default	FALSE

* name="string"

specifies the name of the caslib to add.

Aliases	lib
Aliases	caslib

path="string"

specifies data source-specific information. For PATH and DNFS, this is a file system path.

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

specifies the host access controls on the caslib when directory creation is requested. By default, the permissions are set according to the umask of the session process.

Alias	perms

GROUPREAD	Read access is granted to the owning group with Read and Write access to the owner of the file or directory.
GROUPWRITE	Read and Write access are granted to the owner of the file or directory and to the owning group.
GROUPWRITEPUBLICREAD	Read access is granted to everyone with Read and Write access granted to the owner of the file or directory and the owning group.
PRIVATE	Read and Write access are granted only to the owner of the file or directory.
PUBLICREAD	Read access is granted to everyone with Read and Write access to the owner of the file or directory.
PUBLICWRITE	Read and Write access are granted to everyone.

session=TRUE | FALSE

when set to True, the caslib is scoped to the current session only. Tables that you load in this session cannot be accessed from other sessions. If you specify False, then the caslib is visible to other sessions, subject to access controls.

Default	TRUE

subDirectories=TRUE | FALSE

when set to True, tables and files in subdirectories of the path specified in the caslib definition are accessible from the caslib.

Alias	subDirs
Default	FALSE

transient=TRUE | FALSE

when set to True, the caslib will be a transient caslib.

Default	FALSE

Parameters for srcType="ADLS"

* accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

* fileSystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default	60
Minimum value	0

Parameters for srcType="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

bulkload=TRUE | FALSE

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

Default	TRUE

bulkunload=TRUE | FALSE

when set to TRUE, data is read from Google BigQuery using the BigQuery Export functionality.

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default	1
Range	1–5

client_id="string"

specifies the OAuth client ID for authenticating to Google Cloud Platform

client_secret="string"

specifies the OAuth client secret for authenticating to Google Cloud Platform

conopts="string"

specifies connection options to use for connecting to the database.

credFile="string"

specifies the credentials file for authenticating to Google Cloud Platform

Aliases	credPath
	cred_file
	cred_path

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.

insertbuff=integer

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

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.

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

numWriteNodes=integer

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

Default	1
Range	0–32767

* project="string"

specifies the project ID for the Google Cloud Platform project to connect to

project_list="string"

Specifies the list of projects to make available to the data connector. Specifyingthis option prevents the data connector from querying Google BigQuery for thelist of available projects.

Alias	projectList

proxy="string"

specifies the proxy to use when connecting to Google Cloud Platform

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

scan_strings=TRUE | FALSE

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

Aliases	scanStrings
	scan_string_columns
	scanStringColumns
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", ...>}

token="string"

specifies the OAuth refresh token for authenticating to Google Cloud Platform

Alias	refresh_token

uid="string"

Aliases	user
Aliases	username

use_information_schema=TRUE | FALSE

specifies whether or not to use the information schema for metadata requests containing search patterns

Default	TRUE

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="CAS"

* cashost="string"

specifies the host name for the remote CAS server.

* caslib="string"

specifies the name of the caslib on the remote server to connect to.

casport=integer

specifies the port number for the remote CAS server.

Default	5570
Range	1–65535

password="string"

specifies the password for the remote CAS server.

user="string"

specifies the user name for the remote CAS server.

Parameters for srcType="CLOUDDEX"

append=TRUE | FALSE

Default	FALSE

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.

charCreateMultiplier=double

Default	1
Range	1–5

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the Data Agent.

dataAgentName="string"

dataOnReaderNodesOnly=TRUE | FALSE

Default	FALSE

domainCredsRequired=TRUE | FALSE

Default	TRUE

dropTableOnFailedSave=TRUE | FALSE

Default	TRUE

insertbuff=integer

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

metaCatalog="string"

metaSchema="string"

metaTable="string"

ncharCreateMultiplier=double

Default	1
Range	1–5

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

numWriteNodes=integer

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

Default	1

port=integer

specifies the network port number that the server listens on.

Default	25141

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

remoteDriverOptions="string"

schema="string"

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

server="string"

specifies the host name for the Data Agent.

traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

Alias	username

useMaxCharLen=TRUE | FALSE

Default	FALSE

useMetaTable=TRUE | FALSE

Default	TRUE

useMinMaxToSplit=TRUE | FALSE

Default	FALSE

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

db="string"

Alias	database

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="DEFAULT"

No parameters apply when you specify DEFAULT.

Parameters for srcType="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.

loadTableBackingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

specifies the backing store to use for an in-memory table. If you specify a setting when you load one table, it overrides the setting for the caslib. If you specify a setting when you add a caslib, it applies to all tables in the caslib.

Alias	backingStore
Default	INHERIT

CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

specifies to map the blocks for an in-memory table according to inherited rules of precedence. When used with loading tables, the backing store setting is inherited from the caslib. When adding a caslib, the setting is inherited from the server. The server setting can be specified in the CAS_LOADTABLEBACKINGSTORE environment variable. Valid values are CASDISKCACHE or INPLACEPREFERRED. The default value is CASDISKCACHE.

INPLACEPREFERRED

specifies to use the blocks from an existing SASHDAT file for memory mapping. If the existing blocks cannot be used, then copies of the blocks are used as described for CASDISKCACHE. The most common reason that prevent using existing blocks is when the SASHDAT file is encrypted. This setting prevents removing or replacing a SASHDAT file when the server is running Microsoft Windows.

Parameters for srcType="ESP"

authenticationType="KERB" | "NONE" | "OAUTH" | "SAS"

specifies how to authenticate from SAS Cloud Analytic Services to the ESP server.

Default	NONE

kservicename="string"

specifies the Kerberos service name.

oauthtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port=integer

specifies the network port number that the server listens on.

server="string"

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

username="string"

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

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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

remoteDriverOptions="string"

schema="string"

server="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="GCS"

* bucket="string"

* gcsAuthFile="string"

Parameters for srcType="GREENPLUM"

authenticationDomain="string"

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

Alias	authDomain

branded_driver="string"

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the database.

database="string"

gpl_dsn="string"

Alias	greenplum_dsn

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

Default	5432
Range	1–65535

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"

server="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="HADOOP"

authenticationDomain="string"

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

Alias	authDomain

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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.

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

Default	TRUE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

clusterID="string"

specifies the cluster identifier.

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfsDatadir="string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

hdfsMetadir="string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

hiveClass="string"

specifies the Hive class.

Alias	driverClass

insertbuff=integer

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

loginTimeout=integer

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

Default	30
Minimum value	0

maxSaveThreads=integer

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

Default	0
Minimum value	0

ncharMultiplier=double

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

Default	3
Range	1–5

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

numWriteNodes=integer

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

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

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

port=integer

specifies the Hive JDBC port number.

Default	10000
Range	1–65535

postTableOpts="string"

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

preTableOpts="string"

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

properties="string"

specifies one or more JDBC connection properties to override the default properties. Multiple properties are separated by a semicolon (;).

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

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

schema="string"

specifies the name of the Hive schema.

Default	"default"

scratchDB="string"

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

server="string"

specifies the host name for the Hive server.

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

uri="string"

specifies the Hive URI.

Alias	url

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

encrypt=TRUE | FALSE

Default	FALSE

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

Range	1–65535

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.

server="string"

sliceColumn="variable-name"

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

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

sslCreateSelfSignedCertificate=TRUE | FALSE

Alias	sslCreateCert
Default	FALSE

sslCryptoProvider="string"

Alias	sslProvider

sslHostNameInCertificate="string"

Alias	sslHostNameInCert

sslKeyStore="string"

sslTrustStore="string"

sslValidateCertificate=TRUE | FALSE

Default	FALSE

tabletype="COLUMN" | "ROW"

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="HDFS"

enableRemoteSave=TRUE | FALSE

when set to True and the HDFS cluster is remote from the server, the save action is enabled to save in-memory tables to a remote HDFS cluster. By default, the server does not attempt to save files in a remote HDFS cluster.

Default	FALSE

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.

hadoopHome="string"

specifies the path for the HADOOP_HOME environment variable on the Hadoop NameNode.

hadoopNameNode="string"

specifies the host name of the Hadoop NameNode. The NameNode can be on the host as the server or in a remote HDFS cluster.

remoteHadoopPath="string"

specifies the HDFS path in a remote HDFS cluster to use as a data source.

Parameters for srcType="IMPALA"

authenticationDomain="string"

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

Alias	authDomain

bulkload=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

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"

specifies connection options to use for connecting to the database.

hadoopConfigDir="string"

Hadoop Configuration File Directory

hadoopJarPath="string"

Path to SAS .jar files (colon delimited)

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

impala_dsn="string"

specifies a data source name that is already configured. Using this method to connect requires additional setup such as the Administrator control panel on Windows or through the odbc.ini file on UNIX platforms.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

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

sasJarPath="string"

schema="string"

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

Aliases	database
Aliases	db

scratchDB="string"

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

Alias	scratch_db

server="string"

[deprecated] specifies the host name that runs the Impala daemon.

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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

class="string"

specifies the JDBC driver class

Alias	driverClass

classPath="string"

specifies the JDBC CLASSPATH

conopts="string"

specifies connection options to use for connecting to the database.

dbmax_text=integer

specifies the maximum length for character data type columns.

Default	32767
Minimum value	1

insertbuff=integer

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

login_timeout=integer

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

Alias	loginTimeout
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

query_timeout=integer

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

Alias	queryTimeout
Minimum value	0

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

url="string"

specifies the JDBC connection string

Alias	uri

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="LASR"

authenticationDomain="string"

specifies the authentication domain in SAS metadata that is used to store credentials for data access.

Alias	authDomain

metaLib="string"

specifies the name of the SAS library in SAS metadata that corresponds to the data to load.

passWord="string"

specifies the password.

* port=integer

specifies the network port number that the server listens on.

* server="string"

specifies the host name of the SAS LASR Analytic Server.

signer="string"

specifies the URL for the SAS LASR Analytic Server Signer Service.

tag="string"

specifies a tag which qualifies the names of LASR tables accessed using this caslib.

userName="string"

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

Parameters for srcType="MONGODB"

auth="AUTO" | "KERBEROS" | "LDAP" | "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

PASSWORD

specifies that user/password credentials are used for connection

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"

specifies connection options to use for connecting to the database.

db="string"

specifies the MongoDB database to connect to.

Alias	database

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

platform="ATLAS"

specifies the MongoDB Atlas platform to be targeted

ATLAS

specifies that the MongoDB Atlas platform is the target

port=integer

specifies the network port number that the server listens on.

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.

schema_auth="AUTO" | "KERBEROS" | "LDAP" | "PASSWORD"

specifies whether to use user/password or LDAP for schema store 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

PASSWORD

specifies that user/password credentials are used for connection

schema_collection="string"

specifies the schema collection to use when connecting to MongoDB.

schema_db="string"

specifies the schema database to use when connecting to MongoDB.

Alias	schema_database

schema_platform="ATLAS"

specifies the MongoDB Atlas platform to be targeted

ATLAS

specifies that the MongoDB Atlas platform is the target

schema_port=integer

specifies the schema port to use when connecting to MongoDB.

schema_pwd="string"

specifies the schema password to use when connecting to MongoDB.

schema_server="string"

specifies the schema server to use when connecting to MongoDB.

schema_ssl_ca="string"

specifies the schema SSL certificate authority to use when connecting to MongoDB.

schema_ssl_cert="string"

specifies the schema SSL certificate to use when connecting to MongoDB.

schema_uid="string"

specifies the schema username to use when connecting to MongoDB.

server="string"

specifies the host name for the MongoDB server.

sliceColumn="variable-name"

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

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

ssl_ca="string"

specifies the SSL certificate authority to use when connecting to MongoDB server.

ssl_cert="string"

specifies the SSL certificate to use when connecting to MongoDB server.

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

Alias	db

default_auth_plugin="string"

when set, specifies the name of the authentication plugin to use when connecting

enable_clearTextPlugin=TRUE | FALSE

specifies whether to enable the "mysql_clear_password" plugin for authentication

Default	FALSE

host="string"

Alias	server

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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"

sliceColumn="variable-name"

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

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

socket="string"

ssl_ca="string"

the path of the Certificate Authority (CA) certificate file

ssl_cert="string"

the path of the client public key certificate file

ssl_key="string"

the path of the client private key file

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="NETEZZA"

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

conopts="string"

specifies connection options to use for connecting to the database.

database="string"

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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.

server="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

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.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Aliases	db
Aliases	database

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

ora_encoding="string"

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

path="string"

specifies the Oracle driver, node, and database.

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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.

loadTableBackingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

Alias	backingStore
Default	INHERIT

CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

INPLACEPREFERRED

Parameters for srcType="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

blDelDatFile=TRUE | FALSE

when set to TRUE, remove data and ctl files from disk after bulk unloading operation exits.

Default	FALSE

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.

blPsqlPath="string"

specifies the full-path for the psql utility.

blQuote="string"

specifies the quoting character in data file.

bulkload=TRUE | FALSE

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

Default	FALSE

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"

specifies connection options to use for connecting to the database.

database="string"

specifies the PostgreSQL database to connect to.

insertbuff=integer

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

ldPath="string"

specifies the shared library searching path in LD_LIBRARY_PATH.

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

ptg_dsn="string"

Alias	postgres_dsn

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.

server="string"

specifies the host name for the PostgreSQL server.

sliceColumn="variable-name"

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

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

sslMode="string"

specifies the SSL mode for the connection to PostgreSQL

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="REDSHIFT"

authenticationDomain="string"

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

Alias	authDomain

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.

bulkload=TRUE | FALSE

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

Default	FALSE

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"

specifies connection options to use for connecting to the database.

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.

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

delimiter="string"

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

driver_vendor="string"

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.

insertbuff=integer

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

key="string"

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

profile="string"

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

ptg_dsn="string"

Alias	redshift_dsn

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"

secret="string"

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

server="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

useSSL=TRUE | FALSE

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

Default	FALSE

Parameters for srcType="S3"

accessKeyId="string"

specifies the access key ID that you use to access the Amazon Web Services (AWS) S3 environment.

awsConfigPath="string"

specifies the path and file name of an AWS CLI configuration file that contains connection parameters to access AWS S3. The default location is the .aws directory in your home directory. The default file name is config.

awsConfigProfile="string"

specifies a named profile to use from an AWS CLI config files instead of the default profile.

awsCredentialsPath="string"

specifies the path and file name of an AWS CLI credentials file. The default location is the .aws directory in your home directory. The default file name is credentials.

awsCredentialsProfile="string"

specifies a named profile to use from an AWS CLI credentials file instead of the default profile.

* bucket="string"

specifies the name of the S3 bucket to access.

kmsContext="string"

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

kmsKeyId="string"

specifies the AWS Key Management Services ID.

objectPath="string"

specifies a subdirectory within an S3 bucket.

region="ASIAPACIFICSINGAPORE" | "ASIAPACIFICSYDNEY" | "ASIAPACIFICTOKYO" | "ASIA_PACIFIC_INDIA" | "ASIA_PACIFIC_SEOUL" | "CA_CENTRAL" | "CHINA_BEIJING" | "CHINA_NINGXIA" | "EU_FRANKFURT" | "EU_IRELAND" | "EU_LONDON" | "EU_PARIS" | "SA_SAOPAULO" | "US_EAST" | "US_EAST_OHIO" | "US_GOV" | "US_GOV_FIPS" | "US_STANDARD" | "US_WEST_CALIFORNIA" | "US_WEST_OREGON" | "string"

specifies the AWS region to connect to.

roleArn="string"

specifies the ARN of an IAM role to assume when connecting to S3.

roleName="string"

specifies the name of an IAM role to assume when connecting to S3.

secretAccessKey="string"

specifies the secret access key that you use to access the AWS S3 environment.

sessionToken="string"

specifies an override for the session token. Normally, the session token is automatically refreshed on an as-needed basis.

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.

useIAMRole=TRUE | FALSE

when set to True, credentials are read from an IAM role that is associated with the AWS EC2 instance that is running the server. You must assume a CAS administrator role of Superuser or Data administrator before you can add a caslib that uses an IAM role.

Default	FALSE

useSSL=TRUE | FALSE

when set to False, the server attempts to connect to AWS without using secure communication. By default, secure communication is used.

Default	TRUE

Parameters for srcType="SFORCE"

authendpoint="string"

Specifies the authorization endpoint to use

Alias	aep

authenticationDomain="string"

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

Alias	authDomain

bulkApi=TRUE | FALSE

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

Alias	bulk_api
Default	FALSE

bulkRefresh=integer

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

Alias	bulk_refresh
Minimum value	0

bulkTimeout=integer

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

Alias	bulk_timeout
Minimum value	0

catalog="string"

specifies the database catalog name.

cert_pass="string"

password used to read the Salesforce TLS Certificate

Aliases	cert_password
	cert_pw
	cert_pwd

cert_path="string"

OS path to the Salesforce TLS Certificate

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the database.

insertbuff=integer

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

mutual_auth="string"

Salesforce TLS Mutual Authentication

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

numWriteNodes=integer

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

Default	1
Range	0–32767

proxy_host="string"

specifies the hostname for the proxy to use when connecting to Salesforce

Alias	proxyhost

proxy_pass="string"

specifies the password for the proxy to use when connecting to Salesforce

Alias	proxypass

proxy_port=integer

specifies the port for the proxy to use when connecting to Salesforce

Alias	proxyport
Range	0–65535

proxy_user="string"

specifies the user for the proxy to use when connecting to Salesforce

Alias	proxyuser

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

show_metadata="string"

Show Salesforce Metadata columns

show_recycled="string"

Show Salesforce recycled/deleted tables

Alias	show_deleted

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

uid="string"

Aliases	user
Aliases	username

use_native_names="string"

Use Salesforce native names

Aliases	native_names
Aliases	sas_sforce_use_native_names

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="SNOWFLAKE"

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.

blOptions="string"

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

Alias	bulkloadOptions

bucket="string"

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

bulkload=TRUE | FALSE

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

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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"

specifies connection options to use for connecting to the database.

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.

database="string"

specifies the Snowflake database to connect to.

Alias	db

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

insertbuff=integer

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

key="string"

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

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 Snowflake server resides for bulk-load.

s3Config="string"

specifies an optional S3 configuration file

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.

secret="string"

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

server="string"

specifies the host name for the Snowflake server.

sliceColumn="variable-name"

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

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

snow_dsn="string"

Alias	snowflake_dsn

stage="string"

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

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

useSSL=TRUE | FALSE

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

Default	FALSE

Parameters for srcType="SPARK"

authenticationDomain="string"

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

Alias	authDomain

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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.

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

Default	TRUE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

clusterID="string"

specifies the cluster identifier.

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfsDatadir="string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

hdfsMetadir="string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

hiveClass="string"

specifies the Hive class.

Alias	driverClass

insertbuff=integer

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

loginTimeout=integer

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

Default	30
Minimum value	0

maxSaveThreads=integer

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

Default	0
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Alias	target

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.

port=integer

specifies the spark thriftserver port number.

Default	10016
Range	1–65535

postTableOpts="string"

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

preTableOpts="string"

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

properties="string"

specifies one or more JDBC connection properties to override the default properties. Multiple properties are separated by a semicolon (;).

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

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

schema="string"

specifies the name of the Hive schema.

Default	"default"

scratchDB="string"

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

server="string"

specifies the host name for the spark thriftserver.

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

uri="string"

specifies the Hive URI.

Alias	url

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

Parameters for srcType="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

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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

classPath="string"

optional driver-only JDBC classpath without HDFS access

clusterID="string"

specifies the cluster identifier.

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

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

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

datapath="string"

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

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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.

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfs=TRUE | FALSE

specifies where SPDE should use HDFS (yes) or Traditional Disk (no).

Default	FALSE

hdfsTempDir="string"

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

label="string"

specifies a label to apply to the output data set.

masterPW="string"

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

maxSaveThreads=integer

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

Default	0
Minimum value	0

* mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

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

numWriteBuffers=integer

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

Default	10
Range	1–100

padCompress=integer

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

partSize=64-bit-integer

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

Minimum value	16

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

Specifies which Spark or Hadoop platform to run on.

Alias	target
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
	pass
	passwd

readPW="string"

specifies the password to use for Read access.

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

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

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

writePW="string"

specifies the password to use for Write access.

Parameters for srcType="SQLSERVER"

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

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

Alias	authDomain

authenticationScope="string"

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

Alias	authScope

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

blobThreshold=integer

Minimum value	0

blOptions="string"

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

Alias	bulkloadOptions

bulkload=TRUE | FALSE

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

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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"

specifies connection options to use for connecting to the database.

defaultDir="string"

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

Alias	defaultDirectory

deleteDataFiles=TRUE | FALSE

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

Default	TRUE

delimiter="string"

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

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

escape=TRUE | FALSE

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

Default	FALSE

fileSystem="string"

Azure storage file system

folder="string"

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

identity="string"

Authentication method

insertbuff=integer

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

invalidDate="string"

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

maxErrors=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Aliases	db
	database
	sqlserver_dsn

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.

secret="string"

Key for authentication

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

useLog=TRUE | FALSE

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

Default	FALSE

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="TERADATA"

account="string"

specifies the account number that you want to charge for the Teradata session.

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.

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.

Default	"UTF8"

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.

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies a Teradata Max Text Size value in chars.

Default	32000
Range	1–32000

encoding="string"

specifies the Teradata database data encoding.

insertbuff=integer

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

maxparmsize=64-bit-integer

specifies the maximum parameter size, in characters, when configuring the database connection.

Alias	mps

maxSaveThreads=integer

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

Default	0
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

specifies the password.

Aliases	password
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 name when accessing the Teradata database.

schema="string"

Unused

* server="string"

specifies the host name for the Teradata server.

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

specifies connection options to use for connecting to the database.

database="string"

specifies the PostgreSQL database to connect to.

Alias	db

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Alias	vertica_dsn

port=integer

specifies the network port number that the server listens on.

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.

server="string"

specifies the host name for the PostgreSQL server.

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

specifies the Yellowbrick database to connect to.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

ptg_dsn="string"

Alias	yellowbrick_dsn

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.

server="string"

specifies the host name for the Yellowbrick server.

sliceColumn="variable-name"

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

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

sslMode="string"

specifies the SSL mode for the connection to PostgreSQL

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

addCaslib Action

Adds a new caslib to enable access to a data source.

See:	Working with Caslibs
Examples:	Add an Oracle Caslib
Examples:	Add a File System Path Caslib

Lua Syntax

results, info = s:table_addCaslib{

activeOnAdd=true | false,

createDirectory=true | false,

description="string",

hidden=true | false,

name="string",

path="string",

session=true | false,

subDirectories=true | false,

transient=true | false

}

indicates a required parameter

Parameter Descriptions

activeOnAdd=true | false

when set to True, the new caslib becomes the active caslib.

Default	true

createDirectory=true | false

when set to True, the caslib directory will be created.

Alias	createDir
Default	false

dataSource={srcType="ADLS" | "BIGQUERY" | "CAS" | "CLOUDDEX" | "DB2" | "DEFAULT" | "DNFS" | "ESP" | "FEDSVR" | "GCS" | "GREENPLUM" | "HADOOP" | "HANA" | "HDFS" | "IMPALA" | "JDBC" | "LASR" | "MONGODB" | "MYSQL" | "NETEZZA" | "ODBC" | "ORACLE" | "PATH" | "POSTGRES" | "REDSHIFT" | "S3" | "SFORCE" | "SNOWFLAKE" | "SPARK" | "SPDE" | "SQLSERVER" | "TERADATA" | "VERTICA" | "YELLOWBRICK", srcType-specific-parameters}

specifies the data source type and type-specific parameters.

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

description="string"

specifies a description of the caslib.

hidden=true | false

when set to True, the caslib will be a hidden caslib.

Default	false

* name="string"

specifies the name of the caslib to add.

Aliases	lib
Aliases	caslib

path="string"

specifies data source-specific information. For PATH and DNFS, this is a file system path.

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

specifies the host access controls on the caslib when directory creation is requested. By default, the permissions are set according to the umask of the session process.

Alias	perms

GROUPREAD	Read access is granted to the owning group with Read and Write access to the owner of the file or directory.
GROUPWRITE	Read and Write access are granted to the owner of the file or directory and to the owning group.
GROUPWRITEPUBLICREAD	Read access is granted to everyone with Read and Write access granted to the owner of the file or directory and the owning group.
PRIVATE	Read and Write access are granted only to the owner of the file or directory.
PUBLICREAD	Read access is granted to everyone with Read and Write access to the owner of the file or directory.
PUBLICWRITE	Read and Write access are granted to everyone.

session=true | false

Default	true

subDirectories=true | false

when set to True, tables and files in subdirectories of the path specified in the caslib definition are accessible from the caslib.

Alias	subDirs
Default	false

transient=true | false

when set to True, the caslib will be a transient caslib.

Default	false

Parameters for srcType="ADLS"

* accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

* fileSystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default	60
Minimum value	0

Parameters for srcType="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

bulkload=true | false

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

Default	true

bulkunload=true | false

when set to TRUE, data is read from Google BigQuery using the BigQuery Export functionality.

Default	false

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_id="string"

specifies the OAuth client ID for authenticating to Google Cloud Platform

client_secret="string"

specifies the OAuth client secret for authenticating to Google Cloud Platform

conopts="string"

specifies connection options to use for connecting to the database.

credFile="string"

specifies the credentials file for authenticating to Google Cloud Platform

Aliases	credPath
	cred_file
	cred_path

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.

insertbuff=integer

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

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.

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

numWriteNodes=integer

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

Default	1
Range	0–32767

* project="string"

specifies the project ID for the Google Cloud Platform project to connect to

project_list="string"

Specifies the list of projects to make available to the data connector. Specifyingthis option prevents the data connector from querying Google BigQuery for thelist of available projects.

Alias	projectList

proxy="string"

specifies the proxy to use when connecting to Google Cloud Platform

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

scan_strings=true | false

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

Aliases	scanStrings
	scan_string_columns
	scanStringColumns
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", ...>}

token="string"

specifies the OAuth refresh token for authenticating to Google Cloud Platform

Alias	refresh_token

uid="string"

Aliases	user
Aliases	username

use_information_schema=true | false

specifies whether or not to use the information schema for metadata requests containing search patterns

Default	true

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="CAS"

* cashost="string"

specifies the host name for the remote CAS server.

* caslib="string"

specifies the name of the caslib on the remote server to connect to.

casport=integer

specifies the port number for the remote CAS server.

Default	5570
Range	1–65535

password="string"

specifies the password for the remote CAS server.

user="string"

specifies the user name for the remote CAS server.

Parameters for srcType="CLOUDDEX"

append=true | false

Default	false

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.

charCreateMultiplier=double

Default	1
Range	1–5

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the Data Agent.

dataAgentName="string"

dataOnReaderNodesOnly=true | false

Default	false

domainCredsRequired=true | false

Default	true

dropTableOnFailedSave=true | false

Default	true

insertbuff=integer

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

metaCatalog="string"

metaSchema="string"

metaTable="string"

ncharCreateMultiplier=double

Default	1
Range	1–5

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

numWriteNodes=integer

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

Default	1

port=integer

specifies the network port number that the server listens on.

Default	25141

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

remoteDriverOptions="string"

schema="string"

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

server="string"

specifies the host name for the Data Agent.

traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

Alias	username

useMaxCharLen=true | false

Default	false

useMetaTable=true | false

Default	true

useMinMaxToSplit=true | false

Default	false

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

db="string"

Alias	database

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="DEFAULT"

No parameters apply when you specify DEFAULT.

Parameters for srcType="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.

loadTableBackingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

Alias	backingStore
Default	INHERIT

CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

INPLACEPREFERRED

Parameters for srcType="ESP"

authenticationType="KERB" | "NONE" | "OAUTH" | "SAS"

specifies how to authenticate from SAS Cloud Analytic Services to the ESP server.

Default	NONE

kservicename="string"

specifies the Kerberos service name.

oauthtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port=integer

specifies the network port number that the server listens on.

server="string"

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

username="string"

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

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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

remoteDriverOptions="string"

schema="string"

server="string"

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="GCS"

* bucket="string"

* gcsAuthFile="string"

Parameters for srcType="GREENPLUM"

authenticationDomain="string"

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

Alias	authDomain

branded_driver="string"

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the database.

database="string"

gpl_dsn="string"

Alias	greenplum_dsn

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

Default	5432
Range	1–65535

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"

server="string"

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="HADOOP"

authenticationDomain="string"

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

Alias	authDomain

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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.

bulkLoad=true | false

Specifies whether Bulk Loading should be used for inserting rows.

Default	true

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

clusterID="string"

specifies the cluster identifier.

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfsDatadir="string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

hdfsMetadir="string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

hiveClass="string"

specifies the Hive class.

Alias	driverClass

insertbuff=integer

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

loginTimeout=integer

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

Default	30
Minimum value	0

maxSaveThreads=integer

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

Default	0
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

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

port=integer

specifies the Hive JDBC port number.

Default	10000
Range	1–65535

postTableOpts="string"

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

preTableOpts="string"

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

properties="string"

specifies one or more JDBC connection properties to override the default properties. Multiple properties are separated by a semicolon (;).

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

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

schema="string"

specifies the name of the Hive schema.

Default	"default"

scratchDB="string"

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

server="string"

specifies the host name for the Hive server.

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

uri="string"

specifies the Hive URI.

Alias	url

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

encrypt=true | false

Default	false

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

Range	1–65535

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.

server="string"

sliceColumn="variable-name"

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

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

sslCreateSelfSignedCertificate=true | false

Alias	sslCreateCert
Default	false

sslCryptoProvider="string"

Alias	sslProvider

sslHostNameInCertificate="string"

Alias	sslHostNameInCert

sslKeyStore="string"

sslTrustStore="string"

sslValidateCertificate=true | false

Default	false

tabletype="COLUMN" | "ROW"

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="HDFS"

enableRemoteSave=true | false

Default	false

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.

hadoopHome="string"

specifies the path for the HADOOP_HOME environment variable on the Hadoop NameNode.

hadoopNameNode="string"

specifies the host name of the Hadoop NameNode. The NameNode can be on the host as the server or in a remote HDFS cluster.

remoteHadoopPath="string"

specifies the HDFS path in a remote HDFS cluster to use as a data source.

Parameters for srcType="IMPALA"

authenticationDomain="string"

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

Alias	authDomain

bulkload=true | false

Specifies whether Bulk Loading should be used for inserting rows.

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"

specifies connection options to use for connecting to the database.

hadoopConfigDir="string"

Hadoop Configuration File Directory

hadoopJarPath="string"

Path to SAS .jar files (colon delimited)

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

impala_dsn="string"

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

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

sasJarPath="string"

schema="string"

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

Aliases	database
Aliases	db

scratchDB="string"

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

Alias	scratch_db

server="string"

[deprecated] specifies the host name that runs the Impala daemon.

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="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

class="string"

specifies the JDBC driver class

Alias	driverClass

classPath="string"

specifies the JDBC CLASSPATH

conopts="string"

specifies connection options to use for connecting to the database.

dbmax_text=integer

specifies the maximum length for character data type columns.

Default	32767
Minimum value	1

insertbuff=integer

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

login_timeout=integer

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

Alias	loginTimeout
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

query_timeout=integer

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

Alias	queryTimeout
Minimum value	0

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

url="string"

specifies the JDBC connection string

Alias	uri

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="LASR"

authenticationDomain="string"

specifies the authentication domain in SAS metadata that is used to store credentials for data access.

Alias	authDomain

metaLib="string"

specifies the name of the SAS library in SAS metadata that corresponds to the data to load.

passWord="string"

specifies the password.

* port=integer

specifies the network port number that the server listens on.

* server="string"

specifies the host name of the SAS LASR Analytic Server.

signer="string"

specifies the URL for the SAS LASR Analytic Server Signer Service.

tag="string"

specifies a tag which qualifies the names of LASR tables accessed using this caslib.

userName="string"

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

Parameters for srcType="MONGODB"

auth="AUTO" | "KERBEROS" | "LDAP" | "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

PASSWORD

specifies that user/password credentials are used for connection

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"

specifies connection options to use for connecting to the database.

db="string"

specifies the MongoDB database to connect to.

Alias	database

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

platform="ATLAS"

specifies the MongoDB Atlas platform to be targeted

ATLAS

specifies that the MongoDB Atlas platform is the target

port=integer

specifies the network port number that the server listens on.

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.

schema_auth="AUTO" | "KERBEROS" | "LDAP" | "PASSWORD"

specifies whether to use user/password or LDAP for schema store 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

PASSWORD

specifies that user/password credentials are used for connection

schema_collection="string"

specifies the schema collection to use when connecting to MongoDB.

schema_db="string"

specifies the schema database to use when connecting to MongoDB.

Alias	schema_database

schema_platform="ATLAS"

specifies the MongoDB Atlas platform to be targeted

ATLAS

specifies that the MongoDB Atlas platform is the target

schema_port=integer

specifies the schema port to use when connecting to MongoDB.

schema_pwd="string"

specifies the schema password to use when connecting to MongoDB.

schema_server="string"

specifies the schema server to use when connecting to MongoDB.

schema_ssl_ca="string"

specifies the schema SSL certificate authority to use when connecting to MongoDB.

schema_ssl_cert="string"

specifies the schema SSL certificate to use when connecting to MongoDB.

schema_uid="string"

specifies the schema username to use when connecting to MongoDB.

server="string"

specifies the host name for the MongoDB server.

sliceColumn="variable-name"

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

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

ssl_ca="string"

specifies the SSL certificate authority to use when connecting to MongoDB server.

ssl_cert="string"

specifies the SSL certificate to use when connecting to MongoDB server.

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

Alias	db

default_auth_plugin="string"

when set, specifies the name of the authentication plugin to use when connecting

enable_clearTextPlugin=true | false

specifies whether to enable the "mysql_clear_password" plugin for authentication

Default	false

host="string"

Alias	server

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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"

sliceColumn="variable-name"

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

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

socket="string"

ssl_ca="string"

the path of the Certificate Authority (CA) certificate file

ssl_cert="string"

the path of the client public key certificate file

ssl_key="string"

the path of the client private key file

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="NETEZZA"

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

conopts="string"

specifies connection options to use for connecting to the database.

database="string"

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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.

server="string"

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

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.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Aliases	db
Aliases	database

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

ora_encoding="string"

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

path="string"

specifies the Oracle driver, node, and database.

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="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.

loadTableBackingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

Alias	backingStore
Default	INHERIT

CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

INPLACEPREFERRED

Parameters for srcType="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

blDelDatFile=true | false

when set to TRUE, remove data and ctl files from disk after bulk unloading operation exits.

Default	false

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.

blPsqlPath="string"

specifies the full-path for the psql utility.

blQuote="string"

specifies the quoting character in data file.

bulkload=true | false

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

Default	false

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"

specifies connection options to use for connecting to the database.

database="string"

specifies the PostgreSQL database to connect to.

insertbuff=integer

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

ldPath="string"

specifies the shared library searching path in LD_LIBRARY_PATH.

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

ptg_dsn="string"

Alias	postgres_dsn

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.

server="string"

specifies the host name for the PostgreSQL server.

sliceColumn="variable-name"

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

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

sslMode="string"

specifies the SSL mode for the connection to PostgreSQL

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="REDSHIFT"

authenticationDomain="string"

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

Alias	authDomain

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.

bulkload=true | false

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

Default	false

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"

specifies connection options to use for connecting to the database.

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.

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

delimiter="string"

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

driver_vendor="string"

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.

insertbuff=integer

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

key="string"

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

profile="string"

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

ptg_dsn="string"

Alias	redshift_dsn

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"

secret="string"

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

server="string"

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

useSSL=true | false

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

Default	false

Parameters for srcType="S3"

accessKeyId="string"

specifies the access key ID that you use to access the Amazon Web Services (AWS) S3 environment.

awsConfigPath="string"

awsConfigProfile="string"

specifies a named profile to use from an AWS CLI config files instead of the default profile.

awsCredentialsPath="string"

specifies the path and file name of an AWS CLI credentials file. The default location is the .aws directory in your home directory. The default file name is credentials.

awsCredentialsProfile="string"

specifies a named profile to use from an AWS CLI credentials file instead of the default profile.

* bucket="string"

specifies the name of the S3 bucket to access.

kmsContext="string"

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

kmsKeyId="string"

specifies the AWS Key Management Services ID.

objectPath="string"

specifies a subdirectory within an S3 bucket.

region="ASIAPACIFICSINGAPORE" | "ASIAPACIFICSYDNEY" | "ASIAPACIFICTOKYO" | "ASIA_PACIFIC_INDIA" | "ASIA_PACIFIC_SEOUL" | "CA_CENTRAL" | "CHINA_BEIJING" | "CHINA_NINGXIA" | "EU_FRANKFURT" | "EU_IRELAND" | "EU_LONDON" | "EU_PARIS" | "SA_SAOPAULO" | "US_EAST" | "US_EAST_OHIO" | "US_GOV" | "US_GOV_FIPS" | "US_STANDARD" | "US_WEST_CALIFORNIA" | "US_WEST_OREGON" | "string"

specifies the AWS region to connect to.

roleArn="string"

specifies the ARN of an IAM role to assume when connecting to S3.

roleName="string"

specifies the name of an IAM role to assume when connecting to S3.

secretAccessKey="string"

specifies the secret access key that you use to access the AWS S3 environment.

sessionToken="string"

specifies an override for the session token. Normally, the session token is automatically refreshed on an as-needed basis.

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.

useIAMRole=true | false

Default	false

useSSL=true | false

when set to False, the server attempts to connect to AWS without using secure communication. By default, secure communication is used.

Default	true

Parameters for srcType="SFORCE"

authendpoint="string"

Specifies the authorization endpoint to use

Alias	aep

authenticationDomain="string"

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

Alias	authDomain

bulkApi=true | false

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

Alias	bulk_api
Default	false

bulkRefresh=integer

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

Alias	bulk_refresh
Minimum value	0

bulkTimeout=integer

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

Alias	bulk_timeout
Minimum value	0

catalog="string"

specifies the database catalog name.

cert_pass="string"

password used to read the Salesforce TLS Certificate

Aliases	cert_password
	cert_pw
	cert_pwd

cert_path="string"

OS path to the Salesforce TLS Certificate

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the database.

insertbuff=integer

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

mutual_auth="string"

Salesforce TLS Mutual Authentication

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

numWriteNodes=integer

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

Default	1
Range	0–32767

proxy_host="string"

specifies the hostname for the proxy to use when connecting to Salesforce

Alias	proxyhost

proxy_pass="string"

specifies the password for the proxy to use when connecting to Salesforce

Alias	proxypass

proxy_port=integer

specifies the port for the proxy to use when connecting to Salesforce

Alias	proxyport
Range	0–65535

proxy_user="string"

specifies the user for the proxy to use when connecting to Salesforce

Alias	proxyuser

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

show_metadata="string"

Show Salesforce Metadata columns

show_recycled="string"

Show Salesforce recycled/deleted tables

Alias	show_deleted

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

uid="string"

Aliases	user
Aliases	username

use_native_names="string"

Use Salesforce native names

Aliases	native_names
Aliases	sas_sforce_use_native_names

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="SNOWFLAKE"

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.

blOptions="string"

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

Alias	bulkloadOptions

bucket="string"

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

bulkload=true | false

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

Default	false

catalog="string"

specifies the database catalog name.

charMultiplier=double

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"

specifies connection options to use for connecting to the database.

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.

database="string"

specifies the Snowflake database to connect to.

Alias	db

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

insertbuff=integer

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

key="string"

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

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 Snowflake server resides for bulk-load.

s3Config="string"

specifies an optional S3 configuration file

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.

secret="string"

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

server="string"

specifies the host name for the Snowflake server.

sliceColumn="variable-name"

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

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

snow_dsn="string"

Alias	snowflake_dsn

stage="string"

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

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

useSSL=true | false

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

Default	false

Parameters for srcType="SPARK"

authenticationDomain="string"

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

Alias	authDomain

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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.

bulkLoad=true | false

Specifies whether Bulk Loading should be used for inserting rows.

Default	true

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

clusterID="string"

specifies the cluster identifier.

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfsDatadir="string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

hdfsMetadir="string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

hiveClass="string"

specifies the Hive class.

Alias	driverClass

insertbuff=integer

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

loginTimeout=integer

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

Default	30
Minimum value	0

maxSaveThreads=integer

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

Default	0
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Alias	target

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.

port=integer

specifies the spark thriftserver port number.

Default	10016
Range	1–65535

postTableOpts="string"

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

preTableOpts="string"

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

properties="string"

specifies one or more JDBC connection properties to override the default properties. Multiple properties are separated by a semicolon (;).

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

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

schema="string"

specifies the name of the Hive schema.

Default	"default"

scratchDB="string"

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

server="string"

specifies the host name for the spark thriftserver.

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

uri="string"

specifies the Hive URI.

Alias	url

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

Parameters for srcType="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

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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

classPath="string"

optional driver-only JDBC classpath without HDFS access

clusterID="string"

specifies the cluster identifier.

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

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

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

datapath="string"

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

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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.

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfs=true | false

specifies where SPDE should use HDFS (yes) or Traditional Disk (no).

Default	false

hdfsTempDir="string"

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

label="string"

specifies a label to apply to the output data set.

masterPW="string"

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

maxSaveThreads=integer

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

Default	0
Minimum value	0

* mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

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

numWriteBuffers=integer

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

Default	10
Range	1–100

padCompress=integer

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

partSize=64-bit-integer

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

Minimum value	16

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

Specifies which Spark or Hadoop platform to run on.

Alias	target
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
	pass
	passwd

readPW="string"

specifies the password to use for Read access.

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

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

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

writePW="string"

specifies the password to use for Write access.

Parameters for srcType="SQLSERVER"

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

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

Alias	authDomain

authenticationScope="string"

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

Alias	authScope

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

blobThreshold=integer

Minimum value	0

blOptions="string"

Alias	bulkloadOptions

bulkload=true | false

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

Default	false

catalog="string"

specifies the database catalog name.

charMultiplier=double

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"

specifies connection options to use for connecting to the database.

defaultDir="string"

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

Alias	defaultDirectory

deleteDataFiles=true | false

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

Default	true

delimiter="string"

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

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

escape=true | false

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

Default	false

fileSystem="string"

Azure storage file system

folder="string"

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

identity="string"

Authentication method

insertbuff=integer

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

invalidDate="string"

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

maxErrors=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Aliases	db
	database
	sqlserver_dsn

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.

secret="string"

Key for authentication

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

useLog=true | false

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

Default	false

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="TERADATA"

account="string"

specifies the account number that you want to charge for the Teradata session.

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.

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.

Default	"UTF8"

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.

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies a Teradata Max Text Size value in chars.

Default	32000
Range	1–32000

encoding="string"

specifies the Teradata database data encoding.

insertbuff=integer

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

maxparmsize=64-bit-integer

specifies the maximum parameter size, in characters, when configuring the database connection.

Alias	mps

maxSaveThreads=integer

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

Default	0
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

specifies the password.

Aliases	password
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 name when accessing the Teradata database.

schema="string"

Unused

* server="string"

specifies the host name for the Teradata server.

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

specifies connection options to use for connecting to the database.

database="string"

specifies the PostgreSQL database to connect to.

Alias	db

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Alias	vertica_dsn

port=integer

specifies the network port number that the server listens on.

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.

server="string"

specifies the host name for the PostgreSQL server.

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

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

specifies the Yellowbrick database to connect to.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

ptg_dsn="string"

Alias	yellowbrick_dsn

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.

server="string"

specifies the host name for the Yellowbrick server.

sliceColumn="variable-name"

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

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

sslMode="string"

specifies the SSL mode for the connection to PostgreSQL

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=true | false

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	false

addCaslib Action

Adds a new caslib to enable access to a data source.

See:	Working with Caslibs
Examples:	Add an Oracle Caslib
Examples:	Add a File System Path Caslib

Python Syntax

results= s.table.addCaslib(

activeOnAdd=True | False,

createDirectory=True | False,

dataSource={"srcType":"ADLS" | "BIGQUERY" | "CAS" | "CLOUDDEX" | "DB2" | "DEFAULT" | "DNFS" | "ESP" | "FEDSVR" | "GCS" | "GREENPLUM" | "HADOOP" | "HANA" | "HDFS" | "IMPALA" | "JDBC" | "LASR" | "MONGODB" | "MYSQL" | "NETEZZA" | "ODBC" | "ORACLE" | "PATH" | "POSTGRES" | "REDSHIFT" | "S3" | "SFORCE" | "SNOWFLAKE" | "SPARK" | "SPDE" | "SQLSERVER" | "TERADATA" | "VERTICA" | "YELLOWBRICK", srcType-specific-parameters},

description="string",

hidden=True | False,

name="string",

path="string",

session=True | False,

subDirectories=True | False,

transient=True | False

)

indicates a required parameter

Parameter Descriptions

activeOnAdd=True | False

when set to True, the new caslib becomes the active caslib.

Default	True

createDirectory=True | False

when set to True, the caslib directory will be created.

Alias	createDir
Default	False

dataSource={"srcType":"ADLS" | "BIGQUERY" | "CAS" | "CLOUDDEX" | "DB2" | "DEFAULT" | "DNFS" | "ESP" | "FEDSVR" | "GCS" | "GREENPLUM" | "HADOOP" | "HANA" | "HDFS" | "IMPALA" | "JDBC" | "LASR" | "MONGODB" | "MYSQL" | "NETEZZA" | "ODBC" | "ORACLE" | "PATH" | "POSTGRES" | "REDSHIFT" | "S3" | "SFORCE" | "SNOWFLAKE" | "SPARK" | "SPDE" | "SQLSERVER" | "TERADATA" | "VERTICA" | "YELLOWBRICK", srcType-specific-parameters}

specifies the data source type and type-specific parameters.

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

description="string"

specifies a description of the caslib.

hidden=True | False

when set to True, the caslib will be a hidden caslib.

Default	False

* name="string"

specifies the name of the caslib to add.

Aliases	lib
Aliases	caslib

path="string"

specifies data source-specific information. For PATH and DNFS, this is a file system path.

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

specifies the host access controls on the caslib when directory creation is requested. By default, the permissions are set according to the umask of the session process.

Alias	perms

GROUPREAD	Read access is granted to the owning group with Read and Write access to the owner of the file or directory.
GROUPWRITE	Read and Write access are granted to the owner of the file or directory and to the owning group.
GROUPWRITEPUBLICREAD	Read access is granted to everyone with Read and Write access granted to the owner of the file or directory and the owning group.
PRIVATE	Read and Write access are granted only to the owner of the file or directory.
PUBLICREAD	Read access is granted to everyone with Read and Write access to the owner of the file or directory.
PUBLICWRITE	Read and Write access are granted to everyone.

session=True | False

Default	True

subDirectories=True | False

when set to True, tables and files in subdirectories of the path specified in the caslib definition are accessible from the caslib.

Alias	subDirs
Default	False

transient=True | False

when set to True, the caslib will be a transient caslib.

Default	False

Parameters for srcType="ADLS"

* "accountName":"string"

Azure storage account name

"applicationId":"string"

Application ID for Azure storage

"dnsSuffix":"string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

* "fileSystem":"string"

Azure storage file system

"timeout":integer

Azure storage operation timeout value in seconds

Default	60
Minimum value	0

Parameters for srcType="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

"bulkload":True | False

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

Default	True

"bulkunload":True | False

when set to TRUE, data is read from Google BigQuery using the BigQuery Export functionality.

Default	False

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_id":"string"

specifies the OAuth client ID for authenticating to Google Cloud Platform

"client_secret":"string"

specifies the OAuth client secret for authenticating to Google Cloud Platform

"conopts":"string"

specifies connection options to use for connecting to the database.

"credFile":"string"

specifies the credentials file for authenticating to Google Cloud Platform

Aliases	credPath
	cred_file
	cred_path

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

"insertbuff":integer

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

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

* "project":"string"

specifies the project ID for the Google Cloud Platform project to connect to

"project_list":"string"

Specifies the list of projects to make available to the data connector. Specifyingthis option prevents the data connector from querying Google BigQuery for thelist of available projects.

Alias	projectList

"proxy":"string"

specifies the proxy to use when connecting to Google Cloud Platform

"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

"scan_strings":True | False

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

Aliases	scanStrings
	scan_string_columns
	scanStringColumns
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", ...>]

"token":"string"

specifies the OAuth refresh token for authenticating to Google Cloud Platform

Alias	refresh_token

"uid":"string"

Aliases	user
Aliases	username

"use_information_schema":True | False

specifies whether or not to use the information schema for metadata requests containing search patterns

Default	True

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="CAS"

* "cashost":"string"

specifies the host name for the remote CAS server.

* "caslib":"string"

specifies the name of the caslib on the remote server to connect to.

"casport":integer

specifies the port number for the remote CAS server.

Default	5570
Range	1–65535

"password":"string"

specifies the password for the remote CAS server.

"user":"string"

specifies the user name for the remote CAS server.

Parameters for srcType="CLOUDDEX"

"append":True | False

Default	False

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

"charCreateMultiplier":double

Default	1
Range	1–5

"charMultiplier":double

Default	1
Range	1–5

"conopts":"string"

specifies connection options to use for connecting to the Data Agent.

"dataAgentName":"string"

"dataOnReaderNodesOnly":True | False

Default	False

"domainCredsRequired":True | False

Default	True

"dropTableOnFailedSave":True | False

Default	True

"insertbuff":integer

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

"metaCatalog":"string"

"metaSchema":"string"

"metaTable":"string"

"ncharCreateMultiplier":double

Default	1
Range	1–5

"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

"numWriteNodes":integer

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

Default	1

"port":integer

specifies the network port number that the server listens on.

Default	25141

"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

"remoteDriverOptions":"string"

"schema":"string"

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

"server":"string"

specifies the host name for the Data Agent.

"traceFile":"string"

specifies a name for the trace file.

"traceFlags":"string"

specifies flags to use for tracing the database connection.

"uid":"string"

specifies the user name.

Alias	username

"useMaxCharLen":True | False

Default	False

"useMetaTable":True | False

Default	True

"useMinMaxToSplit":True | False

Default	False

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

"db":"string"

Alias	database

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"readbuff":integer

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

Aliases	ras
Aliases	row_array_size

"schema":"string"

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="DEFAULT"

No parameters apply when you specify DEFAULT.

Parameters for srcType="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.

"loadTableBackingStore":"CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

Alias	backingStore
Default	INHERIT

CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

INPLACEPREFERRED

Parameters for srcType="ESP"

"authenticationType":"KERB" | "NONE" | "OAUTH" | "SAS"

specifies how to authenticate from SAS Cloud Analytic Services to the ESP server.

Default	NONE

"kservicename":"string"

specifies the Kerberos service name.

"oauthtoken":"string"

specifies the OAuth authentication token.

"password":"string"

specifies the password.

"port":integer

specifies the network port number that the server listens on.

"server":"string"

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

"username":"string"

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

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

"database":"string"

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

"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

"remoteDriverOptions":"string"

"schema":"string"

"server":"string"

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="GCS"

* "bucket":"string"

* "gcsAuthFile":"string"

Parameters for srcType="GREENPLUM"

"authenticationDomain":"string"

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

Alias	authDomain

"branded_driver":"string"

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"conopts":"string"

specifies connection options to use for connecting to the database.

"database":"string"

"gpl_dsn":"string"

Alias	greenplum_dsn

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

Default	5432
Range	1–65535

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

"server":"string"

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="HADOOP"

"authenticationDomain":"string"

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

Alias	authDomain

"authToken":"string"

specifies the authentication token used to establish a connection with a particular cluster.

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

"bulkLoad":True | False

Specifies whether Bulk Loading should be used for inserting rows.

Default	True

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"clusterID":"string"

specifies the cluster identifier.

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

"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

"hadoopConfigDir":"string"

specifies the Hadoop configuration files directory.

"hadoopJarPath":"string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

"hdfsDatadir":"string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

"hdfsMetadir":"string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

"hdfsTempDir":"string"

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

Alias	hdfs_tempdir
Default	"/tmp"

"hiveClass":"string"

specifies the Hive class.

Alias	driverClass

"insertbuff":integer

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

"loginTimeout":integer

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

Default	30
Minimum value	0

"maxSaveThreads":integer

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

Default	0
Minimum value	0

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

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

"port":integer

specifies the Hive JDBC port number.

Default	10000
Range	1–65535

"postTableOpts":"string"

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

"preTableOpts":"string"

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

"properties":"string"

specifies one or more JDBC connection properties to override the default properties. Multiple properties are separated by a semicolon (;).

"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

"resturl":"string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

"schema":"string"

specifies the name of the Hive schema.

Default	"default"

"scratchDB":"string"

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

"server":"string"

specifies the host name for the Hive server.

"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

"uri":"string"

specifies the Hive URI.

Alias	url

"webhdfsurl":"string"

specifies the URL used to access Hadoop distributed file system through REST API.

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

"encrypt":True | False

Default	False

"insertbuff":integer

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

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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

Range	1–65535

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

"server":"string"

"sliceColumn":"variable-name"

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

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

"sslCreateSelfSignedCertificate":True | False

Alias	sslCreateCert
Default	False

"sslCryptoProvider":"string"

Alias	sslProvider

"sslHostNameInCertificate":"string"

Alias	sslHostNameInCert

"sslKeyStore":"string"

"sslTrustStore":"string"

"sslValidateCertificate":True | False

Default	False

"tabletype":"COLUMN" | "ROW"

"uid":"string"

Aliases	user
Aliases	username

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="HDFS"

"enableRemoteSave":True | False

Default	False

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

"hadoopHome":"string"

specifies the path for the HADOOP_HOME environment variable on the Hadoop NameNode.

"hadoopNameNode":"string"

specifies the host name of the Hadoop NameNode. The NameNode can be on the host as the server or in a remote HDFS cluster.

"remoteHadoopPath":"string"

specifies the HDFS path in a remote HDFS cluster to use as a data source.

Parameters for srcType="IMPALA"

"authenticationDomain":"string"

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

Alias	authDomain

"bulkload":True | False

Specifies whether Bulk Loading should be used for inserting rows.

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"

specifies connection options to use for connecting to the database.

"hadoopConfigDir":"string"

Hadoop Configuration File Directory

"hadoopJarPath":"string"

Path to SAS .jar files (colon delimited)

"hdfsTempDir":"string"

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

Alias	hdfs_tempdir
Default	"/tmp"

"impala_dsn":"string"

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

specifies the network port number that the server listens on.

"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

"sasJarPath":"string"

"schema":"string"

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

Aliases	database
Aliases	db

"scratchDB":"string"

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

Alias	scratch_db

"server":"string"

[deprecated] specifies the host name that runs the Impala daemon.

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="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

"class_":"string"

specifies the JDBC driver class

Alias	driverClass

"classPath":"string"

specifies the JDBC CLASSPATH

"conopts":"string"

specifies connection options to use for connecting to the database.

"dbmax_text":integer

specifies the maximum length for character data type columns.

Default	32767
Minimum value	1

"insertbuff":integer

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

"login_timeout":integer

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

Alias	loginTimeout
Minimum value	0

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"pwd":"string"

Aliases	password
Aliases	pass_

"query_timeout":integer

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

Alias	queryTimeout
Minimum value	0

"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

"url":"string"

specifies the JDBC connection string

Alias	uri

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="LASR"

"authenticationDomain":"string"

specifies the authentication domain in SAS metadata that is used to store credentials for data access.

Alias	authDomain

"metaLib":"string"

specifies the name of the SAS library in SAS metadata that corresponds to the data to load.

"passWord":"string"

specifies the password.

* "port":integer

specifies the network port number that the server listens on.

* "server":"string"

specifies the host name of the SAS LASR Analytic Server.

"signer":"string"

specifies the URL for the SAS LASR Analytic Server Signer Service.

"tag":"string"

specifies a tag which qualifies the names of LASR tables accessed using this caslib.

"userName":"string"

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

Parameters for srcType="MONGODB"

"auth":"AUTO" | "KERBEROS" | "LDAP" | "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

PASSWORD

specifies that user/password credentials are used for connection

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

specifies connection options to use for connecting to the database.

"db":"string"

specifies the MongoDB database to connect to.

Alias	database

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"platform":"ATLAS"

specifies the MongoDB Atlas platform to be targeted

ATLAS

specifies that the MongoDB Atlas platform is the target

"port":integer

specifies the network port number that the server listens on.

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

"schema_auth":"AUTO" | "KERBEROS" | "LDAP" | "PASSWORD"

specifies whether to use user/password or LDAP for schema store 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

PASSWORD

specifies that user/password credentials are used for connection

"schema_collection":"string"

specifies the schema collection to use when connecting to MongoDB.

"schema_db":"string"

specifies the schema database to use when connecting to MongoDB.

Alias	schema_database

"schema_platform":"ATLAS"

specifies the MongoDB Atlas platform to be targeted

ATLAS

specifies that the MongoDB Atlas platform is the target

"schema_port":integer

specifies the schema port to use when connecting to MongoDB.

"schema_pwd":"string"

specifies the schema password to use when connecting to MongoDB.

"schema_server":"string"

specifies the schema server to use when connecting to MongoDB.

"schema_ssl_ca":"string"

specifies the schema SSL certificate authority to use when connecting to MongoDB.

"schema_ssl_cert":"string"

specifies the schema SSL certificate to use when connecting to MongoDB.

"schema_uid":"string"

specifies the schema username to use when connecting to MongoDB.

"server":"string"

specifies the host name for the MongoDB server.

"sliceColumn":"variable-name"

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

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

"ssl_ca":"string"

specifies the SSL certificate authority to use when connecting to MongoDB server.

"ssl_cert":"string"

specifies the SSL certificate to use when connecting to MongoDB server.

"uid":"string"

Aliases	user
Aliases	username

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

"database":"string"

Alias	db

"default_auth_plugin":"string"

when set, specifies the name of the authentication plugin to use when connecting

"enable_clearTextPlugin":True | False

specifies whether to enable the "mysql_clear_password" plugin for authentication

Default	False

"host":"string"

Alias	server

"insertbuff":integer

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

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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

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

"sliceColumn":"variable-name"

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

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

"socket":"string"

"ssl_ca":"string"

the path of the Certificate Authority (CA) certificate file

"ssl_cert":"string"

the path of the client public key certificate file

"ssl_key":"string"

the path of the client private key file

"uid":"string"

Aliases	user
Aliases	username

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="NETEZZA"

"authenticationDomain":"string"

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

Alias	authDomain

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"client_encoding":"string"

"conopts":"string"

specifies connection options to use for connecting to the database.

"database":"string"

"insertbuff":integer

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

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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

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

"server":"string"

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

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

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"odbc_dsn":"string"

Aliases	db
Aliases	database

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"ora_encoding":"string"

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

"path":"string"

specifies the Oracle driver, node, and database.

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="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.

"loadTableBackingStore":"CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

Alias	backingStore
Default	INHERIT

CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

INPLACEPREFERRED

Parameters for srcType="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

"blDelDatFile":True | False

when set to TRUE, remove data and ctl files from disk after bulk unloading operation exits.

Default	False

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

"blPsqlPath":"string"

specifies the full-path for the psql utility.

"blQuote":"string"

specifies the quoting character in data file.

"bulkload":True | False

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

Default	False

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

specifies connection options to use for connecting to the database.

"database":"string"

specifies the PostgreSQL database to connect to.

"insertbuff":integer

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

"ldPath":"string"

specifies the shared library searching path in LD_LIBRARY_PATH.

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

specifies the network port number that the server listens on.

"ptg_dsn":"string"

Alias	postgres_dsn

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

"server":"string"

specifies the host name for the PostgreSQL server.

"sliceColumn":"variable-name"

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

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

"sslMode":"string"

specifies the SSL mode for the connection to PostgreSQL

"uid":"string"

Aliases	user
Aliases	username

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="REDSHIFT"

"authenticationDomain":"string"

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

Alias	authDomain

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

"bulkload":True | False

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

Default	False

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

specifies connection options to use for connecting to the database.

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

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

"delimiter":"string"

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

"driver_vendor":"string"

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

"insertbuff":integer

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

"key":"string"

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

"profile":"string"

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

"ptg_dsn":"string"

Alias	redshift_dsn

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

"secret":"string"

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

"server":"string"

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

"useSSL":True | False

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

Default	False

Parameters for srcType="S3"

"accessKeyId":"string"

specifies the access key ID that you use to access the Amazon Web Services (AWS) S3 environment.

"awsConfigPath":"string"

"awsConfigProfile":"string"

specifies a named profile to use from an AWS CLI config files instead of the default profile.

"awsCredentialsPath":"string"

specifies the path and file name of an AWS CLI credentials file. The default location is the .aws directory in your home directory. The default file name is credentials.

"awsCredentialsProfile":"string"

specifies a named profile to use from an AWS CLI credentials file instead of the default profile.

* "bucket":"string"

specifies the name of the S3 bucket to access.

"kmsContext":"string"

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

"kmsKeyId":"string"

specifies the AWS Key Management Services ID.

"objectPath":"string"

specifies a subdirectory within an S3 bucket.

"region":"ASIAPACIFICSINGAPORE" | "ASIAPACIFICSYDNEY" | "ASIAPACIFICTOKYO" | "ASIA_PACIFIC_INDIA" | "ASIA_PACIFIC_SEOUL" | "CA_CENTRAL" | "CHINA_BEIJING" | "CHINA_NINGXIA" | "EU_FRANKFURT" | "EU_IRELAND" | "EU_LONDON" | "EU_PARIS" | "SA_SAOPAULO" | "US_EAST" | "US_EAST_OHIO" | "US_GOV" | "US_GOV_FIPS" | "US_STANDARD" | "US_WEST_CALIFORNIA" | "US_WEST_OREGON" | "string"

specifies the AWS region to connect to.

"roleArn":"string"

specifies the ARN of an IAM role to assume when connecting to S3.

"roleName":"string"

specifies the name of an IAM role to assume when connecting to S3.

"secretAccessKey":"string"

specifies the secret access key that you use to access the AWS S3 environment.

"sessionToken":"string"

specifies an override for the session token. Normally, the session token is automatically refreshed on an as-needed basis.

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

"useIAMRole":True | False

Default	False

"useSSL":True | False

when set to False, the server attempts to connect to AWS without using secure communication. By default, secure communication is used.

Default	True

Parameters for srcType="SFORCE"

"authendpoint":"string"

Specifies the authorization endpoint to use

Alias	aep

"authenticationDomain":"string"

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

Alias	authDomain

"bulkApi":True | False

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

Alias	bulk_api
Default	False

"bulkRefresh":integer

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

Alias	bulk_refresh
Minimum value	0

"bulkTimeout":integer

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

Alias	bulk_timeout
Minimum value	0

"catalog":"string"

specifies the database catalog name.

"cert_pass":"string"

password used to read the Salesforce TLS Certificate

Aliases	cert_password
	cert_pw
	cert_pwd

"cert_path":"string"

OS path to the Salesforce TLS Certificate

"charMultiplier":double

Default	1
Range	1–5

"conopts":"string"

specifies connection options to use for connecting to the database.

"insertbuff":integer

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

"mutual_auth":"string"

Salesforce TLS Mutual Authentication

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"proxy_host":"string"

specifies the hostname for the proxy to use when connecting to Salesforce

Alias	proxyhost

"proxy_pass":"string"

specifies the password for the proxy to use when connecting to Salesforce

Alias	proxypass

"proxy_port":integer

specifies the port for the proxy to use when connecting to Salesforce

Alias	proxyport
Range	0–65535

"proxy_user":"string"

specifies the user for the proxy to use when connecting to Salesforce

Alias	proxyuser

"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

"show_metadata":"string"

Show Salesforce Metadata columns

"show_recycled":"string"

Show Salesforce recycled/deleted tables

Alias	show_deleted

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

"uid":"string"

Aliases	user
Aliases	username

"use_native_names":"string"

Use Salesforce native names

Aliases	native_names
Aliases	sas_sforce_use_native_names

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="SNOWFLAKE"

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

"blOptions":"string"

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

Alias	bulkloadOptions

"bucket":"string"

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

"bulkload":True | False

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

Default	False

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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"

specifies connection options to use for connecting to the database.

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

"database":"string"

specifies the Snowflake database to connect to.

Alias	db

"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

"insertbuff":integer

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

"key":"string"

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

specifies the network port number that the server listens on.

"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 Snowflake server resides for bulk-load.

"s3Config":"string"

specifies an optional S3 configuration file

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

"secret":"string"

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

"server":"string"

specifies the host name for the Snowflake server.

"sliceColumn":"variable-name"

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

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

"snow_dsn":"string"

Alias	snowflake_dsn

"stage":"string"

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

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

"useSSL":True | False

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

Default	False

Parameters for srcType="SPARK"

"authenticationDomain":"string"

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

Alias	authDomain

"authToken":"string"

specifies the authentication token used to establish a connection with a particular cluster.

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

"bulkLoad":True | False

Specifies whether Bulk Loading should be used for inserting rows.

Default	True

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

Default	1
Range	1–5

"clusterID":"string"

specifies the cluster identifier.

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

"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

"hadoopConfigDir":"string"

specifies the Hadoop configuration files directory.

"hadoopJarPath":"string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

"hdfsDatadir":"string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

"hdfsMetadir":"string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

"hdfsTempDir":"string"

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

Alias	hdfs_tempdir
Default	"/tmp"

"hiveClass":"string"

specifies the Hive class.

Alias	driverClass

"insertbuff":integer

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

"loginTimeout":integer

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

Default	30
Minimum value	0

"maxSaveThreads":integer

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

Default	0
Minimum value	0

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Alias	target

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.

"port":integer

specifies the spark thriftserver port number.

Default	10016
Range	1–65535

"postTableOpts":"string"

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

"preTableOpts":"string"

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

"properties":"string"

specifies one or more JDBC connection properties to override the default properties. Multiple properties are separated by a semicolon (;).

"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

"resturl":"string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

"schema":"string"

specifies the name of the Hive schema.

Default	"default"

"scratchDB":"string"

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

"server":"string"

specifies the host name for the spark thriftserver.

"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

"uri":"string"

specifies the Hive URI.

Alias	url

"webhdfsurl":"string"

specifies the URL used to access Hadoop distributed file system through REST API.

Parameters for srcType="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

"authToken":"string"

specifies the authentication token used to establish a connection with a particular cluster.

"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

"classPath":"string"

optional driver-only JDBC classpath without HDFS access

"clusterID":"string"

specifies the cluster identifier.

"compress":"BINARY" | "CHAR" | "NO" | "YES"

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

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

"datapath":"string"

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

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

"hadoopConfigDir":"string"

specifies the Hadoop configuration files directory.

"hadoopJarPath":"string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

"hdfs":True | False

specifies where SPDE should use HDFS (yes) or Traditional Disk (no).

Default	False

"hdfsTempDir":"string"

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

"label":"string"

specifies a label to apply to the output data set.

"masterPW":"string"

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

"maxSaveThreads":integer

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

Default	0
Minimum value	0

* "mdfpath":"string"

specifies the path where SPDE MDF are located.

"ncharMultiplier":double

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

"numWriteBuffers":integer

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

Default	10
Range	1–100

"padCompress":integer

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

"partSize":64-bit-integer

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

Minimum value	16

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

Specifies which Spark or Hadoop platform to run on.

Alias	target
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
	pass_
	passwd

"readPW":"string"

specifies the password to use for Read access.

"resturl":"string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

"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

"webhdfsurl":"string"

specifies the URL used to access Hadoop distributed file system through REST API.

"writePW":"string"

specifies the password to use for Write access.

Parameters for srcType="SQLSERVER"

"accountName":"string"

Azure storage account name

"applicationId":"string"

Application ID for Azure storage

"authenticationDomain":"string"

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

Alias	authDomain

"authenticationScope":"string"

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

Alias	authScope

"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

"blobThreshold":integer

Minimum value	0

"blOptions":"string"

Alias	bulkloadOptions

"bulkload":True | False

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

Default	False

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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"

specifies connection options to use for connecting to the database.

"defaultDir":"string"

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

Alias	defaultDirectory

"deleteDataFiles":True | False

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

Default	True

"delimiter":"string"

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

"dnsSuffix":"string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

"escape":True | False

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

Default	False

"fileSystem":"string"

Azure storage file system

"folder":"string"

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

"identity":"string"

Authentication method

"insertbuff":integer

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

"invalidDate":"string"

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

"maxErrors":integer

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

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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"odbc_dsn":"string"

Aliases	db
	database
	sqlserver_dsn

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

"secret":"string"

Key for authentication

"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

"useLog":True | False

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

Default	False

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="TERADATA"

"account":"string"

specifies the account number that you want to charge for the Teradata session.

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

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

Default	"UTF8"

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

"dbmaxText":integer

specifies a Teradata Max Text Size value in chars.

Default	32000
Range	1–32000

"encoding":"string"

specifies the Teradata database data encoding.

"insertbuff":integer

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

"maxparmsize":64-bit-integer

specifies the maximum parameter size, in characters, when configuring the database connection.

Alias	mps

"maxSaveThreads":integer

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

Default	0
Minimum value	0

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"pwd":"string"

specifies the password.

Aliases	password
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 name when accessing the Teradata database.

"schema":"string"

Unused

* "server":"string"

specifies the host name for the Teradata server.

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

specifies connection options to use for connecting to the database.

"database":"string"

specifies the PostgreSQL database to connect to.

Alias	db

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"odbc_dsn":"string"

Alias	vertica_dsn

"port":integer

specifies the network port number that the server listens on.

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

"server":"string"

specifies the host name for the PostgreSQL server.

"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

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

"database":"string"

specifies the Yellowbrick database to connect to.

"insertbuff":integer

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

"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

"numWriteNodes":integer

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

Default	1
Range	0–32767

"port":integer

specifies the network port number that the server listens on.

"ptg_dsn":"string"

Alias	yellowbrick_dsn

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

"server":"string"

specifies the host name for the Yellowbrick server.

"sliceColumn":"variable-name"

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

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

"sslMode":"string"

specifies the SSL mode for the connection to PostgreSQL

"uid":"string"

Aliases	user
Aliases	username

"useNarrowCharacterTypes":True | False

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	False

addCaslib Action

Adds a new caslib to enable access to a data source.

See:	Working with Caslibs
Examples:	Add an Oracle Caslib
Examples:	Add a File System Path Caslib

R Syntax

results <– cas.table.addCaslib(s,

activeOnAdd=TRUE | FALSE,

createDirectory=TRUE | FALSE,

description="string",

hidden=TRUE | FALSE,

name="string",

path="string",

session=TRUE | FALSE,

subDirectories=TRUE | FALSE,

transient=TRUE | FALSE

)

indicates a required parameter

Parameter Descriptions

activeOnAdd=TRUE | FALSE

when set to True, the new caslib becomes the active caslib.

Default	TRUE

createDirectory=TRUE | FALSE

when set to True, the caslib directory will be created.

Alias	createDir
Default	FALSE

dataSource=list(srcType="ADLS" | "BIGQUERY" | "CAS" | "CLOUDDEX" | "DB2" | "DEFAULT" | "DNFS" | "ESP" | "FEDSVR" | "GCS" | "GREENPLUM" | "HADOOP" | "HANA" | "HDFS" | "IMPALA" | "JDBC" | "LASR" | "MONGODB" | "MYSQL" | "NETEZZA" | "ODBC" | "ORACLE" | "PATH" | "POSTGRES" | "REDSHIFT" | "S3" | "SFORCE" | "SNOWFLAKE" | "SPARK" | "SPDE" | "SQLSERVER" | "TERADATA" | "VERTICA" | "YELLOWBRICK", srcType-specific-parameters)

specifies the data source type and type-specific parameters.

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

description="string"

specifies a description of the caslib.

hidden=TRUE | FALSE

when set to True, the caslib will be a hidden caslib.

Default	FALSE

* name="string"

specifies the name of the caslib to add.

Aliases	lib
Aliases	caslib

path="string"

specifies data source-specific information. For PATH and DNFS, this is a file system path.

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

specifies the host access controls on the caslib when directory creation is requested. By default, the permissions are set according to the umask of the session process.

Alias	perms

GROUPREAD	Read access is granted to the owning group with Read and Write access to the owner of the file or directory.
GROUPWRITE	Read and Write access are granted to the owner of the file or directory and to the owning group.
GROUPWRITEPUBLICREAD	Read access is granted to everyone with Read and Write access granted to the owner of the file or directory and the owning group.
PRIVATE	Read and Write access are granted only to the owner of the file or directory.
PUBLICREAD	Read access is granted to everyone with Read and Write access to the owner of the file or directory.
PUBLICWRITE	Read and Write access are granted to everyone.

session=TRUE | FALSE

Default	TRUE

subDirectories=TRUE | FALSE

when set to True, tables and files in subdirectories of the path specified in the caslib definition are accessible from the caslib.

Alias	subDirs
Default	FALSE

transient=TRUE | FALSE

when set to True, the caslib will be a transient caslib.

Default	FALSE

Parameters for srcType="ADLS"

* accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

* fileSystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default	60
Minimum value	0

Parameters for srcType="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

bulkload=TRUE | FALSE

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

Default	TRUE

bulkunload=TRUE | FALSE

when set to TRUE, data is read from Google BigQuery using the BigQuery Export functionality.

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_id="string"

specifies the OAuth client ID for authenticating to Google Cloud Platform

client_secret="string"

specifies the OAuth client secret for authenticating to Google Cloud Platform

conopts="string"

specifies connection options to use for connecting to the database.

credFile="string"

specifies the credentials file for authenticating to Google Cloud Platform

Aliases	credPath
	cred_file
	cred_path

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.

insertbuff=integer

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

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.

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

numWriteNodes=integer

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

Default	1
Range	0–32767

* project="string"

specifies the project ID for the Google Cloud Platform project to connect to

project_list="string"

Specifies the list of projects to make available to the data connector. Specifyingthis option prevents the data connector from querying Google BigQuery for thelist of available projects.

Alias	projectList

proxy="string"

specifies the proxy to use when connecting to Google Cloud Platform

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

scan_strings=TRUE | FALSE

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

Aliases	scanStrings
	scan_string_columns
	scanStringColumns
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", ...>)

token="string"

specifies the OAuth refresh token for authenticating to Google Cloud Platform

Alias	refresh_token

uid="string"

Aliases	user
Aliases	username

use_information_schema=TRUE | FALSE

specifies whether or not to use the information schema for metadata requests containing search patterns

Default	TRUE

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="CAS"

* cashost="string"

specifies the host name for the remote CAS server.

* caslib="string"

specifies the name of the caslib on the remote server to connect to.

casport=integer

specifies the port number for the remote CAS server.

Default	5570
Range	1–65535

password="string"

specifies the password for the remote CAS server.

user="string"

specifies the user name for the remote CAS server.

Parameters for srcType="CLOUDDEX"

append=TRUE | FALSE

Default	FALSE

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.

charCreateMultiplier=double

Default	1
Range	1–5

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the Data Agent.

dataAgentName="string"

dataOnReaderNodesOnly=TRUE | FALSE

Default	FALSE

domainCredsRequired=TRUE | FALSE

Default	TRUE

dropTableOnFailedSave=TRUE | FALSE

Default	TRUE

insertbuff=integer

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

metaCatalog="string"

metaSchema="string"

metaTable="string"

ncharCreateMultiplier=double

Default	1
Range	1–5

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

numWriteNodes=integer

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

Default	1

port=integer

specifies the network port number that the server listens on.

Default	25141

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

remoteDriverOptions="string"

schema="string"

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

server="string"

specifies the host name for the Data Agent.

traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

Alias	username

useMaxCharLen=TRUE | FALSE

Default	FALSE

useMetaTable=TRUE | FALSE

Default	TRUE

useMinMaxToSplit=TRUE | FALSE

Default	FALSE

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

db="string"

Alias	database

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

readbuff=integer

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

Aliases	ras
Aliases	row_array_size

schema="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="DEFAULT"

No parameters apply when you specify DEFAULT.

Parameters for srcType="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.

loadTableBackingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

Alias	backingStore
Default	INHERIT

CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

INPLACEPREFERRED

Parameters for srcType="ESP"

authenticationType="KERB" | "NONE" | "OAUTH" | "SAS"

specifies how to authenticate from SAS Cloud Analytic Services to the ESP server.

Default	NONE

kservicename="string"

specifies the Kerberos service name.

oauthtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port=integer

specifies the network port number that the server listens on.

server="string"

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

username="string"

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

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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

remoteDriverOptions="string"

schema="string"

server="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="GCS"

* bucket="string"

* gcsAuthFile="string"

Parameters for srcType="GREENPLUM"

authenticationDomain="string"

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

Alias	authDomain

branded_driver="string"

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the database.

database="string"

gpl_dsn="string"

Alias	greenplum_dsn

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

Default	5432
Range	1–65535

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"

server="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="HADOOP"

authenticationDomain="string"

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

Alias	authDomain

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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.

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

Default	TRUE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

clusterID="string"

specifies the cluster identifier.

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfsDatadir="string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

hdfsMetadir="string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

hiveClass="string"

specifies the Hive class.

Alias	driverClass

insertbuff=integer

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

loginTimeout=integer

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

Default	30
Minimum value	0

maxSaveThreads=integer

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

Default	0
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

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

port=integer

specifies the Hive JDBC port number.

Default	10000
Range	1–65535

postTableOpts="string"

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

preTableOpts="string"

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

properties="string"

specifies one or more JDBC connection properties to override the default properties. Multiple properties are separated by a semicolon (;).

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

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

schema="string"

specifies the name of the Hive schema.

Default	"default"

scratchDB="string"

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

server="string"

specifies the host name for the Hive server.

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

uri="string"

specifies the Hive URI.

Alias	url

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

encrypt=TRUE | FALSE

Default	FALSE

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

Range	1–65535

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.

server="string"

sliceColumn="variable-name"

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

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

sslCreateSelfSignedCertificate=TRUE | FALSE

Alias	sslCreateCert
Default	FALSE

sslCryptoProvider="string"

Alias	sslProvider

sslHostNameInCertificate="string"

Alias	sslHostNameInCert

sslKeyStore="string"

sslTrustStore="string"

sslValidateCertificate=TRUE | FALSE

Default	FALSE

tabletype="COLUMN" | "ROW"

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="HDFS"

enableRemoteSave=TRUE | FALSE

Default	FALSE

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.

hadoopHome="string"

specifies the path for the HADOOP_HOME environment variable on the Hadoop NameNode.

hadoopNameNode="string"

specifies the host name of the Hadoop NameNode. The NameNode can be on the host as the server or in a remote HDFS cluster.

remoteHadoopPath="string"

specifies the HDFS path in a remote HDFS cluster to use as a data source.

Parameters for srcType="IMPALA"

authenticationDomain="string"

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

Alias	authDomain

bulkload=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

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"

specifies connection options to use for connecting to the database.

hadoopConfigDir="string"

Hadoop Configuration File Directory

hadoopJarPath="string"

Path to SAS .jar files (colon delimited)

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

impala_dsn="string"

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

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

sasJarPath="string"

schema="string"

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

Aliases	database
Aliases	db

scratchDB="string"

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

Alias	scratch_db

server="string"

[deprecated] specifies the host name that runs the Impala daemon.

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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

class="string"

specifies the JDBC driver class

Alias	driverClass

classPath="string"

specifies the JDBC CLASSPATH

conopts="string"

specifies connection options to use for connecting to the database.

dbmax_text=integer

specifies the maximum length for character data type columns.

Default	32767
Minimum value	1

insertbuff=integer

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

login_timeout=integer

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

Alias	loginTimeout
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

Aliases	password
Aliases	pass

query_timeout=integer

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

Alias	queryTimeout
Minimum value	0

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

url="string"

specifies the JDBC connection string

Alias	uri

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="LASR"

authenticationDomain="string"

specifies the authentication domain in SAS metadata that is used to store credentials for data access.

Alias	authDomain

metaLib="string"

specifies the name of the SAS library in SAS metadata that corresponds to the data to load.

passWord="string"

specifies the password.

* port=integer

specifies the network port number that the server listens on.

* server="string"

specifies the host name of the SAS LASR Analytic Server.

signer="string"

specifies the URL for the SAS LASR Analytic Server Signer Service.

tag="string"

specifies a tag which qualifies the names of LASR tables accessed using this caslib.

userName="string"

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

Parameters for srcType="MONGODB"

auth="AUTO" | "KERBEROS" | "LDAP" | "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

PASSWORD

specifies that user/password credentials are used for connection

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"

specifies connection options to use for connecting to the database.

db="string"

specifies the MongoDB database to connect to.

Alias	database

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

platform="ATLAS"

specifies the MongoDB Atlas platform to be targeted

ATLAS

specifies that the MongoDB Atlas platform is the target

port=integer

specifies the network port number that the server listens on.

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.

schema_auth="AUTO" | "KERBEROS" | "LDAP" | "PASSWORD"

specifies whether to use user/password or LDAP for schema store 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

PASSWORD

specifies that user/password credentials are used for connection

schema_collection="string"

specifies the schema collection to use when connecting to MongoDB.

schema_db="string"

specifies the schema database to use when connecting to MongoDB.

Alias	schema_database

schema_platform="ATLAS"

specifies the MongoDB Atlas platform to be targeted

ATLAS

specifies that the MongoDB Atlas platform is the target

schema_port=integer

specifies the schema port to use when connecting to MongoDB.

schema_pwd="string"

specifies the schema password to use when connecting to MongoDB.

schema_server="string"

specifies the schema server to use when connecting to MongoDB.

schema_ssl_ca="string"

specifies the schema SSL certificate authority to use when connecting to MongoDB.

schema_ssl_cert="string"

specifies the schema SSL certificate to use when connecting to MongoDB.

schema_uid="string"

specifies the schema username to use when connecting to MongoDB.

server="string"

specifies the host name for the MongoDB server.

sliceColumn="variable-name"

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

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

ssl_ca="string"

specifies the SSL certificate authority to use when connecting to MongoDB server.

ssl_cert="string"

specifies the SSL certificate to use when connecting to MongoDB server.

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

Alias	db

default_auth_plugin="string"

when set, specifies the name of the authentication plugin to use when connecting

enable_clearTextPlugin=TRUE | FALSE

specifies whether to enable the "mysql_clear_password" plugin for authentication

Default	FALSE

host="string"

Alias	server

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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"

sliceColumn="variable-name"

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

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

socket="string"

ssl_ca="string"

the path of the Certificate Authority (CA) certificate file

ssl_cert="string"

the path of the client public key certificate file

ssl_key="string"

the path of the client private key file

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="NETEZZA"

authenticationDomain="string"

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

Alias	authDomain

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

client_encoding="string"

conopts="string"

specifies connection options to use for connecting to the database.

database="string"

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

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.

server="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

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.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Aliases	db
Aliases	database

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

ora_encoding="string"

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

path="string"

specifies the Oracle driver, node, and database.

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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.

loadTableBackingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

Alias	backingStore
Default	INHERIT

CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

INPLACEPREFERRED

Parameters for srcType="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

blDelDatFile=TRUE | FALSE

when set to TRUE, remove data and ctl files from disk after bulk unloading operation exits.

Default	FALSE

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.

blPsqlPath="string"

specifies the full-path for the psql utility.

blQuote="string"

specifies the quoting character in data file.

bulkload=TRUE | FALSE

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

Default	FALSE

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"

specifies connection options to use for connecting to the database.

database="string"

specifies the PostgreSQL database to connect to.

insertbuff=integer

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

ldPath="string"

specifies the shared library searching path in LD_LIBRARY_PATH.

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

ptg_dsn="string"

Alias	postgres_dsn

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.

server="string"

specifies the host name for the PostgreSQL server.

sliceColumn="variable-name"

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

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

sslMode="string"

specifies the SSL mode for the connection to PostgreSQL

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="REDSHIFT"

authenticationDomain="string"

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

Alias	authDomain

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.

bulkload=TRUE | FALSE

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

Default	FALSE

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"

specifies connection options to use for connecting to the database.

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.

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

delimiter="string"

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

driver_vendor="string"

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.

insertbuff=integer

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

key="string"

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

profile="string"

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

ptg_dsn="string"

Alias	redshift_dsn

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"

secret="string"

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

server="string"

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

useSSL=TRUE | FALSE

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

Default	FALSE

Parameters for srcType="S3"

accessKeyId="string"

specifies the access key ID that you use to access the Amazon Web Services (AWS) S3 environment.

awsConfigPath="string"

awsConfigProfile="string"

specifies a named profile to use from an AWS CLI config files instead of the default profile.

awsCredentialsPath="string"

specifies the path and file name of an AWS CLI credentials file. The default location is the .aws directory in your home directory. The default file name is credentials.

awsCredentialsProfile="string"

specifies a named profile to use from an AWS CLI credentials file instead of the default profile.

* bucket="string"

specifies the name of the S3 bucket to access.

kmsContext="string"

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

kmsKeyId="string"

specifies the AWS Key Management Services ID.

objectPath="string"

specifies a subdirectory within an S3 bucket.

region="ASIAPACIFICSINGAPORE" | "ASIAPACIFICSYDNEY" | "ASIAPACIFICTOKYO" | "ASIA_PACIFIC_INDIA" | "ASIA_PACIFIC_SEOUL" | "CA_CENTRAL" | "CHINA_BEIJING" | "CHINA_NINGXIA" | "EU_FRANKFURT" | "EU_IRELAND" | "EU_LONDON" | "EU_PARIS" | "SA_SAOPAULO" | "US_EAST" | "US_EAST_OHIO" | "US_GOV" | "US_GOV_FIPS" | "US_STANDARD" | "US_WEST_CALIFORNIA" | "US_WEST_OREGON" | "string"

specifies the AWS region to connect to.

roleArn="string"

specifies the ARN of an IAM role to assume when connecting to S3.

roleName="string"

specifies the name of an IAM role to assume when connecting to S3.

secretAccessKey="string"

specifies the secret access key that you use to access the AWS S3 environment.

sessionToken="string"

specifies an override for the session token. Normally, the session token is automatically refreshed on an as-needed basis.

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.

useIAMRole=TRUE | FALSE

Default	FALSE

useSSL=TRUE | FALSE

when set to False, the server attempts to connect to AWS without using secure communication. By default, secure communication is used.

Default	TRUE

Parameters for srcType="SFORCE"

authendpoint="string"

Specifies the authorization endpoint to use

Alias	aep

authenticationDomain="string"

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

Alias	authDomain

bulkApi=TRUE | FALSE

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

Alias	bulk_api
Default	FALSE

bulkRefresh=integer

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

Alias	bulk_refresh
Minimum value	0

bulkTimeout=integer

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

Alias	bulk_timeout
Minimum value	0

catalog="string"

specifies the database catalog name.

cert_pass="string"

password used to read the Salesforce TLS Certificate

Aliases	cert_password
	cert_pw
	cert_pwd

cert_path="string"

OS path to the Salesforce TLS Certificate

charMultiplier=double

Default	1
Range	1–5

conopts="string"

specifies connection options to use for connecting to the database.

insertbuff=integer

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

mutual_auth="string"

Salesforce TLS Mutual Authentication

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

numWriteNodes=integer

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

Default	1
Range	0–32767

proxy_host="string"

specifies the hostname for the proxy to use when connecting to Salesforce

Alias	proxyhost

proxy_pass="string"

specifies the password for the proxy to use when connecting to Salesforce

Alias	proxypass

proxy_port=integer

specifies the port for the proxy to use when connecting to Salesforce

Alias	proxyport
Range	0–65535

proxy_user="string"

specifies the user for the proxy to use when connecting to Salesforce

Alias	proxyuser

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

show_metadata="string"

Show Salesforce Metadata columns

show_recycled="string"

Show Salesforce recycled/deleted tables

Alias	show_deleted

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

uid="string"

Aliases	user
Aliases	username

use_native_names="string"

Use Salesforce native names

Aliases	native_names
Aliases	sas_sforce_use_native_names

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="SNOWFLAKE"

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.

blOptions="string"

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

Alias	bulkloadOptions

bucket="string"

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

bulkload=TRUE | FALSE

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

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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"

specifies connection options to use for connecting to the database.

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.

database="string"

specifies the Snowflake database to connect to.

Alias	db

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

insertbuff=integer

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

key="string"

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

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 Snowflake server resides for bulk-load.

s3Config="string"

specifies an optional S3 configuration file

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.

secret="string"

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

server="string"

specifies the host name for the Snowflake server.

sliceColumn="variable-name"

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

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

snow_dsn="string"

Alias	snowflake_dsn

stage="string"

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

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

useSSL=TRUE | FALSE

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

Default	FALSE

Parameters for srcType="SPARK"

authenticationDomain="string"

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

Alias	authDomain

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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.

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

Default	TRUE

catalog="string"

specifies the database catalog name.

charMultiplier=double

Default	1
Range	1–5

clusterID="string"

specifies the cluster identifier.

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfsDatadir="string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

hdfsMetadir="string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

hdfsTempDir="string"

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

Alias	hdfs_tempdir
Default	"/tmp"

hiveClass="string"

specifies the Hive class.

Alias	driverClass

insertbuff=integer

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

loginTimeout=integer

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

Default	30
Minimum value	0

maxSaveThreads=integer

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

Default	0
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

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

Specifies which Spark or Hadoop platform to run on.

Alias	target

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.

port=integer

specifies the spark thriftserver port number.

Default	10016
Range	1–65535

postTableOpts="string"

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

preTableOpts="string"

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

properties="string"

specifies one or more JDBC connection properties to override the default properties. Multiple properties are separated by a semicolon (;).

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

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

schema="string"

specifies the name of the Hive schema.

Default	"default"

scratchDB="string"

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

server="string"

specifies the host name for the spark thriftserver.

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

uri="string"

specifies the Hive URI.

Alias	url

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

Parameters for srcType="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

authToken="string"

specifies the authentication token used to establish a connection with a particular cluster.

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

classPath="string"

optional driver-only JDBC classpath without HDFS access

clusterID="string"

specifies the cluster identifier.

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

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

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

datapath="string"

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

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

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

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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.

hadoopConfigDir="string"

specifies the Hadoop configuration files directory.

hadoopJarPath="string"

specifies one or more paths to the Hadoop JAR files. Separate paths with colons.

hdfs=TRUE | FALSE

specifies where SPDE should use HDFS (yes) or Traditional Disk (no).

Default	FALSE

hdfsTempDir="string"

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

label="string"

specifies a label to apply to the output data set.

masterPW="string"

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

maxSaveThreads=integer

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

Default	0
Minimum value	0

* mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

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

numWriteBuffers=integer

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

Default	10
Range	1–100

padCompress=integer

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

partSize=64-bit-integer

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

Minimum value	16

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

Specifies which Spark or Hadoop platform to run on.

Alias	target
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
	pass
	passwd

readPW="string"

specifies the password to use for Read access.

resturl="string"

specifies the URL used to submit execution requests through REST API (for example, Apache Livy or Databricks Notebooks).

Alias	jobmanagementurl

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

webhdfsurl="string"

specifies the URL used to access Hadoop distributed file system through REST API.

writePW="string"

specifies the password to use for Write access.

Parameters for srcType="SQLSERVER"

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

authenticationDomain="string"

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

Alias	authDomain

authenticationScope="string"

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

Alias	authScope

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

blobThreshold=integer

Minimum value	0

blOptions="string"

Alias	bulkloadOptions

bulkload=TRUE | FALSE

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

Default	FALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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"

specifies connection options to use for connecting to the database.

defaultDir="string"

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

Alias	defaultDirectory

deleteDataFiles=TRUE | FALSE

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

Default	TRUE

delimiter="string"

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

dnsSuffix="string"

DNS Suffix for Azure storage

Default	"dfs.core.windows.net"

escape=TRUE | FALSE

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

Default	FALSE

fileSystem="string"

Azure storage file system

folder="string"

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

identity="string"

Authentication method

insertbuff=integer

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

invalidDate="string"

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

maxErrors=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Aliases	db
	database
	sqlserver_dsn

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.

secret="string"

Key for authentication

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

useLog=TRUE | FALSE

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

Default	FALSE

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="TERADATA"

account="string"

specifies the account number that you want to charge for the Teradata session.

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.

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.

Default	"UTF8"

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.

Aliases	dtm
Aliases	dataTransfer
Default	SERIAL

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies a Teradata Max Text Size value in chars.

Default	32000
Range	1–32000

encoding="string"

specifies the Teradata database data encoding.

insertbuff=integer

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

maxparmsize=64-bit-integer

specifies the maximum parameter size, in characters, when configuring the database connection.

Alias	mps

maxSaveThreads=integer

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

Default	0
Minimum value	0

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

numWriteNodes=integer

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

Default	1
Range	0–32767

pwd="string"

specifies the password.

Aliases	password
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 name when accessing the Teradata database.

schema="string"

Unused

* server="string"

specifies the host name for the Teradata server.

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

specifies connection options to use for connecting to the database.

database="string"

specifies the PostgreSQL database to connect to.

Alias	db

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

odbc_dsn="string"

Alias	vertica_dsn

port=integer

specifies the network port number that the server listens on.

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.

server="string"

specifies the host name for the PostgreSQL server.

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

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Parameters for srcType="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"

specifies connection options to use for connecting to the database.

database="string"

specifies the Yellowbrick database to connect to.

insertbuff=integer

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

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

numWriteNodes=integer

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

Default	1
Range	0–32767

port=integer

specifies the network port number that the server listens on.

ptg_dsn="string"

Alias	yellowbrick_dsn

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.

server="string"

specifies the host name for the Yellowbrick server.

sliceColumn="variable-name"

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

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

sslMode="string"

specifies the SSL mode for the connection to PostgreSQL

uid="string"

Aliases	user
Aliases	username

useNarrowCharacterTypes=TRUE | FALSE

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

Aliases	useNCT
Aliases	useNarrowCharTypes
Default	FALSE

Last updated: October 18, 2022