db-query-builder.md 15.4 KB
Newer Older
Alexander Makarov committed
1 2 3
Query Builder and Query
=======================

4
> Note: This section is under development.
Qiang Xue committed
5

6 7 8 9
Yii provides a basic database access layer as described in the [Database basics](database-basics.md) section.
The database access layer provides a low-level way to interact with the database. While useful in some situations,
it can be tedious and error-prone to write raw SQLs. An alternative approach is to use the Query Builder.
The Query Builder provides an object-oriented vehicle for generating queries to be executed.
Alexander Makarov committed
10

11
A typical usage of the query builder looks like the following:
Alexander Makarov committed
12 13

```php
14
$rows = (new \yii\db\Query())
15
    ->select('id, name')
16
    ->from('user')
17 18
    ->limit(10)
    ->all();
19 20

// which is equivalent to the following code:
Alexander Makarov committed
21

22
$query = (new \yii\db\Query())
23
    ->select('id, name')
24
    ->from('user')
25
    ->limit(10);
Alexander Makarov committed
26

27
// Create a command. You can get the actual SQL using $command->sql
Alexander Makarov committed
28
$command = $query->createCommand();
29 30

// Execute the command:
Alexander Makarov committed
31 32 33
$rows = $command->queryAll();
```

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
Query Methods
-------------

As you can see, [[yii\db\Query]] is the main player that you need to deal with. Behind the scene,
`Query` is actually only responsible for representing various query information. The actual query
building logic is done by [[yii\db\QueryBuilder]] when you call the `createCommand()` method,
and the query execution is done by [[yii\db\Command]].

For convenience, [[yii\db\Query]] provides a set of commonly used query methods that will build
the query, execute it, and return the result. For example,

- [[yii\db\Query::all()|all()]]: builds the query, executes it and returns all results as an array.
- [[yii\db\Query::one()|one()]]: returns the first row of the result.
- [[yii\db\Query::column()|column()]]: returns the first column of the result.
- [[yii\db\Query::scalar()|scalar()]]: returns the first column in the first row of the result.
- [[yii\db\Query::exists()|exists()]]: returns a value indicating whether the query results in anything.
- [[yii\db\Query::count()|count()]]: returns the result of a `COUNT` query. Other similar methods
  include `sum()`, `average()`, `max()`, `min()`, which support the so-called aggregational data query.


Building Query
--------------

57 58 59 60
In the following, we will explain how to build various clauses in a SQL statement. For simplicity,
we use `$query` to represent a [[yii\db\Query]] object.


61
### `SELECT`
Alexander Makarov committed
62

63
In order to form a basic `SELECT` query, you need to specify what columns to select and from what table:
Alexander Makarov committed
64 65 66

```php
$query->select('id, name')
67
    ->from('user');
Alexander Makarov committed
68 69
```

70 71
Select options can be specified as a comma-separated string, as in the above, or as an array.
The array syntax is especially useful when forming the selection dynamically:
Alexander Makarov committed
72 73

```php
74
$query->select(['id', 'name'])
75
    ->from('user');
Alexander Makarov committed
76 77
```

78 79 80 81 82
> Info: You should always use the array format if your `SELECT` clause contains SQL expressions.
> This is because a SQL expression like `CONCAT(first_name, last_name) AS full_name` may contain commas.
> If you list it together with other columns in a string, the expression may be split into several parts
> by commas, which is not what you want to see.

83
When specifying columns, you may include the table prefixes or column aliases, e.g., `user.id`, `user.id AS user_id`.
84
If you are using array to specify the columns, you may also use the array keys to specify the column aliases,
85
e.g., `['user_id' => 'user.id', 'user_name' => 'user.name']`.
86 87 88 89

To select distinct rows, you may call `distinct()`, like the following:

```php
90
$query->select('user_id')->distinct()->from('post');
91 92
```

93
### `FROM`
94 95 96 97

To specify which table(s) to select data from, call `from()`:

```php
98
$query->select('*')->from('user');
99 100 101
```

You may specify multiple tables using a comma-separated string or an array.
102
Table names can contain schema prefixes (e.g. `'public.user'`) and/or table aliases (e.g. `'user u'`).
103 104 105 106
The method will automatically quote the table names unless it contains some parenthesis
(which means the table is given as a sub-query or DB expression). For example,

```php
107
$query->select('u.*, p.*')->from(['user u', 'post p']);
108 109 110 111 112 113
```

When the tables are specified as an array, you may also use the array keys as the table aliases
(if a table does not need alias, do not use a string key). For example,

