Table Action Set: Syntax

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

dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | duckdb-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},

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

groupBy

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},

name="table-name",

orderBy

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=TRUE | FALSE,

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable

casLib="string"

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

name="table-name"

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

;

indicates a required parameter

Summary: Input Tables

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

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parametertable	whereTable	specifies the table name, caslib, and other common parameters.

Parameter Descriptions

dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | duckdb-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
Aliases	dataSource

inputs={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the column names from the input table. If you do not specify this parameter, then the column information for all columns is shown.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Alias	input

* table={castable}

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

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

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"

location="string"

Specifies the location to use in queries

pwd="string"

Aliases	password
Aliases	pass

qualifier="string"

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

Alias	table_qualifier

scanStringColumns=TRUE | FALSE

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

Aliases	scanStrings
	scan_string_columns
	scan_strings
Default	FALSE

schema="string"

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

uid="string"

Aliases	user
Aliases	username

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

casTypes="ALL" | "BASIC"

ALL

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

BASIC

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

catalog="string"

Specifies the database catalog name.

domainCredsRequired=TRUE | FALSE

Default	TRUE

pwd="string"

Specifies the password.

Aliases	password
Aliases	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
Aliases	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
Aliases	username

Parameters for DUCKDB

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates 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
Aliases	pass

schema="string"

Specifies the name of the 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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	pass

query_timeout=integer

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

Alias	queryTimeout
Minimum value	0

schema="string"

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

uid="string"

Aliases	user
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for REDSHIFT

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates 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

connCatalog="string"

Specifies the Databricks Unity Catalog

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
Aliases	pass

schema="string"

Specifies the name of the 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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

Specifies the passphrase used for an AES encrypted data set.

masterPW="string"

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

mdfpath="string"

Specifies the path where SPDE MDF are located.

pwd="string"

Specifies the password.

Aliases	password
Aliases	pass

readPW="string"

Specifies the password to use for Read access.

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

columnInfo Action

Shows column information.

See:	Results
Example:	Show Column Information for a Table

Lua Syntax

results, info = s:table_columnInfo{

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

caslib="string",

computedOnDemand=true | false,

computedVars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

groupBy

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=true | false,

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable

casLib="string"

name="table-name"

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

indicates a required parameter

Summary: Input Tables

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

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parametertable	whereTable	specifies the table name, caslib, and other common parameters.

Parameter Descriptions

dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | duckdb-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
Aliases	dataSource

inputs={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the column names from the input table. If you do not specify this parameter, then the column information for all columns is shown.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Alias	input

* table={castable}

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

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

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"

location="string"

Specifies the location to use in queries

pwd="string"

Aliases	password
Aliases	pass

qualifier="string"

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

Alias	table_qualifier

scanStringColumns=true | false

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

Aliases	scanStrings
	scan_string_columns
	scan_strings
Default	false

schema="string"

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

uid="string"

Aliases	user
Aliases	username

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

casTypes="ALL" | "BASIC"

ALL

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

BASIC

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

catalog="string"

Specifies the database catalog name.

domainCredsRequired=true | false

Default	TRUE

pwd="string"

Specifies the password.

Aliases	password
Aliases	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
Aliases	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
Aliases	username

Parameters for DUCKDB

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates 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
Aliases	pass

schema="string"

Specifies the name of the 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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	pass

query_timeout=integer

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

Alias	queryTimeout
Minimum value	0

schema="string"

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

uid="string"

Aliases	user
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for REDSHIFT

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates 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

connCatalog="string"

Specifies the Databricks Unity Catalog

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
Aliases	pass

schema="string"

Specifies the name of the 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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

Specifies the passphrase used for an AES encrypted data set.

masterPW="string"

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

mdfpath="string"

Specifies the path where SPDE MDF are located.

pwd="string"

Specifies the password.

Aliases	password
Aliases	pass

readPW="string"

Specifies the password to use for Read access.

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

columnInfo Action

Shows column information.

See:	Results
Example:	Show Column Information for a Table

Python Syntax

results=s.table.columnInfo(

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"caslib":"string",

"computedOnDemand":True | False,

"computedVars"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"computedVarsProgram":"string",

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},

"groupBy"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"groupByMode":"NOSORT" | "REDISTRIBUTE",

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},

"name":"table-name",

"orderBy"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"singlePass":True | False,

"vars"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression",

"whereTable"

"casLib":"string"

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

"name":"table-name"

"vars"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

)

indicates a required parameter

Summary: Input Tables

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

Parameters for Reading Input Tables
Parameter	Subparameter	Description
required parametertable	whereTable	specifies the table name, caslib, and other common parameters.

Parameter Descriptions

dataSourceOptions={adls-parameters | bigquery-parameters | cas-parameters | clouddex-parameters | db2-parameters | duckdb-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
Aliases	dataSource

inputs=[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the column names from the input table. If you do not specify this parameter, then the column information for all columns is shown.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Alias	input

* table={castable}

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

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

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"

location="string"

Specifies the location to use in queries

pwd="string"

Aliases	password
Aliases	pass_

qualifier="string"

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

Alias	table_qualifier

scanStringColumns=True | False

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

Aliases	scanStrings
	scan_string_columns
	scan_strings
Default	False

schema="string"

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

uid="string"

Aliases	user
Aliases	username

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

casTypes="ALL" | "BASIC"

ALL

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

BASIC

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

catalog="string"

Specifies the database catalog name.

domainCredsRequired=True | False

Default	TRUE

pwd="string"

Specifies the password.

Aliases	password
Aliases	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
Aliases	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
Aliases	username

Parameters for DUCKDB

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for HADOOP

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates 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
Aliases	pass_

schema="string"

Specifies the name of the 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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	pass_

query_timeout=integer

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

Alias	queryTimeout
Minimum value	0

schema="string"

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

uid="string"

Aliases	user
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for REDSHIFT

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

Parameters for SPARK

allowSelfSignedCerts="string"

Specify whether to allow self-signed certificates 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

connCatalog="string"

Specifies the Databricks Unity Catalog

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
Aliases	pass_

schema="string"

Specifies the name of the 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

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

AES

AES SPDE Encryption

NO

No SPDE Encryption

YES

Proprietary SPDE Encryption

encryptionPassword="string"

Specifies the passphrase used for an AES encrypted data set.

masterPW="string"

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

mdfpath="string"

Specifies the path where SPDE MDF are located.

pwd="string"

Specifies the password.

Aliases	password
Aliases	pass_

readPW="string"

Specifies the password to use for Read access.

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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	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
Aliases	username

columnInfo Action

Shows column information.

See:	Results
Example:	Show Column Information for a Table

R Syntax

results <– cas.table.columnInfo(s,

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),