Common Parameter: dataSourceOptions

CASL Syntax

Parameters for ADLS_NOREQ

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

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

AliasauthDomain
bucket="string"

specifies the Google Cloud Storage bucket to write data files

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
defaultDir="string"

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

AliasdefaultDirectory
deleteDataFiles=TRUE | FALSE

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

DefaultTRUE
kmsKey="string"

specifies the path to a key file resource within a project

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
qualifier="string"

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

Aliastable_qualifier
readbuff=integer

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

Aliasesras
row_array_size
readMode="STANDARD" | "STORAGE"

specifies the read mode to use for loadTable

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

DefaultFALSE
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"
Aliasesuser
username

Parameters for CAS_NOREQ

password="string"
user="string"

Parameters for CLOUDDEX

authenticationDomain="string"

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

AliasauthDomain
casTypes="ALL" | "BASIC"

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

DefaultBASIC
ALL

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

BASIC

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
dataOnReaderNodesOnly=TRUE | FALSE
DefaultFALSE
dbmsWhere="where-expression"

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

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

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

domainCredsRequired=TRUE | FALSE
DefaultTRUE
metaCatalog="string"
metaSchema="string"
metaTable="string"
ncharMultiplier=double
Default3
Range1–5
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

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

specifies to sort the loaded table by orderby variable list

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

specifies to partition the loaded table

pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

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

Aliasesras
rowArraySize
schema="string"

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

splitColumn="string"
splitRange=double
Default0
traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

Aliasusername
useMetaTable=TRUE | FALSE
DefaultTRUE
useMinMaxToSplit=TRUE | FALSE
DefaultFALSE

Parameters for DB2

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
conopts="string"
invalidDate="string"

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

numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for DNFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for ESP

ouathtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port="string"

specifies the network port number that the server listens on.

server="string"

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

servicename="string"

specifies the Kerberos service name.

username="string"

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

Parameters for FEDSVR

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for GCS_NOREQ

bucket="string"
gcsAuthFile="string"

Parameters for GREENPLUM

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for HADOOP

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1
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.

Default"/tmp"
loginTimeout=integer

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

Default30
Minimum value0
ncharMultiplier=double

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

Default3
Range1–5
numReadNodes=integer

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

Default1
Range0–32767
platform="MAPRED" | "SPARK"

Specifies which hadoop platform to run on.

DefaultMAPRED
MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

specifies the name of the Hive schema.

scratchDB="string"

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

sliceColumn="variable-name"

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

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

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

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for HANA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for HDFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for IMPALA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for JDBC

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
dbmax_text=integer

specifies the maximum length for character data type columns.

Default32767
Minimum value1
login_timeout=integer

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

Minimum value0
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
query_timeout=integer

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

Minimum value0
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for MONGODB

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for MYSQL

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
basedir="string"
Aliasbase_dir
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

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

sliceColumn="variable-name"

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

sliceExpressions={"string-1" <, "string-2", ...>}
socket="string"
uid="string"
Aliasesuser
username

Parameters for NETEZZA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for ODBC

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
blobThreshold=integer
Minimum value0
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
dm_unicode="string"

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

invalidDate="string"

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

numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for ORACLE

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
ora_encoding="string"

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

pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for PATH

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for POSTGRES

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
blDelDatFile=TRUE | FALSE

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

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

bulkunload=TRUE | FALSE

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

DefaultFALSE
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for REDSHIFT

authenticationDomain="string"

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

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

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

AliasbulkloadOptions
bucket="string"

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

bulkunload=TRUE | FALSE

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

DefaultFALSE
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
compress=TRUE | FALSE

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

DefaultFALSE
conopts="string"
credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

defaultDir="string"

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

AliasdefaultDirectory
deleteDataFiles=TRUE | FALSE

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

DefaultTRUE
delimiter="string"

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

escape=TRUE | FALSE

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

