Note
This documentation is for a prior release of Kinetica. For the latest documentation, click here.
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 input parameter view_name passed in as part of the input.
Input Parameter Description
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| table_name | string | Name 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_name | string | 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 | string | Name of the column containing the x values to be filtered. | ||||||
| x_vector | array of doubles | List of x coordinates of the vertices of the polygon representing the area to be filtered. | ||||||
| y_column_name | string | Name of the column containing the y values to be filtered. | ||||||
| y_vector | array of doubles | List of y coordinates of the vertices of the polygon representing the area to be filtered. | ||||||
| options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
Output Parameter Description
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| count | long | The number of records passing the area filter. | ||||
| info | map of string to strings | Additional information. The default value is an empty map ( {} ).
|
