Skip to main content

overview

Dream exposes a powerful, type-driven query building engine to make talking to your database a friendly experience. All fields on your model can be leveraged as elements of your query, and associations can be joined and preloaded to simplify database interactions.

const users = await User.innerJoin('posts', {
  content: ops.ilike('howyadoin'),
}).all()

A range of methods can be used to drill queries down to a selective grouping:

await User.where({ email: null }).first()
await User.where({ email: null }).limit(10).all()
await User.where({ email: null }).count()
await User.pluck('email')
tip

The query building engine provided by Dream provides an enormous API. We recommend you poke around to get a feel for what is possible within Dream.

Executing methods​

Executing methods are those that will actually cause a query to run. Prior to one of these methods being called, the query is being built up for execution. Executing the query will cause an sql query to compile with the given parameters and summon the matching records from the database.

  • To learn about retreiving all records from the database, see the all guide
  • To learn about retreiving selective records from the database, see the find, findBy, findEach, findOrFailBy, and findOrFail guides
  • To learn about retreiving the first record from the database, see the first guide, as well as the firstOrFail guide
  • To learn about retreiving the last record from the database, see the last guide, as well as the lastOrFail guide
  • To learn about counting records, see the count guide.
  • To learn about determining if a record exists, see the exists guide
  • To learn about getting the max value from a given table, see the max guide.
  • To learn about getting the min value from a given table, see the min guide.
  • To learn about plucking values, see the pluck guides

Query building methods​

Query building methods are those that do not execute a query, but instead modify the query to contain new statements, which will then be executed upon executing using one of the above executing statements.