DefaultFALSE
iamAssumeRoleARN="string"

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

iamAssumeRoleName="string"

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

iamRole="string"

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

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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
profile="string"

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

pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
region="string"

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

s3Config="string"

specifies an optional S3 configuration file

schema="string"

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

secret="string"

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

sliceColumn="variable-name"

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

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

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

uid="string"
Aliasesuser
username
useSSL=TRUE | FALSE

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

DefaultFALSE

Parameters for S3

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

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

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

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

sseTextKey="string"

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

Parameters for SFORCE

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

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

uid="string"
Aliasesuser
username

Parameters for SNOWFLAKE

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
scanStringColumns=TRUE | FALSE

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

DefaultFALSE
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"
Aliasesuser
username

Parameters for SPARK

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1
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.

Default"/tmp"
loginTimeout=integer

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

Default30
Minimum value0
ncharMultiplier=double

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

Default3
Range1–5
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

specifies the name of the Hive schema.

scratchDB="string"

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

sliceColumn="variable-name"

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

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

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

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for SPDE

alterPW="string"

specifies the password to use for Alter access.

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

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

masterPW="string"

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

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

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

Default3
Range1–5
numReadNodes=integer

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

Default0
Range0–32767
platform="MAPRED" | "SPARK"

Specifies which hadoop platform to run on.

DefaultMAPRED
MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

pwd="string"

specifies the password.

Aliasespassword
pass
readPW="string"

specifies the password to use for Read access.

statusInterval=integer

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

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

Aliasusername
writePW="string"

specifies the password to use for Write access.

Parameters for SQLSERVER

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
blobThreshold=integer
Minimum value0
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
invalidDate="string"

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

numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for SS_NOREQ

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

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

DefaultINHERIT
CASDISKCACHE

Load into CAS disk cache

INPLACEPREFERRED

Keep table in SingleStore

INHERIT

Inherit load behavior from caslib

* srcType="SS"

Parameters for TERADATA

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
conopts="string"

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

database="string"

specifies the Teradata database to connect to.

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

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

ncharMultiplier=double

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

Default3
Range1–5
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"

Unused

Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

Unused

sliceColumn="variable-name"

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

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

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

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for VERTICA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for YELLOWBRICK

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Lua Syntax

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | hdfs-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

Parameters for ADLS_NOREQ

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

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

AliasauthDomain
bucket="string"

specifies the Google Cloud Storage bucket to write data files

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
defaultDir="string"

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

AliasdefaultDirectory
deleteDataFiles=true | false

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

Defaulttrue
kmsKey="string"

specifies the path to a key file resource within a project

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
qualifier="string"

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

Aliastable_qualifier
readbuff=integer

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

Aliasesras
row_array_size
readMode="STANDARD" | "STORAGE"

specifies the read mode to use for loadTable

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

Defaultfalse
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"
Aliasesuser
username

Parameters for CAS_NOREQ

password="string"
user="string"

Parameters for CLOUDDEX

authenticationDomain="string"

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

AliasauthDomain
casTypes="ALL" | "BASIC"

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

DefaultBASIC
ALL

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

BASIC

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
dataOnReaderNodesOnly=true | false
Defaultfalse
dbmsWhere="where-expression"

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

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

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

domainCredsRequired=true | false
Defaulttrue
metaCatalog="string"
metaSchema="string"
metaTable="string"
ncharMultiplier=double
Default3
Range1–5
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

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

specifies to sort the loaded table by orderby variable list

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

specifies to partition the loaded table

pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

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

Aliasesras
rowArraySize
schema="string"

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

splitColumn="string"
splitRange=double
Default0
traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

Aliasusername
useMetaTable=true | false
Defaulttrue
useMinMaxToSplit=true | false
Defaultfalse

Parameters for DB2

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
conopts="string"
invalidDate="string"

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

numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for DNFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for ESP

ouathtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port="string"

specifies the network port number that the server listens on.

server="string"

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

