Skip to main content

​
◆ filterByArea() [1/2]

FilterByAreaResponse kinetica.Kinetica.filterByArea (FilterByAreaRequestrequest_)
 inline

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 36488 of file KineticaFunctions.cs.

​
◆ filterByArea() [2/2]

FilterByAreaResponse kinetica.Kinetica.filterByArea (stringtable_name,
stringview_name,
stringx_column_name,
IList< double >x_vector,
stringy_column_name,
IList< double >y_vector,
IDictionary< string, string >options = null )
 inline

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.

Parameters
table_nameName of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view_nameIf 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_nameName of the column containing the x values to be filtered.
x_vectorList of x coordinates of the vertices of the polygon representing the area to be filtered.
y_column_nameName of the column containing the y values to be filtered.
y_vectorList of y coordinates of the vertices of the polygon representing the area to be filtered.
optionsOptional 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 provided 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 36594 of file KineticaFunctions.cs.

​
◆ FilterByAreaAsync() [1/2]

async System.Threading.Tasks.Task< FilterByAreaResponse > kinetica.Kinetica.FilterByAreaAsync (FilterByAreaRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Calculates which objects from a table are within a named area of interest (NAI/polygon).

(async)

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 36511 of file KineticaFunctions.cs.

​
◆ FilterByAreaAsync() [2/2]

async System.Threading.Tasks.Task< FilterByAreaResponse > kinetica.Kinetica.FilterByAreaAsync (stringtable_name,
stringview_name,
stringx_column_name,
IList< double >x_vector,
stringy_column_name,
IList< double >y_vector,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Calculates which objects from a table are within a named area of interest (NAI/polygon).

(async)

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.

Parameters
table_nameName of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view_nameIf 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_nameName of the column containing the x values to be filtered.
x_vectorList of x coordinates of the vertices of the polygon representing the area to be filtered.
y_column_nameName of the column containing the y values to be filtered.
y_vectorList of y coordinates of the vertices of the polygon representing the area to be filtered.
optionsOptional 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 provided is non-existent, it will be automatically created.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 36684 of file KineticaFunctions.cs.