> ## 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.FilterByRangeRequest > kinetica.FilterByRangeRequest — Kinetica C# API

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

Inheritance diagram for kinetica.FilterByRangeRequest:
Collaboration diagram for kinetica.FilterByRangeRequest:

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

Public Member Functions
  FilterByRangeRequest ()
  Constructs a FilterByRangeRequest object with default parameters.
 
  FilterByRangeRequest (string table\_name, string view\_name, string column\_name, double lower\_bound, double upper\_bound, IDictionary\< string, string > options=null)
  Constructs a FilterByRangeRequest object with the specified parameters.
 
  FilterByRangeRequest ()
  Constructs a FilterByRangeRequest object with default parameters.
 
  FilterByRangeRequest (string table\_name, string view\_name, string column\_name, double lower\_bound, double upper\_bound, IDictionary\< string, string > options=null)
  Constructs a FilterByRangeRequest 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 the table on which the filter by range operation will be performed, 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.
 
string  column\_name \[get, set]
  Name of a column on which the operation would be applied.
 
double  lower\_bound \[get, set]
  Value of the lower bound (inclusive).
 
double  upper\_bound \[get, set]
  Value of the upper bound (inclusive).
 
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.filterByRange.

Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by FilterByRangeRequest.table\_name is added to the view FilterByRangeRequest.view\_name if its column is within \[FilterByRangeRequest.lower\_bound, FilterByRangeRequest.upper\_bound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Definition at line 27 of file FilterByRange.cs.

Constructor & Destructor Documentation

◆ FilterByRangeRequest() \[1/4]

kinetica.FilterByRangeRequest.FilterByRangeRequest ( )
inline

Constructs a FilterByRangeRequest object with default parameters.

Definition at line 155 of file FilterByRange.cs.

◆ FilterByRangeRequest() \[2/4]

kinetica.FilterByRangeRequest.FilterByRangeRequest ( string table\_name,
string view\_name,
string column\_name,
double lower\_bound,
double upper\_bound,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByRangeRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the filter by range operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
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 ''.
column\_name Name of a column on which the operation would be applied.
lower\_bound Value of the lower bound (inclusive).
upper\_bound Value of the upper bound (inclusive).
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 220 of file FilterByRange.cs.

◆ FilterByRangeRequest() \[3/4]

kinetica.FilterByRangeRequest.FilterByRangeRequest ( )
inline

Constructs a FilterByRangeRequest object with default parameters.

Definition at line 155 of file FilterByRange.cs.

◆ FilterByRangeRequest() \[4/4]

kinetica.FilterByRangeRequest.FilterByRangeRequest ( string table\_name,
string view\_name,
string column\_name,
double lower\_bound,
double upper\_bound,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByRangeRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the filter by range operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
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 ''.
column\_name Name of a column on which the operation would be applied.
lower\_bound Value of the lower bound (inclusive).
upper\_bound Value of the upper bound (inclusive).
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 220 of file FilterByRange.cs.

Property Documentation

◆ column\_name

string kinetica.FilterByRangeRequest.column\_name
getset

Name of a column on which the operation would be applied.

Definition at line 98 of file FilterByRange.cs.

◆ lower\_bound

double kinetica.FilterByRangeRequest.lower\_bound
getset

Value of the lower bound (inclusive).

Definition at line 101 of file FilterByRange.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 151 of file FilterByRange.cs.

◆ table\_name

string kinetica.FilterByRangeRequest.table\_name
getset

Name of the table on which the filter by range operation will be performed, in \[schema\_name.

]table\_name format, using standard name resolution rules.

Must be an existing table.

Definition at line 84 of file FilterByRange.cs.

◆ upper\_bound

double kinetica.FilterByRangeRequest.upper\_bound
getset

Value of the upper bound (inclusive).

Definition at line 104 of file FilterByRange.cs.

◆ view\_name

string kinetica.FilterByRangeRequest.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 94 of file FilterByRange.cs.

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