servicename="string"

specifies the Kerberos service name.

username="string"

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

Parameters for FEDSVR

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for GCS_NOREQ

bucket="string"
gcsAuthFile="string"

Parameters for GREENPLUM

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for HADOOP

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1
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.

Default"/tmp"
loginTimeout=integer

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

Default30
Minimum value0
ncharMultiplier=double

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

Default3
Range1–5
numReadNodes=integer

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

Default1
Range0–32767
platform="MAPRED" | "SPARK"

Specifies which hadoop platform to run on.

DefaultMAPRED
MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

specifies the name of the Hive schema.

scratchDB="string"

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

sliceColumn="variable-name"

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

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

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

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for HANA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for HDFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for IMPALA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for JDBC

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
dbmax_text=integer

specifies the maximum length for character data type columns.

Default32767
Minimum value1
login_timeout=integer

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

Minimum value0
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
query_timeout=integer

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

Minimum value0
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for MONGODB

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for MYSQL

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
basedir="string"
Aliasbase_dir
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

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

sliceColumn="variable-name"

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

sliceExpressions={"string-1" <, "string-2", ...>}
socket="string"
uid="string"
Aliasesuser
username

Parameters for NETEZZA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for ODBC

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
blobThreshold=integer
Minimum value0
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
dm_unicode="string"

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

invalidDate="string"

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

numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for ORACLE

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
ora_encoding="string"

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

pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for PATH

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for POSTGRES

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
blDelDatFile=true | false

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

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

bulkunload=true | false

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

Defaultfalse
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for REDSHIFT

authenticationDomain="string"

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

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

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

AliasbulkloadOptions
bucket="string"

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

bulkunload=true | false

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

Defaultfalse
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
compress=true | false

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

Defaultfalse
conopts="string"
credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

defaultDir="string"

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

AliasdefaultDirectory
deleteDataFiles=true | false

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

Defaulttrue
delimiter="string"

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

escape=true | false

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

Defaultfalse
iamAssumeRoleARN="string"

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

iamAssumeRoleName="string"

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

iamRole="string"

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

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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
profile="string"

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

pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
region="string"

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

s3Config="string"

specifies an optional S3 configuration file

schema="string"

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

secret="string"

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

sliceColumn="variable-name"

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

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

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

uid="string"
Aliasesuser
username
useSSL=true | false

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

Defaultfalse

Parameters for S3

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

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

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

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

sseTextKey="string"

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

Parameters for SFORCE

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

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

uid="string"
Aliasesuser
username

Parameters for SNOWFLAKE

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
scanStringColumns=true | false

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

Defaultfalse
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"
Aliasesuser
username

Parameters for SPARK

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1
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.

Default"/tmp"
loginTimeout=integer

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

Default30
Minimum value0
ncharMultiplier=double

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

Default3
Range1–5
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

specifies the name of the Hive schema.

scratchDB="string"

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

sliceColumn="variable-name"

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

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

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

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for SPDE

alterPW="string"

specifies the password to use for Alter access.

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

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

masterPW="string"

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

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

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

Default3
Range1–5
numReadNodes=integer

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

Default0
Range0–32767
platform="MAPRED" | "SPARK"

Specifies which hadoop platform to run on.

DefaultMAPRED
MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

pwd="string"

specifies the password.

Aliasespassword
pass
readPW="string"

specifies the password to use for Read access.

statusInterval=integer

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

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

Aliasusername
writePW="string"

specifies the password to use for Write access.

Parameters for SQLSERVER

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
blobThreshold=integer
Minimum value0
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
invalidDate="string"

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

numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for SS_NOREQ

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

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

DefaultINHERIT
CASDISKCACHE

Load into CAS disk cache

INPLACEPREFERRED

Keep table in SingleStore

INHERIT

Inherit load behavior from caslib

* srcType="SS"

Parameters for TERADATA

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
conopts="string"

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

