Table Action Set: Syntax

Provides actions for accessing and managing data

save Action

Saves a table to a caslib's data source.

See:Saving Tables and Exporting Data
Save a Table
Save a SAS7BDAT File in a Caslib

CASL Syntax

table.save <result=results> <status=rc> /
caslib="string",
compress=TRUE | FALSE,
copies=integer,
dataSourceOptions={adls-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vednfs-parameters | vepath-parameters | vertica-parameters | ves3-parameters | yellowbrick-parameters},
exportOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DTA" | "EXCEL" | "JMP" | "ORC" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter name="string",
permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer,
replace=TRUE | FALSE,
saveAttrs=TRUE | FALSE,
required parameter table={
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
computedVarsProgram="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
onDemand=TRUE | FALSE,
orderBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=TRUE | FALSE,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression",
whereTable={
casLib="string"
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
viewAsTable=TRUE | FALSE
;
indicates a required parameter

Summary: Input Tables

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

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

—

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

Parameter Descriptions

caslib="string"

specifies the target caslib for the table.

compress=TRUE | FALSE

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

DefaultFALSE

copies=integer

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

Minimum value-1

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

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

Aliasexport

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

* name="string"

specifies the table name.

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

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

replace=TRUE | FALSE

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

DefaultFALSE

saveAttrs=TRUE | FALSE

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

DefaultFALSE

* table={castable}

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

For more information about specifying the table parameter, see the common castable parameter.

viewAsTable=TRUE | FALSE

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

DefaultFALSE

Parameters for ADLS

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

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

bulkload=TRUE | FALSE

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

DefaultFALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

defaultDir="string"

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

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.

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

qualifier="string"

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

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for CLOUDDEX

append=TRUE | FALSE

DefaultFALSE

authenticationDomain="string"

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

casTypes="ALL" | "BASIC"

ALL

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

BASIC

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

catalog="string"

specifies the database catalog name.

charCreateMultiplier=double

Default1
Range1–5

charMultiplier=double

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

Default1
Range1–5

dbCreateTableOpts="string"

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

domainCredsRequired=TRUE | FALSE

DefaultTRUE

dropTableOnFailedSave=TRUE | FALSE

DefaultTRUE

insertbuff=integer

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

ncharCreateMultiplier=double

Default1
Range1–5

ncharMultiplier=double

Default3
Range1–5

numWriteNodes=integer

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

Default1

pwd="string"

specifies the password.

schema="string"

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

traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

useMaxCharLen=TRUE | FALSE

DefaultFALSE

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for DB2

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for HADOOP

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

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

Default1
Range1–5

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

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

Default32767
Minimum value1

hdfsDatadir="string"

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

hdfsMetadir="string"

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

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

insertbuff=integer

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

loginTimeout=integer

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

Default30
Minimum value0

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

platform="MAPRED" | "SPARK"

MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

postTableOpts="string"

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

preTableOpts="string"

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

pwd="string"

specifies the password.

readbuff=integer

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

Aliasras row_array_size

schema="string"

specifies the name of the Hive schema.

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.

Parameters for HANA

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

specifies connection options to use for connecting to the database.

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

insertbuff=integer

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

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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"

Parameters for IMPALA

authenticationDomain="string"

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

bulkload=TRUE | FALSE

DefaultFALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for JDBC

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

login_timeout=integer

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

AliasloginTimeout
Minimum value0

pwd="string"

query_timeout=integer

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

AliasqueryTimeout
Minimum value0

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for MONGODB

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for MYSQL

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for ODBC

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for ORACLE

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for POSTGRES

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for REDSHIFT

authenticationDomain="string"

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

awsConfig="string"

specifies the AWS configuration file if different from the default.

blOptions="string"

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

bucket="string"

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

bulkload=TRUE | FALSE

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

DefaultFALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

compress=TRUE | FALSE

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

DefaultFALSE

conopts="string"

credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

dbCreateTableOpts="string"

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

defaultDir="string"

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

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

insertbuff=integer

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

key="string"

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

numWriteNodes=integer

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

Default1
Range0–32767

profile="string"

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

pwd="string"

region="string"

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

s3Config="string"

specifies an optional S3 configuration file

schema="string"

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

secret="string"

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

token="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

useSSL=TRUE | FALSE

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

DefaultFALSE

Parameters for SFORCE

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for SNOWFLAKE

authenticationDomain="string"

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

awsConfig="string"

specifies the AWS configuration file if different from the default.

blOptions="string"

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

bucket="string"

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

bulkload=TRUE | FALSE

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

DefaultFALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

compress=TRUE | FALSE

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

DefaultFALSE

conopts="string"

credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

dbCreateTableOpts="string"

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

defaultDir="string"

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

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

insertbuff=integer

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

key="string"

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

numWriteNodes=integer

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

Default1
Range0–32767

profile="string"

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

pwd="string"

region="string"

specifies the Amazon Web Services region that the Snowflake 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.

stage="string"

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

token="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

useSSL=TRUE | FALSE

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

DefaultFALSE

Parameters for SPARK

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

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

Default1
Range1–5

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

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

Default1024
Minimum value1

hdfsDatadir="string"

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

hdfsMetadir="string"

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

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

insertbuff=integer

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

loginTimeout=integer

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

Default30
Minimum value0

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

postTableOpts="string"

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

preTableOpts="string"

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

pwd="string"

specifies the password.

readbuff=integer

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

Aliasras row_array_size

schema="string"

specifies the name of the Hive schema.

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.

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.

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

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

Default1
Range1–5

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

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

datapath="string"

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

dbCreateTableOpts="string"

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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

label="string"

specifies a label to apply to the output data set.

masterPW="string"

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

maxSaveThreads=integer

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

Default0
Minimum value0

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

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

Default3
Range1–5

numWriteBuffers=integer

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

Default10
Range1–100

padCompress=integer

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

partSize=64-bit-integer

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

Minimum value16

platform="MAPRED" | "SPARK"

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.

readPW="string"

specifies the password to use for Read access.

statusInterval=integer

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

Default0

uid="string"

specifies the user name.

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.

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for TERADATA

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

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

Default1
Range1–5

conopts="string"

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

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

specifies a Teradata Max Text Size value in chars.

Default32000
Range1–32000

insertbuff=integer

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

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

specifies the password.

schema="string"

Unused

statusInterval=integer

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

Default0

uid="string"

specifies the user name.

Parameters for VEDNFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEPATH

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VERTICA

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for VES3

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

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

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

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

sseTextKey="string"

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

Parameters for YELLOWBRICK

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO

Parameters for fileType="BASESAS"

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

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

DefaultNO
encoding="string"

specifies file encoding

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

specifies whether to encrypt an output SAS data set

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

specifies a password for encrypting or decrypting stored data.

password="string"

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

pointobs=TRUE | FALSE

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

DefaultTRUE
read="string"

specifies the Read password for the SAS data set.

reuse=TRUE | FALSE

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

DefaultFALSE

Parameters for fileType="CSV" | "DELIMITED"

addbom=TRUE | FALSE

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

DefaultFALSE

Parameters for fileType="DTA"

No parameters apply when you specify DTA

Parameters for fileType="EXCEL"

range="string"

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

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="JMP"

No parameters apply when you specify JMP

Parameters for fileType="ORC"

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

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

DefaultZLIB

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS

Parameters for fileType="XLS"

range="string"

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

sheet="string"

specifies the name of the worksheet to import.

save Action

Saves a table to a caslib's data source.

See:Saving Tables and Exporting Data
Save a Table
Save a SAS7BDAT File in a Caslib

Lua Syntax

results, info = s:table_save{
caslib="string",
compress=true | false,
copies=integer,
dataSourceOptions={adls-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vednfs-parameters | vepath-parameters | vertica-parameters | ves3-parameters | yellowbrick-parameters},
exportOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DTA" | "EXCEL" | "JMP" | "ORC" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter name="string",
permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer,
replace=true | false,
saveAttrs=true | false,
required parameter table={
caslib="string",
computedOnDemand=true | false,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
computedVarsProgram="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
onDemand=true | false,
orderBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=true | false,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression",
whereTable={
casLib="string"
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
viewAsTable=true | false
}
indicates a required parameter

Summary: Input Tables

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

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

—

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

Parameter Descriptions

caslib="string"

specifies the target caslib for the table.

compress=true | false

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

Defaultfalse

copies=integer

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

Minimum value-1

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

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

Aliasexport

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

* name="string"

specifies the table name.

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

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

replace=true | false

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

Defaultfalse

saveAttrs=true | false

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

Defaultfalse

* table={castable}

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

For more information about specifying the table parameter, see the common castable parameter.

viewAsTable=true | false

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

Defaultfalse

Parameters for ADLS

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

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

bulkload=true | false

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

Defaultfalse

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

defaultDir="string"

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

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.

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

qualifier="string"

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

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for CLOUDDEX

append=true | false

Defaultfalse

authenticationDomain="string"

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

casTypes="ALL" | "BASIC"

ALL

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

BASIC

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

catalog="string"

specifies the database catalog name.

charCreateMultiplier=double

Default1
Range1–5

charMultiplier=double

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

Default1
Range1–5

dbCreateTableOpts="string"

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

domainCredsRequired=true | false

DefaultTRUE

dropTableOnFailedSave=true | false

DefaultTRUE

insertbuff=integer

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

ncharCreateMultiplier=double

Default1
Range1–5

ncharMultiplier=double

Default3
Range1–5

numWriteNodes=integer

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

Default1

pwd="string"

specifies the password.

schema="string"

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

traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

useMaxCharLen=true | false

Defaultfalse

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for DB2

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for HADOOP

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=true | false

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

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

Default1
Range1–5

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

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

Default32767
Minimum value1

hdfsDatadir="string"

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

hdfsMetadir="string"

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

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

insertbuff=integer

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

loginTimeout=integer

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

Default30
Minimum value0

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

platform="MAPRED" | "SPARK"

MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

postTableOpts="string"

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

preTableOpts="string"

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

pwd="string"

specifies the password.

readbuff=integer

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

Aliasras row_array_size

schema="string"

specifies the name of the Hive schema.

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.

Parameters for HANA

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

specifies connection options to use for connecting to the database.

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

insertbuff=integer

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

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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"

Parameters for IMPALA

authenticationDomain="string"

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

bulkload=true | false

Defaultfalse

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for JDBC

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

login_timeout=integer

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

AliasloginTimeout
Minimum value0

pwd="string"

query_timeout=integer

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

AliasqueryTimeout
Minimum value0

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for MONGODB

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for MYSQL

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for ODBC

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for ORACLE

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for POSTGRES

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for REDSHIFT

authenticationDomain="string"

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

awsConfig="string"

specifies the AWS configuration file if different from the default.

blOptions="string"

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

bucket="string"

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

bulkload=true | false

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

Defaultfalse

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

compress=true | false

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

Defaultfalse

conopts="string"

credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

dbCreateTableOpts="string"

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

defaultDir="string"

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

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

insertbuff=integer

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

key="string"

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

numWriteNodes=integer

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

Default1
Range0–32767

profile="string"

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

pwd="string"

region="string"

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

s3Config="string"

specifies an optional S3 configuration file

schema="string"

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

secret="string"

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

token="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

useSSL=true | false

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

Defaultfalse

Parameters for SFORCE

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for SNOWFLAKE

authenticationDomain="string"

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

awsConfig="string"

specifies the AWS configuration file if different from the default.

blOptions="string"

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

bucket="string"

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

bulkload=true | false

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

Defaultfalse

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

compress=true | false

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

Defaultfalse

conopts="string"

credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

dbCreateTableOpts="string"

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

defaultDir="string"

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

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

insertbuff=integer

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

key="string"

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

numWriteNodes=integer

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

Default1
Range0–32767

profile="string"

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

pwd="string"

region="string"

specifies the Amazon Web Services region that the Snowflake 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.

stage="string"

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

token="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

useSSL=true | false

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

Defaultfalse

Parameters for SPARK

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=true | false

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

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

Default1
Range1–5

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

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

Default1024
Minimum value1

hdfsDatadir="string"

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

hdfsMetadir="string"

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

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

insertbuff=integer

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

loginTimeout=integer

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

Default30
Minimum value0

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

postTableOpts="string"

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

preTableOpts="string"

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

pwd="string"

specifies the password.

readbuff=integer

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

Aliasras row_array_size

schema="string"

specifies the name of the Hive schema.

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.

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.

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

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

Default1
Range1–5

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

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

datapath="string"

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

dbCreateTableOpts="string"

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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

label="string"

specifies a label to apply to the output data set.

masterPW="string"

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

maxSaveThreads=integer

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

Default0
Minimum value0

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

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

Default3
Range1–5

numWriteBuffers=integer

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

Default10
Range1–100

padCompress=integer

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

partSize=64-bit-integer

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

Minimum value16

platform="MAPRED" | "SPARK"

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.

readPW="string"

specifies the password to use for Read access.

statusInterval=integer

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

Default0

uid="string"

specifies the user name.

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.

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for TERADATA

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

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

Default1
Range1–5

conopts="string"

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

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

specifies a Teradata Max Text Size value in chars.

Default32000
Range1–32000

insertbuff=integer

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

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

specifies the password.

schema="string"

Unused

statusInterval=integer

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

Default0

uid="string"

specifies the user name.

Parameters for VEDNFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEPATH

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VERTICA

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for VES3

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

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

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

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

sseTextKey="string"

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

Parameters for YELLOWBRICK

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=true | false

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

AliasuseNCT useNarrowCharTypes
Defaultfalse

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO

Parameters for fileType="BASESAS"

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

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

DefaultNO
encoding="string"

specifies file encoding

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

specifies whether to encrypt an output SAS data set

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

specifies a password for encrypting or decrypting stored data.

password="string"

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

pointobs=true | false

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

Defaulttrue
read="string"

specifies the Read password for the SAS data set.

reuse=true | false

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

Defaultfalse

Parameters for fileType="CSV" | "DELIMITED"

addbom=true | false

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

Defaultfalse

Parameters for fileType="DTA"

No parameters apply when you specify DTA

Parameters for fileType="EXCEL"

range="string"

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

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="JMP"

No parameters apply when you specify JMP

Parameters for fileType="ORC"

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

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

DefaultZLIB

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS

Parameters for fileType="XLS"

range="string"

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

sheet="string"

specifies the name of the worksheet to import.

save Action

Saves a table to a caslib's data source.

See:Saving Tables and Exporting Data
Save a Table
Save a SAS7BDAT File in a Caslib

Python Syntax

results= s.table.save(
caslib="string",
compress=True | False,
copies=integer,
dataSourceOptions={adls-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vednfs-parameters | vepath-parameters | vertica-parameters | ves3-parameters | yellowbrick-parameters},
exportOptions={"fileType":"AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DTA" | "EXCEL" | "JMP" | "ORC" | "SPSS" | "XLS", fileType-specific-parameters},
required parameter name="string",
permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer,
replace=True | False,
saveAttrs=True | False,
required parameter table={
"caslib":"string",
"computedOnDemand":True | False,
"computedVars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"computedVarsProgram":"string",
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},
"groupBy":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"groupByMode":"NOSORT" | "REDISTRIBUTE",
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter "name":"table-name",
"onDemand":True | False,
"orderBy":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"singlePass":True | False,
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"where":"where-expression",
"whereTable":{
"casLib":"string"
"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter "name":"table-name"
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>]
"where":"where-expression"
}
},
viewAsTable=True | False
)
indicates a required parameter

Summary: Input Tables

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

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

—

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

Parameter Descriptions

caslib="string"

specifies the target caslib for the table.

compress=True | False

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

DefaultFalse

copies=integer

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

Minimum value-1

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

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

Aliasexport

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

* name="string"

specifies the table name.

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

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

replace=True | False

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

DefaultFalse

saveAttrs=True | False

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

DefaultFalse

* table={castable}

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

For more information about specifying the table parameter, see the common castable parameter.

viewAsTable=True | False

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

DefaultFalse

Parameters for ADLS

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

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

bulkload=True | False

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

DefaultFalse

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

defaultDir="string"

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

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.

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

qualifier="string"

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

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for CLOUDDEX

append=True | False

DefaultFalse

authenticationDomain="string"

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

casTypes="ALL" | "BASIC"

ALL

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

BASIC

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

catalog="string"

specifies the database catalog name.

charCreateMultiplier=double

Default1
Range1–5

charMultiplier=double

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

Default1
Range1–5

dbCreateTableOpts="string"

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

domainCredsRequired=True | False

DefaultTRUE

dropTableOnFailedSave=True | False

DefaultTRUE

insertbuff=integer

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

ncharCreateMultiplier=double

Default1
Range1–5

ncharMultiplier=double

Default3
Range1–5

numWriteNodes=integer

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

Default1

pwd="string"

specifies the password.

schema="string"

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

traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

useMaxCharLen=True | False

DefaultFalse

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for DB2

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for HADOOP

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=True | False

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

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

Default1
Range1–5

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

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

Default32767
Minimum value1

hdfsDatadir="string"

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

hdfsMetadir="string"

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

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

insertbuff=integer

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

loginTimeout=integer

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

Default30
Minimum value0

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

platform="MAPRED" | "SPARK"

MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

postTableOpts="string"

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

preTableOpts="string"

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

pwd="string"

specifies the password.

readbuff=integer

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

Aliasras row_array_size

schema="string"

specifies the name of the Hive schema.

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.

Parameters for HANA

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

specifies connection options to use for connecting to the database.

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

insertbuff=integer

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

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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"

Parameters for IMPALA

authenticationDomain="string"

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

bulkload=True | False

DefaultFalse

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for JDBC

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

login_timeout=integer

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

AliasloginTimeout
Minimum value0

pwd="string"

query_timeout=integer

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

AliasqueryTimeout
Minimum value0

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for MONGODB

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for MYSQL

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for ODBC

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for ORACLE

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for POSTGRES

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for REDSHIFT

authenticationDomain="string"

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

awsConfig="string"

specifies the AWS configuration file if different from the default.

blOptions="string"

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

bucket="string"

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

bulkload=True | False

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

DefaultFalse

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

compress=True | False

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

DefaultFalse

conopts="string"

credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

dbCreateTableOpts="string"

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

defaultDir="string"

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

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

insertbuff=integer

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

key="string"

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

numWriteNodes=integer

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

Default1
Range0–32767

profile="string"

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

pwd="string"

region="string"

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

s3Config="string"

specifies an optional S3 configuration file

schema="string"

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

secret="string"

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

token="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

useSSL=True | False

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

DefaultFalse

Parameters for SFORCE

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for SNOWFLAKE

authenticationDomain="string"

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

awsConfig="string"

specifies the AWS configuration file if different from the default.

blOptions="string"

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

bucket="string"

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

bulkload=True | False

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

DefaultFalse

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

compress=True | False

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

DefaultFalse

conopts="string"

credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

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

dbCreateTableOpts="string"

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

defaultDir="string"

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

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

insertbuff=integer

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

key="string"

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

numWriteNodes=integer

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

Default1
Range0–32767

profile="string"

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

pwd="string"

region="string"

specifies the Amazon Web Services region that the Snowflake 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.

stage="string"

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

token="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

useSSL=True | False

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

DefaultFalse

Parameters for SPARK

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=True | False

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

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

Default1
Range1–5

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

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

Default1024
Minimum value1

hdfsDatadir="string"

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

hdfsMetadir="string"

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

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

insertbuff=integer

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

loginTimeout=integer

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

Default30
Minimum value0

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

postTableOpts="string"

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

preTableOpts="string"

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

pwd="string"

specifies the password.

readbuff=integer

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

Aliasras row_array_size

schema="string"

specifies the name of the Hive schema.

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.

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.

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

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

Default1
Range1–5

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

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

datapath="string"

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

dbCreateTableOpts="string"

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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

label="string"

specifies a label to apply to the output data set.

masterPW="string"

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

maxSaveThreads=integer

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

Default0
Minimum value0

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

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

Default3
Range1–5

numWriteBuffers=integer

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

Default10
Range1–100

padCompress=integer

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

partSize=64-bit-integer

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

Minimum value16

platform="MAPRED" | "SPARK"

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.

readPW="string"

specifies the password to use for Read access.

statusInterval=integer

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

Default0

uid="string"

specifies the user name.

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.

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for TERADATA

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

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

Default1
Range1–5

conopts="string"

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

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

specifies a Teradata Max Text Size value in chars.

Default32000
Range1–32000

insertbuff=integer

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

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

specifies the password.

schema="string"

Unused

statusInterval=integer

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

Default0

uid="string"

specifies the user name.

Parameters for VEDNFS

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEPATH

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VERTICA

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for VES3

encryptionDomain="string"

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

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

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

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

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

sseTextKey="string"

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

Parameters for YELLOWBRICK

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=True | False

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

AliasuseNCT useNarrowCharTypes
DefaultFalse

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO

Parameters for fileType="BASESAS"

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

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

DefaultNO
"encoding":"string"

specifies file encoding

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

specifies whether to encrypt an output SAS data set

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

specifies a password for encrypting or decrypting stored data.

"password":"string"

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

"pointobs":True | False

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

DefaultTrue
"read":"string"

specifies the Read password for the SAS data set.

"reuse":True | False

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

DefaultFalse

Parameters for fileType="CSV" | "DELIMITED"

"addbom":True | False

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

DefaultFalse

Parameters for fileType="DTA"

No parameters apply when you specify DTA

Parameters for fileType="EXCEL"

"range":"string"

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

"sheet":"string"

specifies the name of the worksheet to import.

Parameters for fileType="JMP"

No parameters apply when you specify JMP

Parameters for fileType="ORC"

"compress":"NO" | "YES" | "ZLIB"

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

DefaultZLIB

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS

Parameters for fileType="XLS"

"range":"string"

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

"sheet":"string"

specifies the name of the worksheet to import.

save Action

Saves a table to a caslib's data source.

See:Saving Tables and Exporting Data
Save a Table
Save a SAS7BDAT File in a Caslib

R Syntax

results <– cas.table.save(s,
caslib="string",
compress=TRUE | FALSE,
copies=integer,
dataSourceOptions=list(adls-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vednfs-parameters | vepath-parameters | vertica-parameters | ves3-parameters | yellowbrick-parameters),
exportOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DTA" | "EXCEL" | "JMP" | "ORC" | "SPSS" | "XLS", fileType-specific-parameters),
required parameter name="string",
permission="GROUPREAD" | "GROUPWRITE" | "GROUPWRITEPUBLICREAD" | "PRIVATE" | "PUBLICREAD" | "PUBLICWRITE" | integer,
replace=TRUE | FALSE,
saveAttrs=TRUE | FALSE,
required parameter table=list(
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
computedVarsProgram="string",
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),
groupBy=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters),
required parameter name="table-name",
onDemand=TRUE | FALSE,
orderBy=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
singlePass=TRUE | FALSE,
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
where="where-expression",
whereTable=list(
casLib="string"
dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | hadoop-parameters | hana-parameters | impala-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sforce-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameterslist)
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
required parameter name="table-name"
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>)
where="where-expression"
)
),
viewAsTable=TRUE | FALSE
)
indicates a required parameter

