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

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

Inheritance diagram for kinetica.FilterByBoxRequest:
Collaboration diagram for kinetica.FilterByBoxRequest:

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

Public Member Functions
  FilterByBoxRequest ()
  Constructs a FilterByBoxRequest object with default parameters.
 
  FilterByBoxRequest (string table\_name, string view\_name, string x\_column\_name, double min\_x, double max\_x, string y\_column\_name, double min\_y, double max\_y, IDictionary\< string, string > options=null)
  Constructs a FilterByBoxRequest object with the specified parameters.
 
  FilterByBoxRequest ()
  Constructs a FilterByBoxRequest object with default parameters.
 
  FilterByBoxRequest (string table\_name, string view\_name, string x\_column\_name, double min\_x, double max\_x, string y\_column\_name, double min\_y, double max\_y, IDictionary\< string, string > options=null)
  Constructs a FilterByBoxRequest 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 bounding box 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  x\_column\_name \[get, set]
  Name of the column on which to perform the bounding box query.
 
double  min\_x \[get, set]
  Lower bound for the column chosen by FilterByBoxRequest.x\_column\_name.
 
double  max\_x \[get, set]
  Upper bound for FilterByBoxRequest.x\_column\_name.
 
string  y\_column\_name \[get, set]
  Name of a column on which to perform the bounding box query.
 
double  min\_y \[get, set]
  Lower bound for FilterByBoxRequest.y\_column\_name.
 
double  max\_y \[get, set]
  Upper bound for FilterByBoxRequest.y\_column\_name.
 
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.filterByBox.

Calculates how many objects within the given table lie in a rectangular box. 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 resultant set which satisfies the input NAI restriction specification is also created when a FilterByBoxRequest.view\_name is passed in as part of the input payload.

Definition at line 21 of file FilterByBox.cs.

Constructor & Destructor Documentation

◆ FilterByBoxRequest() \[1/4]

kinetica.FilterByBoxRequest.FilterByBoxRequest ( )
inline

Constructs a FilterByBoxRequest object with default parameters.

Definition at line 171 of file FilterByBox.cs.

◆ FilterByBoxRequest() \[2/4]

kinetica.FilterByBoxRequest.FilterByBoxRequest ( string table\_name,
string view\_name,
string x\_column\_name,
double min\_x,
double max\_x,
string y\_column\_name,
double min\_y,
double max\_y,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByBoxRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the bounding box 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 ''.
x\_column\_name Name of the column on which to perform the bounding box query. Must be a valid numeric column.
min\_x Lower bound for the column chosen by x\_column\_name . Must be less than or equal to max\_x .
max\_x Upper bound for x\_column\_name . Must be greater than or equal to min\_x .
y\_column\_name Name of a column on which to perform the bounding box query. Must be a valid numeric column.
min\_y Lower bound for y\_column\_name . Must be less than or equal to max\_y .
max\_y Upper bound for y\_column\_name . Must be greater than or equal to min\_y .
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 245 of file FilterByBox.cs.

◆ FilterByBoxRequest() \[3/4]

kinetica.FilterByBoxRequest.FilterByBoxRequest ( )
inline

Constructs a FilterByBoxRequest object with default parameters.

Definition at line 171 of file FilterByBox.cs.

◆ FilterByBoxRequest() \[4/4]

kinetica.FilterByBoxRequest.FilterByBoxRequest ( string table\_name,
string view\_name,
string x\_column\_name,
double min\_x,
double max\_x,
string y\_column\_name,
double min\_y,
double max\_y,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByBoxRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the bounding box 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 ''.
x\_column\_name Name of the column on which to perform the bounding box query. Must be a valid numeric column.
min\_x Lower bound for the column chosen by x\_column\_name . Must be less than or equal to max\_x .
max\_x Upper bound for x\_column\_name . Must be greater than or equal to min\_x .
y\_column\_name Name of a column on which to perform the bounding box query. Must be a valid numeric column.
min\_y Lower bound for y\_column\_name . Must be less than or equal to max\_y .
max\_y Upper bound for y\_column\_name . Must be greater than or equal to min\_y .
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 245 of file FilterByBox.cs.

Property Documentation

◆ max\_x

double kinetica.FilterByBoxRequest.max\_x
getset

Upper bound for FilterByBoxRequest.x\_column\_name.

Must be greater than or equal to FilterByBoxRequest.min\_x.

Definition at line 103 of file FilterByBox.cs.

◆ max\_y

double kinetica.FilterByBoxRequest.max\_y
getset

Upper bound for FilterByBoxRequest.y\_column\_name.

Must be greater than or equal to FilterByBoxRequest.min\_y.

Definition at line 120 of file FilterByBox.cs.

◆ min\_x

double kinetica.FilterByBoxRequest.min\_x
getset

Lower bound for the column chosen by FilterByBoxRequest.x\_column\_name.

Must be less than or equal to FilterByBoxRequest.max\_x.

Definition at line 97 of file FilterByBox.cs.

◆ min\_y

double kinetica.FilterByBoxRequest.min\_y
getset

Lower bound for FilterByBoxRequest.y\_column\_name.

Must be less than or equal to FilterByBoxRequest.max\_y.

Definition at line 114 of file FilterByBox.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 167 of file FilterByBox.cs.

◆ table\_name

string kinetica.FilterByBoxRequest.table\_name
getset

Name of the table on which the bounding box operation will be performed, in \[schema\_name.

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

Must be an existing table.

Definition at line 76 of file FilterByBox.cs.

◆ view\_name

string kinetica.FilterByBoxRequest.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 86 of file FilterByBox.cs.

◆ x\_column\_name

string kinetica.FilterByBoxRequest.x\_column\_name
getset

Name of the column on which to perform the bounding box query.

Must be a valid numeric column.

Definition at line 91 of file FilterByBox.cs.

◆ y\_column\_name

string kinetica.FilterByBoxRequest.y\_column\_name
getset

Name of a column on which to perform the bounding box query.

Must be a valid numeric column.

Definition at line 108 of file FilterByBox.cs.

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