Create indexes on one or more table variables.
| Parameter | Description |
|---|---|
| casout | Specifies the settings for an output table. Alias: outTable. Long form: casout={name="table-name"}. Shortcut form: casout="table-name". The casouttable value can be one or more of the following: - caslib: Specifies the name of the caslib for the output table. - compress: When set to True, applies data compression to the table. Default: FALSE. - indexVars: Specifies the list of variables to create indexes for in the output data. - label: Specifies the descriptive label to associate with the table. - lifetime: 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: 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: 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. INHERIT: Use the default memory format that is set for the server. By default, the server uses the standard memory format. If an administrator sets the CAS_DEFAULT_MEMORY_FORMAT environment variable to DVR, then the DVR memory format is set as the default for the server. STANDARD: Use the standard memory format. - name: Specifies the name for the output table. - promote: 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: When set to True, overwrites an existing table that has the same name. Default: FALSE. - replication: 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. - tableRedistUpPolicy: Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server. DEFER: Defer redistribution policy selection to higher-level entity. NOREDIST: Do not redistribute table data when the number of worker pods changes on a running CAS server. REBALANCE: Rebalance table data when the number of worker pods changes on a running CAS server. - threadBlockSize: 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. Alias: blockSize. 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: 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. |
| table | Specifies the table the index is for. For more information about specifying the table parameter, see the common castable parameter (details inferred from syntax): - caslib: Specifies the name of the caslib for the table. - computedOnDemand: When set to TRUE, variables are computed only when needed. - computedVars: A list of dictionaries, each defining a computed variable with properties like format, formattedLength, label, name (required), nfd, and nfl. - computedVarsProgram: A string containing the program to compute variables. - dataSourceOptions: Options specific to the data source. - groupBy: A list of dictionaries, each defining a variable for grouping with properties like format, formattedLength, label, name (required), nfd, and nfl. - groupByMode: Specifies how grouping is handled. Options are "NOSORT" (no sorting) or "REDISTRIBUTE" (redistribute data for grouping). - importOptions: Options for importing data, including fileType (e.g., "CSV", "HDAT") and fileType-specific-parameters. - name: The name of the table (required). - orderBy: A list of dictionaries, each defining a variable for ordering with properties like format, formattedLength, label, name (required), nfd, and nfl. - singlePass: When set to TRUE, processes the data in a single pass. - vars: A list of dictionaries, each defining a variable with properties like format, formattedLength, label, name (required), nfd, and nfl. - where: A string containing a WHERE expression to filter rows. - whereTable: A dictionary specifying a table for WHERE clause evaluation, including casLib, dataSourceOptions, importOptions, name (required), vars, and where sub-parameters. |