Summary: Input Tables

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

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

—

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

Parameter Descriptions

caslib="string"

specifies the target caslib for the table.

compress=TRUE | FALSE

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

DefaultFALSE

copies=integer

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

Minimum value-1

exportOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DTA" | "EXCEL" | "JMP" | "ORC" | "SPSS" | "XLS", fileType-specific-parameters)

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

Aliasexport

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

* name="string"

specifies the table name.

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

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

replace=TRUE | FALSE

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

DefaultFALSE

saveAttrs=TRUE | FALSE

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

DefaultFALSE

* table=list(castable)

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

For more information about specifying the table parameter, see the common castable parameter.

viewAsTable=TRUE | FALSE

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

DefaultFALSE

Parameters for ADLS

accountName="string"

Azure storage account name

applicationId="string"

Application ID for Azure storage

dnsSuffix="string"

DNS Suffix for Azure storage

filesystem="string"

Azure storage file system

timeout=integer

Azure storage operation timeout value in seconds

Default60
Minimum value0

Parameters for BIGQUERY

authenticationDomain="string"

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

bulkload=TRUE | FALSE

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

DefaultFALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

defaultDir="string"

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

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.

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

qualifier="string"

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

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for CLOUDDEX

append=TRUE | FALSE

DefaultFALSE

authenticationDomain="string"

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

casTypes="ALL" | "BASIC"

ALL

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

BASIC

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

catalog="string"

specifies the database catalog name.

charCreateMultiplier=double

Default1
Range1–5

charMultiplier=double

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

Default1
Range1–5

dbCreateTableOpts="string"

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

domainCredsRequired=TRUE | FALSE

DefaultTRUE

dropTableOnFailedSave=TRUE | FALSE

DefaultTRUE

insertbuff=integer

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

ncharCreateMultiplier=double

Default1
Range1–5

ncharMultiplier=double

Default3
Range1–5

numWriteNodes=integer

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

Default1

pwd="string"

specifies the password.

schema="string"

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

traceFile="string"

specifies a name for the trace file.

traceFlags="string"

specifies flags to use for tracing the database connection.

uid="string"

specifies the user name.

useMaxCharLen=TRUE | FALSE

DefaultFALSE

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for DB2

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for HADOOP

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

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

Default1
Range1–5

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

dbmaxText=integer

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

Default32767
Minimum value1

hdfsDatadir="string"

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

hdfsMetadir="string"

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

hdfsTempDir="string"

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

Aliashdfs_tempdir
Default"/tmp"

insertbuff=integer

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

loginTimeout=integer

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

Default30
Minimum value0

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

