0

Class yii\db\mssql\PDO

All Classes | Methods | Constants
Inheritanceyii\db\mssql\PDO » PDO
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/db/mssql/PDO.php

This is an extension of the default PDO class of MSSQL and DBLIB drivers.

It provides workarounds for improperly implemented functionalities of the MSSQL and DBLIB drivers.

The SQLSRV_ATTR_ENCODING and SQLSRV_ENCODING_SYSTEM constants can be used in yii\db\Connection::$attributes to eliminate the implicit nvarchar conversion overhead on char/varchar indexed columns.

Public Methods

Hide inherited methods

Method Description Defined By
beginTransaction() Starts a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions. yii\db\mssql\PDO
commit() Commits a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions. yii\db\mssql\PDO
getAttribute() Retrieve a database connection attribute. yii\db\mssql\PDO
lastInsertId() Returns value of the last inserted ID. yii\db\mssql\PDO
rollBack() Rollbacks a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions. yii\db\mssql\PDO

Constants

Hide inherited constants

Constant Value Description Defined By
SQLSRV_ATTR_ENCODING 1000 A constant for the pdo_sqlsrv encoding attribute. Pass as a key in yii\db\Connection::$attributes. Not supported by the FreeTDS (dblib) driver. yii\db\mssql\PDO
SQLSRV_ENCODING_SYSTEM 3 A constant for ANSI (system code page) string encoding. Use with SQLSRV_ATTR_ENCODING to avoid the implicit nvarchar-to-varchar conversion that degrades performance on char/varchar indexed columns. yii\db\mssql\PDO
SQLSRV_ENCODING_UTF8 65001 A constant for UTF-8 string encoding. This is the pdo_sqlsrv default for PDO::PARAM_STR parameters. yii\db\mssql\PDO

Method Details

Hide inherited methods

beginTransaction() public method

Starts a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions.

public boolean beginTransaction ( )
return boolean

The result of a transaction start.

 

                public function beginTransaction(): bool
{
    $this->exec('BEGIN TRANSACTION');
    return true;
}
commit() public method

Commits a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions.

public boolean commit ( )
return boolean

The result of a transaction commit.

 

                public function commit(): bool
{
    $this->exec('COMMIT TRANSACTION');
    return true;
}
getAttribute() public method

Retrieve a database connection attribute.

It is necessary to override PDO's method as some MSSQL PDO driver (for example, dblib) does not support getting attributes.

public mixed getAttribute ( integer $attribute )
$attribute integer

One of the PDO::ATTR_* constants.
return mixed

A successful call returns the value of the requested PDO attribute. An unsuccessful call returns null.

 

                public function getAttribute(int $attribute): mixed
{
    $sql = <<<SQL
    SELECT CAST(SERVERPROPERTY('productversion') AS VARCHAR)
    SQL;
    try {
        return parent::getAttribute($attribute);
    } catch (PDOException $e) {
        switch ($attribute) {
            case self::ATTR_SERVER_VERSION:
                // Reached only on the `dblib` driver (throws on `getAttribute()`); never on `sqlsrv`/CI.
                // @codeCoverageIgnoreStart
                return $this->query($sql)->fetchColumn();
                // @codeCoverageIgnoreEnd
            default:
                throw $e;
        }
    }
}
lastInsertId() public method

Returns value of the last inserted ID.

public string|false lastInsertId ( string|null $sequence = null )
$sequence string|null

The sequence name. Defaults to null.
return string|false

Last inserted ID value.

 

                public function lastInsertId(string|null $sequence = null): string|false
{
    $sql = <<<SQL
    SELECT CAST(COALESCE(SCOPE_IDENTITY(), @@IDENTITY) AS bigint)
    SQL;
    $id = $this->query($sql)->fetchColumn();
    return $id === null ? false : (string) $id;
}
rollBack() public method

Rollbacks a transaction. It is necessary to override PDO's method as MSSQL PDO driver does not natively support transactions.

public boolean rollBack ( )
return boolean

The result of a transaction roll back.

 

                public function rollBack(): bool
{
    $this->exec('ROLLBACK TRANSACTION');
    return true;
}