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, 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...
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 35 of file FilterByValue.cs.

Constructor & Destructor Documentation

kinetica.FilterByValueRequest.FilterByValueRequest ( )

inline

Constructs a FilterByValueRequest object with default parameters.

Definition at line 185 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, in [schema_name.]table_name format, using standard name resolution rules.
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 ''.
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. 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. The default value is an empty Dictionary.

Definition at line 248 of file FilterByValue.cs.

Property Documentation

double kinetica.FilterByValueRequest._value

getset

The value to search for.

The default value is 0.

Definition at line 133 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 141 of file FilterByValue.cs.

bool kinetica.FilterByValueRequest.is_string = ""

getset

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

Definition at line 129 of file FilterByValue.cs.

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

The default value is an empty Dictionary.

Definition at line 180 of file FilterByValue.cs.

string kinetica.FilterByValueRequest.table_name

getset

Name of an existing table on which to perform the calculation, in [schema_name.

]table_name format, using standard name resolution rules.

Definition at line 116 of file FilterByValue.cs.

string kinetica.FilterByValueRequest.value_str = 0

getset

The string value to search for.

The default value is ''.

Definition at line 137 of file FilterByValue.cs.

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

---

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

• Kinetica/Protocol/FilterByValue.cs