Command.php 32 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8
namespace yii\db;
w  
Qiang Xue committed
9

10
use Yii;
Qiang Xue committed
11
use yii\base\NotSupportedException;
12
use yii\caching\Cache;
Qiang Xue committed
13

w  
Qiang Xue committed
14
/**
w  
Qiang Xue committed
15
 * Command represents a SQL statement to be executed against a database.
w  
Qiang Xue committed
16
 *
Qiang Xue committed
17
 * A command object is usually created by calling [[Connection::createCommand()]].
Qiang Xue committed
18
 * The SQL statement it represents can be set via the [[sql]] property.
w  
Qiang Xue committed
19
 *
Qiang Xue committed
20
 * To execute a non-query SQL (such as INSERT, DELETE, UPDATE), call [[execute()]].
Qiang Xue committed
21
 * To execute a SQL statement that returns result data set (such as SELECT),
22
 * use [[queryAll()]], [[queryOne()]], [[queryColumn()]], [[queryScalar()]], or [[query()]].
Qiang Xue committed
23 24 25
 * For example,
 *
 * ~~~
Qiang Xue committed
26
 * $users = $connection->createCommand('SELECT * FROM tbl_user')->queryAll();
Qiang Xue committed
27
 * ~~~
w  
Qiang Xue committed
28
 *
Qiang Xue committed
29
 * Command supports SQL statement preparation and parameter binding.
Qiang Xue committed
30 31
 * Call [[bindValue()]] to bind a value to a SQL parameter;
 * Call [[bindParam()]] to bind a PHP variable to a SQL parameter.
w  
Qiang Xue committed
32
 * When binding a parameter, the SQL statement is automatically prepared.
Qiang Xue committed
33
 * You may also call [[prepare()]] explicitly to prepare a SQL statement.
w  
Qiang Xue committed
34
 *
Qiang Xue committed
35 36 37 38
 * Command also supports building SQL statements by providing methods such as [[insert()]],
 * [[update()]], etc. For example,
 *
 * ~~~
Alexander Makarov committed
39
 * $connection->createCommand()->insert('tbl_user', [
Qiang Xue committed
40 41
 *     'name' => 'Sam',
 *     'age' => 30,
Alexander Makarov committed
42
 * ])->execute();
Qiang Xue committed
43 44 45 46
 * ~~~
 *
 * To build SELECT SQL statements, please use [[QueryBuilder]] instead.
 *
47 48
 * @property string $rawSql The raw SQL with parameter values inserted into the corresponding placeholders in
 * [[sql]]. This property is read-only.
49
 * @property string $sql The SQL statement to be executed.
Qiang Xue committed
50
 *
w  
Qiang Xue committed
51
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
52
 * @since 2.0
w  
Qiang Xue committed
53
 */
