Table Action Set: Syntax
Provides actions for accessing and managing data
fileInfo Action
Lists the files in a caslib's data source.
| See: | What Does the FileInfo Action Do? |
|---|---|
| Example: | List Files in a Caslib's Data Source |
Parameter Descriptions
allFiles=TRUE | FALSE
| Default | FALSE |
|---|
when set to True, lists all file types in the results. When set to False, lists all file types that are supported by the data connector specified in the caslib. For more information about what file types are supported by each data connector, see Supported File Types by Caslib.
caslib="string"
specifies the name of the caslib for the output table.
dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | fedsvr-parameters | gcs-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
includeDirectories=TRUE | FALSE
when set to True, includes directories in the results.
| Alias | includeDirs |
|---|---|
| Default | TRUE |
kbytes=TRUE | FALSE
when set to True, lists file sizes in kilobytes.
| Default | FALSE |
|---|
path="string"
specifies the file, directory, or table name. You can use wildcard characters (% and _) to limit the results to file names that match a pattern. For more information, see Using Wildcard Characters with the FileInfo and TableInfo Actions.
rowCount=TRUE | FALSE
when set to True, includes the number of rows in the results. Some data sources do not support this parameter.
| Default | FALSE |
|---|
wildEscape="string"
specifies the character or characters to use for escaping wildcard characters.
| Default | "\" |
|---|
wildignore=TRUE | FALSE
when set to True, the characters % and _ are not interpreted as wildcard characters. For example, if you need to match the name 'sales_2019', then setting this parameter to True avoids interpreting the underscore character as a wildcard.
| Default | FALSE |
|---|
wildsensitive=TRUE | FALSE
when set to False and wildcards are used, names are matched without regard to case.
| Default | TRUE |
|---|
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
Parameters for BIGQUERY
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
ignore_fedsql_objects=TRUE | FALSE
when set to TRUE, skip scanning for FedSQL objects when listing tables.
| Alias | ignoreFedSQLObjects |
|---|---|
| Default | FALSE |
location="string"
specifies the location to use in queries
pwd="string"
| Aliases | password |
|---|---|
| pass |
qualifier="string"
specifies an alternate project ID to be used in table references in SQL queries
| Alias | table_qualifier |
|---|
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
use_information_schema=TRUE | FALSE
specifies whether or not to use the information schema for metadata requests containing search patterns
| Default | TRUE |
|---|
Parameters for CAS
password="string"
user="string"
Parameters for CLOUDDEX
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
domainCredsRequired=TRUE | FALSE
| Default | TRUE |
|---|
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
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.
| Alias | username |
|---|
Parameters for DB2
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for FEDSVR
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for GCS
bucket="string"
Parameters for GREENPLUM
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for HADOOP
allowSelfSignedCerts="string"
Specify whether to allow self-signed certficiats for the JDBC connection
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
httpPath="string"
The path component of the JDBC URL
loginTimeout=integer
Specifies the login time-out in seconds for connecting to the data source.
| Default | 30 |
|---|---|
| Minimum value | 0 |
mapreduceJobName="string"
Specify the MapReduce job name for SAS queries
mapreduceJobQueueName="string"
Specify the MapReduce queue used for SAS queries
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the name of the Hive schema.
| Alias | database |
|---|
sslTrustStore="string"
Specify the trust store for the JDBC driver
tezQueueName="string"
Specify the TEZ queue used for SAS queries
trustStorePassword="string"
Specify the JDBC driver trust store password
uid="string"
specifies the user name.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for HANA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for IMPALA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for INFORMIX
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for JDBC
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
login_timeout=integer
specifies the number of seconds to wait for a connection attempt before returning an error.
| Alias | loginTimeout |
|---|---|
| Minimum value | 0 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
query_timeout=integer
specifies the number of seconds to wait for a query to finish executing before returning an error.
| Alias | queryTimeout |
|---|---|
| Minimum value | 0 |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for MONGODB
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for MYSQL
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for NETEZZA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for ODBC
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for ORACLE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for POSTGRES
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for REDSHIFT
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SAPIQ
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SFORCE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SINGLESTORE_STANDARD
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SNOWFLAKE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SPARK
allowSelfSignedCerts="string"
Specify whether to allow self-signed certficiats for the JDBC connection
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
httpPath="string"
The path component of the JDBC URL
loginTimeout=integer
Specifies the login time-out in seconds for connecting to the data source.
| Default | 30 |
|---|---|
| Minimum value | 0 |
mapreduceJobName="string"
Specify the MapReduce job name for SAS queries
mapreduceJobQueueName="string"
Specify the MapReduce queue used for SAS queries
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the name of the Hive schema.
| Alias | database |
|---|
sslTrustStore="string"
Specify the trust store for the JDBC driver
tezQueueName="string"
Specify the TEZ queue used for SAS queries
trustStorePassword="string"
Specify the JDBC driver trust store password
uid="string"
specifies the user name.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for SPDE
alterPW="string"
specifies the password to use for Alter access.
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
mdfpath="string"
specifies the path where SPDE MDF are located.
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
uid="string"
specifies the user name.
| Alias | username |
|---|
writePW="string"
specifies the password to use for Write access.
Parameters for SQLSERVER
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SS
* srcType="SINGLESTORE"
Parameters for TERADATA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
conopts="string"
specifies connection options to use for connecting to the Teradata database.
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
Unused
uid="string"
specifies the user name.
| Alias | username |
|---|
Parameters for VERTICA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for YELLOWBRICK
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
fileInfo Action
Lists the files in a caslib's data source.
| See: | What Does the FileInfo Action Do? |
|---|---|
| Example: | List Files in a Caslib's Data Source |
Parameter Descriptions
allFiles=true | false
| Default | FALSE |
|---|
when set to True, lists all file types in the results. When set to False, lists all file types that are supported by the data connector specified in the caslib. For more information about what file types are supported by each data connector, see Supported File Types by Caslib.
caslib="string"
specifies the name of the caslib for the output table.
dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | fedsvr-parameters | gcs-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
includeDirectories=true | false
when set to True, includes directories in the results.
| Alias | includeDirs |
|---|---|
| Default | true |
kbytes=true | false
when set to True, lists file sizes in kilobytes.
| Default | false |
|---|
path="string"
specifies the file, directory, or table name. You can use wildcard characters (% and _) to limit the results to file names that match a pattern. For more information, see Using Wildcard Characters with the FileInfo and TableInfo Actions.
rowCount=true | false
when set to True, includes the number of rows in the results. Some data sources do not support this parameter.
| Default | false |
|---|
wildEscape="string"
specifies the character or characters to use for escaping wildcard characters.
| Default | "\" |
|---|
wildignore=true | false
when set to True, the characters % and _ are not interpreted as wildcard characters. For example, if you need to match the name 'sales_2019', then setting this parameter to True avoids interpreting the underscore character as a wildcard.
| Default | false |
|---|
wildsensitive=true | false
when set to False and wildcards are used, names are matched without regard to case.
| Default | true |
|---|
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
Parameters for BIGQUERY
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
ignore_fedsql_objects=true | false
when set to TRUE, skip scanning for FedSQL objects when listing tables.
| Alias | ignoreFedSQLObjects |
|---|---|
| Default | false |
location="string"
specifies the location to use in queries
pwd="string"
| Aliases | password |
|---|---|
| pass |
qualifier="string"
specifies an alternate project ID to be used in table references in SQL queries
| Alias | table_qualifier |
|---|
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
use_information_schema=true | false
specifies whether or not to use the information schema for metadata requests containing search patterns
| Default | TRUE |
|---|
Parameters for CAS
password="string"
user="string"
Parameters for CLOUDDEX
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
domainCredsRequired=true | false
| Default | TRUE |
|---|
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
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.
| Alias | username |
|---|
Parameters for DB2
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for FEDSVR
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for GCS
bucket="string"
Parameters for GREENPLUM
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for HADOOP
allowSelfSignedCerts="string"
Specify whether to allow self-signed certficiats for the JDBC connection
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
httpPath="string"
The path component of the JDBC URL
loginTimeout=integer
Specifies the login time-out in seconds for connecting to the data source.
| Default | 30 |
|---|---|
| Minimum value | 0 |
mapreduceJobName="string"
Specify the MapReduce job name for SAS queries
mapreduceJobQueueName="string"
Specify the MapReduce queue used for SAS queries
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the name of the Hive schema.
| Alias | database |
|---|
sslTrustStore="string"
Specify the trust store for the JDBC driver
tezQueueName="string"
Specify the TEZ queue used for SAS queries
trustStorePassword="string"
Specify the JDBC driver trust store password
uid="string"
specifies the user name.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for HANA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for IMPALA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for INFORMIX
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for JDBC
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
login_timeout=integer
specifies the number of seconds to wait for a connection attempt before returning an error.
| Alias | loginTimeout |
|---|---|
| Minimum value | 0 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
query_timeout=integer
specifies the number of seconds to wait for a query to finish executing before returning an error.
| Alias | queryTimeout |
|---|---|
| Minimum value | 0 |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for MONGODB
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for MYSQL
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for NETEZZA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for ODBC
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for ORACLE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for POSTGRES
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for REDSHIFT
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SAPIQ
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SFORCE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SINGLESTORE_STANDARD
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SNOWFLAKE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SPARK
allowSelfSignedCerts="string"
Specify whether to allow self-signed certficiats for the JDBC connection
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
httpPath="string"
The path component of the JDBC URL
loginTimeout=integer
Specifies the login time-out in seconds for connecting to the data source.
| Default | 30 |
|---|---|
| Minimum value | 0 |
mapreduceJobName="string"
Specify the MapReduce job name for SAS queries
mapreduceJobQueueName="string"
Specify the MapReduce queue used for SAS queries
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the name of the Hive schema.
| Alias | database |
|---|
sslTrustStore="string"
Specify the trust store for the JDBC driver
tezQueueName="string"
Specify the TEZ queue used for SAS queries
trustStorePassword="string"
Specify the JDBC driver trust store password
uid="string"
specifies the user name.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for SPDE
alterPW="string"
specifies the password to use for Alter access.
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
mdfpath="string"
specifies the path where SPDE MDF are located.
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
uid="string"
specifies the user name.
| Alias | username |
|---|
writePW="string"
specifies the password to use for Write access.
Parameters for SQLSERVER
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SS
* srcType="SINGLESTORE"
Parameters for TERADATA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
conopts="string"
specifies connection options to use for connecting to the Teradata database.
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
Unused
uid="string"
specifies the user name.
| Alias | username |
|---|
Parameters for VERTICA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for YELLOWBRICK
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
fileInfo Action
Lists the files in a caslib's data source.
| See: | What Does the FileInfo Action Do? |
|---|---|
| Example: | List Files in a Caslib's Data Source |
Parameter Descriptions
allFiles=True | False
| Default | FALSE |
|---|
when set to True, lists all file types in the results. When set to False, lists all file types that are supported by the data connector specified in the caslib. For more information about what file types are supported by each data connector, see Supported File Types by Caslib.
caslib="string"
specifies the name of the caslib for the output table.
dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | fedsvr-parameters | gcs-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
includeDirectories=True | False
when set to True, includes directories in the results.
| Alias | includeDirs |
|---|---|
| Default | True |
kbytes=True | False
when set to True, lists file sizes in kilobytes.
| Default | False |
|---|
path="string"
specifies the file, directory, or table name. You can use wildcard characters (% and _) to limit the results to file names that match a pattern. For more information, see Using Wildcard Characters with the FileInfo and TableInfo Actions.
rowCount=True | False
when set to True, includes the number of rows in the results. Some data sources do not support this parameter.
| Default | False |
|---|
wildEscape="string"
specifies the character or characters to use for escaping wildcard characters.
| Default | "\" |
|---|
wildignore=True | False
when set to True, the characters % and _ are not interpreted as wildcard characters. For example, if you need to match the name 'sales_2019', then setting this parameter to True avoids interpreting the underscore character as a wildcard.
| Default | False |
|---|
wildsensitive=True | False
when set to False and wildcards are used, names are matched without regard to case.
| Default | True |
|---|
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
Parameters for BIGQUERY
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
ignore_fedsql_objects=True | False
when set to TRUE, skip scanning for FedSQL objects when listing tables.
| Alias | ignoreFedSQLObjects |
|---|---|
| Default | False |
location="string"
specifies the location to use in queries
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
qualifier="string"
specifies an alternate project ID to be used in table references in SQL queries
| Alias | table_qualifier |
|---|
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
use_information_schema=True | False
specifies whether or not to use the information schema for metadata requests containing search patterns
| Default | TRUE |
|---|
Parameters for CAS
password="string"
user="string"
Parameters for CLOUDDEX
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
domainCredsRequired=True | False
| Default | TRUE |
|---|
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass_ |
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.
| Alias | username |
|---|
Parameters for DB2
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for FEDSVR
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for GCS
bucket="string"
Parameters for GREENPLUM
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for HADOOP
allowSelfSignedCerts="string"
Specify whether to allow self-signed certficiats for the JDBC connection
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
httpPath="string"
The path component of the JDBC URL
loginTimeout=integer
Specifies the login time-out in seconds for connecting to the data source.
| Default | 30 |
|---|---|
| Minimum value | 0 |
mapreduceJobName="string"
Specify the MapReduce job name for SAS queries
mapreduceJobQueueName="string"
Specify the MapReduce queue used for SAS queries
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the name of the Hive schema.
| Alias | database |
|---|
sslTrustStore="string"
Specify the trust store for the JDBC driver
tezQueueName="string"
Specify the TEZ queue used for SAS queries
trustStorePassword="string"
Specify the JDBC driver trust store password
uid="string"
specifies the user name.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for HANA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for IMPALA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for INFORMIX
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for JDBC
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
login_timeout=integer
specifies the number of seconds to wait for a connection attempt before returning an error.
| Alias | loginTimeout |
|---|---|
| Minimum value | 0 |
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
query_timeout=integer
specifies the number of seconds to wait for a query to finish executing before returning an error.
| Alias | queryTimeout |
|---|---|
| Minimum value | 0 |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for MONGODB
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for MYSQL
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for NETEZZA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for ODBC
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for ORACLE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for POSTGRES
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for REDSHIFT
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SAPIQ
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SFORCE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SINGLESTORE_STANDARD
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SNOWFLAKE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SPARK
allowSelfSignedCerts="string"
Specify whether to allow self-signed certficiats for the JDBC connection
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
httpPath="string"
The path component of the JDBC URL
loginTimeout=integer
Specifies the login time-out in seconds for connecting to the data source.
| Default | 30 |
|---|---|
| Minimum value | 0 |
mapreduceJobName="string"
Specify the MapReduce job name for SAS queries
mapreduceJobQueueName="string"
Specify the MapReduce queue used for SAS queries
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the name of the Hive schema.
| Alias | database |
|---|
sslTrustStore="string"
Specify the trust store for the JDBC driver
tezQueueName="string"
Specify the TEZ queue used for SAS queries
trustStorePassword="string"
Specify the JDBC driver trust store password
uid="string"
specifies the user name.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for SPDE
alterPW="string"
specifies the password to use for Alter access.
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
mdfpath="string"
specifies the path where SPDE MDF are located.
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass_ |
uid="string"
specifies the user name.
| Alias | username |
|---|
writePW="string"
specifies the password to use for Write access.
Parameters for SQLSERVER
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SS
* srcType="SINGLESTORE"
Parameters for TERADATA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
conopts="string"
specifies connection options to use for connecting to the Teradata database.
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass_ |
schema="string"
Unused
uid="string"
specifies the user name.
| Alias | username |
|---|
Parameters for VERTICA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for YELLOWBRICK
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass_ |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
fileInfo Action
Lists the files in a caslib's data source.
| See: | What Does the FileInfo Action Do? |
|---|---|
| Example: | List Files in a Caslib's Data Source |
Parameter Descriptions
allFiles=TRUE | FALSE
| Default | FALSE |
|---|
when set to True, lists all file types in the results. When set to False, lists all file types that are supported by the data connector specified in the caslib. For more information about what file types are supported by each data connector, see Supported File Types by Caslib.
caslib="string"
specifies the name of the caslib for the output table.
dataSourceOptions=list(adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | fedsvr-parameters | gcs-parameters | greenplum-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | netezza-parameters | odbc-parameters | oracle-parameters | postgres-parameters | redshift-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
includeDirectories=TRUE | FALSE
when set to True, includes directories in the results.
| Alias | includeDirs |
|---|---|
| Default | TRUE |
kbytes=TRUE | FALSE
when set to True, lists file sizes in kilobytes.
| Default | FALSE |
|---|
path="string"
specifies the file, directory, or table name. You can use wildcard characters (% and _) to limit the results to file names that match a pattern. For more information, see Using Wildcard Characters with the FileInfo and TableInfo Actions.
rowCount=TRUE | FALSE
when set to True, includes the number of rows in the results. Some data sources do not support this parameter.
| Default | FALSE |
|---|
wildEscape="string"
specifies the character or characters to use for escaping wildcard characters.
| Default | "\" |
|---|
wildignore=TRUE | FALSE
when set to True, the characters % and _ are not interpreted as wildcard characters. For example, if you need to match the name 'sales_2019', then setting this parameter to True avoids interpreting the underscore character as a wildcard.
| Default | FALSE |
|---|
wildsensitive=TRUE | FALSE
when set to False and wildcards are used, names are matched without regard to case.
| Default | TRUE |
|---|
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
| Default | 0 |
|---|---|
| Minimum value | 0 |
Parameters for BIGQUERY
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
ignore_fedsql_objects=TRUE | FALSE
when set to TRUE, skip scanning for FedSQL objects when listing tables.
| Alias | ignoreFedSQLObjects |
|---|---|
| Default | FALSE |
location="string"
specifies the location to use in queries
pwd="string"
| Aliases | password |
|---|---|
| pass |
qualifier="string"
specifies an alternate project ID to be used in table references in SQL queries
| Alias | table_qualifier |
|---|
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
use_information_schema=TRUE | FALSE
specifies whether or not to use the information schema for metadata requests containing search patterns
| Default | TRUE |
|---|
Parameters for CAS
password="string"
user="string"
Parameters for CLOUDDEX
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
domainCredsRequired=TRUE | FALSE
| Default | TRUE |
|---|
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
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.
| Alias | username |
|---|
Parameters for DB2
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for FEDSVR
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for GCS
bucket="string"
Parameters for GREENPLUM
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for HADOOP
allowSelfSignedCerts="string"
Specify whether to allow self-signed certficiats for the JDBC connection
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
httpPath="string"
The path component of the JDBC URL
loginTimeout=integer
Specifies the login time-out in seconds for connecting to the data source.
| Default | 30 |
|---|---|
| Minimum value | 0 |
mapreduceJobName="string"
Specify the MapReduce job name for SAS queries
mapreduceJobQueueName="string"
Specify the MapReduce queue used for SAS queries
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the name of the Hive schema.
| Alias | database |
|---|
sslTrustStore="string"
Specify the trust store for the JDBC driver
tezQueueName="string"
Specify the TEZ queue used for SAS queries
trustStorePassword="string"
Specify the JDBC driver trust store password
uid="string"
specifies the user name.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for HANA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for IMPALA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for INFORMIX
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for JDBC
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
login_timeout=integer
specifies the number of seconds to wait for a connection attempt before returning an error.
| Alias | loginTimeout |
|---|---|
| Minimum value | 0 |
pwd="string"
| Aliases | password |
|---|---|
| pass |
query_timeout=integer
specifies the number of seconds to wait for a query to finish executing before returning an error.
| Alias | queryTimeout |
|---|---|
| Minimum value | 0 |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for MONGODB
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for MYSQL
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for NETEZZA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for ODBC
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for ORACLE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for POSTGRES
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for REDSHIFT
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SAPIQ
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SFORCE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SINGLESTORE_STANDARD
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SNOWFLAKE
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SPARK
allowSelfSignedCerts="string"
Specify whether to allow self-signed certficiats for the JDBC connection
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
httpPath="string"
The path component of the JDBC URL
loginTimeout=integer
Specifies the login time-out in seconds for connecting to the data source.
| Default | 30 |
|---|---|
| Minimum value | 0 |
mapreduceJobName="string"
Specify the MapReduce job name for SAS queries
mapreduceJobQueueName="string"
Specify the MapReduce queue used for SAS queries
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the name of the Hive schema.
| Alias | database |
|---|
sslTrustStore="string"
Specify the trust store for the JDBC driver
tezQueueName="string"
Specify the TEZ queue used for SAS queries
trustStorePassword="string"
Specify the JDBC driver trust store password
uid="string"
specifies the user name.
| Alias | username |
|---|
useSsl="string"
Specifies whether to connect using SSL or not
zooKeeperNamespace="string"
Specify the ZooKeeper namespace
zooKeeperPort=integer
Specify the ZooKeeper client port
| Default | 2181 |
|---|---|
| Range | 1–65535 |
zooKeeperQuorum="string"
Specify the ZooKeeper quorum
Parameters for SPDE
alterPW="string"
specifies the password to use for Alter access.
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
mdfpath="string"
specifies the path where SPDE MDF are located.
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
uid="string"
specifies the user name.
| Alias | username |
|---|
writePW="string"
specifies the password to use for Write access.
Parameters for SQLSERVER
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for SS
* srcType="SINGLESTORE"
Parameters for TERADATA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
authenticationScope="string"
specifies the scope to acquire a token for authorizing requests to the database
| Alias | authScope |
|---|
authenticationType="AUTO" | "KERBEROS" | "LDAP" | "OAUTH2" | "PASSWORD"
AUTO
specifies that the authentication type is determined based on other connection options
KERBEROS
specifies that Kerberos authentication is used for connection
LDAP
specifies that LDAP authentication is used for connection
OAUTH2
specifies that OAUTH2 authentication is used for connection
PASSWORD
specifies that user/password credentials are used for connection
conopts="string"
specifies connection options to use for connecting to the Teradata database.
pwd="string"
specifies the password.
| Aliases | password |
|---|---|
| pass |
schema="string"
Unused
uid="string"
specifies the user name.
| Alias | username |
|---|
Parameters for VERTICA
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |
Parameters for YELLOWBRICK
authenticationDomain="string"
specifies the authentication domain that is used to retrieve database credentials.
| Alias | authDomain |
|---|
catalog="string"
specifies the database catalog name.
conopts="string"
pwd="string"
| Aliases | password |
|---|---|
| pass |
schema="string"
specifies the schema so that you can use to fully qualify objects in another database for SQL processing.
uid="string"
| Aliases | user |
|---|---|
| username |