database="string"

specifies the Teradata database to connect to.

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

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

ncharMultiplier=double

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

Default3
Range1–5
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"

Unused

Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

Unused

sliceColumn="variable-name"

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

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

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

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for VERTICA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for YELLOWBRICK

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Python Syntax

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | hdfs-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

Parameters for ADLS_NOREQ

"accountName":"string"

Azure storage account name

"applicationId":"string"

Application ID for Azure storage

"dnsSuffix":"string"

DNS Suffix for Azure storage

"filesystem":"string"

Azure storage file system

"timeout":integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

Parameters for BIGQUERY

"authenticationDomain":"string"

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

AliasauthDomain
"bucket":"string"

specifies the Google Cloud Storage bucket to write data files

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"defaultDir":"string"

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

AliasdefaultDirectory
"deleteDataFiles":True | False

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

DefaultTrue
"kmsKey":"string"

specifies the path to a key file resource within a project

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"qualifier":"string"

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

Aliastable_qualifier
"readbuff":integer

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

Aliasesras
row_array_size
"readMode":"STANDARD" | "STORAGE"

specifies the read mode to use for loadTable

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

DefaultFalse
"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"
Aliasesuser
username

Parameters for CAS_NOREQ

"password":"string"
"user":"string"

Parameters for CLOUDDEX

"authenticationDomain":"string"

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

AliasauthDomain
"casTypes":"ALL" | "BASIC"

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

DefaultBASIC
ALL

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

BASIC

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

"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"dataOnReaderNodesOnly":True | False
DefaultFalse
"dbmsWhere":"where-expression"

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

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

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

"domainCredsRequired":True | False
DefaultTrue
"metaCatalog":"string"
"metaSchema":"string"
"metaTable":"string"
"ncharMultiplier":double
Default3
Range1–5
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

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

specifies to sort the loaded table by orderby variable list

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

specifies to partition the loaded table

"pwd":"string"

specifies the password.

Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
rowArraySize
"schema":"string"

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

"splitColumn":"string"
"splitRange":double
Default0
"traceFile":"string"

specifies a name for the trace file.

"traceFlags":"string"

specifies flags to use for tracing the database connection.

"uid":"string"

specifies the user name.

Aliasusername
"useMetaTable":True | False
DefaultTrue
"useMinMaxToSplit":True | False
DefaultFalse

Parameters for DB2

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"
"conopts":"string"
"invalidDate":"string"

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

"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for DNFS

"encryptionDomain":"string"

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

"encryptionPassword":"string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for ESP

"ouathtoken":"string"

specifies the OAuth authentication token.

"password":"string"

specifies the password.

"port":"string"

specifies the network port number that the server listens on.

"server":"string"

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

"servicename":"string"

specifies the Kerberos service name.

"username":"string"

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

Parameters for FEDSVR

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for GCS_NOREQ

"bucket":"string"
"gcsAuthFile":"string"

Parameters for GREENPLUM

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for HADOOP

"authenticationDomain":"string"

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

AliasauthDomain
"bufferSize":64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

"dbmaxText":integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1
"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.

Default"/tmp"
"loginTimeout":integer

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

Default30
Minimum value0
"ncharMultiplier":double

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

Default3
Range1–5
"numReadNodes":integer

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

Default1
Range0–32767
"platform":"MAPRED" | "SPARK"

Specifies which hadoop platform to run on.

DefaultMAPRED
MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

"pwd":"string"

specifies the password.

Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
row_array_size
"schema":"string"

specifies the name of the Hive schema.

"scratchDB":"string"

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

"sliceColumn":"variable-name"

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

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

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

Default0
"uid":"string"

specifies the user name.

Aliasusername

Parameters for HANA

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for HDFS

"encryptionDomain":"string"

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

"encryptionPassword":"string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for IMPALA

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"

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

"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for JDBC

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"dbmax_text":integer

specifies the maximum length for character data type columns.

