Skip to main content
interface FilterByGeometryRequest
column_name: string;
input_wkt?: string;
operation: string;
options?: Record<string, string>;
table_name: string;
view_name?: string;
column_name input_wkt? operation options? table_name view_name?
column_name: string

Name of the column to be used in the filter. Must be a geospatial geometry column.

input_wkt?: string

A geometry in WKT format that will be used to filter the objects in table_name.

operation: string

The geometric filtering operation to perform.

options?: Record<string, string>

Optional parameters.

table_name: string

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?: 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.