/filter/byarea - Kinetica Docs

URL: http://<db.host>:<db.port>/filter/byarea

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

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).

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 ”.

string

Name of the column containing the x values to be filtered.

array of doubles

List of x coordinates of the vertices of the polygon representing the area to be filtered.

string

Name of the column containing the y values to be filtered.

array of doubles

List of y coordinates of the vertices of the polygon representing the area to be filtered.

map of string to strings

Optional parameters.The default value is an empty map ( {} ).

Show options

If true, a unique temporary table name will be generated in the sys_temp schema and used in place of input parameter 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.The default value is false.The supported values are:

true
false

[DEPRECATED—please specify the containing schema for the view as part of input parameter view_name and use /create/schema 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.

Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘filter_by_area_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

This embedded JSON represents the result of the /filter/byarea endpoint:

Show data_str

long

The number of records passing the area filter.

map of string to strings

Additional information.The default value is an empty map ( {} ).

Show info

The fully qualified name of the view (i.e. including the schema).

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description