Default32767
Minimum value1
"login_timeout":integer

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

Minimum value0
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"query_timeout":integer

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

Minimum value0
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for MONGODB

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"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.

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for MYSQL

"authenticationDomain":"string"

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

AliasauthDomain
"authenticationScope":"string"

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

AliasauthScope
"basedir":"string"
Aliasbase_dir
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
row_array_size
"schema":"string"

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

"sliceColumn":"variable-name"

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

"sliceExpressions":["string-1" <, "string-2", ...>]
"socket":"string"
"uid":"string"
Aliasesuser
username

Parameters for NETEZZA

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"
"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for ODBC

"authenticationDomain":"string"

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

AliasauthDomain
"authenticationScope":"string"

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

AliasauthScope
"blobThreshold":integer
Minimum value0
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"

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

"conopts":"string"
"dm_unicode":"string"

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

"invalidDate":"string"

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

"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for ORACLE

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"ora_encoding":"string"

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

"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for PATH

"encryptionDomain":"string"

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

"encryptionPassword":"string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for POSTGRES

"authenticationDomain":"string"

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

AliasauthDomain
"authenticationScope":"string"

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

AliasauthScope
"blDelDatFile":True | False

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

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

"bulkunload":True | False

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

DefaultFalse
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"

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

"conopts":"string"
"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.

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for REDSHIFT

"authenticationDomain":"string"

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

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

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

AliasbulkloadOptions
"bucket":"string"

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

"bulkunload":True | False

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

DefaultFalse
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"
"compress":True | False

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

DefaultFalse
"conopts":"string"
"credentialsFile":"string"

specifies the AWS credentials file to use.

"credentialsProfile":"string"

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

"defaultDir":"string"

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

AliasdefaultDirectory
"deleteDataFiles":True | False

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

DefaultTrue
"delimiter":"string"

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

"escape":True | False

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

DefaultFalse
"iamAssumeRoleARN":"string"

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

"iamAssumeRoleName":"string"

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

"iamRole":"string"

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

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"profile":"string"

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

"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
row_array_size
"region":"string"

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

"s3Config":"string"

specifies an optional S3 configuration file

"schema":"string"

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

"secret":"string"

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

"sliceColumn":"variable-name"

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

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

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

"uid":"string"
Aliasesuser
username
"useSSL":True | False

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

DefaultFalse

Parameters for S3

"encryptionDomain":"string"

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

"encryptionPassword":"string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

"kmsContext":"string"

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

"kmsKeyId":"string"

specifies the AWS Key Management Services ID.

"sseHexKey":"string"

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

"sseTextKey":"string"

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

Parameters for SFORCE

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
row_array_size
"schema":"string"

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

"uid":"string"
Aliasesuser
username

Parameters for SNOWFLAKE

"authenticationDomain":"string"

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

AliasauthDomain
"authenticationScope":"string"

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

AliasauthScope
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"

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

"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
row_array_size
"scanStringColumns":True | False

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

DefaultFalse
"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"
Aliasesuser
username

Parameters for SPARK

"authenticationDomain":"string"

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

AliasauthDomain
"bufferSize":64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

"dbmaxText":integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1
"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.

Default"/tmp"
"loginTimeout":integer

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

Default30
Minimum value0
"ncharMultiplier":double

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

Default3
Range1–5
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"

specifies the password.

Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
row_array_size
"schema":"string"

specifies the name of the Hive schema.

"scratchDB":"string"

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

"sliceColumn":"variable-name"

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

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

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

Default0
"uid":"string"

specifies the user name.

Aliasusername

Parameters for SPDE

"alterPW":"string"

specifies the password to use for Alter access.

"authenticationDomain":"string"

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

AliasauthDomain
"bufferSize":64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

"encryptionPassword":"string"

specifies the passphrase used for an AES encrypted data set.

"hdfsTempDir":"string"

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

"masterPW":"string"

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

