Skip to main content
  • Calculates which objects from a table or view match a string expression for the given string columns. Setting case_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.

    Parameters

    • table_name: string

      Name of the table on which the filter operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view.

    • 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.

    • expression: string

      The expression with which to filter the table.

    • mode: string

      The string filtering mode to apply. See below for details.

    • column_names: string[]

      List of columns on which to apply the filter. Ignored for search mode.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    Returns Promise<FilterByStringResponse>

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