Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.AggregateGroupByRequest.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 EXPRESSION = "expression"
 Filter expression to apply to the table prior to computing the aggregate group by. More...
 
const string HAVING = "having"
 Filter expression to apply to the aggregated results. More...
 
const string SORT_ORDER = "sort_order"
 String indicating how the returned values should be sorted - ascending or descending. More...
 
const string ASCENDING = "ascending"
 Indicates that the returned values should be sorted in ascending order. More...
 
const string DESCENDING = "descending"
 Indicates that the returned values should be sorted in descending order. More...
 
const string SORT_BY = "sort_by"
 String determining how the results are sorted. More...
 
const string KEY = "key"
 Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. More...
 
const string VALUE = "value"
 Indicates that the returned values should be sorted by value, which corresponds to the aggregates. 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 RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"
 Force the result table to be replicated (ignores any sharding). More...
 
const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk"
 If true then set a primary key for the result table. More...
 
const string TTL = "ttl"
 Sets the TTL of the table specified in result_table. More...
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the number of records per chunk to be used for the result table. More...
 
const string CREATE_INDEXES = "create_indexes"
 Comma-separated list of columns on which to create indexes on the result table. More...
 
const string VIEW_ID = "view_id"
 ID of view of which the result table will be a member. More...
 
const string MATERIALIZE_ON_GPU = "materialize_on_gpu"
 No longer used. More...
 
const string PIVOT = "pivot"
 pivot column More...
 
const string PIVOT_VALUES = "pivot_values"
 The value list provided will become the column headers in the output. More...
 
const string GROUPING_SETS = "grouping_sets"
 Customize the grouping attribute sets to compute the aggregates. More...
 
const string ROLLUP = "rollup"
 This option is used to specify the multilevel aggregates. More...
 
const string CUBE = "cube"
 This option is used to specify the multidimensional aggregates. 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.
  • EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  • HAVING: Filter expression to apply to the aggregated results.
  • SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. Supported values:
    • ASCENDING: Indicates that the returned values should be sorted in ascending order.
    • DESCENDING: Indicates that the returned values should be sorted in descending order.
    The default value is ASCENDING.
  • SORT_BY: String determining how the results are sorted. Supported values:
    • KEY: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
    • VALUE: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
    The default value is VALUE.
  • RESULT_TABLE: The name of the table used to store the results. Has the same naming restrictions as tables. Column names (group-by and aggregate fields) need to be given aliases e.g. ["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
  • 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.
  • RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values: The default value is FALSE.
  • RESULT_TABLE_GENERATE_PK: If true then set a primary key for the result table. Must be used in combination with the result_table option. Supported values: The default value is FALSE.
  • TTL: Sets the TTL of the table specified in result_table.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
  • CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the result_table option.
  • VIEW_ID: ID of view of which the result table will be a member. The default value is ''.
  • MATERIALIZE_ON_GPU: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values: The default value is FALSE.
  • PIVOT: pivot column
  • PIVOT_VALUES: The value list provided will become the column headers in the output. Should be the values from the pivot_column.
  • GROUPING_SETS: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operartors. The attribute sets should be enclosed in paranthesis and can include composite attributes. All attributes specified in the grouping sets must present in the groupby attributes.
  • ROLLUP: This option is used to specify the multilevel aggregates.
  • CUBE: This option is used to specify the multidimensional aggregates.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 358 of file AggregateGroupBy.cs.

Member Data Documentation

const string kinetica.AggregateGroupByRequest.Options.ASCENDING = "ascending"

Indicates that the returned values should be sorted in ascending order.

Definition at line 398 of file AggregateGroupBy.cs.

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

Indicates the number of records per chunk to be used for the result table.

Must be used in combination with the result_table option.

Definition at line 520 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.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 365 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.CREATE_INDEXES = "create_indexes"

Comma-separated list of columns on which to create indexes on the result table.

Must be used in combination with the result_table option.

Definition at line 525 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.CUBE = "cube"

This option is used to specify the multidimensional aggregates.

Definition at line 575 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.DESCENDING = "descending"

Indicates that the returned values should be sorted in descending order.

Definition at line 402 of file AggregateGroupBy.cs.

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

Filter expression to apply to the table prior to computing the aggregate group by.

Definition at line 369 of file AggregateGroupBy.cs.

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

Definition at line 474 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.GROUPING_SETS = "grouping_sets"

Customize the grouping attribute sets to compute the aggregates.

These sets can include ROLLUP or CUBE operartors. The attribute sets should be enclosed in paranthesis and can include composite attributes. All attributes specified in the grouping sets must present in the groupby attributes.

Definition at line 567 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.HAVING = "having"

Filter expression to apply to the aggregated results.

Definition at line 373 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.KEY = "key"

Indicates that the returned values should be sorted by key, which corresponds to the grouping columns.

If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.

Definition at line 435 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.MATERIALIZE_ON_GPU = "materialize_on_gpu"

No longer used.

See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:

The default value is FALSE.

Definition at line 552 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.PIVOT = "pivot"

pivot column

Definition at line 555 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.PIVOT_VALUES = "pivot_values"

The value list provided will become the column headers in the output.

Should be the values from the pivot_column.

Definition at line 560 of file AggregateGroupBy.cs.

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

The name of the table used to store the results.

Has the same naming restrictions as tables. Column names (group-by and aggregate fields) need to be given aliases e.g. ["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.

Definition at line 452 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"

Force the result table to be replicated (ignores any sharding).

Must be used in combination with the result_table option. Supported values:

The default value is FALSE.

Definition at line 492 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE_GENERATE_PK = "result_table_generate_pk"

If true then set a primary key for the result table.

Must be used in combination with the result_table option. Supported values:

The default value is FALSE.

Definition at line 510 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.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 472 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.ROLLUP = "rollup"

This option is used to specify the multilevel aggregates.

Definition at line 571 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.SORT_BY = "sort_by"

String determining how the results are sorted.

Supported values:

  • KEY: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
  • VALUE: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.

The default value is VALUE.

Definition at line 428 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.SORT_ORDER = "sort_order"

String indicating how the returned values should be sorted - ascending or descending.

Supported values:

  • ASCENDING: Indicates that the returned values should be sorted in ascending order.
  • DESCENDING: Indicates that the returned values should be sorted in descending order.

The default value is ASCENDING.

Definition at line 394 of file AggregateGroupBy.cs.

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

Definition at line 473 of file AggregateGroupBy.cs.

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

Sets the TTL of the table specified in result_table.

Definition at line 515 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.VALUE = "value"

Indicates that the returned values should be sorted by value, which corresponds to the aggregates.

If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.

Definition at line 442 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.VIEW_ID = "view_id"

ID of view of which the result table will be a member.

The default value is ''.

Definition at line 529 of file AggregateGroupBy.cs.

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