platform="MAPRED" | "SPARK"

MAPRED

Specifies to run EP jobs on the Map Reduce platform.

SPARK

Specifies to run EP jobs on the Spark platform.

postTableOpts="string"

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

preTableOpts="string"

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

pwd="string"

specifies the password.

readbuff=integer

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

Aliasras row_array_size

schema="string"

specifies the name of the Hive schema.

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.

Parameters for HANA

authenticationDomain="string"

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

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

specifies connection options to use for connecting to the database.

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

AUTO

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

PARALLEL

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

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

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

insertbuff=integer

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

maxSaveThreads=integer

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

Default0
Minimum value0

ncharMultiplier=double

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

Default3
Range1–5

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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"

Parameters for IMPALA

authenticationDomain="string"

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

bulkload=TRUE | FALSE

DefaultFALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

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

insertbuff=integer

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

numWriteNodes=integer

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

Default1
Range0–32767

pwd="string"

schema="string"

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

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

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

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for JDBC

authenticationDomain="string"

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

catalog="string"

specifies the database catalog name.

charMultiplier=double

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

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

login_timeout=integer

specifies the number of seconds to wait for a connection attempt before returning an error.

AliasloginTimeout
Minimum value0

pwd="string"

query_timeout=integer

specifies the number of seconds to wait for a query to finish executing before returning an error.

