Introduction to BrewwQL

What is BrewwQL?

We designed BrewwQL to help users simply and powerfully filter their data in Breww.

With a few simple operators, you can now easily create simple or complex filters to drill down deeper and more easily into your Breww data.

BrewwQL can seem daunting at first, especially if you're new to "query languages", but the doors it opens to both reporting and customisability in Breww make it worth reading on! If you've built reporting using SQL before, then you'll be right at home.

Examples

Basic examples

To best understand BrewwQL, it's helpful to see some simple examples.

Let's say we wanted to see all of our customers whose delivery address was in London. In the customer filter form, we would type:

delivery_address_city = "London"

And that's it. The autocomplete will show every option as you go, making it really straightforward to put together queries and view available options.

If we want to drill down deeper, we can. From those customers, maybe we only want to see those whose average order value is greater than £250. For this we would chain two statements together with the and operator.

delivery_address_city = "London" and average_order_value > 250

Perhaps we are wondering which of those customers have lapsed, as we might want to contact them about reordering. So let's narrow the search for only customers who haven't ordered in the last 90 days.

delivery_address_city = "London" and average_order_value > 250 and last_order_date < "90 days ago"

Now let's say we are doing some admin, and we wanted to see all customers who we haven't entered a contact for yet. In the customer filter box, we would type:

contacts = None

Advanced examples

BrewwQL allows us to traverse through attributes of what we are searching through. For example if we wanted to see customers who are part of a customer group with a billing address in London we would write:

customer_group.invoice_address_city = "London"

The . between customer_group and invoice_address_city is used in BrewwQL as a way of traversing through attributes of attributes.

We can also use brackets to add more complexity to our searches.

(delivery_address_city = "London" or average_order_value > 250) and last_order_date < "90 days ago"

The above statement will be analysed from left to right, and statements in brackets will be evaluated as a single attribute. So the query will retrieve all customers whose delivery address city is London OR who has an average order value greater than £250 ONLY if they also have a last order date more recent than 90 days ago.

We can also nest brackets within brackets. The below query will return either customers who are in London AND are Pubs, OR those whose average order value is greater than £250, as long as their last order date is more recent than 90 days ago.

((delivery_address_city = "London" and type.type = "Pub") or average_order_value > 250) and last_order_date < "90 days ago"

Using the same attribute multiple times

This can be a little confusing at first. Each statement between operators, must be complete and be able to work on its own. This means that if you're joining multiple filters together with and or or, like STATEMENT and STATEMENT, both statements must be complete on their own.

We'll walk through an example - when looking at product filtering, you could filter the type of product to only include casks with:

type = "Cask"

Or you could filter kegs only with:

type = "Keg"

Now, if you wanted to include both casks and kegs, you might be tempted (and understandably so), to do this:

type = "Cask" and "Keg"

However, this is incorrect on two counts. The first being that each statement (each side of the and) must be a complete statement. Here, the type = "Cask" is perfect, but the second statement being just "Keg" is meaningless on its own, and so will not work. So, you can correct this to:

type = "Cask" and type = "Keg"

This is much closer (and hopefully explains what's meant by each statement being a complete statement when looked at on its own). However, in this particular case, this isn't what's needed. We're looking for both cask and keg products, but this will be checked against each individual product, and any single product cannot be both a cask and a keg. The above is filtering on products which are both casks and kegs (which is impossible), so what we really need to check is if the product is either a cask or the product is a keg. And that can be done with:

type = "Cask" or type = "Keg"

Success! The above would give the desired result of finding both cask products and keg products. If you wanted to make this a little neater (and maybe more readable), you could instead use the in operator to check if the product's type is in the list of options given. This would be done with:

type in ("Cask", "Keg")

This is certainly more readable if the number of options were to increase from two to four (or even more):

type in ("Cask", "Keg", "Service", "Guest beer")

Verses the more verbose:

type = "Cask" or type = "Keg" or type = "Service" or type = "Guest beer"

Dates

BrewwQL allows you to filter on dates and has a powerful natural language understanding. For example, if you'd like all customers who have ordered since the 1st January 2021, you can simply enter:

last_order_date > "1st January 2021"

or:

last_order_date > "01/01/2021"

or even:

last_order_date > "1 Jan 2021"

BrewwQL also understands relative dates, so you can filter on the last 30 days with:

last_order_date > "30 days ago"

or filter on the last two months with:

last_order_date > "2 months ago"

Some other useful options for date filtering include the phrases:

last_order_date > "first of this month"

or:

last_order_date < "last of this month"

or:

last_order_date > "first of last month"

or:

last_order_date < "last of last month"

or:

last_order_date < "Monday last week"

or:

last_order_date < "Monday next week"

or:

last_order_date < "last Monday"

or:

last_order_date < "previous Monday"

or:

last_order_date < "next Tuesday"

or:

last_order_date < "this Wednesday"

You can think of this as if someone started counting at the beginning of time. The number they had counted to last week is less than the number they have counted to right now.

To filter on a range of dates, you can use the same field twice:

last_order_date > "first of last month" and last_order_date  <= "last of last month"

Date ranges

BrewwQL date filtering is always based on a specific date, rather than date ranges. For this reason, to create a date range filter, you need to add two filters. For example:

last_order_date > "01/01/2025" and last_order_date  <= "07/01/2025"

As date ranges cannot be used in a single filter, the following will not work:

last_order_date = "This week"

But this will work to achieve a filter of "This week":

last_order_date >= "This Monday" and last_order_date  <= "This Sunday"

Case-sensitivity

Do capitals matter in my searches? No, a search for:

delivery_address_city = "London"

and

delivery_address_city = "london"

will return the same results.

Operator reference

How to add a date range in BrewwQL

BrewwQL is a powerful function in Breww that allows for filtering of data across multiple areas, such as customers, sales and reporting, to present precise and accurate data. One feature of BrewwQL is the ability to set custom & dynamic date ranges. In this document, as an example, we'll cover retrieving all customers who ordered within the last 1 to 3 months.

Go to Customers and click on the Add filter button in the BrewwQL box. This will present a choice of options of filters, but for this example, 'Last order date' has been selected.

From here, you can then select the first part of your date range by entering your date (dates can be entered in the format DD/MM/YYYY (e.g. "29/03/2022") or as relative dates, such as "3 months ago"). For the example above, we are going to enter '1 month ago' and select 'Last Order Date is older than or equal to 1 month ago'.

BrewwQL has the ability to add multiple concurrent filters to the query. This is how you would select your second date in the range. For the example above, you will want to add a 'Last activity date' of '3 months ago'. To continue this example, select an order date of 'Last order date is more recent than or equal to 3 months ago'.

This should give you a BrewwQL query string that looks like something like this:

last_order_date <= "1 month ago" and last_order_date >= "3 months ago"

You can see the separate queries joined by the 'and' keyword.

If you have any questions or need help forming a query, please let us know.