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.
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
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
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"
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
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 or 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 was 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"
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"
last_order_date > "01/01/2021"
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"
A date is greater
> than another if it is more recent, and less
< than another if it is older.
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.
Do capitals matter in my searches? No, a search for
delivery_address_city = "london" will return the same results.
||Where the name is equal to "The Shop"|
||Not equal to||
||Where the name is not equal to "The Shop"|
||Where the name contains "The"|
||Does not contain||
||Where the name does not contain "The"|
||Where the average order value is greater than 100|
||Greater than or equal to||
||Where the average order value is greater than or equal to 100|
||Where the average order value is less than 100|
||Less than or equal to||
||Where the average order value is less than or equal to 100|
||Where the name is either "The Shop" or "The Pub" or "The Restaurant"|
||Where the name is not "The Shop" and not "The Pub" and not "The Restaurant"|