Skip to main content
filter_by_box_geometry(table_name=None, view_name=”, column_name=None, min_x=None, max_x=None, min_y=None, max_y=None, options=)[source]

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 input parameter view_name is passed in as part of the input payload.

Parameters

table_name (str) –

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 (str) –

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 (str) –

Name of the geospatial geometry column to be filtered.

min_x (float) –

Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to input parameter max_x.

max_x (float) –

Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to input parameter min_x.

min_y (float) –

Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to input parameter max_y.

max_y (float) –

Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to input parameter min_y.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • create_temp_table – 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. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • collection_name – [DEPRECATED–please specify the containing schema for the view as part of input parameter view_name and use GPUdb.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.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

count (long) –

The number of records passing the box filter.

info (dict of str to str) –

Additional information. Allowed keys are:

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

The default value is an empty dict ( ).