A set of parameters for /aggregate/unique. 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, long limit=10000, IDictionary< string, string > options=null)
	Constructs an AggregateUniqueRequest object with the specified parameters. More...

	AggregateUniqueRequest (string table_name, string column_name, long offset, long limit=10000, 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 the table 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 `[get, set]`
	A positive integer indicating the maximum number of results to be returned. More...

string	encoding = 10000 `[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 /aggregate/unique.

Returns all the unique values from a particular column (specified by <member name="column_name">) of a particular table (specified by <member name="table_name">). If <member name="column_name"> is a numeric column the values will be in <member name="binary_encoded_response">. Otherwise if <member name="column_name"> is a string column the values will be in <member name="json_encoded_response">. The results can be paged via the <member name="offset"> and <member name="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 <member name="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 <member name="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 <member name="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 when the value of <member name="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 245 of file AggregateUnique.cs.

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

inline

Constructs an AggregateUniqueRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the operation will be performed. Must be an existing table.
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 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 max number of results should be returned.
options	Optional parameters. collection_name Name of a collection which is to contain the table specified in 'result_table', otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail. expression Optional filter expression to apply to the table. sort_order String indicating how the returned values should be sorted. Values: ascending, descending. 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. result_table_persist If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false (the default) then the result table will be a read-only, memory-only temporary table. Values: true, false. ttl Sets the TTL of the table specified in 'result_table'. The value must be the desired TTL in minutes.

Definition at line 310 of file AggregateUnique.cs.

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

inline

Constructs an AggregateUniqueRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the operation will be performed. Must be an existing table.
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 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 max number of results should be returned.
encoding	Specifies the encoding for returned records. Values: binary, json.
options	Optional parameters. collection_name Name of a collection which is to contain the table specified in 'result_table', otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail. expression Optional filter expression to apply to the table. sort_order String indicating how the returned values should be sorted. Values: ascending, descending. 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. result_table_persist If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false (the default) then the result table will be a read-only, memory-only temporary table. Values: true, false. ttl Sets the TTL of the table specified in 'result_table'. The value must be the desired TTL in minutes.

Definition at line 391 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 175 of file AggregateUnique.cs.

string kinetica.AggregateUniqueRequest.encoding = 10000

getset

Specifies the encoding for returned records.

Values: binary, json.

Definition at line 191 of file AggregateUnique.cs.

long kinetica.AggregateUniqueRequest.limit

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.

Definition at line 186 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 minimum allowed value is 0. The maximum allowed value is MAX_INT.

Definition at line 181 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', otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.
expression Optional filter expression to apply to the table.
sort_order String indicating how the returned values should be sorted. Values: ascending, descending.
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.
result_table_persist If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false (the default) then the result table will be a read-only, memory-only temporary table. Values: true, false.
ttl Sets the TTL of the table specified in 'result_table'. The value must be the desired TTL in minutes.

Definition at line 240 of file AggregateUnique.cs.

string kinetica.AggregateUniqueRequest.table_name

getset

Name of the table on which the operation will be performed.

Must be an existing table.

Definition at line 170 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

Property Documentation