filter\_by\_geometry(table\_name=None, view\_name='', column\_name=None, input\_wkt='', operation=None, options={"{"}{"}"})\[source]

Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by input parameter input\_wkt.

Parameters

table\_name (str) –

Name of the table on which the filter by geometry will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.

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 column to be used in the filter. Must be a geospatial geometry column.

input\_wkt (str) –

A geometry in WKT format that will be used to filter the objects in input parameter table\_name. The default value is ‘’.

operation (str) –

The geometric filtering operation to perform. Allowed values are:

contains – Matches records that contain the given WKT in input parameter input\_wkt, i.e. the given WKT is within the bounds of a record’s geometry.
crosses – Matches records that cross the given WKT.
disjoint – Matches records that are disjoint from the given WKT.
equals – Matches records that are the same as the given WKT.
intersects – Matches records that intersect the given WKT.
overlaps – Matches records that overlap the given WKT.
touches – Matches records that touch the given WKT.
within – Matches records that are within the given WKT.

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 geometry 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 ( {"{"}{"}"} ).