Kinetica C# API  Version 6.1.0.0
Public Attributes | List of all members
kinetica.AggregateUnpivotRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string COLLECTION_NAME = "collection_name"
 Name of a collection which is to contain the table specified in result_table. More...
 
const string RESULT_TABLE = "result_table"
 The name of the table used to store the results. More...
 
const string RESULT_TABLE_PERSIST = "result_table_persist"
 If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string EXPRESSION = "expression"
 Filter expression to apply to the table prior to unpivot processing. More...
 
const string ORDER_BY = "order_by"
 Comma-separated list of the columns to be sorted by; e.g. More...
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the chunk size to be used for the result table. More...
 
const string LIMIT = "limit"
 The number of records to keep. More...
 
const string TTL = "ttl"
 Sets the TTL of the table specified in result_table. More...
 

Detailed Description

Optional parameters.

  • COLLECTION_NAME: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table.
  • RESULT_TABLE: The name of the table used to store the results. Has the same naming restrictions as tables. If present, no results are returned in the response.
  • RESULT_TABLE_PERSIST: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is FALSE.
  • EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
  • ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name.
  • CHUNK_SIZE: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
  • LIMIT: The number of records to keep.
  • TTL: Sets the TTL of the table specified in result_table.


A set of string constants for the parameter options.

Definition at line 145 of file AggregateUnpivot.cs.

Member Data Documentation

◆ CHUNK_SIZE

const string kinetica.AggregateUnpivotRequest.Options.CHUNK_SIZE = "chunk_size"

Indicates the chunk size to be used for the result table.

Must be used in combination with the result_table option.

Definition at line 197 of file AggregateUnpivot.cs.

◆ COLLECTION_NAME

const string kinetica.AggregateUnpivotRequest.Options.COLLECTION_NAME = "collection_name"

Name of a collection which is to contain the table specified in result_table.

If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table.

Definition at line 152 of file AggregateUnpivot.cs.

◆ EXPRESSION

const string kinetica.AggregateUnpivotRequest.Options.EXPRESSION = "expression"

Filter expression to apply to the table prior to unpivot processing.

Definition at line 185 of file AggregateUnpivot.cs.

◆ FALSE

const string kinetica.AggregateUnpivotRequest.Options.FALSE = "false"

Definition at line 181 of file AggregateUnpivot.cs.

◆ LIMIT

const string kinetica.AggregateUnpivotRequest.Options.LIMIT = "limit"

The number of records to keep.

Definition at line 200 of file AggregateUnpivot.cs.

◆ ORDER_BY

const string kinetica.AggregateUnpivotRequest.Options.ORDER_BY = "order_by"

Comma-separated list of the columns to be sorted by; e.g.

'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name.

Definition at line 192 of file AggregateUnpivot.cs.

◆ RESULT_TABLE

const string kinetica.AggregateUnpivotRequest.Options.RESULT_TABLE = "result_table"

The name of the table used to store the results.

Has the same naming restrictions as tables. If present, no results are returned in the response.

Definition at line 159 of file AggregateUnpivot.cs.

◆ RESULT_TABLE_PERSIST

const string kinetica.AggregateUnpivotRequest.Options.RESULT_TABLE_PERSIST = "result_table_persist"

If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified.

If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:

The default value is FALSE.

Definition at line 179 of file AggregateUnpivot.cs.

◆ TRUE

const string kinetica.AggregateUnpivotRequest.Options.TRUE = "true"

Definition at line 180 of file AggregateUnpivot.cs.

◆ TTL

const string kinetica.AggregateUnpivotRequest.Options.TTL = "ttl"

Sets the TTL of the table specified in result_table.

Definition at line 205 of file AggregateUnpivot.cs.

The documentation for this struct was generated from the following file: