Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Classes | Public Member Functions | Properties | List of all members
kinetica.AggregateUniqueRequest Class Reference

A set of parameters for Kinetica.aggregateUnique(string,string,long,long,IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.AggregateUniqueRequest:
+ Collaboration diagram for kinetica.AggregateUniqueRequest:

Classes

struct  Encoding
 Specifies the encoding for returned records. More...
 
struct  Options
 Optional parameters. More...
 

Public Member Functions

 AggregateUniqueRequest ()
 Constructs an AggregateUniqueRequest object with default parameters. More...
 
 AggregateUniqueRequest (string table_name, string column_name, long?offset=null, long?limit=null, IDictionary< string, string > options=null)
 Constructs an AggregateUniqueRequest object with the specified parameters. More...
 
 AggregateUniqueRequest (string table_name, string column_name, long?offset=null, long?limit=null, string encoding=null, IDictionary< string, string > options=null)
 Constructs an AggregateUniqueRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string table_name [get, set]
 Name of an existing table or view on which the operation will be performed. More...
 
string column_name [get, set]
 Name of the column or an expression containing one or more column names on which the unique function would be applied. More...
 
long offset [get, set]
 A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). More...
 
long limit = 0 [get, set]
 A positive integer indicating the maximum number of results to be returned. More...
 
string encoding = -9999 [get, set]
 Specifies the encoding for returned records. More...
 
IDictionary< string, string > options = Encoding.BINARY [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.aggregateUnique(string,string,long,long,IDictionary{string, string}).


Returns all the unique values from a particular column (specified by column_name) of a particular table or view (specified by table_name). If column_name is a numeric column the values will be in <member name="binary_encoded_response">. Otherwise if column_name is a string column the values will be in <member name="json_encoded_response">. The results can be paged via the offset and limit parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options would be::
{"limit":"10","sort_order":"descending"}.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the column_name, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of column_name is an unrestricted-length string.

Definition at line 52 of file AggregateUnique.cs.

Constructor & Destructor Documentation

kinetica.AggregateUniqueRequest.AggregateUniqueRequest ( )
inline

Constructs an AggregateUniqueRequest object with default parameters.

Definition at line 516 of file AggregateUnique.cs.

kinetica.AggregateUniqueRequest.AggregateUniqueRequest ( string  table_name,
string  column_name,
long?  offset = null,
long?  limit = null,
IDictionary< string, string >  options = null 
)
inline

Constructs an AggregateUniqueRequest object with the specified parameters.

Parameters
table_nameName of an existing table or view on which the operation will be performed.
column_nameName of the column or an expression containing one or more column names on which the unique function would be applied.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999.
optionsOptional 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: Optional filter expression to apply to the table.
  • SORT_ORDER: String indicating how the returned values should be sorted. Supported values: The default value is ASCENDING.
  • RESULT_TABLE: The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. Not available if is an unrestricted-length string.
  • 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.
  • VIEW_ID: ID of view of which the result table will be a member. The default value is ''.
The default value is an empty Dictionary.

Definition at line 671 of file AggregateUnique.cs.

kinetica.AggregateUniqueRequest.AggregateUniqueRequest ( string  table_name,
string  column_name,
long?  offset = null,
long?  limit = null,
string  encoding = null,
IDictionary< string, string >  options = null 
)
inline

Constructs an AggregateUniqueRequest object with the specified parameters.

Parameters
table_nameName of an existing table or view on which the operation will be performed.
column_nameName of the column or an expression containing one or more column names on which the unique function would be applied.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999.
encodingSpecifies the encoding for returned records. Supported values:
  • BINARY: Indicates that the returned records should be binary encoded.
  • JSON: Indicates that the returned records should be json encoded.
The default value is BINARY.
optionsOptional 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: Optional filter expression to apply to the table.
  • SORT_ORDER: String indicating how the returned values should be sorted. Supported values: The default value is ASCENDING.
  • RESULT_TABLE: The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. Not available if is an unrestricted-length string.
  • 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.
  • VIEW_ID: ID of view of which the result table will be a member. The default value is ''.
The default value is an empty Dictionary.

Definition at line 858 of file AggregateUnique.cs.

Property Documentation

string kinetica.AggregateUniqueRequest.column_name
getset

Name of the column or an expression containing one or more column names on which the unique function would be applied.

Definition at line 340 of file AggregateUnique.cs.

string kinetica.AggregateUniqueRequest.encoding = -9999
getset

Specifies the encoding for returned records.

Supported values:

  • BINARY: Indicates that the returned records should be binary encoded.
  • JSON: Indicates that the returned records should be json encoded.

The default value is BINARY.

Definition at line 380 of file AggregateUnique.cs.

long kinetica.AggregateUniqueRequest.limit = 0
getset

A positive integer indicating the maximum number of results to be returned.

Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999.

Definition at line 359 of file AggregateUnique.cs.

long kinetica.AggregateUniqueRequest.offset
getset

A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Definition at line 346 of file AggregateUnique.cs.

IDictionary<string, string> kinetica.AggregateUniqueRequest.options = Encoding.BINARY
getset

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: Optional filter expression to apply to the table.
  • SORT_ORDER: String indicating how the returned values should be sorted. Supported values: The default value is ASCENDING.
  • RESULT_TABLE: The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. Not available if is an unrestricted-length string.
  • 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.
  • VIEW_ID: ID of view of which the result table will be a member. The default value is ''.

The default value is an empty Dictionary.

Definition at line 511 of file AggregateUnique.cs.

string kinetica.AggregateUniqueRequest.table_name
getset

Name of an existing table or view on which the operation will be performed.

Definition at line 335 of file AggregateUnique.cs.

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