```php
maks feltrin committed
114
$query->select('u.*, p.*')->from(['u' => 'user', 'p' => 'post']);
115 116 117 118
```

You may specify a sub-query using a `Query` object. In this case, the corresponding array key will be used
as the alias for the sub-query.
Qiang Xue committed
119

120
```php
121
$subQuery = (new Query())->select('id')->from('user')->where('status=1');
122 123
$query->select('*')->from(['u' => $subQuery]);
```
Qiang Xue committed
124

125

126
### `WHERE`
Alexander Makarov committed
127

128
Usually data is selected based upon certain criteria. Query Builder has some useful methods to specify these, the most powerful of which being `where`. It can be used in multiple ways.
Alexander Makarov committed
129

130
The simplest way to apply a condition is to use a string:
Alexander Makarov committed
131 132

```php
Alexander Makarov committed
133
$query->where('status=:status', [':status' => $status]);
Alexander Makarov committed
134 135
```

136
When using strings, make sure you're binding the query parameters, not creating a query by string concatenation. The above approach is safe to use, the following is not:
Alexander Makarov committed
137

138 139 140 141 142
```php
$query->where("status=$status"); // Dangerous!
```

Instead of binding the status value immediately, you can do so using `params` or `addParams`:
Alexander Makarov committed
143 144 145

```php
$query->where('status=:status');
Alexander Makarov committed
146
$query->addParams([':status' => $status]);
Alexander Makarov committed
147 148
```

149
Multiple conditions can simultaneously be set in `where` using the *hash format*:
Alexander Makarov committed
150 151

```php
Alexander Makarov committed
152
$query->where([
153 154 155
    'status' => 10,
    'type' => 2,
    'id' => [4, 8, 15, 16, 23, 42],
Alexander Makarov committed
156
]);
Alexander Makarov committed
157 158
```

159
That code will generate the following SQL:
Alexander Makarov committed
160 161 162 163 164

```sql
WHERE (`status` = 10) AND (`type` = 2) AND (`id` IN (4, 8, 15, 16, 23, 42))
```

165
NULL is a special value in databases, and is handled smartly by the Query Builder. This code:
Alexander Makarov committed
166 167

```php
Alexander Makarov committed
168
$query->where(['status' => null]);
Alexander Makarov committed
169 170
```

171
results in this WHERE clause:
Alexander Makarov committed
172 173 174 175 176

```sql
WHERE (`status` IS NULL)
```

177 178 179 180 181 182 183 184 185 186 187 188 189 190
You can also create sub-queries with `Query` objects like the following,

```php
$userQuery = (new Query)->select('id')->from('user');
$query->where(['id' => $userQuery]);
```

which will generate the following SQL:

```sql
WHERE `id` IN (SELECT `id` FROM `user`)
```


Alexander Makarov committed
191
Another way to use the method is the operand format which is `[operator, operand1, operand2, ...]`.
Alexander Makarov committed
192 193 194 195

Operator can be one of the following:

- `and`: the operands should be concatenated together using `AND`. For example,
Alexander Makarov committed
196
  `['and', 'id=1', 'id=2']` will generate `id=1 AND id=2`. If an operand is an array,
Alexander Makarov committed
197
  it will be converted into a string using the rules described here. For example,
Alexander Makarov committed
198
  `['and', 'type=1', ['or', 'id=1', 'id=2']]` will generate `type=1 AND (id=1 OR id=2)`.
Alexander Makarov committed
199
  The method will NOT do any quoting or escaping.
200

Alexander Makarov committed
201
- `or`: similar to the `and` operator except that the operands are concatenated using `OR`.
202

Alexander Makarov committed
203 204
- `between`: operand 1 should be the column name, and operand 2 and 3 should be the
   starting and ending values of the range that the column is in.
Alexander Makarov committed
205
   For example, `['between', 'id', 1, 10]` will generate `id BETWEEN 1 AND 10`.
206

Alexander Makarov committed
207 208
- `not between`: similar to `between` except the `BETWEEN` is replaced with `NOT BETWEEN`
  in the generated condition.
209

210 211 212 213
- `in`: operand 1 should be a column or DB expression. Operand 2 can be either an array or a `Query` object.
  It will generate an `IN` condition. If Operand 2 is an array, it will represent the range of the values
  that the column or DB expression should be; If Operand 2 is a `Query` object, a sub-query will be generated
  and used as the range of the column or DB expression. For example,
Alexander Makarov committed
214
  `['in', 'id', [1, 2, 3]]` will generate `id IN (1, 2, 3)`.
Alexander Makarov committed
215
  The method will properly quote the column name and escape values in the range.
