Skip to main content
interface FilterByStringRequest
column_names: string[];
expression: string;
mode: string;
options?: Record<string, string>;
table_name: string;
view_name?: string;
column_names expression mode options? table_name view_name?
column_names: string[]

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

expression: string

The expression with which to filter the table.

mode: string

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

options?: Record<string, string>

Optional 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

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.