AliasqueryTimeout
Minimum value0

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for MONGODB

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for MYSQL

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for ODBC

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for ORACLE

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for POSTGRES

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for REDSHIFT

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

awsConfig="string"

specifies the AWS configuration file if different from the default.

blOptions="string"

specifies any additional COPY options that are added to the end of the COPY command.

bucket="string"

specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=TRUE | FALSE

when set to TRUE, data is written to Redshift using the COPY command.

DefaultFALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=TRUE | FALSE

when set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

defaultDir="string"

specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

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

insertbuff=integer

specifies the number of rows to insert in one write block.

key="string"

specifies the Amazon Web Services access key that is used with key-based access control.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

region="string"

specifies the Amazon Web Services region that the Redshift server resides for bulk-load.

s3Config="string"

specifies an optional S3 configuration file

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

secret="string"

specifies the Amazon Web Services secret access key that is used with key-based access control.

token="string"

specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

useSSL=TRUE | FALSE

when set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFALSE

Parameters for SFORCE

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for SNOWFLAKE

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

awsConfig="string"

specifies the AWS configuration file if different from the default.

blOptions="string"

specifies any additional COPY options that are added to the end of the COPY command.

bucket="string"

specifies the S3 bucket name (and subdirectory, if applicable) to write data files.

