> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.FilterByValueRequest > kinetica.FilterByValueRequest — Kinetica C# API

A set of parameters for Kinetica.filterByValue. More...

Inheritance diagram for kinetica.FilterByValueRequest:
Collaboration diagram for kinetica.FilterByValueRequest:

Classes
struct   Options
  A set of string constants for the parameter FilterByValueRequest.options. More...
 

Public Member Functions
  FilterByValueRequest ()
  Constructs a FilterByValueRequest object with default parameters.
 
  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.
 
  FilterByValueRequest ()
  Constructs a FilterByValueRequest object with default parameters.
 
  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.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of an existing table on which to perform the calculation, in \[schema\_name.
 
string  view\_name = "" \[get, set]
  If provided, then this will be the name of the view containing the results, in \[schema\_name.
 
bool  is\_string \[get, set]
  Indicates whether the value being searched for is string or numeric.
 
double  \_value = 0 \[get, set]
  The value to search for.
 
string  value\_str = "" \[get, set]
  The string value to search for.
 
string  column\_name \[get, set]
  Name of a column on which the filter by value would be applied.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.filterByValue.

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

Constructor & Destructor Documentation

◆ FilterByValueRequest() \[1/4]

kinetica.FilterByValueRequest.FilterByValueRequest ( )
inline

Constructs a FilterByValueRequest object with default parameters.

Definition at line 157 of file FilterByValue.cs.

◆ FilterByValueRequest() \[2/4]

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 view\_name . 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: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use Kinetica.createSchema 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 225 of file FilterByValue.cs.

◆ FilterByValueRequest() \[3/4]

kinetica.FilterByValueRequest.FilterByValueRequest ( )
inline

Constructs a FilterByValueRequest object with default parameters.

Definition at line 157 of file FilterByValue.cs.

◆ FilterByValueRequest() \[4/4]

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 view\_name . 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: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use Kinetica.createSchema 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 225 of file FilterByValue.cs.

Property Documentation

◆ \_value

double kinetica.FilterByValueRequest.\_value = 0
getset

The value to search for.

The default value is 0.

Definition at line 98 of file FilterByValue.cs.

◆ column\_name

string kinetica.FilterByValueRequest.column\_name
getset

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

Definition at line 106 of file FilterByValue.cs.

◆ is\_string

bool kinetica.FilterByValueRequest.is\_string
getset

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

Definition at line 94 of file FilterByValue.cs.

◆ options

IDictionary\< string, string > kinetica.FilterByValueRequest.options = new Dictionary\()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 153 of file FilterByValue.cs.

◆ table\_name

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

◆ value\_str

string kinetica.FilterByValueRequest.value\_str = ""
getset

The string value to search for.

The default value is ''.

Definition at line 102 of file FilterByValue.cs.

◆ view\_name

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

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