"mdfpath":"string"

specifies the path where SPDE MDF are located.

"ncharMultiplier":double

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

Default3
Range1–5
"numReadNodes":integer

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

Default0
Range0–32767
"platform":"MAPRED" | "SPARK"

Specifies which hadoop platform to run on.

DefaultMAPRED
MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

"pwd":"string"

specifies the password.

Aliasespassword
pass_
"readPW":"string"

specifies the password to use for Read access.

"statusInterval":integer

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

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

Aliasusername
"writePW":"string"

specifies the password to use for Write access.

Parameters for SQLSERVER

"authenticationDomain":"string"

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

AliasauthDomain
"authenticationScope":"string"

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

AliasauthScope
"blobThreshold":integer
Minimum value0
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"

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

"conopts":"string"
"invalidDate":"string"

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

"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for SS_NOREQ

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

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

DefaultINHERIT
CASDISKCACHE

Load into CAS disk cache

INPLACEPREFERRED

Keep table in SingleStore

INHERIT

Inherit load behavior from caslib

* "srcType":"SS"

Parameters for TERADATA

"authenticationDomain":"string"

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

AliasauthDomain
"bufferSize":64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
"conopts":"string"

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

"database":"string"

specifies the Teradata database to connect to.

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

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

"ncharMultiplier":double

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

Default3
Range1–5
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"

Unused

Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
row_array_size
"schema":"string"

Unused

"sliceColumn":"variable-name"

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

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

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

Default0
"uid":"string"

specifies the user name.

Aliasusername

Parameters for VERTICA

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"

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

"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for YELLOWBRICK

"authenticationDomain":"string"

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

AliasauthDomain
"catalog":"string"

specifies the database catalog name.

"charMultiplier":double

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

Default1
Range1–5
"client_encoding":"string"

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

"conopts":"string"
"numReadBuffers":integer

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

Default4
Range1–10
"numReadNodes":integer

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

Default1
Range0–32767
"pwd":"string"
Aliasespassword
pass_
"readbuff":integer

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

Aliasesras
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"
Aliasesuser
username

R Syntax

dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | hdfs-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)

Parameters for ADLS_NOREQ

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

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

AliasauthDomain
bucket="string"

specifies the Google Cloud Storage bucket to write data files

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
defaultDir="string"

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

AliasdefaultDirectory
deleteDataFiles=TRUE | FALSE

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

DefaultTRUE
kmsKey="string"

specifies the path to a key file resource within a project

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
qualifier="string"

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

Aliastable_qualifier
readbuff=integer

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

Aliasesras
row_array_size
readMode="STANDARD" | "STORAGE"

specifies the read mode to use for loadTable

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

DefaultFALSE
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"
Aliasesuser
username

Parameters for CAS_NOREQ

password="string"
user="string"

Parameters for CLOUDDEX

authenticationDomain="string"

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

AliasauthDomain
casTypes="ALL" | "BASIC"

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

DefaultBASIC
ALL

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

BASIC

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
dataOnReaderNodesOnly=TRUE | FALSE
DefaultFALSE
dbmsWhere="where-expression"

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

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

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

domainCredsRequired=TRUE | FALSE
DefaultTRUE
metaCatalog="string"
metaSchema="string"
metaTable="string"
ncharMultiplier=double
Default3
Range1–5
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

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

specifies to sort the loaded table by orderby variable list

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

specifies to partition the loaded table

pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

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

Aliasesras
rowArraySize
schema="string"

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

splitColumn="string"
splitRange=double
Default0
traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

Aliasusername
useMetaTable=TRUE | FALSE
DefaultTRUE
useMinMaxToSplit=TRUE | FALSE
DefaultFALSE

Parameters for DB2

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
conopts="string"
invalidDate="string"

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

numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for DNFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for ESP

ouathtoken="string"

specifies the OAuth authentication token.

password="string"

specifies the password.

port="string"

