Tables Action Set: Syntax
Provides actions for accessing and managing data
loadTable Action
Loads a table from a caslib's data source.
CASL Syntax
Parameter Descriptions
attrTable="string"
specifies the name of an existing extended attributes table to use with an ADD, UPDATE, or CONVERT task. For CONVERT, this parameter names the table to use for storing the extended attributes.
casOut={casouttablebasic}
specifies the settings for an output table.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
For more information about this common parameter, see casouttablebasic.
caslib="string"
specifies the name of the caslib to use.
| Alias | sourceCaslib |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
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.
For more information about this common parameter, see casinvardesc.
groupByFmts={"string-1" <, "string-2", ...>}
specifies the format to apply to each group-by variable. To avoid specifying a format for a group-by variable, use "" (no format).
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.
onDemand=TRUE | FALSE
when set to True, the action is less aggressive with memory use. This parameter limits the virtual memory size, limits the number of open handles, and relies on the operating system to page efficiently. There is a very small performance penalty.
| 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.
For more information about this common parameter, see casinvardesc.
* path="string"
specifies the file, directory, or table name.
| Alias | source |
promote=TRUE | FALSE
when set to True, the view is added with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
readAhead=TRUE | FALSE
when set to True, loads the table into memory immediately. By default, a table is loaded into memory when it is first used.
| 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.
For more information about this common parameter, see casinvardesc.
| Alias |
where="where-expression"
specifies an expression for subsetting the input data.
Result Descriptions
caslib
The result is a string. You can access the value from results.caslib.
tableName
The result is a string. You can access the value from results.tableName.
loadTable Action
Loads a table from a caslib's data source.
Lua Syntax
Parameter Descriptions
attrTable="string"
specifies the name of an existing extended attributes table to use with an ADD, UPDATE, or CONVERT task. For CONVERT, this parameter names the table to use for storing the extended attributes.
casOut={casouttablebasic}
specifies the settings for an output table.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
For more information about this common parameter, see casouttablebasic.
caslib="string"
specifies the name of the caslib to use.
| Alias | sourceCaslib |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
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.
For more information about this common parameter, see casinvardesc.
groupByFmts={"string-1" <, "string-2", ...>}
specifies the format to apply to each group-by variable. To avoid specifying a format for a group-by variable, use "" (no format).
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.
onDemand=true | false
when set to True, the action is less aggressive with memory use. This parameter limits the virtual memory size, limits the number of open handles, and relies on the operating system to page efficiently. There is a very small performance penalty.
| 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.
For more information about this common parameter, see casinvardesc.
* path="string"
specifies the file, directory, or table name.
| Alias | source |
promote=true | false
when set to True, the view is added with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | false |
readAhead=true | false
when set to True, loads the table into memory immediately. By default, a table is loaded into memory when it is first used.
| 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.
For more information about this common parameter, see casinvardesc.
| Alias |
where="where-expression"
specifies an expression for subsetting the input data.
Result Descriptions
caslib
The result is a string. You can access the value from results.caslib.
tableName
The result is a string. You can access the value from results.tableName.
loadTable Action
Loads a table from a caslib's data source.
Python Syntax
Parameter Descriptions
attrTable="string"
specifies the name of an existing extended attributes table to use with an ADD, UPDATE, or CONVERT task. For CONVERT, this parameter names the table to use for storing the extended attributes.
casOut={casouttablebasic}
specifies the settings for an output table.
To simplify, you can specify only a value for the name parameter. In this case, the other parameters in the list use default values.
For more information about this common parameter, see casouttablebasic.
caslib="string"
specifies the name of the caslib to use.
| Alias | sourceCaslib |
dataSourceOptions={"key-1":any-list-or-data-type-1 <, "key-2":any-list-or-data-type-2, ...>}
specifies data source options.
"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.
For more information about this common parameter, see casinvardesc.
"groupByFmts":{"string-1" <, "string-2", ...>}
specifies the format to apply to each group-by variable. To avoid specifying a format for a group-by variable, use "" (no format).
"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.
onDemand=True | False
when set to True, the action is less aggressive with memory use. This parameter limits the virtual memory size, limits the number of open handles, and relies on the operating system to page efficiently. There is a very small performance penalty.
| 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.
For more information about this common parameter, see casinvardesc.
* path="string"
specifies the file, directory, or table name.
| Alias | source |
promote=True | False
when set to True, the view is added with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | False |
readAhead=True | False
when set to True, loads the table into memory immediately. By default, a table is loaded into memory when it is first used.
| 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.
For more information about this common parameter, see casinvardesc.
| Alias |
where="where-expression"
specifies an expression for subsetting the input data.
Result Descriptions
caslib
The result is a string. You can access the value from results.caslib.
tableName
The result is a string. You can access the value from results.tableName.