Query DSL

Yao Query DSL is used to query data from the database or other data sources. It is a powerful tool for filtering, sorting, and aggregating data to get the desired results.

Note: This document is a work in progress, some links may not work as expected.

{
  "from": "pets",
  "debug": true,
  "select": [
    "category_id",
    "category.category_name",
    ":COUNT(pets.id) as total"
  ],
  "joins": [
    {
      "left": true,
      "from": "pet_categories as category",
      "key": "category_id",
      "foreign": "category.id"
    }
  ],
  "wheres": [
    { "field": "pets.created_at", ">=": "from" },
    { "field": "pets.created_at", "<=": "to" }
  ],
  "groups": ["category_id"]
}

👉 Query DSL Reference

Section	Description
Overview	An introduction to the Query DSL and its purpose.
Basics Usage	Basic usage of the Query DSL.
Select	Selecting fields from the data source.
Wheres	Filtering data based on conditions.
Joins	Joining multiple tables to get related data.
Groups	Grouping data based on fields.
Orders	Sorting data based on fields.
Limits	Limiting the number of records returned.
Subqueries	Using subqueries to get data from nested queries.
Unions	Combining multiple queries into a single result.

Table of Contents