Text-contains filter

Provide a text input that allows the user to filter by substring match on a text column.

Ingredient Family: sqlFilterIngredients

Outline Display: Filter by way of string similarity on column {{columnName}} from table {{table}}, where the options for the dropdown are drawn from the query: {{query}}

Local scope

The parent slot binds these (look up the slot in the parent to see how):

  • $query – The query that will get filtered

Names introduced within this component’s knobs:

  • table – table picked from the FROM clause of $query
  • queryTab – result columns of query (referenceable as a virtual table)

Settings

Required

  • table : table name/alias from the FROM of $query
    The name or alias of the table that has the column we’re filtering by

  • columnName : column of table (type filter: exactly text; optional)
    An existing string column from the table specified by tnm that we are filtering by

  • query : SQL query
    A SQL query returning the values for the dropdown
    Must produce: result named Value matching showable type, then no more results
    Scope: none – this query does not accept [Username] or handler parameters. Use only table/column references and literal values.

  • label : constant value (type: text; required, non-nullable)
    The label for the dropdown

Optional

  • cssWidth : constant value (type: integer; required, non-nullable)
    Width as an integer between 1 and 12 where 12 is a full row