specifies the network port number that the server listens on.

server="string"

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

servicename="string"

specifies the Kerberos service name.

username="string"

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

Parameters for FEDSVR

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for GCS_NOREQ

bucket="string"
gcsAuthFile="string"

Parameters for GREENPLUM

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for HADOOP

authenticationDomain="string"

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

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

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

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1
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.

Default"/tmp"
loginTimeout=integer

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

Default30
Minimum value0
ncharMultiplier=double

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

Default3
Range1–5
numReadNodes=integer

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

Default1
Range0–32767
platform="MAPRED" | "SPARK"

Specifies which hadoop platform to run on.

DefaultMAPRED
MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

specifies the name of the Hive schema.

scratchDB="string"

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

sliceColumn="variable-name"

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

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

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

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for HANA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for HDFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for IMPALA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for JDBC

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
dbmax_text=integer

specifies the maximum length for character data type columns.

Default32767
Minimum value1
login_timeout=integer

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

Minimum value0
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
query_timeout=integer

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

Minimum value0
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for MONGODB

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for MYSQL

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
basedir="string"
Aliasbase_dir
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
schema="string"

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

sliceColumn="variable-name"

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

sliceExpressions=list("string-1" <, "string-2", ...>)
socket="string"
uid="string"
Aliasesuser
username

Parameters for NETEZZA

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for ODBC

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
blobThreshold=integer
Minimum value0
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
dm_unicode="string"

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

invalidDate="string"

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

numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for ORACLE

authenticationDomain="string"

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

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
conopts="string"
numReadBuffers=integer

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

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
ora_encoding="string"

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

pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for PATH

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for POSTGRES

authenticationDomain="string"

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

AliasauthDomain
authenticationScope="string"

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

AliasauthScope
blDelDatFile=TRUE | FALSE

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

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

bulkunload=TRUE | FALSE

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

DefaultFALSE
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"

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

conopts="string"
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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
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"
Aliasesuser
username

Parameters for REDSHIFT

authenticationDomain="string"

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

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

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

AliasbulkloadOptions
bucket="string"

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

bulkunload=TRUE | FALSE

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

DefaultFALSE
catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5
client_encoding="string"
compress=TRUE | FALSE

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

DefaultFALSE
conopts="string"
credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

defaultDir="string"

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

AliasdefaultDirectory
deleteDataFiles=TRUE | FALSE

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

DefaultTRUE
delimiter="string"

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

escape=TRUE | FALSE

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

DefaultFALSE
iamAssumeRoleARN="string"

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

iamAssumeRoleName="string"

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

iamRole="string"

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

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.

Default4
Range1–10
numReadNodes=integer

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

Default1
Range0–32767
profile="string"

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

pwd="string"
Aliasespassword
pass
readbuff=integer

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

Aliasesras
row_array_size
region="string"

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

s3Config="string"

specifies an optional S3 configuration file

schema="string"

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

secret="string"

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

sliceColumn="variable-name"

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

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

specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"
Aliasesuser
username
useSSL=TRUE | FALSE

when set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFALSE

Parameters for S3

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

specifies the AWS Key Management Services encryption context for the cryptographic operation.

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

specifies an encryption key in the form of a 64-digit hexadecimal value.

sseTextKey="string"

specifies a plain-text version of the key to use with server-side encryption.

Parameters for SFORCE

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5
conopts="string"
numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default4
Range1–10
pwd="string"
Aliasespassword
pass
readbuff=integer

specifies the number of rows to read in one read block.

Aliasesras
row_array_size
schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"
Aliasesuser
username

Parameters for SNOWFLAKE

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain
authenticationScope="string"

specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope
catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5
client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"
numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default4
Range1–10
numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

specifies the number of rows to read in one read block.

Aliasesras
row_array_size
scanStringColumns=TRUE | FALSE

when set to TRUE, the data connector issues a query to scan all VARCHAR columns for their max length.

