Interface Yiisoft\Db\Driver\Pdo\PdoCommandInterface

Defined in: Yiisoft\Db\Command\CommandInterface::addCheck()

Creates an SQL command for adding a CHECK constraint to an existing table.

Defined in: Yiisoft\Db\Command\CommandInterface::addColumn()

Creates an SQL command for adding a new DB column.

Defined in: Yiisoft\Db\Command\CommandInterface::addCommentOnColumn()

Builds an SQL command for adding a comment to a column.

Defined in: Yiisoft\Db\Command\CommandInterface::addCommentOnTable()

Builds an SQL command for adding comment to the table.

Defined in: Yiisoft\Db\Command\CommandInterface::addDefaultValue()

Creates an SQL command for adding a default value constraint to an existing table.

Defined in: Yiisoft\Db\Command\CommandInterface::addForeignKey()

Creates an SQL command for adding a foreign key constraint to an existing table.

The method will quote the name, table, referenceTable parameters before using them in the generated SQL.

Defined in: Yiisoft\Db\Command\CommandInterface::addPrimaryKey()

Creates an SQL command for adding a primary key constraint to an existing table.

The method will quote the table and column names.

Defined in: Yiisoft\Db\Command\CommandInterface::addUnique()

Creates an SQL command for adding a unique constraint to an existing table.

Defined in: Yiisoft\Db\Command\CommandInterface::alterColumn()

Creates an SQL command for changing the definition of a column.

Defined in: Yiisoft\Db\Command\CommandInterface::bindParam()

Binds a parameter to the SQL statement to be executed.

Defined in: Yiisoft\Db\Command\CommandInterface::bindValue()

Binds a value to a parameter.

Defined in: Yiisoft\Db\Command\CommandInterface::bindValues()

Binds a list of values to the corresponding parameters.

This is similar to {@see \Yiisoft\Db\Command\bindValue()} except that it binds many values at a time.

Note that the SQL data type of each value is determined by its PHP type.

Defined in: Yiisoft\Db\Command\CommandInterface::cancel()

Cancels the execution of the SQL statement.

Defined in: Yiisoft\Db\Command\CommandInterface::checkIntegrity()

Builds an SQL command for enabling or disabling integrity check.

Defined in: Yiisoft\Db\Command\CommandInterface::createIndex()

Creates an SQL command for creating a new index.

Defined in: Yiisoft\Db\Command\CommandInterface::createTable()

Creates an 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 is the name of the column which will be properly quoted by the method, and definition is the type of the column which can contain a native database column type, {@see \Yiisoft\Db\Constant\ColumnType abstract} or {@see \Yiisoft\Db\Constant\PseudoType pseudo} type, or can be represented as instance of {@see \Yiisoft\Db\Schema\Column\ColumnInterface}.

The {@see \Yiisoft\Db\Command\QueryBuilderInterface::buildColumnDefinition()} method will be invoked to convert column definitions into SQL representation. For example, it will convert string not null to varchar(255) not null and pk to int PRIMARY KEY AUTO_INCREMENT (for MySQL).

The preferred way is to use {@see \Yiisoft\Db\Command\ColumnBuilder} to generate column definitions as instances of {@see \Yiisoft\Db\Schema\Column\ColumnInterface}.

$this->createTable(
    'example_table',
    [
        'id' => ColumnBuilder::primaryKey(),
        'name' => ColumnBuilder::string(64)->notNull(),
        'type' => ColumnBuilder::integer()->notNull()->defaultValue(10),
        'description' => ColumnBuilder::text(),
        'rule_name' => ColumnBuilder::string(64),
        'data' => ColumnBuilder::text(),
        'created_at' => ColumnBuilder::datetime()->notNull(),
        'updated_at' => ColumnBuilder::datetime(),
    ],
);

If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly put into the generated SQL.

The method will quote the table and columns parameter before using it in the generated SQL.

Defined in: Yiisoft\Db\Command\CommandInterface::createView()

Creates a SQL View.

Defined in: Yiisoft\Db\Command\CommandInterface::delete()

Creates a DELETE command.

For example,

$connectionInterface->createCommand()->delete('user', 'status = 0')->execute();

or with using parameter binding for the condition:

$status = 0;
$connectionInterface->createCommand()->delete('user', 'status = :status', [':status' => $status])->execute();

The method will escape the table and column names.

Note that the created command isn't executed until you call {@see \Yiisoft\Db\Command\execute()}.

Defined in: Yiisoft\Db\Command\CommandInterface::dropCheck()

Creates an SQL command for dropping a check constraint.

