Creating segments - Forest Documentation

Create a segment

Enable Layout Editor mode (top right of your screen)

Click the ⚙️ cog icon next to the collection you want to edit

Go to the Segments tab

Click “Create your first segment” (or ”+ New segment” if you already have some)

Give your segment a name

Add one or more filters

Optionally adjust the sort field and order

Save

Newly created segments are disabled by default. Enable them from the Segments tab in Layout Editor mode.

SQL Query segments

For advanced filtering, create a segment using a raw SQL query.

To enable SQL Query segments in back-end v2, your developers need to add a connection name to the datasources on which you want to run live queries.

SQL Query mode is only available for SQL databases. For security reasons, only SELECT queries are allowed.

Switch to Query mode, type your SQL query, and save. The query must return the primary key column of the collection.

SELECT t.id FROM transactions t
JOIN companies beneficiary ON t.beneficiary_company_id = beneficiary.id
JOIN companies emitter ON t.emitter_company_id = emitter.id
WHERE beneficiary.headquarter ILIKE '%United States%'
  AND emitter.headquarter ILIKE '%United States%'

To query across multiple databases in PostgreSQL, you can use the dblink function.

​Create a segment

​Reorder segments

​SQL Query segments

Create a segment

Reorder segments

SQL Query segments