DefaultFALSE
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"
Aliasesuser
username

Parameters for SPARK

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the database and SAS Cloud Analytic Services.

AUTO

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

specifies to perform a serial load.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1
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.

Default"/tmp"
loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0
ncharMultiplier=double

specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5
numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default1
Range0–32767
pwd="string"

specifies the password.

Aliasespassword
pass
readbuff=integer

specifies the number of rows to read in one read block.

Aliasesras
row_array_size
schema="string"

specifies the name of the Hive schema.

scratchDB="string"

specifies the Hive Schema/Database to use when creating temporary tables and views.

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)
statusInterval=integer

specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for SPDE

alterPW="string"

specifies the password to use for Alter access.

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the database and SAS Cloud Analytic Services.

AUTO

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

specifies to perform a serial load.

encrypt="AES" | "NO" | "YES"

specifies the type of encryption to be used on created SPDE tables.

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

specifies the Hadoop HDFS directory to use to store temporary data.

masterPW="string"

specifies the master password to use for Read/Write/Alter access.

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5
numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default0
Range0–32767
platform="MAPRED" | "SPARK"

Specifies which hadoop platform to run on.

DefaultMAPRED
MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

pwd="string"

specifies the password.

Aliasespassword
pass
readPW="string"

specifies the password to use for Read access.

statusInterval=integer

specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0
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.

Aliasusername
writePW="string"

specifies the password to use for Write access.

Parameters for SQLSERVER

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain
authenticationScope="string"

specifies the scope to acquire a token for authorizing requests to the database

AliasauthScope
blobThreshold=integer
Minimum value0
catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5
client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"
invalidDate="string"

specifies the behavior when the data connector reads date values that are outside the valid SAS date range.

numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default4
Range1–10
numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

specifies the number of rows to read in one read block.

Aliasesras
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"
Aliasesuser
username

Parameters for SS_NOREQ

backingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

'INPLACEPREFERRED' to keep table in SingleStore, 'CASDISKCACHE' to load into CAS, 'INHERIT' to get from caslib

DefaultINHERIT
CASDISKCACHE

Load into CAS disk cache

INPLACEPREFERRED

Keep table in SingleStore

INHERIT

Inherit load behavior from caslib

* srcType="SS"

Parameters for TERADATA

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain
bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0
TIPYou 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

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5
conopts="string"

specifies connection options to use for connecting to the Teradata database.

database="string"

specifies the Teradata database to connect to.

Aliasdb
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the database and SAS Cloud Analytic Services.

AUTO

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

specifies to perform a serial load.

ncharMultiplier=double

specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5
numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default4
Range1–10
numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default1
Range0–32767
pwd="string"

Unused

Aliasespassword
pass
readbuff=integer

specifies the number of rows to read in one read block.

Aliasesras
row_array_size
schema="string"

Unused

sliceColumn="variable-name"

specifies the column to use for slicing the result set when using numReadNodes.

sliceExpressions=list("string-1" <, "string-2", ...>)
statusInterval=integer

specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0
uid="string"

specifies the user name.

Aliasusername

Parameters for VERTICA

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5
client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"
numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default4
Range1–10
numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

specifies the number of rows to read in one read block.

Aliasesras
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"
Aliasesuser
username

Parameters for YELLOWBRICK

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

AliasauthDomain
catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5
client_encoding="string"

specifies the client encoding type to use when connecting to the data source.

conopts="string"
numReadBuffers=integer

specifies the number of read buffers to use for the pipeline read.

Default4
Range1–10
numReadNodes=integer

specifies the number of grid nodes that will connect to and read data from the DBMS during a LoadTable action.

Default1
Range0–32767
pwd="string"
Aliasespassword
pass
readbuff=integer

specifies the number of rows to read in one read block.

Aliasesras
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"
Aliasesuser
username
Last updated: January 5, 2022