Defined in: Yiisoft\Db\Command\CommandInterface::dropColumn()

Creates an SQL command for dropping a DB column.

Defined in: Yiisoft\Db\Command\CommandInterface::dropCommentFromColumn()

Builds an SQL command for dropping comment from column.

Defined in: Yiisoft\Db\Command\CommandInterface::dropCommentFromTable()

Builds an SQL command for dropping comment from the table.

Defined in: Yiisoft\Db\Command\CommandInterface::dropDefaultValue()

Creates an SQL command for dropping a default value constraint.

Defined in: Yiisoft\Db\Command\CommandInterface::dropForeignKey()

Creates an SQL command for dropping a foreign key constraint.

Defined in: Yiisoft\Db\Command\CommandInterface::dropIndex()

Creates an SQL command for dropping an index.

Defined in: Yiisoft\Db\Command\CommandInterface::dropPrimaryKey()

Creates an SQL command for removing a primary key constraint to an existing table.

Defined in: Yiisoft\Db\Command\CommandInterface::dropTable()

Creates an SQL command for dropping a DB table.

Defined in: Yiisoft\Db\Command\CommandInterface::dropUnique()

Creates an SQL command for dropping a unique constraint.

Defined in: Yiisoft\Db\Command\CommandInterface::dropView()

Drops an SQL View.

Defined in: Yiisoft\Db\Command\CommandInterface::execute()

Executes the SQL statement.

You should use this method only for executing a non-query SQL statement, such as INSERT, DELETE, UPDATE SQLs. It returns no result set.

Defined in: Yiisoft\Db\Command\CommandInterface::getParams()

Return the params used in the last query.

Defined in: Yiisoft\Db\Command\CommandInterface::getRawSql()

Returns the raw SQL by inserting parameter values into the corresponding placeholders in {@see getSql()}.

Note that you should mainly use the return value of this method for logging.

It's likely that this method returns an invalid SQL due to improper replacement of parameter placeholders.

Defined in: Yiisoft\Db\Command\CommandInterface::getSql()

Returns the SQL statement for this command.

Defined in: Yiisoft\Db\Command\CommandInterface::insert()

Creates an INSERT command.

For example,

$connectionInterface->createCommand()->insert(
    'user',
    [
        'name' => 'Sam',
        'age' => 30,
    ]
)->execute();

The method will escape the column names, and bind the values to be inserted.

Note that the created command isn't executed until you call {@see \Yiisoft\Db\Command\execute()}.

Defined in: Yiisoft\Db\Command\CommandInterface::insertBatch()

Creates a batch INSERT command.

For example,

$connectionInterface->createCommand()->insertBatch(
    'user',
    [
        ['Tom', 30],
        ['Jane', 20],
        ['Linda', 25],
    ],
    ['name', 'age']
)->execute();

or as associative arrays where the keys are column names

$connectionInterface->createCommand()->insertBatch(
    'user',
    [
        ['name' => 'Tom', 'age' => 30],
        ['name' => 'Jane', 'age' => 20],
        ['name' => 'Linda', 'age' => 25],
    ]
)->execute();

The method will escape the column names, and quote the values to insert.

Note that the values in each row must match the corresponding column names.

Also note that the created command isn't executed until {@see \Yiisoft\Db\Command\execute()} is called.

Defined in: Yiisoft\Db\Command\CommandInterface::insertReturningPks()

Attention! Please use function only as a last resort. The feature will be refactored in future releases.

Executes the INSERT command, returning primary key inserted values.

Defined in: Yiisoft\Db\Command\CommandInterface::prepare()

Prepares the SQL statement to be executed.

For complex SQL statement that's to be executed many times, this may improve performance.

For SQL statement with binding parameters, this method is invoked automatically.

Defined in: Yiisoft\Db\Command\CommandInterface::query()

Executes the SQL statement and returns a query result.

This method is for executing an SQL query that returns result set, such as SELECT.

Defined in: Yiisoft\Db\Command\CommandInterface::queryAll()

Executes the SQL statement and returns ALL rows at once.

Defined in: Yiisoft\Db\Command\CommandInterface::queryColumn()

Execute the SQL statement and returns the first column of the result.

