A set of parameters for Kinetica.aggregateUnique. More...

Inheritance diagram for kinetica.AggregateUniqueRequest:

Collaboration diagram for kinetica.AggregateUniqueRequest:

Classes
struct	Encoding
	A set of string constants for the parameter encoding. More...

struct	Options
	A set of string constants for the parameter options. 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, in [schema_name. 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 = 0 `[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 = -9999 `[get, set]`
	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. More...

string	encoding = Encoding.BINARY `[get, set]`
	Specifies the encoding for returned records. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[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.

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 data. Otherwise if column_name is a string column, the values will be in json_encoded_response. The results can be paged via 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 48 of file AggregateUnique.cs.

Constructor & Destructor Documentation

◆ AggregateUniqueRequest() [1/3]

kinetica.AggregateUniqueRequest.AggregateUniqueRequest ( )

inline

Constructs an AggregateUniqueRequest object with default parameters.

Definition at line 470 of file AggregateUnique.cs.

◆ AggregateUniqueRequest() [2/3]

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_name	Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
column_name	Name of the column or an expression containing one or more column names on which the unique function would be applied.
offset	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.
limit	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server 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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.
options	Optional parameters. CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema provided is non-existent, it will be automatically created. EXPRESSION: Optional filter expression to apply to the table. SORT_ORDER: String indicating how the returned values should be sorted. Supported values: ASCENDING DESCENDING The default value is ASCENDING. ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''. RESULT_TABLE: The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if column_name 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: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE 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. CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option. CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a 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 692 of file AggregateUnique.cs.

◆ AggregateUniqueRequest() [3/3]

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_name	Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
column_name	Name of the column or an expression containing one or more column names on which the unique function would be applied.
offset	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.
limit	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server 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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.
encoding	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.
options	Optional parameters. CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema provided is non-existent, it will be automatically created. EXPRESSION: Optional filter expression to apply to the table. SORT_ORDER: String indicating how the returned values should be sorted. Supported values: ASCENDING DESCENDING The default value is ASCENDING. ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''. RESULT_TABLE: The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if column_name 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: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE 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. CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option. CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a 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 942 of file AggregateUnique.cs.

Property Documentation

◆ column_name

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 231 of file AggregateUnique.cs.

◆ encoding

string kinetica.AggregateUniqueRequest.encoding = Encoding.BINARY

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 271 of file AggregateUnique.cs.

◆ limit

long kinetica.AggregateUniqueRequest.limit = -9999

getset

A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server 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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.

Definition at line 253 of file AggregateUnique.cs.

◆ offset

long kinetica.AggregateUniqueRequest.offset = 0

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 238 of file AggregateUnique.cs.

◆ options

IDictionary<string, string> kinetica.AggregateUniqueRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:
- TRUE
- FALSE
The default value is FALSE.
COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema provided is non-existent, it will be automatically created.
EXPRESSION: Optional filter expression to apply to the table.
SORT_ORDER: String indicating how the returned values should be sorted. Supported values:
- ASCENDING
- DESCENDING
The default value is ASCENDING.
ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.
RESULT_TABLE: The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if column_name 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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
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.
CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a 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 466 of file AggregateUnique.cs.

◆ table_name

string kinetica.AggregateUniqueRequest.table_name

getset

Name of an existing table or view on which the operation will be performed, in [schema_name.

]table_name format, using standard name resolution rules.

Definition at line 226 of file AggregateUnique.cs.

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

Kinetica/Protocol/AggregateUnique.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AggregateUniqueRequest() [1/3]

◆ AggregateUniqueRequest() [2/3]

◆ AggregateUniqueRequest() [3/3]

Property Documentation

◆ column_name

◆ encoding

◆ limit

◆ offset

◆ options

◆ table_name