Skip to main content
  • Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a view_name is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

    Parameters

    • table_name: string

      Name of the table whose data will be filtered, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.

    • 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 by whose value the data will be filtered from the table designated by table_name.

    • source_table_name: string

      Name of the table whose data will be compared against in the table called table_name, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.

    • source_table_column_name: string

      Name of the column in the source_table_name whose values will be used as the filter for table table_name. Must be a geospatial geometry column if in ‘spatial’ mode; otherwise, Must match the type of the column_name.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    Returns Promise<FilterByTableResponse>

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

  • Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a view_name is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

    Parameters

    Returns Promise<FilterByTableResponse>

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