This method is best used when you need only the first column of a result (that's the first element in each row).

Defined in: Yiisoft\Db\Command\CommandInterface::queryOne()

Executes the SQL statement and returns the first row of the result.

This method is best used when you need only the first row of a result.

Defined in: Yiisoft\Db\Command\CommandInterface::queryScalar()

Execute the SQL statement and returns the value of the first column in the first row of data.

This method is best used when you need only a single value. Do not use this method for boolean values as it returns false if there is no value.

Defined in: Yiisoft\Db\Command\CommandInterface::renameColumn()

Creates an SQL command for renaming a column.

Defined in: Yiisoft\Db\Command\CommandInterface::renameTable()

Creates an SQL command for renaming a DB table.

Defined in: Yiisoft\Db\Command\CommandInterface::resetSequence()

Executes a db command resetting the sequence value of a table's primary key.

Reason for execute is that some databases (Oracle) need several queries to do so.

The sequence is reset such that the primary key of the next new row inserted will have the specified value or the maximum existing value +1.

Defined in: Yiisoft\Db\Command\CommandInterface::setRawSql()

Specifies the SQL statement to execute.

The SQL statement won't be modified in any way.

The earlier SQL (if any) will be discarded, and {@see \Yiisoft\Db\Expression\Value\Param} will be cleared as well.

See {@see \Yiisoft\Db\Command\reset()} for details.

See also:

• \Yiisoft\Db\Command\reset()
• cancel()

Defined in: Yiisoft\Db\Command\CommandInterface::setRetryHandler()

Sets a closure (anonymous function) which called when a database exception is thrown when executing the command.

The signature of the closure should be:

use Yiisoft\Db\Exception\Exception;

function (Exception $e, int $attempt): bool
{
    // return true or false (whether to retry the command or throw $e)
}

The closure will receive an {@see \Yiisoft\Db\Exception\Exception} converted from the thrown database exception and the current attempt to execute the command, starting from 1.

If the closure returns true, the command will be retried. If the closure returns false, the {@see \Yiisoft\Db\Exception\Exception} will be thrown.

Defined in: Yiisoft\Db\Command\CommandInterface::setSql()

Specifies the SQL statement to execute. The SQL statement will be quoted using {@see ConnectionInterface::quoteSql()}.

The previous SQL (if any) will be discarded, and {@see \Yiisoft\Db\Expression\Value\Param} will be cleared as well. See {@see \Yiisoft\Db\Command\reset()} for details.

See also:

• \Yiisoft\Db\Command\reset()
• cancel()

Defined in: Yiisoft\Db\Command\CommandInterface::showDatabases()

List all database names in the current connection.

Defined in: Yiisoft\Db\Command\CommandInterface::truncateTable()

Creates an SQL command for truncating a DB table.

Defined in: Yiisoft\Db\Command\CommandInterface::update()

Creates an UPDATE command.

For example,

$connectionInterface->createCommand()->update('user', ['status' => 1], 'age > 30')->execute();

or with using parameter binding for the condition:

$minAge = 30;
$connectionInterface->createCommand()->update(
    'user',
    ['status' => 1],
    'age > :minAge',
    [':minAge' => $minAge]
)->execute();

The method will escape the column names and bind the values to update.

Note that the created command isn't executed until you call {@see \Yiisoft\Db\Command\execute()}.

Defined in: Yiisoft\Db\Command\CommandInterface::upsert()

Creates a command to insert rows into a database table if they don't already exist (matching unique constraints) or update them if they do.

For example,

$sql = $queryBuilder->upsert(
    'pages',
    [
        'name' => 'Front page',
        'url' => 'http://example.com/', // url is unique
        'visits' => 0,
    ],
    [
        'visits' => new \Yiisoft\Db\Expression\Expression('visits + 1'),
    ],
    $params,
);

The method will escape the table and column names.

Defined in: Yiisoft\Db\Command\CommandInterface::upsertReturning()

Creates a command to insert rows into a database table if they don't already exist (matching unique constraints) or update them if they do, returning values from the specified columns.

The method will quote the table, insertColumns, updateColumns and returnColumns parameters before using it in the generated SQL.

See also upsertReturningPks().

Defined in: Yiisoft\Db\Command\CommandInterface::upsertReturningPks()

Creates a command to insert rows into a database table if they don't already exist (matching unique constraints) or update them if they do, with returning inserted or updated primary key values.

The method will quote the table, insertColumns and updateColumns parameters before using it in the generated SQL.

See also upsertReturning().

Defined in: Yiisoft\Db\Command\CommandInterface::withDbTypecasting()

Returns copy of the instance with enabled or disabled typecasting of values when inserting or updating records.

Defined in: Yiisoft\Db\Command\CommandInterface::withPhpTypecasting()

Returns a copy of the instance with enabled or disabled typecasting of values when retrieving records from DB.

Defined in: Yiisoft\Db\Command\CommandInterface::withTypecasting()

Returns a copy of the instance with enabled or disabled typecasting of values when inserting, updating or retrieving records from DB.