Common Parameter: outputTables
CASL Syntax
Parameter Descriptions
groupByVarsRaw=TRUE | FALSE
when set to True, uses raw instead of formatted group-by values in the CAS table.
| Default | TRUE |
|---|
includeAll=TRUE | FALSE
when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.
| Default | FALSE |
|---|
names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>}
specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.
For more information, see outputTables Parameter (Shared Concepts).
The casouttable value is specified as follows:
caslib="string"
specifies the name of the caslib for the output table.
compress=TRUE | FALSE
when set to True, applies data compression to the table.
| Default | FALSE |
|---|
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 |
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
|---|
memoryFormat="DVR" | "INHERIT" | "STANDARD"
specifies the memory format for the output table.
| Default | INHERIT |
|---|
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 |
threadBlockSize=64-bit-integer
specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
timeStamp="string"
specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
repeated=TRUE | FALSE
when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.
| Default | FALSE |
|---|
replace=TRUE | FALSE
when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.
| Default | TRUE |
|---|
Lua Syntax
Parameter Descriptions
groupByVarsRaw=true | false
when set to True, uses raw instead of formatted group-by values in the CAS table.
| Default | true |
|---|
includeAll=true | false
when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.
| Default | false |
|---|
names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>}
specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.
For more information, see outputTables Parameter (Shared Concepts).
The casouttable value is specified as follows:
caslib="string"
specifies the name of the caslib for the output table.
compress=true | false
when set to True, applies data compression to the table.
| Default | false |
|---|
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 |
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
|---|
memoryFormat="DVR" | "INHERIT" | "STANDARD"
specifies the memory format for the output table.
| Default | INHERIT |
|---|
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 |
threadBlockSize=64-bit-integer
specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
timeStamp="string"
specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
repeated=true | false
when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.
| Default | false |
|---|
replace=true | false
when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.
| Default | true |
|---|
Python Syntax
Parameter Descriptions
"groupByVarsRaw":True | False
when set to True, uses raw instead of formatted group-by values in the CAS table.
| Default | True |
|---|
"includeAll":True | False
when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.
| Default | False |
|---|
"names":["string-1" <, "string-2", ...>] | {"key-1":{casouttable-1} <, "key-2":{casouttable-2}, ...>}
specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.
For more information, see outputTables Parameter (Shared Concepts).
The casouttable value is specified as follows:
"caslib":"string"
specifies the name of the caslib for the output table.
"compress":True | False
when set to True, applies data compression to the table.
| Default | False |
|---|
"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 |
"maxMemSize":64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
|---|
"memoryFormat":"DVR" | "INHERIT" | "STANDARD"
specifies the memory format for the output table.
| Default | INHERIT |
|---|
"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 |
"threadBlockSize":64-bit-integer
specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
"timeStamp":"string"
specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.
"where":["string-1" <, "string-2", ...>]
specifies an expression for subsetting the output data.
"repeated":True | False
when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.
| Default | False |
|---|
"replace":True | False
when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.
| Default | True |
|---|
R Syntax
Parameter Descriptions
groupByVarsRaw=TRUE | FALSE
when set to True, uses raw instead of formatted group-by values in the CAS table.
| Default | TRUE |
|---|
includeAll=TRUE | FALSE
when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.
| Default | FALSE |
|---|
names=list("string-1" <, "string-2", ...>) | list(key-1=list(casouttable-1) <, key-2=list(casouttable-2), ...>)
specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.
For more information, see outputTables Parameter (Shared Concepts).
The casouttable value is specified as follows:
caslib="string"
specifies the name of the caslib for the output table.
compress=TRUE | FALSE
when set to True, applies data compression to the table.
| Default | FALSE |
|---|
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 |
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
|---|
memoryFormat="DVR" | "INHERIT" | "STANDARD"
specifies the memory format for the output table.
| Default | INHERIT |
|---|
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 |
threadBlockSize=64-bit-integer
specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.
| Default | 1048576 |
|---|---|
| Minimum value | 0 |
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
timeStamp="string"
specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.
where=list("string-1" <, "string-2", ...>)
specifies an expression for subsetting the output data.
repeated=TRUE | FALSE
when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.
| Default | FALSE |
|---|
replace=TRUE | FALSE
when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.
| Default | TRUE |
|---|