database-basics.md 7.77 KB
Newer Older
1 2 3
Database basics
===============

4
Yii has a database access layer built on top of PHP's [PDO](http://www.php.net/manual/en/book.pdo.php). It provides
5 6 7
uniform API and solves some inconsistencies between different DBMS. By default Yii supports the following DBMS:

- [MySQL](http://www.mysql.com/)
8
- [MariaDB](https://mariadb.com/)
9 10
- [SQLite](http://sqlite.org/)
- [PostgreSQL](http://www.postgresql.org/)
Qiang Xue committed
11
- [CUBRID](http://www.cubrid.org/): version 9.1.0 or higher.
12
- [Oracle](http://www.oracle.com/us/products/database/overview/index.html)
Qiang Xue committed
13 14
- [MSSQL](https://www.microsoft.com/en-us/sqlserver/default.aspx): version 2012 or above is required if you
  want to use LIMIT/OFFSET.
15

16

17 18 19 20 21 22 23
Configuration
-------------

In order to start using database you need to configure database connection component first by adding `db` component
to application configuration (for "basic" web application it's `config/web.php`) like the following:

```php
Alexander Makarov committed
24
return [
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
    // ...
    'components' => [
        // ...
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=localhost;dbname=mydatabase', // MySQL, MariaDB
            //'dsn' => 'sqlite:/path/to/database/file', // SQLite
            //'dsn' => 'pgsql:host=localhost;port=5432;dbname=mydatabase', // PostgreSQL
            //'dsn' => 'cubrid:dbname=demodb;host=localhost;port=33000', // CUBRID
            //'dsn' => 'sqlsrv:Server=localhost;Database=mydatabase', // MS SQL Server, sqlsrv driver
            //'dsn' => 'dblib:host=localhost;dbname=mydatabase', // MS SQL Server, dblib driver
            //'dsn' => 'mssql:host=localhost;dbname=mydatabase', // MS SQL Server, mssql driver
            //'dsn' => 'oci:dbname=//localhost:1521/mydatabase', // Oracle
            'username' => 'root',
            'password' => '',
            'charset' => 'utf8',
        ],
    ],
    // ...
Alexander Makarov committed
44
];
45
```
46

47 48
Please refer to the [PHP manual](http://www.php.net/manual/en/function.PDO-construct.php) for more details
on the format of the DSN string.
49

50
After the connection component is configured you can access it using the following syntax:
51 52 53 54 55

```php
$connection = \Yii::$app->db;
```

56
You can refer to [[yii\db\Connection]] for a list of properties you can configure. Also note that you can define more
57
than one connection component and use both at the same time if needed:
58 59 60 61 62 63

```php
$primaryConnection = \Yii::$app->db;
$secondaryConnection = \Yii::$app->secondDb;
```

64
If you don't want to define the connection as an application component you can instantiate it directly:
65 66

```php
Alexander Makarov committed
67
$connection = new \yii\db\Connection([
68 69 70
    'dsn' => $dsn,
     'username' => $username,
     'password' => $password,
Alexander Makarov committed
71
]);
72 73 74
$connection->open();
```

75

76 77 78 79 80
> **Tip**: if you need to execute additional SQL queries right after establishing a connection you can add the
> following to your application configuration file:
>
```php
return [
81 82 83 84 85 86 87 88 89 90 91 92
    // ...
    'components' => [
        // ...
        'db' => [
            'class' => 'yii\db\Connection',
            // ...
            'on afterOpen' => function($event) {
                $event->sender->createCommand("SET time_zone = 'UTC'")->execute();
            }
        ],
    ],
    // ...
93 94 95
];
```

96 97 98
Basic SQL queries
-----------------

99
Once you have a connection instance you can execute SQL queries using [[yii\db\Command]].
100 101 102 103 104 105 106 107 108 109 110 111 112

### SELECT

When query returns a set of rows:

```php
$command = $connection->createCommand('SELECT * FROM tbl_post');
$posts = $command->queryAll();
```

When only a single row is returned:

```php
113
$command = $connection->createCommand('SELECT * FROM tbl_post WHERE id=1');
114
$post = $command->queryOne();
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
```

When there are multiple values from the same column:

```php
$command = $connection->createCommand('SELECT title FROM tbl_post');
$titles = $command->queryColumn();
```

When there's a scalar value:

```php
$command = $connection->createCommand('SELECT COUNT(*) FROM tbl_post');
$postCount = $command->queryScalar();
```

### UPDATE, INSERT, DELETE etc.

If SQL executed doesn't return any data you can use command's `execute` method:

```php
136
$command = $connection->createCommand('UPDATE tbl_post SET status=1 WHERE id=1');
137 138 139
$command->execute();
```

140
Alternatively the following syntax that takes care of proper table and column names quoting is possible:
141 142 143

```php
// INSERT
Alexander Makarov committed
144
$connection->createCommand()->insert('tbl_user', [
145 146
    'name' => 'Sam',
    'age' => 30,
Alexander Makarov committed
147
])->execute();
148 149

// INSERT multiple rows at once
Alexander Makarov committed
150
$connection->createCommand()->batchInsert('tbl_user', ['name', 'age'], [
151 152 153
    ['Tom', 30],
    ['Jane', 20],
    ['Linda', 25],
Alexander Makarov committed
154
])->execute();
155 156

// UPDATE
Alexander Makarov committed
157
$connection->createCommand()->update('tbl_user', ['status' => 1], 'age > 30')->execute();
158 159 160 161 162

// DELETE
$connection->createCommand()->delete('tbl_user', 'status = 0')->execute();
```

163 164 165
Quoting table and column names
------------------------------

166
Most of the time you would use the following syntax for quoting table and column names:
167 168

```php
169
$sql = "SELECT COUNT([[$column]]) FROM {{$table}}";
170 171 172
$rowCount = $connection->createCommand($sql)->queryScalar();
```

173
In the code above `[[X]]` will be converted to properly quoted column name while `{{Y}}` will be converted to properly
174 175
quoted table name.

176 177
The alternative is to quote table and column names manually using [[yii\db\Connection::quoteTableName()]] and
[[yii\db\Connection::quoteColumnName()]]:
178 179 180 181 182 183 184

```php
$column = $connection->quoteColumnName($column);
$table = $connection->quoteTableName($table);
$sql = "SELECT COUNT($column) FROM $table";
$rowCount = $connection->createCommand($sql)->queryScalar();
```
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212

Prepared statements
-------------------

In order to securely pass query parameters you can use prepared statements:

```php
$command = $connection->createCommand('SELECT * FROM tbl_post WHERE id=:id');
$command->bindValue(':id', $_GET['id']);
$post = $command->query();
```

Another usage is performing a query multiple times while preparing it only once:

```php
$command = $connection->createCommand('DELETE FROM tbl_post WHERE id=:id');
$command->bindParam(':id', $id);

$id = 1;
$command->execute();

$id = 2;
$command->execute();
```

Transactions
------------

213
You can perform transactional SQL queries like the following:
214 215 216 217

```php
$transaction = $connection->beginTransaction();
try {
218 219 220 221
    $connection->createCommand($sql1)->execute();
     $connection->createCommand($sql2)->execute();
    // ... executing other SQL statements ...
    $transaction->commit();
222
} catch(Exception $e) {
223
    $transaction->rollBack();
224 225 226
}
```

227 228 229 230 231 232
You can also nest multiple transactions, if needed:

```php
// outer transaction
$transaction1 = $connection->beginTransaction();
try {
233 234 235 236 237 238 239 240 241 242 243 244
    $connection->createCommand($sql1)->execute();

    // inner transaction
    $transaction2 = $connection->beginTransaction();
    try {
        $connection->createCommand($sql2)->execute();
        $transaction2->commit();
    } catch (Exception $e) {
        $transaction2->rollBack();
    }

    $transaction1->commit();
245
} catch (Exception $e) {
246
    $transaction1->rollBack();
247 248 249 250
}
```


251 252 253 254 255
Working with database schema
----------------------------

### Getting schema information

256
You can get a [[yii\db\Schema]] instance like the following:
257 258 259 260 261 262 263 264 265 266 267

```php
$schema = $connection->getSchema();
```

It contains a set of methods allowing you to retrieve various information about the database:

```php
$tables = $schema->getTableNames();
```

268
For the full reference check [[yii\db\Schema]].
269 270 271

### Modifying schema

272
Aside from basic SQL queries [[yii\db\Command]] contains a set of methods allowing to modify database schema:
273 274 275 276 277 278 279 280 281 282

- createTable, renameTable, dropTable, truncateTable
- addColumn, renameColumn, dropColumn, alterColumn
- addPrimaryKey, dropPrimaryKey
- addForeignKey, dropForeignKey
- createIndex, dropIndex

These can be used as follows:

```php
283
// CREATE TABLE
Alexander Makarov committed
284
$connection->createCommand()->createTable('tbl_post', [
285 286 287
    'id' => 'pk',
    'title' => 'string',
    'text' => 'text',
Alexander Makarov committed
288
]);
289 290
```

291
For the full reference check [[yii\db\Command]].