q (Query) ​

You can use almost everything on any database server. Also, it supports recursive conditions.

Simple Condition ​

/api/v1/users?q={ "id": 1 }

WHERE `id` = 1

Multiple Conditions ​

/api/v1/users?q=[ {"name": "John"}, {"surname": "Locke" } ]

WHERE `name` = 'John' AND `surname` = 'Locke'

Logical Expressions ​

/api/v1/users?q=[ {"name": "John"}, {"$or.surname": "Locke" } ]

WHERE `name` = 'John' OR `surname` = 'Locke'

Also, you can use the $and prefix. If you don't specify any prefix, $and will be used as default.

Recursive Conditions ​

/api/v1/users?q=[
   [{"name": "John"}, {"$or.surname": "Locke" }],
   [{"$or.age": 18}, {"$or.id": 666 }]
  ]

WHERE
  (
    `name` = 'John' OR `surname` = 'Locke'
  )
  OR (
    `age` = 18 OR `id` = 666
  )

Parent Conditions ​

If there is a one-to-one relationship between the parent record, you can filter the child's data by parent's fields.

Let's assume that you have a relationship like this;

class Student extends Model {
  school(): IRelation {
    return this.hasOne("School", "id", "school_id");
  }
}

class School extends Model {}

In this scenario, the client is able to query the student by the school's names;

/api/v1/students?q=[ {"school.name.$like": "*Institution*"} ]

The SQL equivalent will be like this;

SELECT students.*
FROM students
LEFT JOIN schools ON schools.id = students.school_id
WHERE schools.name LIKE "%Institution%";

Operators ​

You may use the following operators in all of your queries by adding the operator to the end of your field name.