w  
Qiang Xue committed
54
class Command extends \yii\base\Component
w  
Qiang Xue committed
55
{
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 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 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    /**
     * @var Connection the DB connection that this command is associated with
     */
    public $db;
    /**
     * @var \PDOStatement the PDOStatement object that this command is associated with
     */
    public $pdoStatement;
    /**
     * @var integer the default fetch mode for this command.
     * @see http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php
     */
    public $fetchMode = \PDO::FETCH_ASSOC;
    /**
     * @var array the parameters (name => value) that are bound to the current PDO statement.
     * This property is maintained by methods such as [[bindValue()]].
     * Do not modify it directly.
     */
    public $params = [];
    /**
     * @var string the SQL statement that this command represents
     */
    private $_sql;

    /**
     * Returns the SQL statement for this command.
     * @return string the SQL statement to be executed
     */
    public function getSql()
    {
        return $this->_sql;
    }

    /**
     * Specifies the SQL statement to be executed.
     * The previous SQL execution (if any) will be cancelled, and [[params]] will be cleared as well.
     * @param  string $sql the SQL statement to be set.
     * @return static this command instance
     */
    public function setSql($sql)
    {
        if ($sql !== $this->_sql) {
            $this->cancel();
            $this->_sql = $this->db->quoteSql($sql);
            $this->params = [];
        }

        return $this;
    }

    /**
     * Returns the raw SQL by inserting parameter values into the corresponding placeholders in [[sql]].
     * Note that the return value of this method should mainly be used for logging purpose.
     * It is likely that this method returns an invalid SQL due to improper replacement of parameter placeholders.
     * @return string the raw SQL with parameter values inserted into the corresponding placeholders in [[sql]].
     */
    public function getRawSql()
    {
        if (empty($this->params)) {
            return $this->_sql;
        } else {
            $params = [];
            foreach ($this->params as $name => $value) {
                if (is_string($value)) {
                    $params[$name] = $this->db->quoteValue($value);
                } elseif ($value === null) {
                    $params[$name] = 'NULL';
                } else {
                    $params[$name] = $value;
                }
            }
            if (isset($params[1])) {
                $sql = '';
                foreach (explode('?', $this->_sql) as $i => $part) {
                    $sql .= (isset($params[$i]) ? $params[$i] : '') . $part;
                }

                return $sql;
            } else {
                return strtr($this->_sql, $params);
            }
        }
    }

    /**
     * Prepares the SQL statement to be executed.
     * For complex SQL statement that is to be executed multiple times,
     * this may improve performance.
     * For SQL statement with binding parameters, this method is invoked
     * automatically.
     * @throws Exception if there is any DB error
     */
    public function prepare()
    {
        if ($this->pdoStatement == null) {
            $sql = $this->getSql();
            try {
                $this->pdoStatement = $this->db->pdo->prepare($sql);
            } catch (\Exception $e) {
                $message = $e->getMessage() . "\nFailed to prepare SQL: $sql";
                $errorInfo = $e instanceof \PDOException ? $e->errorInfo : null;
                throw new Exception($message, $errorInfo, (int) $e->getCode(), $e);
            }
        }
    }

    /**
     * Cancels the execution of the SQL statement.
     * This method mainly sets [[pdoStatement]] to be null.
     */
    public function cancel()
    {
        $this->pdoStatement = null;
    }

    /**
     * Binds a parameter to the SQL statement to be executed.
     * @param  string|integer $name          parameter identifier. For a prepared statement
     *                                       using named placeholders, this will be a parameter name of
     *                                       the form `:name`. For a prepared statement using question mark
     *                                       placeholders, this will be the 1-indexed position of the parameter.
     * @param  mixed          $value         Name of the PHP variable to bind to the SQL statement parameter
     * @param  integer        $dataType      SQL data type of the parameter. If null, the type is determined by the PHP type of the value.
     * @param  integer        $length        length of the data type
     * @param  mixed          $driverOptions the driver-specific options
     * @return static         the current command being executed
     * @see http://www.php.net/manual/en/function.PDOStatement-bindParam.php
     */
    public function bindParam($name, &$value, $dataType = null, $length = null, $driverOptions = null)
    {
        $this->prepare();
        if ($dataType === null) {
            $dataType = $this->db->getSchema()->getPdoType($value);
        }
        if ($length === null) {
            $this->pdoStatement->bindParam($name, $value, $dataType);
        } elseif ($driverOptions === null) {
            $this->pdoStatement->bindParam($name, $value, $dataType, $length);
        } else {
            $this->pdoStatement->bindParam($name, $value, $dataType, $length, $driverOptions);
        }
        $this->params[$name] =& $value;

        return $this;
    }

    /**
     * Binds a value to a parameter.
     * @param  string|integer $name     Parameter identifier. For a prepared statement
     *                                  using named placeholders, this will be a parameter name of
     *                                  the form `:name`. For a prepared statement using question mark
     *                                  placeholders, this will be the 1-indexed position of the parameter.
     * @param  mixed          $value    The value to bind to the parameter
     * @param  integer        $dataType SQL data type of the parameter. If null, the type is determined by the PHP type of the value.
     * @return static         the current command being executed
     * @see http://www.php.net/manual/en/function.PDOStatement-bindValue.php
     */
    public function bindValue($name, $value, $dataType = null)
    {
        $this->prepare();
        if ($dataType === null) {
            $dataType = $this->db->getSchema()->getPdoType($value);
        }
        $this->pdoStatement->bindValue($name, $value, $dataType);
        $this->params[$name] = $value;

        return $this;
    }

    /**
     * Binds a list of values to the corresponding parameters.
     * This is similar to [[bindValue()]] except that it binds multiple values at a time.
     * Note that the SQL data type of each value is determined by its PHP type.
     * @param  array  $values the values to be bound. This must be given in terms of an associative
     *                        array with array keys being the parameter names, and array values the corresponding parameter values,
     *                        e.g. `[':name' => 'John', ':age' => 25]`. By default, the PDO type of each value is determined
     *                        by its PHP type. You may explicitly specify the PDO type by using an array: `[value, type]`,
     *                        e.g. `[':name' => 'John', ':profile' => [$profile, \PDO::PARAM_LOB]]`.
     * @return static the current command being executed
     */
    public function bindValues($values)
    {
        if (!empty($values)) {
            $this->prepare();
            foreach ($values as $name => $value) {
                if (is_array($value)) {
                    $type = $value[1];
                    $value = $value[0];
                } else {
                    $type = $this->db->getSchema()->getPdoType($value);
                }
                $this->pdoStatement->bindValue($name, $value, $type);
                $this->params[$name] = $value;
            }
        }

        return $this;
    }

    /**
     * Executes the SQL statement.
     * This method should only be used for executing non-query SQL statement, such as `INSERT`, `DELETE`, `UPDATE` SQLs.
     * No result set will be returned.
     * @return integer   number of rows affected by the execution.
     * @throws Exception execution failed
     */
    public function execute()
    {
        $sql = $this->getSql();

        $rawSql = $this->getRawSql();

        Yii::info($rawSql, __METHOD__);

        if ($sql == '') {
            return 0;
        }

        $token = $rawSql;
        try {
            Yii::beginProfile($token, __METHOD__);

            $this->prepare();
            $this->pdoStatement->execute();
            $n = $this->pdoStatement->rowCount();

            Yii::endProfile($token, __METHOD__);

            return $n;
        } catch (\Exception $e) {
            Yii::endProfile($token, __METHOD__);
            if ($e instanceof Exception) {
                throw $e;
            } else {
                $message = $e->getMessage() . "\nThe SQL being executed was: $rawSql";
                $errorInfo = $e instanceof \PDOException ? $e->errorInfo : null;
                throw new Exception($message, $errorInfo, (int) $e->getCode(), $e);
            }
        }
    }

    /**
     * Executes the SQL statement and returns query result.
     * This method is for executing a SQL query that returns result set, such as `SELECT`.
     * @return DataReader the reader object for fetching the query result
     * @throws Exception  execution failed
     */
    public function query()
    {
        return $this->queryInternal('');
    }

    /**
     * Executes the SQL statement and returns ALL rows at once.
     * @param  integer   $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php)
     *                              for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used.
     * @return array     all rows of the query result. Each array element is an array representing a row of data.
     *                             An empty array is returned if the query results in nothing.
     * @throws Exception execution failed
     */
    public function queryAll($fetchMode = null)
    {
        return $this->queryInternal('fetchAll', $fetchMode);
    }

    /**
     * Executes the SQL statement and returns the first row of the result.
     * This method is best used when only the first row of result is needed for a query.
     * @param  integer       $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php)
     *                                  for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used.
     * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query
     *                                 results in nothing.
     * @throws Exception     execution failed
     */
    public function queryOne($fetchMode = null)
    {
        return $this->queryInternal('fetch', $fetchMode);
    }

    /**
     * Executes the SQL statement and returns the value of the first column in the first row of data.
     * This method is best used when only a single value is needed for a query.
     * @return string|boolean the value of the first column in the first row of the query result.
     *                        False is returned if there is no value.
     * @throws Exception      execution failed
     */
    public function queryScalar()
    {
        $result = $this->queryInternal('fetchColumn', 0);
        if (is_resource($result) && get_resource_type($result) === 'stream') {
            return stream_get_contents($result);
        } else {
            return $result;
        }
    }

    /**
     * Executes the SQL statement and returns the first column of the result.
     * This method is best used when only the first column of result (i.e. the first element in each row)
     * is needed for a query.
     * @return array     the first column of the query result. Empty array is returned if the query results in nothing.
     * @throws Exception execution failed
     */
    public function queryColumn()
    {
        return $this->queryInternal('fetchAll', \PDO::FETCH_COLUMN);
    }

    /**
     * Performs the actual DB query of a SQL statement.
     * @param  string    $method    method of PDOStatement to be called
     * @param  integer   $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php)
     *                              for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used.
     * @return mixed     the method execution result
     * @throws Exception if the query causes any problem
     */
    private function queryInternal($method, $fetchMode = null)
    {
        $db = $this->db;
        $rawSql = $this->getRawSql();

        Yii::info($rawSql, 'yii\db\Command::query');

        /** @var \yii\caching\Cache $cache */
        if ($db->enableQueryCache && $method !== '') {
381
            $cache = is_string($db->queryCache) ? Yii::$app->get($db->queryCache, false) : $db->queryCache;
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
        }

        if (isset($cache) && $cache instanceof Cache) {
            $cacheKey = [
                __CLASS__,
                $method,
                $db->dsn,
                $db->username,
                $rawSql,
            ];
            if (($result = $cache->get($cacheKey)) !== false) {
                Yii::trace('Query result served from cache', 'yii\db\Command::query');

                return $result;
            }
        }

        $token = $rawSql;
        try {
            Yii::beginProfile($token, 'yii\db\Command::query');

            $this->prepare();
            $this->pdoStatement->execute();

            if ($method === '') {
                $result = new DataReader($this);
            } else {
                if ($fetchMode === null) {
                    $fetchMode = $this->fetchMode;
                }
                $result = call_user_func_array([$this->pdoStatement, $method], (array) $fetchMode);
                $this->pdoStatement->closeCursor();
            }

            Yii::endProfile($token, 'yii\db\Command::query');

            if (isset($cache, $cacheKey) && $cache instanceof Cache) {
                $cache->set($cacheKey, $result, $db->queryCacheDuration, $db->queryCacheDependency);
                Yii::trace('Saved query result in cache', 'yii\db\Command::query');
            }

            return $result;
        } catch (\Exception $e) {
            Yii::endProfile($token, 'yii\db\Command::query');
            if ($e instanceof Exception) {
                throw $e;
            } else {
                $message = $e->getMessage()  . "\nThe SQL being executed was: $rawSql";
                $errorInfo = $e instanceof \PDOException ? $e->errorInfo : null;
                throw new Exception($message, $errorInfo, (int) $e->getCode(), $e);
            }
        }
    }

    /**
     * Creates an INSERT command.
     * For example,
     *
     * ~~~
     * $connection->createCommand()->insert('tbl_user', [
     *     'name' => 'Sam',
     *     'age' => 30,
     * ])->execute();
     * ~~~
     *
     * The method will properly escape the column names, and bind the values to be inserted.
     *
     * Note that the created command is not executed until [[execute()]] is called.
     *
     * @param  string  $table   the table that new rows will be inserted into.
     * @param  array   $columns the column data (name => value) to be inserted into the table.
     * @return Command the command object itself
     */
    public function insert($table, $columns)
    {
        $params = [];
        $sql = $this->db->getQueryBuilder()->insert($table, $columns, $params);

        return $this->setSql($sql)->bindValues($params);
    }

    /**
     * Creates a batch INSERT command.
     * For example,
     *
     * ~~~
     * $connection->createCommand()->batchInsert('tbl_user', ['name', 'age'], [
     *     ['Tom', 30],
     *     ['Jane', 20],
     *     ['Linda', 25],
     * ])->execute();
     * ~~~
     *
     * Note that the values in each row must match the corresponding column names.
     *
     * @param  string  $table   the table that new rows will be inserted into.
     * @param  array   $columns the column names
     * @param  array   $rows    the rows to be batch inserted into the table
     * @return Command the command object itself
     */
    public function batchInsert($table, $columns, $rows)
    {
        $sql = $this->db->getQueryBuilder()->batchInsert($table, $columns, $rows);

        return $this->setSql($sql);
    }

    /**
     * Creates an UPDATE command.
     * For example,
     *
     * ~~~
     * $connection->createCommand()->update('tbl_user', ['status' => 1], 'age > 30')->execute();
     * ~~~
     *
     * The method will properly escape the column names and bind the values to be updated.
     *
     * Note that the created command is not executed until [[execute()]] is called.
     *
     * @param  string       $table     the table to be updated.
     * @param  array        $columns   the column data (name => value) to be updated.
     * @param  string|array $condition the condition that will be put in the WHERE part. Please
     *                                 refer to [[Query::where()]] on how to specify condition.
     * @param  array        $params    the parameters to be bound to the command
     * @return Command      the command object itself
     */
    public function update($table, $columns, $condition = '', $params = [])
    {
        $sql = $this->db->getQueryBuilder()->update($table, $columns, $condition, $params);

        return $this->setSql($sql)->bindValues($params);
    }

    /**
     * Creates a DELETE command.
     * For example,
     *
     * ~~~
     * $connection->createCommand()->delete('tbl_user', 'status = 0')->execute();
     * ~~~
     *
     * The method will properly escape the table and column names.
     *
     * Note that the created command is not executed until [[execute()]] is called.
     *
     * @param  string       $table     the table where the data will be deleted from.
     * @param  string|array $condition the condition that will be put in the WHERE part. Please
     *                                 refer to [[Query::where()]] on how to specify condition.
     * @param  array        $params    the parameters to be bound to the command
     * @return Command      the command object itself
     */
    public function delete($table, $condition = '', $params = [])
    {
        $sql = $this->db->getQueryBuilder()->delete($table, $condition, $params);

        return $this->setSql($sql)->bindValues($params);
    }

    /**
     * Creates a SQL command for creating a new DB table.
     *
     * The columns in the new table should be specified as name-definition pairs (e.g. 'name' => 'string'),
     * where name stands for a column name which will be properly quoted by the method, and definition
     * stands for the column type which can contain an abstract DB type.
     * The method [[QueryBuilder::getColumnType()]] will be called
     * to convert the abstract column types to physical ones. For example, `string` will be converted
     * as `varchar(255)`, and `string not null` becomes `varchar(255) not null`.
     *
     * If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly
     * inserted into the generated SQL.
     *
     * @param  string  $table   the name of the table to be created. The name will be properly quoted by the method.
     * @param  array   $columns the columns (name => definition) in the new table.
     * @param  string  $options additional SQL fragment that will be appended to the generated SQL.
     * @return Command the command object itself
     */
    public function createTable($table, $columns, $options = null)
    {
        $sql = $this->db->getQueryBuilder()->createTable($table, $columns, $options);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for renaming a DB table.
     * @param  string  $table   the table to be renamed. The name will be properly quoted by the method.
     * @param  string  $newName the new table name. The name will be properly quoted by the method.
     * @return Command the command object itself
     */
    public function renameTable($table, $newName)
    {
        $sql = $this->db->getQueryBuilder()->renameTable($table, $newName);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for dropping a DB table.
     * @param  string  $table the table to be dropped. The name will be properly quoted by the method.
     * @return Command the command object itself
     */
    public function dropTable($table)
    {
        $sql = $this->db->getQueryBuilder()->dropTable($table);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for truncating a DB table.
     * @param  string  $table the table to be truncated. The name will be properly quoted by the method.
     * @return Command the command object itself
     */
    public function truncateTable($table)
    {
        $sql = $this->db->getQueryBuilder()->truncateTable($table);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for adding a new DB column.
     * @param  string  $table  the table that the new column will be added to. The table name will be properly quoted by the method.
     * @param  string  $column the name of the new column. The name will be properly quoted by the method.
     * @param  string  $type   the column type. [[\yii\db\QueryBuilder::getColumnType()]] will be called
     *                         to convert the give column type to the physical one. For example, `string` will be converted
     *                         as `varchar(255)`, and `string not null` becomes `varchar(255) not null`.
     * @return Command the command object itself
     */
    public function addColumn($table, $column, $type)
    {
        $sql = $this->db->getQueryBuilder()->addColumn($table, $column, $type);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for dropping a DB column.
     * @param  string  $table  the table whose column is to be dropped. The name will be properly quoted by the method.
     * @param  string  $column the name of the column to be dropped. The name will be properly quoted by the method.
     * @return Command the command object itself
     */
    public function dropColumn($table, $column)
    {
        $sql = $this->db->getQueryBuilder()->dropColumn($table, $column);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for renaming a column.
     * @param  string  $table   the table whose column is to be renamed. The name will be properly quoted by the method.
     * @param  string  $oldName the old name of the column. The name will be properly quoted by the method.
     * @param  string  $newName the new name of the column. The name will be properly quoted by the method.
     * @return Command the command object itself
     */
    public function renameColumn($table, $oldName, $newName)
    {
        $sql = $this->db->getQueryBuilder()->renameColumn($table, $oldName, $newName);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for changing the definition of a column.
     * @param  string  $table  the table whose column is to be changed. The table name will be properly quoted by the method.
     * @param  string  $column the name of the column to be changed. The name will be properly quoted by the method.
     * @param  string  $type   the column type. [[\yii\db\QueryBuilder::getColumnType()]] will be called
     *                         to convert the give column type to the physical one. For example, `string` will be converted
     *                         as `varchar(255)`, and `string not null` becomes `varchar(255) not null`.
     * @return Command the command object itself
     */
    public function alterColumn($table, $column, $type)
    {
        $sql = $this->db->getQueryBuilder()->alterColumn($table, $column, $type);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for adding a primary key constraint to an existing table.
     * The method will properly quote the table and column names.
     * @param  string       $name    the name of the primary key constraint.
     * @param  string       $table   the table that the primary key constraint will be added to.
     * @param  string|array $columns comma separated string or array of columns that the primary key will consist of.
     * @return Command      the command object itself.
     */
    public function addPrimaryKey($name, $table, $columns)
    {
        $sql = $this->db->getQueryBuilder()->addPrimaryKey($name, $table, $columns);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for removing a primary key constraint to an existing table.
     * @param  string  $name  the name of the primary key constraint to be removed.
     * @param  string  $table the table that the primary key constraint will be removed from.
     * @return Command the command object itself
     */
    public function dropPrimaryKey($name, $table)
    {
        $sql = $this->db->getQueryBuilder()->dropPrimaryKey($name, $table);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for adding a foreign key constraint to an existing table.
     * The method will properly quote the table and column names.
     * @param  string  $name       the name of the foreign key constraint.
     * @param  string  $table      the table that the foreign key constraint will be added to.
     * @param  string  $columns    the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas.
     * @param  string  $refTable   the table that the foreign key references to.
     * @param  string  $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas.
     * @param  string  $delete     the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
     * @param  string  $update     the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
     * @return Command the command object itself
     */
    public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null)
    {
        $sql = $this->db->getQueryBuilder()->addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete, $update);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for dropping a foreign key constraint.
     * @param  string  $name  the name of the foreign key constraint to be dropped. The name will be properly quoted by the method.
     * @param  string  $table the table whose foreign is to be dropped. The name will be properly quoted by the method.
     * @return Command the command object itself
     */
    public function dropForeignKey($name, $table)
    {
        $sql = $this->db->getQueryBuilder()->dropForeignKey($name, $table);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for creating a new index.
     * @param  string       $name    the name of the index. The name will be properly quoted by the method.
     * @param  string       $table   the table that the new index will be created for. The table name will be properly quoted by the method.
     * @param  string|array $columns the column(s) that should be included in the index. If there are multiple columns, please separate them
     *                               by commas. The column names will be properly quoted by the method.
     * @param  boolean      $unique  whether to add UNIQUE constraint on the created index.
     * @return Command      the command object itself
     */
    public function createIndex($name, $table, $columns, $unique = false)
    {
        $sql = $this->db->getQueryBuilder()->createIndex($name, $table, $columns, $unique);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for dropping an index.
     * @param  string  $name  the name of the index to be dropped. The name will be properly quoted by the method.
     * @param  string  $table the table whose index is to be dropped. The name will be properly quoted by the method.
     * @return Command the command object itself
     */
    public function dropIndex($name, $table)
    {
        $sql = $this->db->getQueryBuilder()->dropIndex($name, $table);

        return $this->setSql($sql);
    }

    /**
     * Creates a SQL command for resetting the sequence value of a table's primary key.
     * The sequence will be reset such that the primary key of the next new row inserted
     * will have the specified value or 1.
     * @param  string                $table the name of the table whose primary key sequence will be reset
     * @param  mixed                 $value the value for the primary key of the next new row inserted. If this is not set,
     *                                      the next new row's primary key will have a value 1.
     * @return Command               the command object itself
     * @throws NotSupportedException if this is not supported by the underlying DBMS
     */
    public function resetSequence($table, $value = null)
    {
        $sql = $this->db->getQueryBuilder()->resetSequence($table, $value);

        return $this->setSql($sql);
    }

    /**
     * Builds a SQL command for enabling or disabling integrity check.
     * @param  boolean               $check  whether to turn on or off the integrity check.
     * @param  string                $schema the schema name of the tables. Defaults to empty string, meaning the current
     *                                       or default schema.
     * @param  string                $table  the table name.
     * @return Command               the command object itself
     * @throws NotSupportedException if this is not supported by the underlying DBMS
     */
    public function checkIntegrity($check = true, $schema = '', $table = '')
    {
        $sql = $this->db->getQueryBuilder()->checkIntegrity($check, $schema, $table);

        return $this->setSql($sql);
    }
w  
Qiang Xue committed
782
}