216 217
  The `in` operator also supports composite columns. In this case, operand 1 should be an array of the columns,
  while operand 2 should be an array of arrays or a `Query` object representing the range of the columns.
218

Alexander Makarov committed
219
- `not in`: similar to the `in` operator except that `IN` is replaced with `NOT IN` in the generated condition.
220

Alexander Makarov committed
221 222
- `like`: operand 1 should be a column or DB expression, and operand 2 be a string or an array representing
  the values that the column or DB expression should be like.
223
  For example, `['like', 'name', 'tester']` will generate `name LIKE '%tester%'`.
Alexander Makarov committed
224
  When the value range is given as an array, multiple `LIKE` predicates will be generated and concatenated
225
  using `AND`. For example, `['like', 'name', ['test', 'sample']]` will generate
Alexander Makarov committed
226
  `name LIKE '%test%' AND name LIKE '%sample%'`.
227 228 229 230 231 232
  You may also provide an optional third operand to specify how to escape special characters in the values.
  The operand should be an array of mappings from the special characters to their
  escaped counterparts. If this operand is not provided, a default escape mapping will be used.
  You may use `false` or an empty array to indicate the values are already escaped and no escape
  should be applied. Note that when using an escape mapping (or the third operand is not provided),
  the values will be automatically enclosed within a pair of percentage characters.
