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, in [schema_name. More...

string	view_name `[get, set]`
	If provided, then this will be the name of the view containing the results, in [schema_name. 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 30 of file Filter.cs.

Constructor & Destructor Documentation

kinetica.FilterRequest.FilterRequest ( )

inline

Constructs a FilterRequest object with default parameters.

Definition at line 203 of file Filter.cs.

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, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view_name	If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
expression	The select expression to filter the specified table. For details see Expressions.
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 . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of and use /create/schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created. 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 275 of file Filter.cs.

Property Documentation

string kinetica.FilterRequest.expression = ""

getset

The select expression to filter the specified table.

For details see Expressions.

Definition at line 147 of file Filter.cs.

IDictionary<string, string> kinetica.FilterRequest.options

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 . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values:
- TRUE
- FALSE
The default value is FALSE.
COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of and use /create/schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
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 198 of file Filter.cs.

string kinetica.FilterRequest.table_name

getset

Name of the table to filter, in [schema_name.

]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).

Definition at line 133 of file Filter.cs.

string kinetica.FilterRequest.view_name

getset

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

]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.

Definition at line 142 of file Filter.cs.

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

Kinetica/Protocol/Filter.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation