kinetica.FilterRequest Class Reference

A set of parameters for Kinetica.filter(string,string,string,IDictionary<string, string>). More...

Inheritance diagram for kinetica.FilterRequest:

Collaboration diagram for kinetica.FilterRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	FilterRequest ()
	Constructs a FilterRequest object with default parameters. More...
	FilterRequest (string table_name, string view_name, string expression, IDictionary< string, string > options=null)
	Constructs a FilterRequest 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 to filter. More...
string	view_name [get, set]
	If provided, then this will be the name of the view containing the results. More...
string	expression = "" [get, set]
	The select expression to filter the specified table. More...
IDictionary< string, string >	options [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.filter(string,string,string,IDictionary<string, string>).

Filters data based on the specified expression. The results are stored in a result set with the given view_name.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Definition at line 28 of file Filter.cs.

Constructor & Destructor Documentation

FilterRequest() [1/2]

kinetica.FilterRequest.FilterRequest ( )

inline

Constructs a FilterRequest object with default parameters.

Definition at line 127 of file Filter.cs.

FilterRequest() [2/2]

kinetica.FilterRequest.FilterRequest ( string  table_name, string  view_name, string  expression, IDictionary< string, string >  options = null  )

inline

Constructs a FilterRequest object with the specified parameters.

Parameters

table_name	Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by .
view_name	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
expression	The select expression to filter the specified table. For details see Expressions.
options	Optional parameters. COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level. VIEW_ID: view this filtered-view is part of. The default value is ''. TTL: Sets the TTL of the view specified in . The default value is an empty Dictionary.

Definition at line 172 of file Filter.cs.

Property Documentation

expression

string kinetica.FilterRequest.expression = ""

getset

The select expression to filter the specified table.

For details see Expressions.

Definition at line 95 of file Filter.cs.

options

IDictionary<string, string> kinetica.FilterRequest.options

getset

Optional parameters.

• COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
• VIEW_ID: view this filtered-view is part of. The default value is ''.
• TTL: Sets the TTL of the view specified in .

The default value is an empty Dictionary.

Definition at line 122 of file Filter.cs.

table_name

string kinetica.FilterRequest.table_name

getset

Name of the table to filter.

This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by .

Definition at line 84 of file Filter.cs.

view_name

string kinetica.FilterRequest.view_name

getset

If provided, then this will be the name of the view containing the results.

Has the same naming restrictions as tables. The default value is ''.

Definition at line 90 of file Filter.cs.

---

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

• Kinetica/Protocol/Filter.cs