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

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

Inheritance diagram for kinetica.FilterByBoxGeometryRequest:
Collaboration diagram for kinetica.FilterByBoxGeometryRequest:

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

Public Member Functions
  FilterByBoxGeometryRequest ()
  Constructs a FilterByBoxGeometryRequest object with default parameters.
 
  FilterByBoxGeometryRequest (string table\_name, string view\_name, string column\_name, double min\_x, double max\_x, double min\_y, double max\_y, IDictionary\< string, string > options=null)
  Constructs a FilterByBoxGeometryRequest object with the specified parameters.
 
  FilterByBoxGeometryRequest ()
  Constructs a FilterByBoxGeometryRequest object with default parameters.
 
  FilterByBoxGeometryRequest (string table\_name, string view\_name, string column\_name, double min\_x, double max\_x, double min\_y, double max\_y, IDictionary\< string, string > options=null)
  Constructs a FilterByBoxGeometryRequest 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  column\_name \[get, set]
  Name of the geospatial geometry column to be filtered.
 
double  min\_x \[get, set]
  Lower bound for the x-coordinate of the rectangular box.
 
double  max\_x \[get, set]
  Upper bound for the x-coordinate of the rectangular box.
 
double  min\_y \[get, set]
  Lower bound for the y-coordinate of the rectangular box.
 
double  max\_y \[get, set]
  Upper bound for the y-coordinate of the rectangular box.
 
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.filterByBoxGeometry.

Calculates which geospatial geometry objects from a table intersect 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 FilterByBoxGeometryRequest.view\_name is passed in as part of the input payload.

Definition at line 21 of file FilterByBoxGeometry.cs.

Constructor & Destructor Documentation

◆ FilterByBoxGeometryRequest() \[1/4]

kinetica.FilterByBoxGeometryRequest.FilterByBoxGeometryRequest ( )
inline

Constructs a FilterByBoxGeometryRequest object with default parameters.

Definition at line 168 of file FilterByBoxGeometry.cs.

◆ FilterByBoxGeometryRequest() \[2/4]

kinetica.FilterByBoxGeometryRequest.FilterByBoxGeometryRequest ( string table\_name,
string view\_name,
string column\_name,
double min\_x,
double max\_x,
double min\_y,
double max\_y,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByBoxGeometryRequest 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 ''.
column\_name Name of the geospatial geometry column to be filtered.
min\_x Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to max\_x .
max\_x Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to min\_x .
min\_y Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to max\_y .
max\_y Upper bound for the y-coordinate of the rectangular box. 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 provided is non-existent, it will be automatically created.
The default value is an empty Dictionary.

Definition at line 241 of file FilterByBoxGeometry.cs.

◆ FilterByBoxGeometryRequest() \[3/4]

kinetica.FilterByBoxGeometryRequest.FilterByBoxGeometryRequest ( )
inline

Constructs a FilterByBoxGeometryRequest object with default parameters.

Definition at line 168 of file FilterByBoxGeometry.cs.

◆ FilterByBoxGeometryRequest() \[4/4]

kinetica.FilterByBoxGeometryRequest.FilterByBoxGeometryRequest ( string table\_name,
string view\_name,
string column\_name,
double min\_x,
double max\_x,
double min\_y,
double max\_y,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByBoxGeometryRequest 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 ''.
column\_name Name of the geospatial geometry column to be filtered.
min\_x Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to max\_x .
max\_x Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to min\_x .
min\_y Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to max\_y .
max\_y Upper bound for the y-coordinate of the rectangular box. 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 provided is non-existent, it will be automatically created.
The default value is an empty Dictionary.

Definition at line 241 of file FilterByBoxGeometry.cs.

Property Documentation

◆ column\_name

string kinetica.FilterByBoxGeometryRequest.column\_name
getset

Name of the geospatial geometry column to be filtered.

Definition at line 93 of file FilterByBoxGeometry.cs.

◆ max\_x

double kinetica.FilterByBoxGeometryRequest.max\_x
getset

Upper bound for the x-coordinate of the rectangular box.

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

Definition at line 105 of file FilterByBoxGeometry.cs.

◆ max\_y

double kinetica.FilterByBoxGeometryRequest.max\_y
getset

Upper bound for the y-coordinate of the rectangular box.

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

Definition at line 117 of file FilterByBoxGeometry.cs.

◆ min\_x

double kinetica.FilterByBoxGeometryRequest.min\_x
getset

Lower bound for the x-coordinate of the rectangular box.

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

Definition at line 99 of file FilterByBoxGeometry.cs.

◆ min\_y

double kinetica.FilterByBoxGeometryRequest.min\_y
getset

Lower bound for the y-coordinate of the rectangular box.

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

Definition at line 111 of file FilterByBoxGeometry.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 164 of file FilterByBoxGeometry.cs.

◆ table\_name

string kinetica.FilterByBoxGeometryRequest.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 79 of file FilterByBoxGeometry.cs.

◆ view\_name

string kinetica.FilterByBoxGeometryRequest.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 89 of file FilterByBoxGeometry.cs.

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