LIBNAME Statement Options Listed Alphabetically
|
Name
|
Syntax and Description
|
|---|---|
|
ACCESS=READONLY
Determines the access level with which a libref
connection is opened.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
ACCESS=READONLY | TEMP
Assigns an access attribute to the SAS library.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
ADJUST_BYTE_SEMANTIC_COLUMN_LENGTHS=AUTO | YES | NO
Specifies whether to adjust the lengths of CHAR or VARCHAR data type columns when
reading from Oracle into SAS. This option applies only for columns that have been
created in
Oracle using BYTE semantics.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
ADJUST_NCHAR_COLUMN_LENGTHS=YES | NO
Specifies whether to adjust the lengths of NCHAR
or NVARCHAR data type columns.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
ADMIN=name
Specifies an administrator's name for Access Control Lists (ACLs) in Parquet
files.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
ADMINPASS=password
Specifies the administrator's password for Access Control Lists (ACLs) in
Parquet files.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
ALLOW_LARGE_RESULTS=ALWAYS | MUST | OFF
Specifies whether to allow query results larger than the Google BigQuery
maximum response size.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
AUTOCOMMIT=YES | NO
Indicates whether updates are committed immediately
after they are submitted.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BINARY_BYTE_LIMIT=n
Specifies the maximum length for binary columns
that do not have a defined length.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_ACCOUNTNAME="account-name"
Specifies the name of the account to use on the
external storage system.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_APPLICATIONID="string"
Specifies the application ID (a GUID string) for
accessing the external storage system.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_AWS_CONFIG_FILE=path-and-file-name
Specifies the location of the AWS configuration
file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_AWS_PROFILE_NAME=profile-name
Specifies the AWS profile to use when there is more
than one profile in the AWS configuration file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_AZURE_SAS=value
Specifies the Azure shared access signature token value.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_BADFILE=path-and-file-name
Identifies a file that contains records that were rejected during bulk
loading.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_BUCKET='<bucket-name>'
Specifies the bucket name to use when transferring
data files in bulk.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_COMPRESS=YES | NO
Specifies whether to compress data files using the
gzip format.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_CONFIG='<path-and-file-name>'
Specifies the location of the optional configuration
file that the SAS communication layer uses to interact with the Amazon
S3 tool.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_CONTROL=path-and-control-file-name
Identifies the file that contains control statements.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_DATAFILE=path-and-data-file-name
Specifies the file that contains DBMS data for bulk loading.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_DEFAULT_DIR='host-specific-directory-path'
Specifies where bulk loading creates all intermediate
files.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_DELETE_DATAFILE=YES | NO
Specifies whether to delete only the data file (NO) or all files that the
SAS/ACCESS engine creates (YES) for the DBMS bulk-load facility.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_DELETE_ONLY_DATAFILE=YES | NO
Specifies whether to delete the data file that the SAS/ACCESS engine creates
for the DBMS bulk-load facility.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_DELIMITER='<any-single-character>'
Specifies override of the default delimiter character
for separating columns of data during bulk loading or unloading (retrieval).
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_DIRECT_PATH=YES | NO
Specifies the Oracle SQL*Loader DIRECT option.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_DISCARDFILE=path-and-discard-file-name
Specifies the file that contains records that were filtered from bulk loading
because they did not match the criteria as specified in the CONTROL file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_DNSSUFFIX="network-storage-host-name"
Specifies the network host name where the storage
system resides.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_FILESYSTEM="file-system-name"
Specifies the name of the file system within the external storage
system.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_FOLDER="file-path-and-folder"
Specifies the folder or file path for the data in
the external storage system.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_FORMAT=CSV | ORC | PARQUET | TEXT
Specifies the format of the bulk-load staging file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_IAM_ASSUME_ROLE_ARN="ARN-value"
Specifies an Amazon Resource Name (ARN) that identifies
an IAM role.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_IAM_ASSUME_ROLE_NAME="value"
Specifies an AWS IAM role name that enables you to connect to an Amazon S3
environment.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_IDENTITY="identity-value"
Specifies the authentication method for the COPY
command.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_INDEX_OPTIONS='any valid SQL*Loader Index option'
segment-name
Enables you to specify SQL*Loader Index options with bulk
loading.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_KEY=key-value
Specifies the Amazon Web Services access key that
is used with key-based access control.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_LOAD_METHOD=APPEND | INSERT
| REPLACE
| TRUNCATE
Specifies the method by which data is loaded into a table during bulk
loading.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_LOG=<'>file-name<'>
Specifies the name of the error file where all errors are written when
BULKLOAD=YES.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_MAXERRORS=value
Specifies the maximum number of rejected rows that
are allowed in the load before the COPY command is canceled.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_NUM_DATAFILES=value
Specifies the number of data files to create to contain the source
data.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_NUM_READ_THREADS=value
Specifies the number of threads to use for bulk
unloading from the DBMS into SAS.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_OPTIONS='option-1<, option-2<,..., option-N>>'
BL_OPTIONS='option-1=value-1 <, option-2=value-2 <... option-N=value-N>>'
Passes to the DBMS bulk-load facility options that affect how it loads and
processes data.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_PARFILE=<parameter-file>
Specifies a file that contains the SQL*Loader command-line
options.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_PRESERVE_BLANKS=YES | NO
Determines how the SQL*Loader handles requests to insert blank spaces into
CHAR/VARCHAR2 columns with the NOT NULL constraint.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_RECOVERABLE=YES | NO
Determines whether the LOAD process is recoverable.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_REGION=region
Specifies the Amazon Web Services (AWS) region from
which data is being retrieved.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_RETURN_WARNINGS_AS_ERRORS=YES | NO
Specifies whether SQL*Loader (bulk-load) warnings should be displayed in SAS
through the SYSERR macro as warnings or errors.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_SECRET=secret-access-key
Specifies the secret access key that is used when
you transfer data in bulk.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_SUPPRESS_NULLIF=(_ALL_=YES | NO)
BL_SUPPRESS_NULLIF=(column-name-1=YES | NO)< ... column-name-N=YES | NO>)
Specifies whether to suppress the NULLIF clause for the specified columns to
increase performance when a table is created.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_TIMEOUT=value
Specifies the maximum completion time for a storage
task, in seconds.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_TOKEN=temporary-token
Specifies a temporary token that is associated with
the temporary credentials that you specify with the BL_KEY= and BL_SECRET=
options.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_USE_ESCAPE=YES | NO
Specifies whether to escape a predefined set of
special characters during bulk loading or bulk retrieval.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_USE_LOG=YES | NO
Specifies whether to get reports on rejected rows
and the corresponding error file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_USE_PIPE=YES | NO
Specifies whether to use a named pipe for data transfer.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BL_WRITEBUFF=value
Specifies the number of rows to buffer in memory before writing to your data
source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BULKLOAD=YES | NO
Determines whether SAS uses a data source utility to insert data into a data
source table.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
BULKUNLOAD=YES | NO
Rapidly retrieves (fetches) a large number of rows
from an external data set.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CACHE_SIZE=n | nK | nM | nG
Specifies the buffer size in memory before writing data during table creation
(output).
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CHAR_COLUMN_LIMIT=n
Specifies the maximum length for character columns
that do not have a defined length.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CLIENT_ENCODING='encoding'
Specifies the encoding to use when transferring
data from your DBMS.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CLIENT_ID=ID-value
Specifies the client ID value for the OAuth client that is used to connect to
Google BigQuery using the OAuth authentication method.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CLIENT_SECRET=authentication-secret
Specifies the client secret value for the OAuth client that is used to connect
to Google BigQuery using the OAuth authentication method.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
COMPRESS=NO | BROTLI | GZIP | LZ4 | LZ4_HADP | SNAPPY | ZLIB | ZSTD
Controls the compression for new output tables.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
COMPRESS=NO | CHAR | BINARY
Controls the compression of observations in output SAS data sets for a SAS
library.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
CONNECTION= GLOBAL | GLOBALREAD | SHARED | SHAREDREAD | UNIQUE
Specifies whether operations on single or multiple
librefs can share a connection to the DBMS.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CONNECTION_GROUP=connection-group-name
Causes operations on multiple librefs and on multiple
SQL pass-through facility CONNECT statements to share a connection
to the DBMS.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CONOPTS='connection_option1<;connection_option2...>';
Specifies database-specific connection options to use when
connecting.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CRED_PATH='path-and-filename'
Specifies the location of a credential file that enables authentication to
Google Cloud Platform.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
CURSOR_TYPE=DYNAMIC | FORWARD_ONLY | KEYSET_DRIVEN | STATIC
Specifies the cursor type for read-only and updatable
cursors.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
LIBNAME
libref
'SAS-library'
<CVPBYTES=bytes>CVPENGINE=V9<CVPEXCLUDE=variable
expression><CVPFORMATWIDTH=YES | NO><CVPINCLUDE=variable
expression><CVPMULTIPLIER=multiplier>;
Reduce the risk of truncation when character variables are
transcoded.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
DATABASE=<'>database-name<' >
Specifies the database that you want to access.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DATETIME2=YES | NO
Specifies the scale for the timestamp literal for
Microsoft SQL Server 2008 and the native Microsoft driver.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DB_LENGTH_SEMANTICS_BYTE=YES | NO
Indicates whether CHAR and VARCHAR2 column lengths
are specified in bytes or characters when creating an Oracle table.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DB_OBJECTS=TABLES | VIEWS | SYNONYMS | PUBLIC_SYNONYMS | ALL
Specifies which database objects to return with
PROC DATASETS or in SAS Explorer.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBCLIENT_ENCODING_FIXED=YES | NO
Specifies whether SAS session encoding is a fixed
width.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBCLIENT_MAX_BYTES=maximum-client-bytes
Specifies the maximum number of bytes per single character in SAS session
encoding when reading character data from a DBMS.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBCOMMIT=n
Causes an automatic COMMIT (permanently writing
data to the DBMS) after processing a specified number of rows.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBCONINIT="DBMS-user-command"
Specifies a user-defined initialization command
to execute immediately after every connection to the DBMS that is
within the scope of the LIBNAME statement or libref.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBCONTERM=<'>DBMS-user-command<'>
Specifies a user-defined termination command to
execute before every disconnect from the DBMS that is within the scope
of the LIBNAME statement or libref.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBCREATE_TABLE_OPTS='DBMS-SQL-clauses'
Specifies DBMS-specific syntax to add to the CREATE
TABLE statement.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBGEN_NAME=DBMS | SAS
Specifies the method that SAS uses to rename any DBMS columns that contain
characters that SAS does not allow.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBINDEX=YES | NO
Specifies whether SAS uses columns that have specified DBMS indexes when
processing a join.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBLIBINIT=<'>DBMS-user-command<'>
Specifies a user-defined initialization command
to execute once within the scope of the LIBNAME statement or libref
that established the first connection to the DBMS.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBLIBTERM=<'>DBMS-user-command<'>
Specifies a user-defined termination command to
execute once, before the DBMS that is associated with the first connection
made by the LIBNAME statement or libref disconnects.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBLINK=database-link
For Oracle, this option specifies a link from your
local database to database objects on another server.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBMAX_TEXT=bytes
Specifies the maximum length, in bytes, of large object or long character data
that SAS reads from the DBMS.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBMSTEMP=YES | NO
Specifies whether SAS creates temporary tables.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBNULLKEYS=YES | NO
Specifies whether Null values are allowed in key columns.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBNULLWHERE=YES | NO
Specifies whether character columns in a WHERE clause
can contain NULL values.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBSASLABEL=COMPAT | NONE
Specifies the column labels an engine uses.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBSERVER_ENCODING_FIXED=YES | NO
Specifies whether Oracle database encoding is a
fixed width.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBSERVER_MAX_BYTES=max-server-bytes
Specifies the maximum number of bytes per single
character in the database server encoding.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DBSLICEPARM=NONE | THREADED_APPS | ALL
DBSLICEPARM= ( NONE | THREADED_APPS | ALL
<max-threads>
)
DBSLICEPARM= (
NONE | THREADED_APPS | ALL<, max-threads>
)
Controls the scope of DBMS threaded Reads and the
number of threads.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DEFAULT_AUTH_PLUGIN=caching_sha2_password | mysql_native_password
Specifies the authentication plugin to use for a connection to a data
source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DEFER=YES | NO
Specifies whether to defer the connection to the data source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DELETE_MULT_ROWS=YES | NO
Indicates whether to let SAS delete multiple rows
from a data source, such as a DBMS table.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DIRECT_SQL=NO
| NOFUNCTIONS
| NOGENSQL | NOMULTOUTJOINS | NONE | NOWHERE | YES
Specifies whether generated SQL is passed to the
DBMS for processing.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DIRECTORIES_AS_DATA=YES | NO
Specifies whether file system directories are used
as tables.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DRIVER_TRACE=tracing-level
Requests tracing information that logs transaction
records to an external file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DRIVER_TRACEFILE='path-and-filename'
Specifies the name of the trace log.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DRIVER_TRACEOPTIONS=value
Specifies options for the trace log file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DRIVERCLASS=<'>driver<'>
Specifies the fully qualified class name of the JDBC driver required for
establishing a connection to your database.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
DSN=<'>data-source<'>
Specifies the configured ODBC data source to which you want to connect.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
ESCAPE_BACKSLASH=YES
| NO
Specifies whether backslashes in literals are preserved during data copy from
a SAS data set to a table.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
FETCH_NUMERIC_TYPE=FLOAT64 | NUMERIC
Specifies how to load NUMERIC data from Google BigQuery.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
FILE_NAME_EXTENSION=extension-type | _NONE_
FILE_NAME_EXTENSION=(extension-type-1 ... extension-type-n <_NONE_>)
Specifies nondefault file extensions for SAS to read and write
files.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
FILELOCKS=NONE | FAIL | CONTINUE
Specifies whether file locking is turned on or off for the files that are
opened under the libref in the LIBNAME statement.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
FILELOCKWAIT=n
Specifies the number of seconds SAS waits for a locked file to become
available to another process.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
GO_ENABLE_LOGGING=YES | NO
Specifies whether to enable logging in the Go layer.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
GO_LOG_FILE="path-and-file-name"
Specifies the file that contains log information from the Go
layer.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
GO_LOG_FORMAT=json | pretty | term | file | plain | message | logfmt
Specifies the format for trace messages in Go layer
logging.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
GO_LOG_LEVEL=ERROR | WARN | INFO | DEBUG | TRACE
Specifies the logging level for Go layer logging.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
IGNORE_FEDSQL_OBJECTS=YES | NO
Specifies whether to ignore FedSQL objects in a library
query.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
IGNORE_READ_ONLY_COLUMNS=YES | NO
Specifies whether to ignore or include columns where
data types are read-only when generating a SQL statement for inserts
or updates.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
INENCODING=ANY | ASCIIANY | EBDICANY | encoding-value
Overrides and changes the encoding when reading or writing SAS data sets in
the SAS library.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
INSERT_SQL=YES | NO
Specifies the method that SAS/ACCESS uses to insert rows into a data
source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
INSERTBUFF=positive-integer
Specifies the number of rows in a single DBMS insert.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
KEYSET_SIZE=number-of-rows
Specifies the number of rows that are keyset driven.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
KMS_PATH="path-and-filename"
Specifies the location of a key file resource within a
project.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
LARGE_RESULTS_DATASET=<'>Google-BigQuery-data-set-ID<'>
Specifies a data set ID for query results.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
LARGE_RESULTS_EXPIRATION_TIME=milliseconds
Specifies the amount of time in milliseconds until a temporary table is
deleted.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
LARGE_RESULTS_PROJECT=<'>project-ID<'>
Specifies a project ID for large query results.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
LIBRARYDEFINITION=source-definition-URI
Retrieves pre-defined engine LIBNAME information from the Data Sources
microservice and performs a LIBNAME assignment.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
LOCATION="location"
Specifies the localization that was used to store data.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
LOCKWAIT=YES
| NO
Specifies whether to wait indefinitely until rows
are available for locking.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
LOGIN_TIMEOUT=numeric-value
Specifies the default login time-out for connecting
to and accessing data sources in a library.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
MAX_BINARY_LEN=value
Specifies the maximum length in bytes of a binary column.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
MAX_CHAR_LEN=value
Specifies the maximum number of characters to allocate for string
columns.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
MAX_STRING_SIZE=NONE | EXTENDED | STANDARD
Specifies whether to override string limits that are returned via
Oracle.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
MODE=STANDARD
| PERFORMANCE
Specifies the performance
mode for Google BigQuery.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
MULTI_DATASRC_OPT=IN_CLAUSE | NONE
Used in place of DBKEY to improve performance when
processing a join between two data sources.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
NOPROMPT=<'>connection-options<'>
Specifies connection options for your database.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
OR_BINARY_DOUBLE
=YES
| NO
Specifies the default data type to use for numeric
table columns.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
OR_ENABLE_INTERRUPT=YES | NO
Allows interruption of any long-running SQL processes
on the DBMS server.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
OR_UPD_NOWHERE=YES | NO
Specifies whether SAS uses an extra WHERE clause
when updating rows with no locking.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
OUTREP=format
Specifies the data representation for the SAS library, which is the form in
which data is stored in a particular operating environment.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
PASSWORD=<'>password<'>
Specifies the password or access token to access a data source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
PATH=<'>Oracle-database-specification<'>
Specifies the Oracle driver, node, and database.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
POINTOBS=YES | NO
Specifies whether SAS creates compressed data sets whose observations can be
randomly accessed or sequentially accessed.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
PORT=port-number
Specifies the port number that is used to connect to the data
source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
POST_DML_STMT_OPTS=value
Specifies text to append to an INSERT, UPDATE, or
DELETE statement.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
POST_STMT_OPTS='DBMS-SQL-options'
Allows additional database-specific options to be
placed after the CREATE TABLE statement in generated SQL code.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
PRESERVE_COL_NAMES=YES | NO
Specifies whether to preserve spaces, special characters, and case sensitivity in
DBMS column names when you create DBMS tables.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
PRESERVE_COMMENTS=YES | NO
Specifies whether comments should be kept and passed
down to your data source for processing.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
PRESERVE_GUID=YES | NO
Preserves the Microsoft SQL Server GUID (Unique
Identifier).
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
PRESERVE_TAB_NAMES=YES | NO
Specifies whether to preserve spaces, special characters, and case sensitivity in
DBMS table names.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
PROJECT='project-ID'
Specifies the project ID for a Google Cloud Platform
project.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
PROJECT_LIST="project-ID-1<,project-ID-2...>"
Specifies a list of projects to access on Google Cloud
Platform.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
PROXY="URL"
Specifies the URL of a proxy server that is used to connect to Google
BigQuery.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
QUALIFIER=<'>qualifier-name<'>
Enables identification of tables and views with the specified
qualifier.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
QUERY_TAG="string"
Specifies an optional string that you can use to tag queries to your data
source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
QUERY_TIMEOUT=number-of-seconds
Specifies the number of seconds of inactivity to
wait before canceling a query.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
QUOTE_CHAR="character "
Specifies which quotation mark character to use
when delimiting identifiers.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
READ_ISOLATION_LEVEL=DBMS-specific
values
Specifies the degree of isolation of the current
application process from other concurrently running application processes.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
READ_LOCK_TYPE=ROW
| TABLE
| NOLOCK
Specifies how data in a DBMS table is locked during
a READ transaction.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
READ_MODE=BULKUNLOAD | STANDARD | STORAGE
Specifies the method to use to move data into SAS.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
READBUFF=integer
Specifies the number of rows of DBMS data to read
into the buffer.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
REFRESH_TOKEN=token-value
Specifies the refresh token value for the OAuth client that is used to connect
to Google BigQuery using the OAuth authentication method.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
REPEMPTY=YES | NO
Controls replacement of a data set when the new one is empty.
Product: Base SAS
Document: Accessing SAS Data with SAS Viya Workbench
| |
|
REREAD_EXPOSURE=YES | NO
Specifies whether the SAS/ACCESS engine functions
like a random access engine for the scope of the LIBNAME statement.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
RESULTS=MEMORY | SERVER
Determines how result sets are retrieved from the server.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SCANSTRINGCOLUMNS=YES | NO
Specifies whether to determine the maximum length of VARCHAR or long type columns
in a database table or a query.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SCHEMA=<'>schema-name<'>
Specifies the schema to use when accessing tables
and views in a database.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SERVER=<'>server-name<'>
Specifies the server, host name, or IP address that is used to connect to the
data source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SHOW_SYNONYMS=YES | NO
Specifies whether synonyms only or tables, views, or materialized views are
available through your LIBNAME connection.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SKIP_IDENTITY_COL=YES | NO
Specifies whether to skip IDENTITY columns when writing to an external
table.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SPOOL=YES | NO | DBMS
Specifies whether SAS creates a utility spool file
during Read transactions that read data more than once.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SQL_FUNCTIONS=ALL | EXTERNAL_REPLACE=<libref.member>
| EXTERNAL_APPEND=<libref.member> Customizes the in-memory SQL dictionary function
list for this particular LIBNAME statement.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SQL_FUNCTIONS_COPY=libref.member | SASLOG
Specifies whether to write the functions that are associated with a LIBNAME
statement to a SAS data set or the SAS log.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SQLGENERATION=NONE | DBMS
Specifies whether SAS procedures generate SQL for in-database processing of
source data.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_ACCOUNT_NAME=name
Specifies the account name for connecting to Microsoft Azure.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_APPLICATION_ID="string"
Specifies the application ID for connecting to Microsoft Azure.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_AWS_CONFIG_FILE="path-and-AWS-configuration-file-name"
Specifies the location of the Amazon Web Services (AWS) configuration file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_AWS_KEY="key-string"
Specifies the primary service account key for AWS authentication.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_AWS_KEY_FILE="credentials-file-location"
Specifies the path and file name of an AWS credentials file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_AWS_KEY_FILE_PROFILE="profile-name"
Specifies a profile name from the Amazon Web Services (AWS) credentials file
and config file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_AWS_REGION="region"
Specifies the AWS region for Amazon S3 data.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_AWS_SECRET_KEY="key-string"
Specifies the secret key for AWS authentication.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_AWS_SESSION_TOKEN="token-string"
Specifies the temporary security token for AWS authentication.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_BUCKET_NAME="bucket-name"
Specifies the name of the storage bucket.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_CLIENT_SECRET="secret-string"
Specifies the secret key for Azure authentication.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_DNS_SUFFIX="name"
Specifies the network host name for connecting to Microsoft
Azure.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_FILE_SYSTEM=name
Specifies the name of the file system for connecting to Microsoft
Azure.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_PLATFORM=ADLS | AWS
Specifies the type of cloud storage system.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_SHARED_KEY="string"
Specifies the account key for connecting to Microsoft Azure.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STORAGE_TIMEOUT=n
Specifies the maximum completion time for connecting
to a cloud storage system.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
STRINGDATES=YES | NO
Specifies whether to read date and time values from the database as character
strings.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
SUB_CHAR=value
Specifies a substitution character to use in place
of any invalid characters that cannot be represented in the SAS session
encoding.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
TRACE=YES | NO
Specifies whether to turn on tracing information
for use in debugging.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
TRACEFILE=file-name | <'>path-and-file-name<'>
Specifies the file name to which the DBMS driver
manager writes trace information.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
TRACEFLAGS=ALL | COLBINDINGS | GETDATA | PUTDATA | TIMESTAMP
Specifies whether to record column, time, and other parameter data in the
trace file.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
UPDATE_ISOLATION_LEVEL=DBMS-specific-value
Specifies the degree of isolation of the current
application process from other concurrently running application processes.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
UPDATE_LOCK_TYPE=ROW | TABLE | NOLOCK
Specifies how data in a DBMS table is locked during
an update transaction.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
UPDATE_MULT_ROWS=YES | NO
Indicates whether SAS updates multiple rows from
a data source, such as a DBMS table.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
UPDATE_SQL=YES | NO
Specifies whether SAS uses current-of-cursor SQL to update and delete rows in a
data source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
UPDATEBUFF=positive-integer
Specifies the number of rows that are processed
in a single DBMS Update or Delete operation.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
USE_INFORMATION_SCHEMA=YES | NO
Specifies whether to use INFORMATION_SCHEMA in Google BigQuery to retrieve a
list of schemas and tables or views.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
USE_ODBC_CL=YES | NO
Indicates whether the Driver Manager uses the ODBC
Cursor Library.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
USE_PIPELINE=NO | YES
Enables pipeline read functionality for Amazon Redshift.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
USE_SP_TABLES=YES | NO
Specifies whether to use the sp_tables stored procedure to check for table
existence.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
USER=<'>user-identifier<'>
Specifies the user name or user ID for connecting to a data
source.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
USERS=(name-1=password-1… name-n=password-n)
Defines users and their passwords that can be specified in Access Control
Lists (ACLs) for Parquet files.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
UTILCONN_TRANSIENT=NO | YES
Specifies whether a utility connection is automatically dropped as soon as it is
no longer in use.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
| |
|
WARN_BIGINT=YES | NO
issues a warning in the SAS log if the BIGINT data
type is in a DBMS table.
Product: Accessing External Data Sources
Document: Accessing External Data Sources with SAS®Viya Workbench
|
Last updated: September 24, 2026