233 234 235 236

  > Note: When using PostgreSQL you may also use [`ilike`](http://www.postgresql.org/docs/8.3/static/functions-matching.html#FUNCTIONS-LIKE)
  > instead of `like` for case-insensitive matching.

Alexander Makarov committed
237 238
- `or like`: similar to the `like` operator except that `OR` is used to concatenate the `LIKE`
  predicates when operand 2 is an array.
239

Alexander Makarov committed
240 241
- `not like`: similar to the `like` operator except that `LIKE` is replaced with `NOT LIKE`
  in the generated condition.
242

Alexander Makarov committed
243 244
- `or not like`: similar to the `not like` operator except that `OR` is used to concatenate
  the `NOT LIKE` predicates.
245

246
- `exists`: requires one operand which must be an instance of [[yii\db\Query]] representing the sub-query.
247
  It will build a `EXISTS (sub-query)` expression.
248

249
- `not exists`: similar to the `exists` operator and builds a `NOT EXISTS (sub-query)` expression.
Alexander Makarov committed
250

Qiang Xue committed
251
If you are building parts of condition dynamically it's very convenient to use `andWhere()` and `orWhere()`:
Alexander Makarov committed
252 253 254 255 256

```php
$status = 10;
$search = 'yii';

Alexander Makarov committed
257
$query->where(['status' => $status]);
Alexander Makarov committed
258
if (!empty($search)) {
259
    $query->andWhere(['like', 'title', $search]);
Alexander Makarov committed
260 261 262 263 264 265 266 267 268
}
```

In case `$search` isn't empty the following SQL will be generated:

```sql
WHERE (`status` = 10) AND (`title` LIKE '%yii%')
```

Qiang Xue committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
#### Building Filter Conditions

When building filter conditions based on user inputs, you usually want to specially handle "empty inputs"
by ignoring them in the filters. For example, you have an HTML form that takes username and email inputs.
If the user only enters something in the username input, you may want to build a query that only tries to
match the entered username. You may use the `filterWhere()` method achieve this goal:

```php
// $username and $email are from user inputs
$query->filterWhere([
    'username' => $username,
    'email' => $email,
]);
```

The `filterWhere()` method is very similar to `where()`. The main difference is that `filterWhere()`
will remove empty values from the provided condition. So if `$email` is "empty", the resulting query
will be `...WHERE username=:username`; and if both `$username` and `$email` are "empty", the query
will have no `WHERE` part.

A value is *empty* if it is null, an empty string, a string consisting of whitespaces, or an empty array.

You may also use `andFilterWhere()` and `orFilterWhere()` to append more filter conditions.


294
### `ORDER BY`
Alexander Makarov committed
295

296
For ordering results `orderBy` and `addOrderBy` could be used:
Alexander Makarov committed
297 298

```php
Alexander Makarov committed
299
$query->orderBy([
300 301
    'id' => SORT_ASC,
    'name' => SORT_DESC,
Alexander Makarov committed
302
]);
Alexander Makarov committed
303 304 305 306
```

Here we are ordering by `id` ascending and then by `name` descending.

307 308
```

309
### `GROUP BY` and `HAVING`
Alexander Makarov committed
310 311 312 313 314 315 316 317 318 319

In order to add `GROUP BY` to generated SQL you can use the following:

```php
$query->groupBy('id, status');
```

If you want to add another field after using `groupBy`:

```php
Alexander Makarov committed
320
$query->addGroupBy(['created_at', 'updated_at']);
Alexander Makarov committed
321 322 323 324 325 326
```

To add a `HAVING` condition the corresponding `having` method and its `andHaving` and `orHaving` can be used. Parameters
for these are similar to the ones for `where` methods group:

```php
Alexander Makarov committed
327
$query->having(['status' => $status]);
Alexander Makarov committed
328 329
```

330
### `LIMIT` and `OFFSET`
Alexander Makarov committed
331 332 333 334 335 336 337 338 339 340 341 342 343

To limit result to 10 rows `limit` can be used:

```php
$query->limit(10);
```

To skip 100 fist rows use:

```php
$query->offset(100);
```

344 345 346 347 348 349 350 351 352 353 354
### `JOIN`

The `JOIN` clauses are generated in the Query Builder by using the applicable join method:

- `innerJoin()`
- `leftJoin()`
- `rightJoin()`

This left join selects data from two related tables in one query:

```php
355 356 357
$query->select(['user.name AS author', 'post.title as title'])
    ->from('user')
    ->leftJoin('post', 'post.user_id = user.id');
358 359 360 361 362 363 364 365
```

In the code, the `leftJoin()` method's first parameter
specifies the table to join to. The second parameter defines the join condition.

If your database application supports other join types, you can use those via the  generic `join` method:

```php
366
$query->join('FULL OUTER JOIN', 'post', 'post.user_id = user.id');
367 368 369 370 371 372 373 374 375 376 377 378 379 380
```

The first argument is the join type to perform. The second is the table to join to, and the third is the condition.

Like `FROM`, you may also join with sub-queries. To do so, specify the sub-query as an array
which must contain one element. The array value must be a `Query` object representing the sub-query,
while the array key is the alias for the sub-query. For example,

```php
$query->leftJoin(['u' => $subQuery], 'u.id=author_id');
```


### `UNION`
Alexander Makarov committed
381 382 383 384 385

`UNION` in SQL adds results of one query to results of another query. Columns returned by both queries should match.
In Yii in order to build it you can first form two query objects and then use `union` method:

```php
386
$query = new Query();
387
$query->select("id, 'post' as type, name")->from('post')->limit(10);
Alexander Makarov committed
388

389
$anotherQuery = new Query();
390
$anotherQuery->select('id, 'user' as type, name')->from('user')->limit(10);
Alexander Makarov committed
391 392 393 394

$query->union($anotherQuery);
```

395 396 397 398 399 400 401 402 403 404 405 406 407 408

Batch Query
-----------

When working with large amount of data, methods such as [[yii\db\Query::all()]] are not suitable
because they require loading all data into the memory. To keep the memory requirement low, Yii
provides the so-called batch query support. A batch query makes uses of data cursor and fetches
data in batches.

Batch query can be used like the following:

```php
use yii\db\Query;

409
$query = (new Query())
410
    ->from('user')
411
    ->orderBy('id');
412

Qiang Xue committed
413
foreach ($query->batch() as $users) {
414
    // $users is an array of 100 or fewer rows from the user table
415 416
}

Qiang Xue committed
417
// or if you want to iterate the row one by one
418
foreach ($query->each() as $user) {
419
    // $user represents one row of data from the user table
420 421
}
```
422

Qiang Xue committed
423 424 425 426 427 428 429 430 431
The method [[yii\db\Query::batch()]] and [[yii\db\Query::each()]] return an [[yii\db\BatchQueryResult]] object
which implements the `Iterator` interface and thus can be used in the `foreach` construct.
During the first iteration, a SQL query is made to the database. Data are since then fetched in batches
in the iterations. By default, the batch size is 100, meaning 100 rows of data are being fetched in each batch.
You can change the batch size by passing the first parameter to the `batch()` or `each()` method.

Compared to the [[yii\db\Query::all()]], the batch query only loads 100 rows of data at a time into the memory.
If you process the data and then discard it right away, the batch query can help keep the memory usage under a limit.

432 433 434 435 436 437
If you specify the query result to be indexed by some column via [[yii\db\Query::indexBy()]], the batch query
will still keep the proper index. For example,

```php
use yii\db\Query;

438
$query = (new Query())
439
    ->from('user')
440
    ->indexBy('username');
441

Qiang Xue committed
442
foreach ($query->batch() as $users) {
443
    // $users is indexed by the "username" column
444 445 446 447 448
}

foreach ($query->each() as $username => $user) {
}
```