kinetica.FilterByValueRequest Class Reference

A set of parameters for Kinetica.filterByValue(string,string,bool,double,string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.FilterByValueRequest:

Collaboration diagram for kinetica.FilterByValueRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	FilterByValueRequest ()
	Constructs a FilterByValueRequest object with default parameters. More...
	FilterByValueRequest (string table_name, string view_name, bool is_string, double?_value, string value_str, string column_name, IDictionary< string, string > options=null)
	Constructs a FilterByValueRequest 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 on which to perform the calculation. More...
string	view_name [get, set]
	If provided, then this will be the name of the view containing the results. More...
bool	is_string = "" [get, set]
	Indicates whether the value being searched for is string or numeric. More...
double	_value [get, set]
	The value to search for. More...
string	value_str = 0 [get, set]
	The string value to search for. More...
string	column_name = "" [get, set]
	Name of a column on which the filter by value would be applied. 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.filterByValue(string,string,bool,double,string,string,IDictionary{string, string}).

Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Definition at line 28 of file FilterByValue.cs.

Constructor & Destructor Documentation

kinetica.FilterByValueRequest.FilterByValueRequest ( )

inline

Constructs a FilterByValueRequest object with default parameters.

Definition at line 99 of file FilterByValue.cs.

kinetica.FilterByValueRequest.FilterByValueRequest ( string  table_name, string  view_name, bool  is_string, double?  _value, string  value_str, string  column_name, IDictionary< string, string >  options = null  )

inline

Constructs a FilterByValueRequest object with the specified parameters.

Parameters

table_name	Name of an existing table on which to perform the calculation.
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 ''.
is_string	Indicates whether the value being searched for is string or numeric.
_value	The value to search for. The default value is 0.
value_str	The string value to search for. The default value is ''.
column_name	Name of a column on which the filter by value would be applied.
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. The default value is an empty Dictionary.

Definition at line 131 of file FilterByValue.cs.

Property Documentation

double kinetica.FilterByValueRequest._value

getset

The value to search for.

The default value is 0.

Definition at line 72 of file FilterByValue.cs.

string kinetica.FilterByValueRequest.column_name = ""

getset

Name of a column on which the filter by value would be applied.

Definition at line 80 of file FilterByValue.cs.

bool kinetica.FilterByValueRequest.is_string = ""

getset

Indicates whether the value being searched for is string or numeric.

Definition at line 68 of file FilterByValue.cs.

IDictionary<string, string> kinetica.FilterByValueRequest.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.

The default value is an empty Dictionary.

Definition at line 94 of file FilterByValue.cs.

string kinetica.FilterByValueRequest.table_name

getset

Name of an existing table on which to perform the calculation.

Definition at line 58 of file FilterByValue.cs.

string kinetica.FilterByValueRequest.value_str = 0

getset

The string value to search for.

The default value is ''.

Definition at line 76 of file FilterByValue.cs.

string kinetica.FilterByValueRequest.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 64 of file FilterByValue.cs.

---

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

• Kinetica/Protocol/FilterByValue.cs