`q` (Query)

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

Simple Condition

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

sql

WHERE `id` = 1

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

sql

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

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

sql

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.

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

sql

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

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*"} ]

WARNING

Clients should use the relationship definition title (school in this example) in the query.

The SQL equivalent will be like this;

sql

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

WARNING

You can use these kinds of queries for only a one-to-one relationship. For example, you can't filter schools by student names.

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