bulkload=TRUE | FALSE

when set to TRUE, data is written to Snowflake using the COPY INTO command.

DefaultFALSE

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress=TRUE | FALSE

when set to TRUE, use GZIP compression on data files.

DefaultFALSE

conopts="string"

credentialsFile="string"

specifies the AWS credentials file to use.

credentialsProfile="string"

specifies the AWS profile name in the AWS credentials file to use if using an account with multiple profiles.

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

defaultDir="string"

specifies the default directory on the local node where data files are written. Defaults to SAS utility directory.

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

insertbuff=integer

specifies the number of rows to insert in one write block.

key="string"

specifies the Amazon Web Services access key that is used with key-based access control.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

profile="string"

specifies the AWS profile to use if using an account with multiple profiles.

pwd="string"

region="string"

specifies the Amazon Web Services region that the Snowflake 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.

stage="string"

specifies the internal stage including path to use for bulk-load.

token="string"

specifies a temporary token that is associated with the temporary credentials that you specify with the secret and key options.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

useSSL=TRUE | FALSE

when set to TRUE, create an SSL connection to S3 when transmitting data files.

DefaultFALSE

Parameters for SPARK

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

bulkLoad=TRUE | FALSE

Specifies whether Bulk Loading should be used for inserting rows.

DefaultTRUE

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies the maximum length for STRING data type columns. For Hive, this parameter does not apply to CHAR or VARCHAR columns.

