> ## 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. # filterByBox

◆ filterByBox() \[1/2]

FilterByBoxResponse kinetica.Kinetica.filterByBox ( FilterByBoxRequest request\_ )
inline

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 view\_name is passed in as part of the input payload.

Parameters
request\_ Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 36936 of file KineticaFunctions.cs.

◆ filterByBox() \[2/2]

FilterByBoxResponse kinetica.Kinetica.filterByBox ( 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

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 view\_name is passed in as part of the input payload.

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 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.
Returns
Response object containing the result of the operation.

Definition at line 37047 of file KineticaFunctions.cs.

◆ FilterByBoxAsync() \[1/2]

async System.Threading.Tasks.Task\< FilterByBoxResponse > kinetica.Kinetica.FilterByBoxAsync ( FilterByBoxRequest request\_,
System.Threading.CancellationToken cancellationToken = default )
inline

Calculates how many objects within the given table lie in a rectangular box.

(async)

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 view\_name is passed in as part of the input payload.

Parameters
request\_ Request object containing the parameters for the operation.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 36959 of file KineticaFunctions.cs.

◆ FilterByBoxAsync() \[2/2]

async System.Threading.Tasks.Task\< FilterByBoxResponse > kinetica.Kinetica.FilterByBoxAsync ( 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,
System.Threading.CancellationToken cancellationToken = default )
inline

Calculates how many objects within the given table lie in a rectangular box.

(async)

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 view\_name is passed in as part of the input payload.

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 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.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 37144 of file KineticaFunctions.cs.