Table Action Set: Syntax

CASL Syntax

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

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

format=TRUE | FALSE,

from=64-bit-integer,

index=TRUE | FALSE,

maxRows=integer,

sasTypes=TRUE | FALSE,

={{

formatted="FORMATTED" | "RAW",

name="variable-name",

order="ASCENDING" | "DESCENDING"

}, {...}},

sortLocale="string",

sortMethodCutoff=double,

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

}

to=64-bit-integer

;

indicates a required parameter

Summary: Input Tables

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

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

Parameter Descriptions

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

specifies the column names from the input table. If you do not specify this parameter, then all columns are fetched.

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

format=TRUE | FALSE

when set to True, formats are applied to the variables.

Default	FALSE

from=64-bit-integer

specifies the ordinal position of the first row to return.

Default	1

index=TRUE | FALSE

when set to True, adds a column named Index to the results that is to identify each row.

Default	TRUE

maxRows=integer

specifies the maximum number of rows to return per result table. The fetch action result table is divided into multiple result tables with a maximum row number set by the maxrows parameter. If you specify maxrows=0, then the fetch action does not return any rows.

Default	1000

sasTypes=TRUE | FALSE

when set to True, converts data to fixed-width character and double data types.

Default	TRUE

sortBy={{fetchorderbyelement-1} <, {fetchorderbyelement-2}, ...>}

specifies the variables and variable settings for sorting results.

Alias	orderBy

The fetchorderbyelement value can be one or more of the following:

formatted="FORMATTED" | "RAW"

specifies whether the formatted or raw value for the variable is used.

Default	RAW

* name="variable-name"

specifies the variable name to use for sorting.

order="ASCENDING" | "DESCENDING"

specifies whether the ascending or descending value for the variable is used.

Default	ASCENDING

sortLocale="string"

Locale to use for comparisons during sort.

sortMethodCutoff=double

specifies the cutoff point for choosing between two sort methods.

Default	2
Range	0–100

* table={castable}

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

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

to=64-bit-integer

specifies the ordinal position of the last row to return.

Default	20

fetch Action

Fetches rows from a table or view.

Example:

Lua Syntax

results, info = s:table_fetch{

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

format=true | false,

from=64-bit-integer,

index=true | false,

maxRows=integer,

sasTypes=true | false,

={{

formatted="FORMATTED" | "RAW",

name="variable-name",

order="ASCENDING" | "DESCENDING"

}, {...}},

sortLocale="string",

sortMethodCutoff=double,

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"

}

to=64-bit-integer

}

indicates a required parameter

Summary: Input Tables

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

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

Parameter Descriptions

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

specifies the column names from the input table. If you do not specify this parameter, then all columns are fetched.

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

format=true | false

when set to True, formats are applied to the variables.

Default	false

from=64-bit-integer

specifies the ordinal position of the first row to return.

Default	1

index=true | false

when set to True, adds a column named Index to the results that is to identify each row.

Default	true

maxRows=integer

Default	1000

sasTypes=true | false

when set to True, converts data to fixed-width character and double data types.

Default	true

sortBy={{fetchorderbyelement-1} <, {fetchorderbyelement-2}, ...>}

specifies the variables and variable settings for sorting results.

Alias	orderBy

The fetchorderbyelement value can be one or more of the following:

formatted="FORMATTED" | "RAW"

specifies whether the formatted or raw value for the variable is used.

Default	RAW

* name="variable-name"

specifies the variable name to use for sorting.

order="ASCENDING" | "DESCENDING"

specifies whether the ascending or descending value for the variable is used.

Default	ASCENDING

sortLocale="string"

Locale to use for comparisons during sort.

sortMethodCutoff=double

specifies the cutoff point for choosing between two sort methods.

Default	2
Range	0–100

* table={castable}

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

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

to=64-bit-integer

specifies the ordinal position of the last row to return.

Default	20

fetch Action

Fetches rows from a table or view.

Example:

Python Syntax

results=s.table.fetch(

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

format=True | False,

from_=64-bit-integer,

index=True | False,

maxRows=integer,

sasTypes=True | False,

=[{

"formatted":"FORMATTED" | "RAW",

"name":"variable-name",

"order":"ASCENDING" | "DESCENDING"

}<, {...}>],

sortLocale="string",

sortMethodCutoff=double,

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

}

to=64-bit-integer

)

indicates a required parameter

Summary: Input Tables

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

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

Parameter Descriptions

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

specifies the column names from the input table. If you do not specify this parameter, then all columns are fetched.

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

format=True | False

when set to True, formats are applied to the variables.

Default	False

from_=64-bit-integer

specifies the ordinal position of the first row to return.

Default	1

index=True | False

when set to True, adds a column named Index to the results that is to identify each row.

Default	True

maxRows=integer

Default	1000

sasTypes=True | False

when set to True, converts data to fixed-width character and double data types.

Default	True

sortBy=[{fetchorderbyelement-1} <, {fetchorderbyelement-2}, ...>]

specifies the variables and variable settings for sorting results.

Alias	orderBy

The fetchorderbyelement value can be one or more of the following:

"formatted":"FORMATTED" | "RAW"

specifies whether the formatted or raw value for the variable is used.

Default	RAW

* "name":"variable-name"

specifies the variable name to use for sorting.

"order":"ASCENDING" | "DESCENDING"

specifies whether the ascending or descending value for the variable is used.

Default	ASCENDING

sortLocale="string"

Locale to use for comparisons during sort.

sortMethodCutoff=double

specifies the cutoff point for choosing between two sort methods.

Default	2
Range	0–100

* table={castable}

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

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

to=64-bit-integer

specifies the ordinal position of the last row to return.

Default	20

fetch Action

Fetches rows from a table or view.

Example:

R Syntax

results <– cas.table.fetch(s,

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

format=TRUE | FALSE,

from=64-bit-integer,

index=TRUE | FALSE,

maxRows=integer,

sasTypes=TRUE | FALSE,

=list( list(

formatted="FORMATTED" | "RAW",

name="variable-name",

order="ASCENDING" | "DESCENDING"

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

sortLocale="string",

sortMethodCutoff=double,