Класс Sqlserver
Драйвер SQLServer.
- Cake\Database\Driver implements Cake\Database\DriverInterface
-
Cake\Database\Driver\Sqlserver использует Cake\Database\Dialect\SqlserverDialectTrait
Краткое описание свойств
-
$_baseConfigprotectedБазовые параметры конфигурации для драйвера Sqlserverarray
Унаследованные свойства
-
_autoQuoting,_config,_connection_endQuote,_startQuote
Краткое описание методов
- connect() publicУстанавливает соединение с сервером базы данных.
- enabled() publicВозвращает, может ли PHP использовать этот драйвер для подключения к базе данных
- prepare() publicПодготавливает SQL-запрос для выполнения
- supportsDynamicConstraints() public
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Подробное описание методов
connect()source public
connect( )
Устанавливает соединение с сервером базы данных.
Обратите внимание, что атрибут PDO::ATTR_PERSISTENT не поддерживается драйверами SQL Server PHP PDO. Поэтому вы не можете использовать опцию постоянного подключения при подключении к SQL Server (для получения дополнительной информации см.: https://github.com/Microsoft/msphpsql/issues/65).
Возвращает
booleantrue при успехе
Вызывает
InvalidArgumentExceptionесли в конфигурации драйвера задано недопустимое значение
enabled()source public
enabled( )
Возвращает, может ли PHP использовать этот драйвер для подключения к базе данных
Возвращает
booleantrue, если драйвер можно использовать
prepare()source public
prepare( string|Cake\Database\Query $query )
Подготавливает SQL-запрос для выполнения
Параметры
- string|
Cake\Database\Query$query - Запрос для подготовки.
Возвращает
Cake\Database\StatementInterfaceПереопределяет
Cake\Database\Driver::prepare() supportsDynamicConstraints()source public
supportsDynamicConstraints( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращает
booleantrue, если драйвер поддерживает динамические ограничения.
Методы, унаследованные от Cake\Database\Driver
__construct()source public
__construct( array $config = [] )
Конструктор
Параметры
- array
$configoptional [] - Конфигурация для драйвера.
Вызывает
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
array_connect()source protected
_connect( string $dsn , array $config )
Устанавливает соединение с сервером базы данных
Параметры
- string
$dsn - Спецификация DSN, специфичная для драйвера PDO
- array
$config - конфигурация, которая будет использоваться для создания подключения
Возвращает
booleantrue при успехе
autoQuoting()source public deprecated
autoQuoting( boolean|null $enable = null )
Возвращает, должен ли этот драйвер автоматически заключать идентификаторы в запросы
Если вызывается с булевым аргументом, это переключится на авто-цитирование в соответствии с переданным значением
Устарело
3.4.0 используйте enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.Параметры
- boolean|null
$enableoptional null - Включить авто-цитирование
Возвращает
booleanbeginTransaction()source public
beginTransaction( )
Начинает транзакцию.
Возвращает
booleanИстина при успехе, ложь в противном случае.
Реализация
Cake\Database\DriverInterface::beginTransaction() commitTransaction()source public
commitTransaction( )
Подтверждает транзакцию.
Возвращает
booleanИстина при успехе, ложь в противном случае.
Реализация
Cake\Database\DriverInterface::commitTransaction() compileQuery()source public
compileQuery( Cake\Database\Query $query , Cake\Database\ValueBinder $generator )
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.
Параметры
-
Cake\Database\Query$query - Запрос для компиляции.
- Cake\Database\ValueBinder
$generator - Используемый обработчик значений.
Возвращает
arrayсодержащий 2 элемента. Первый элемент - преобразованный запрос, а второй - скомпилированный SQL.
Реализация
Cake\Database\DriverInterface::compileQuery() connection()source public deprecated
connection( mixed $connection = null )
Возвращает правильный ресурс или объект соединения, который используется внутри Если в качестве первого аргумента передано значение, оно установит внутренний объект соединения или результат в переданное значение.
Устарело
3.6.0 Используйте getConnection()/setConnection() вместо этого.Параметры
- mixed
$connectionoptional null - Экземпляр подключения PDO.
Возвращает
mixedВнутренний объект соединения.
disableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Получает SQL-код для отключения внешних ключей.
Возвращает
stringРеализация
Cake\Database\DriverInterface::disableForeignKeySQL() disconnect()source public
disconnect( )
Отключается от сервера базы данных.
Реализация
Cake\Database\DriverInterface::disconnect() enableAutoQuoting()source public
enableAutoQuoting( boolean $enable = true )
Устанавливает, должен ли этот драйвер автоматически заключать идентификаторы в запросы.
Параметры
- boolean
$enableoptional true - Включить авто-цитирование
Возвращает
$this
Реализация
Cake\Database\DriverInterface::enableAutoQuoting() enableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Получить SQL для включения внешних ключей.
Возвращает
stringРеализация
Cake\Database\DriverInterface::enableForeignKeySQL() getConnection()source public
getConnection( )
Получить внутренний экземпляр соединения PDO.
Возвращает
PDOРеализация
Cake\Database\DriverInterface::getConnection() isAutoQuotingEnabled()source public
isAutoQuotingEnabled( )
Возвращает, следует ли этому драйверу автоматически заключать идентификаторы в запросах.
Возвращает
booleanРеализация
Cake\Database\DriverInterface::isAutoQuotingEnabled() isConnected()source public
isConnected( )
Проверяет, подключен ли драйвер.
Возвращает
booleanРеализация
Cake\Database\DriverInterface::isConnected() lastInsertId()source public
lastInsertId( string|null $table = null , string|null $column = null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.
Параметры
- string|null
$tableнеобязательно null - имя таблицы или последовательности, чтобы получить последнее значение вставки.
- string|null
$columnнеобязательно null - имя столбца, представляющего первичный ключ.
Возвращает
string|integerРеализация
Cake\Database\DriverInterface::lastInsertId() newCompiler()source public
newCompiler( )
Возвращает экземпляр QueryCompiler.
Возвращает
Cake\Database\QueryCompilerРеализация
Cake\Database\DriverInterface::newCompiler() queryTranslator()source abstract public
queryTranslator( string $type )
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, который был преобразован для адаптации к особенностям используемого диалекта SQL.
Параметры
- string
$type Тип запроса, который должен быть преобразован (select, insert, update, delete).
Возвращает
callableРеализация
Cake\Database\DriverInterface::queryTranslator() quote()source public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса
Параметры
- mixed
$value - Значение для цитирования.
- string
$type - Тип, используемый для определения вида цитирования.
Возвращает
stringРеализация
Cake\Database\DriverInterface::quote() quoteIdentifier()source abstract public
quoteIdentifier( string $identifier )
Заключает в кавычки идентификатор базы данных (имя столбца, имя таблицы и т. д.) для безопасного использования в запросах без риска использования зарезервированных слов.
Параметры
- string
$identifier - Выражение идентификатора для цитирования.
Возвращает
stringРеализация
Cake\Database\DriverInterface::quoteIdentifier() releaseSavePointSQL()source abstract public
releaseSavePointSQL( string $name )
Получить SQL для освобождения точки сохранения.
Параметры
- string
$name - Имя таблицы.
Возвращает
stringРеализация
Cake\Database\DriverInterface::releaseSavePointSQL() rollbackSavePointSQL()source abstract public
rollbackSavePointSQL( string $name )
Получить SQL для отката точки сохранения.
Параметры
- string
$name - Имя таблицы.
Возвращает
stringРеализация
Cake\Database\DriverInterface::rollbackSavePointSQL() rollbackTransaction()source public
rollbackTransaction( )
Откатывает транзакцию.
Возвращает
booleanУспех - true, в противном случае - false.
Реализация
Cake\Database\DriverInterface::rollbackTransaction() savePointSQL()source abstract public
savePointSQL( string $name )
Получить SQL для создания точки сохранения.
Параметры
- string
$name - Имя таблицы.
Возвращает
stringРеализация
Cake\Database\DriverInterface::savePointSQL() schema()source public
schema( )
Возвращает имя схемы, которое используется.
Возвращает
stringРеализация
Cake\Database\DriverInterface::schema() schemaDialect()source abstract public
schemaDialect( )
Получить диалект схемы.
Возвращает
Cake\Database\Schema\BaseSchemaРеализация
Cake\Database\DriverInterface::schemaDialect() schemaValue()source public
schemaValue( mixed $value )
Экранирует значения для использования в определениях схемы.
Параметры
- mixed
$value - Значение для экранирования.
Возвращает
stringСтрока для использования в определениях схемы.
Реализация
Cake\Database\DriverInterface::schemaValue() setConnection()source public
setConnection( PDO $connection )
Установить внутренний экземпляр соединения PDO.
Параметры
- PDO
$connection - Экземпляр PDO.
Возвращает
$this
Реализация
Cake\Database\DriverInterface::setConnection() supportsQuoting()source public
supportsQuoting( )
Проверяет, поддерживает ли драйвер цитирование, так как PDO_ODBC его не поддерживает.
Возвращает
booleanРеализация
Cake\Database\DriverInterface::supportsQuoting() supportsSavePoints()source public
supportsSavePoints( )
Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.
Возвращает
booleanTrue, если точки сохранения поддерживаются, false в противном случае.
Реализация
Cake\Database\DriverInterface::supportsSavePoints() Методы, используемые из Cake\Database\Dialect\SqlserverDialectTrait
_expressionTranslators()source protected
_expressionTranslators( )
Возвращает словарь выражений, которые необходимо преобразовать при компиляции Query в SQL. Ключи массива — имена методов, которые нужно вызвать в этом классе.
Возвращает
array_pagingSubquery()source protected
_pagingSubquery( Cake\Database\Query $original , integer $limit , integer $offset )
Генерирует подзапрос для постраничной навигации для более старых версий SQLServer.
До SQLServer 2012 не было эквивалента LIMIT OFFSET, поэтому необходимо использовать подзапрос.
Параметры
- Cake\Database\Query
$original - Запрос, который нужно обернуть в подзапрос.
- целое число
$limit - Количество строк для выборки.
- целое число
$offset - Количество строк для смещения.
Возвращает
Cake\Database\QueryИзмененный объект запроса.
_selectQueryTranslator()source protected
_selectQueryTranslator( Cake\Database\Query $query )
Изменяет лимит/смещение на TSQL
Параметры
- Cake\Database\Query
$query - Запрос для преобразования
Возвращает
Cake\Database\QueryИзмененный запрос
_transformDistinct()source protected
_transformDistinct( Cake\Database\Query $original )
Возвращает переданный запрос после переписывания условия DISTINCT, так что драйверы, не поддерживающие часть «ON», могут предоставить фактический способ ее реализации
Параметры
- Cake\Database\Query
$original - Запрос, который нужно преобразовать
Возвращает
Cake\Database\Query_transformFunctionExpression()source protected
_transformFunctionExpression( Cake\Database\Expression\FunctionExpression $expression )
Принимает выражение FunctionExpression и изменяет его так, чтобы оно соответствовало этому диалекту SQL.
Параметры
- Cake\Database\Expression\FunctionExpression
$expression - Выражение функции, которое нужно преобразовать в TSQL.
_version()source public
_version( )
disableForeignKeySQL()source public
disableForeignKeySQL( )
enableForeignKeySQL()source public
enableForeignKeySQL( )
releaseSavePointSQL()source public
releaseSavePointSQL( string $name )
Возвращает фрагмент SQL для освобождения ранее созданной точки сохранения
Параметры
- строка
$name - имя точки сохранения
Возвращает
строкаrollbackSavePointSQL()source public
rollbackSavePointSQL( string $name )
Возвращает фрагмент SQL для отката ранее созданной точки сохранения
Параметры
- строка
$name - имя точки сохранения
Возвращает
строкаsavePointSQL()source public
savePointSQL( string $name )
Возвращает фрагмент SQL для создания новой точки сохранения транзакции
Параметры
- строка
$name - имя точки сохранения
Возвращает
строкаschemaDialect()source public
schemaDialect( )
Получить диалект схемы.
Используется пакетом Cake\Schema для отражения схемы и генерации схемы.
Возвращает
Cake\Database\Schema\SqlserverSchemaПодробное описание свойств
$_baseConfigsource
protected массив
Основные параметры конфигурации для драйвера Sqlserver
[
'host' => 'localhost\SQLEXPRESS',
'username' => '',
'password' => '',
'database' => 'cake',
'port' => '',
// PDO::SQLSRV_ENCODING_UTF8
'encoding' => 65001,
'flags' => [],
'init' => [],
'settings' => [],
'attributes' => [],
'app' => null,
'connectionPooling' => null,
'failoverPartner' => null,
'loginTimeout' => null,
'multiSubnetFailover' => null,
]
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Database.Driver.Sqlserver.html