Skip to main content
  • Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by input_wkt.

    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 | undefined

      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.

    • column_name: string

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

    • input_wkt: string | undefined

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

    • operation: string

      The geometric filtering operation to perform.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    Returns Promise<FilterByGeometryResponse>

    Promise<Types.FilterByGeometryResponse> - Promise resolving to the response