Text parameter

Text parameters are replaced by an array of strings in your query. They are ideal for filtering data by category names or text-based identifiers—such as product types or admin regions.

Text Parameter Settings

When creating a text parameter, you'll configure:

Values

Define the list of selectable values shown in the control UI.

  • Add manually: Enter values directly.

  • Add from Source: Select a column from your data source to auto-populate the list with up to 1,000 distinct values.

    • You can sort the values by frequency or alphabetically, in ascending or descending order.

Naming

  • Display name: The name that will appear in the control UI.

  • SQL name: The name that needs to be used in your SQL query. It always has to be enclosed between double curly brackets, like: {{day_night}}.

Using Text Parameters in your SQL Query

Once the parameter is created, add the parameer to your SQL query using the SQL name:

SELECT * FROM `carto-demo-data`.demo_tables.fires_worldwide
WHERE daynight IN {{day_night}}

After adding the parameter, the control UI will appear in the right-side panel, allowing users to:

  • Search values

  • Enter custom text

  • Select one or multiple categories

Text parameters are replaced by an array of strings. Use SQL syntax that supports arrays—like IN—for proper evaluation.

Last updated

Was this helpful?