Table Action Set: Syntax
Provides actions for accessing and managing data
upload Action
Transfers binary data to the server to create objects like tables.
| Note: | The upload action cannot be run from CASL, Python, and other clients in the same way that other actions like loadTable are run. Each client provides a client-specific function or method for transferring data to the server that runs the upload action. |
|---|
Summary: Output 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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the settings for an output table. |
Parameter Descriptions
casOut={casouttablebasic}
specifies the settings for an output table.
| Long form | casOut={name="table-name"} |
|---|---|
| Shortcut form | casOut="table-name" |
The casouttablebasic value can be one or more of the following:
caslib="string"
specifies the name of the caslib for the output table.
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data.
label="string"
specifies the descriptive label to associate with the table.
lifetime=64-bit-integer
specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.
| Default | 0 |
|---|---|
| Minimum value | 0 |
memoryFormat="DVR" | "INHERIT" | "STANDARD"
specifies the memory format for the output table.
| Default | INHERIT |
|---|
DVR
use the duplicate value reduction memory format. This memory format can reduce the memory consumption and file size when the input data contains duplicate values.
name="table-name"
specifies the name for the output table.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
|---|
promote=TRUE | FALSE
when set to True, adds the output table 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 |
|---|
replace=TRUE | FALSE
when set to True, overwrites an existing table that has the same name.
| Default | FALSE |
|---|
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.
| Default | 1 |
|---|---|
| Minimum value | 0 |
* importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
The value that you specify for the fileType parameter determines the other parameters that apply. For more information about this common parameter, see importOptions.
upload Action
Transfers binary data to the server to create objects like tables.
| Note: | The upload action cannot be run from CASL, Python, and other clients in the same way that other actions like loadTable are run. Each client provides a client-specific function or method for transferring data to the server that runs the upload action. |
|---|
Summary: Output 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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the settings for an output table. |
Parameter Descriptions
casOut={casouttablebasic}
specifies the settings for an output table.
| Long form | casOut={name="table-name"} |
|---|---|
| Shortcut form | casOut="table-name" |
The casouttablebasic value can be one or more of the following:
caslib="string"
specifies the name of the caslib for the output table.
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data.
label="string"
specifies the descriptive label to associate with the table.
lifetime=64-bit-integer
specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.
| Default | 0 |
|---|---|
| Minimum value | 0 |
memoryFormat="DVR" | "INHERIT" | "STANDARD"
specifies the memory format for the output table.
| Default | INHERIT |
|---|
DVR
use the duplicate value reduction memory format. This memory format can reduce the memory consumption and file size when the input data contains duplicate values.
name="table-name"
specifies the name for the output table.
onDemand=true | false
This parameter is deprecated.
| Default | true |
|---|
promote=true | false
when set to True, adds the output table 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 |
|---|
replace=true | false
when set to True, overwrites an existing table that has the same name.
| Default | false |
|---|
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.
| Default | 1 |
|---|---|
| Minimum value | 0 |
* importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
The value that you specify for the fileType parameter determines the other parameters that apply. For more information about this common parameter, see importOptions.
upload Action
Transfers binary data to the server to create objects like tables.
| Note: | The upload action cannot be run from CASL, Python, and other clients in the same way that other actions like loadTable are run. Each client provides a client-specific function or method for transferring data to the server that runs the upload action. |
|---|
Summary: Output 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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the settings for an output table. |
Parameter Descriptions
casOut={casouttablebasic}
specifies the settings for an output table.
| Long form | casOut={"name":"table-name"} |
|---|---|
| Shortcut form | casOut="table-name" |
The casouttablebasic value can be one or more of the following:
"caslib":"string"
specifies the name of the caslib for the output table.
"indexVars":["variable-name-1" <, "variable-name-2", ...>]
specifies the list of variables to create indexes for in the output data.
"label":"string"
specifies the descriptive label to associate with the table.
"lifetime":64-bit-integer
specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.
| Default | 0 |
|---|---|
| Minimum value | 0 |
"memoryFormat":"DVR" | "INHERIT" | "STANDARD"
specifies the memory format for the output table.
| Default | INHERIT |
|---|
DVR
use the duplicate value reduction memory format. This memory format can reduce the memory consumption and file size when the input data contains duplicate values.
"name":"table-name"
specifies the name for the output table.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
|---|
"promote":True | False
when set to True, adds the output table 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 |
|---|
"replace":True | False
when set to True, overwrites an existing table that has the same name.
| Default | False |
|---|
"replication":integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.
| Default | 1 |
|---|---|
| Minimum value | 0 |
* importOptions={"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
The value that you specify for the fileType parameter determines the other parameters that apply. For more information about this common parameter, see importOptions.
upload Action
Transfers binary data to the server to create objects like tables.
| Note: | The upload action cannot be run from CASL, Python, and other clients in the same way that other actions like loadTable are run. Each client provides a client-specific function or method for transferring data to the server that runs the upload action. |
|---|
Summary: Output 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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the settings for an output table. |
Parameter Descriptions
casOut=list(casouttablebasic)
specifies the settings for an output table.
| Long form | casOut=list(name="table-name") |
|---|---|
| Shortcut form | casOut="table-name" |
The casouttablebasic value can be one or more of the following:
caslib="string"
specifies the name of the caslib for the output table.
indexVars=list("variable-name-1" <, "variable-name-2", ...>)
specifies the list of variables to create indexes for in the output data.
label="string"
specifies the descriptive label to associate with the table.
lifetime=64-bit-integer
specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.
| Default | 0 |
|---|---|
| Minimum value | 0 |
memoryFormat="DVR" | "INHERIT" | "STANDARD"
specifies the memory format for the output table.
| Default | INHERIT |
|---|
DVR
use the duplicate value reduction memory format. This memory format can reduce the memory consumption and file size when the input data contains duplicate values.
name="table-name"
specifies the name for the output table.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
|---|
promote=TRUE | FALSE
when set to True, adds the output table 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 |
|---|
replace=TRUE | FALSE
when set to True, overwrites an existing table that has the same name.
| Default | FALSE |
|---|
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.
| Default | 1 |
|---|---|
| Minimum value | 0 |
* importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
The value that you specify for the fileType parameter determines the other parameters that apply. For more information about this common parameter, see importOptions.