Default1024
Minimum value1

hdfsDatadir="string"

specifies the path to an HDFS directory that will be used to store the data when saving a Cloud Analytic Services table.

hdfsMetadir="string"

specifies the path to an HDFS directory that contains XML-based table definitions, called SASHDMD descriptors.

hdfsTempDir="string"

specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

insertbuff=integer

specifies the number of rows to insert in one write block.

loginTimeout=integer

Specifies the login time-out in seconds for connecting to the data source.

Default30
Minimum value0

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

postTableOpts="string"

Specifies additional database-specific options to be placed after the table name in a CREATE TABLE statement.

preTableOpts="string"

Specifies additional database-specific options to be placed before the table name in a CREATE TABLE statement.

pwd="string"

specifies the password.

readbuff=integer

specifies the number of rows to read in one read block.

Aliasras row_array_size

schema="string"

specifies the name of the Hive schema.

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.

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.

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

compress="BINARY" | "CHAR" | "NO" | "YES"

BINARY

Binary SPDE Compression

CHAR

Char SPDE Compression

NO

No SPDE Compression

YES

Yes SPDE Compression

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

specifies to perform a serial load.

datapath="string"

specifies the path to place data files for created SPDE tables.

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

encrypt="AES" | "NO" | "YES"

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

specifies the passphrase used for an AES encrypted data set.

hdfsTempDir="string"

specifies the Hadoop HDFS directory to use to store temporary data.

Aliashdfs_tempdir
Default"/tmp"

label="string"

specifies a label to apply to the output data set.

masterPW="string"

specifies the master password to use for Read/Write/Alter access.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

mdfpath="string"

specifies the path where SPDE MDF are located.

ncharMultiplier=double

specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteBuffers=integer

specifies the number of write buffers to use for the pipeline write.

Default10
Range1–100

