Common Parameter: castable
CASL Syntax
Parameter Descriptions
caslib="string"
specifies the caslib containing the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, the computed variables specified in the compVars parameter are created when the table is loaded instead of when the action begins.
| Default | FALSE |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each parameter in the compPgm parameter.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the format field length plus the format precision length.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the format precision length.
nfl=integer
specifies the format field length.
computedVarsProgram="string"
specifies an expression for each variable that you included in the compVars parameter.
| Alias | compPgm |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the format field length plus the format precision length.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the format precision length.
nfl=integer
specifies the format field length.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "MVA" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions.
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
when set to True, table access is less aggressive with virtual memory use.
| Default | TRUE |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables or it can be combined with groupBy variables when groupByMode is set to REDISTRIBUTE.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the format field length plus the format precision length.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the format precision length.
nfl=integer
specifies the format field length.
singlePass=TRUE | FALSE
when set to True, the data does not create a transient table in the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the format field length plus the format precision length.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the format precision length.
nfl=integer
specifies the format field length.
where="where-expression"
specifies an expression for subsetting the input data.
Lua Syntax
Parameter Descriptions
caslib="string"
specifies the caslib containing the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=true | false
when set to True, the computed variables specified in the compVars parameter are created when the table is loaded instead of when the action begins.
| Default | false |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each parameter in the compPgm parameter.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the format field length plus the format precision length.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the format precision length.
nfl=integer
specifies the format field length.
computedVarsProgram="string"
specifies an expression for each variable that you included in the compVars parameter.
| Alias | compPgm |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the format field length plus the format precision length.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the format precision length.
nfl=integer
specifies the format field length.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "MVA" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions.
* name="table-name"
specifies the name of the table to use.
onDemand=true | false
when set to True, table access is less aggressive with virtual memory use.
| Default | true |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables or it can be combined with groupBy variables when groupByMode is set to REDISTRIBUTE.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the format field length plus the format precision length.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the format precision length.
nfl=integer
specifies the format field length.
singlePass=true | false
when set to True, the data does not create a transient table in the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the format field length plus the format precision length.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the format precision length.
nfl=integer
specifies the format field length.
where="where-expression"
specifies an expression for subsetting the input data.
Python Syntax
Parameter Descriptions
"caslib":"string"
specifies the caslib containing the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
"computedOnDemand":True | False
when set to True, the computed variables specified in the compVars parameter are created when the table is loaded instead of when the action begins.
| Default | False |
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the computed variables to create. Specify an expression for each parameter in the compPgm parameter.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
| Alias | compVars |
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the format field length plus the format precision length.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the format precision length.
"nfl":integer
specifies the format field length.
"computedVarsProgram":"string"
specifies an expression for each variable that you included in the compVars parameter.
| Alias | compPgm |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the format field length plus the format precision length.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the format precision length.
"nfl":integer
specifies the format field length.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "MVA" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions.
* "name":"table-name"
specifies the name of the table to use.
"onDemand":True | False
when set to True, table access is less aggressive with virtual memory use.
| Default | True |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables or it can be combined with groupBy variables when groupByMode is set to REDISTRIBUTE.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the format field length plus the format precision length.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the format precision length.
"nfl":integer
specifies the format field length.
"singlePass":True | False
when set to True, the data does not create a transient table in the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the format field length plus the format precision length.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the format precision length.
"nfl":integer
specifies the format field length.
"where":"where-expression"
specifies an expression for subsetting the input data.