padCompress=integer

specifies the size of additional padding to allow for compressed SPDE tables. This enables subsequent updates to perform more efficiently.

partSize=64-bit-integer

specifies the partition size (in number of MBs) to use for created SPDE tables.

Minimum value16

platform="MAPRED" | "SPARK"

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.

readPW="string"

specifies the password to use for Read access.

statusInterval=integer

specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

specifies the user name.

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.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for TERADATA

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

bufferSize=64-bit-integer

specifies the incoming data buffer size, in bytes.

Default1048576
Minimum value0

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

specifies connection options to use for connecting to the Teradata database.

dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

AUTO

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

PARALLEL

specifies to perform a parallel load using the SAS Embedded Process. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

SERIAL

specifies to perform a serial load.

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

dbmaxText=integer

specifies a Teradata Max Text Size value in chars.

Default32000
Range1–32000

insertbuff=integer

specifies the number of rows to insert in one write block.

maxSaveThreads=integer

Specifies the maximum number of threads to use to save a table.

Default0
Minimum value0

ncharMultiplier=double

specifies a multiplier value to be used with multi-byte encoded character variables. Specify a value larger than the default to avoid character data truncation. Specify a value smaller than the default to conserve storage for data that doesn't require the maximum bytes. The byte lengths are calculated by multiplying the character length by the specified value.

Default3
Range1–5

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

specifies the password.

schema="string"

Unused

statusInterval=integer

specifies the interval for status messages to display to the console during a table load. When the specified number of incoming data buffers are added to the table, a message is displayed.

Default0

uid="string"

specifies the user name.

Parameters for VEDNFS

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VEPATH

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for VERTICA

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for VES3

encryptionDomain="string"

specifies the name for a collection of data that is stored with a common encryption password.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

kmsContext="string"

specifies the AWS Key Management Services encryption context for the cryptographic operation.

kmsKeyId="string"

specifies the AWS Key Management Services ID.

sseHexKey="string"

specifies an encryption key in the form of a 64-digit hexadecimal value.

sseTextKey="string"

specifies a plain-text version of the key to use with server-side encryption.

Parameters for YELLOWBRICK

authenticationDomain="string"

specifies the authentication domain that is used to retrieve database credentials.

catalog="string"

specifies the database catalog name.

charMultiplier=double

specifies a multiplier value to expand single-byte encoded character variables to avoid character data truncation. The lengths are increased by multiplying the character length by the specified value.

Default1
Range1–5

conopts="string"

dbCreateTableOpts="string"

specifies database-specific CREATE TABLE options that will be appended to the generated CREATE TABLE statement.

insertbuff=integer

specifies the number of rows to insert in one write block.

numWriteNodes=integer

specifies the number of grid nodes that will connect to and write data to the DBMS during a Save action.

Default1
Range0–32767

pwd="string"

schema="string"

specifies the schema so that you can use to fully qualify objects in another database for SQL processing.

uid="string"

useNarrowCharacterTypes=TRUE | FALSE

when set to TRUE, the data connector creates narrow character types(CHAR and VARCHAR) during a Save action. The default of FALSE creates wide character types(NCHAR and NVARCHAR).

AliasuseNCT useNarrowCharTypes
DefaultFALSE

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO

Parameters for fileType="BASESAS"

compress="BINARY" | "CHAR" | "NO" | "YES"

when set to True, applies data compression to the table.

DefaultNO
encoding="string"

specifies file encoding

encrypt="AES" | "AES2" | "NO" | "YES"

specifies whether to encrypt an output SAS data set

DefaultNO
encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

password="string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

pointobs=TRUE | FALSE

specifies whether SAS creates compressed data sets whose observations can be randomly accessed or sequentially accessed

DefaultTRUE
read="string"

specifies the Read password for the SAS data set.

reuse=TRUE | FALSE

specifies whether new rows can be written to freed space in a compressed SAS data set

DefaultFALSE

Parameters for fileType="CSV" | "DELIMITED"

addbom=TRUE | FALSE

when set to True, the file includes a byte-order mark (BOM) at the beginning of the file. The BOM can help programs such as Microsoft Excel to interpret national characters in text fields correctly. By default, the BOM is not added to the file.

DefaultFALSE

Parameters for fileType="DTA"

No parameters apply when you specify DTA

Parameters for fileType="EXCEL"

range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="JMP"

No parameters apply when you specify JMP

Parameters for fileType="ORC"

compress="NO" | "YES" | "ZLIB"

when set to True, applies data compression to the table.

DefaultZLIB

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS

Parameters for fileType="XLS"

range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Last updated: November 19, 2020