Класс Sqlserver
Драйвер SQLServer.
- Cake\Database\Driver
-
Cake\Database\Driver\Sqlserver использует Cake\Database\Driver\PDODriverTrait , 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\StatementInterfacesupportsDynamicConstraints()source public
supportsDynamicConstraints( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений для уже созданных таблиц.
Возвращает
booleantrue, если драйвер поддерживает динамические ограничения
Наследованные методы из Cake\Database\Driver
__construct()source public
__construct( array $config [] )
Конструктор
Параметры
- array
$configнеобязательно [] - Конфигурация для драйвера.
Исключения
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.
Возвращает
arrayautoQuoting()source public
autoQuoting( boolean|null $enable null )
Возвращает, будет ли этот драйвер автоматически указывать идентификаторы в запросах
Если вызывается с булевым аргументом, это переключает автоматическое указание на переданное значение
Устарело
3.4.0 используйте enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.Параметры
- boolean|null
$enableнеобязательно null - Включать или выключать автоматическое указание
Возвращает
booleanbeginTransaction()source abstract public
beginTransaction( )
Начинает транзакцию
Возвращает
booleantrue при успехе, иначе false
commitTransaction()source abstract public
commitTransaction( )
Подтверждает транзакцию
Возвращает
booleantrue при успехе, иначе false
compileQuery()source public
compileQuery( Cake\Database\Query $query , Cake\Database\ValueBinder $generator )
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL
Параметры
-
Cake\Database\Query$query - Запрос для компиляции.
- Cake\Database\ValueBinder
$generator - Используемый менеджер связывания значений.
Возвращает
arrayсодержащий 2 элемента. Первый элемент - преобразованный запрос, второй - скомпилированная строка SQL
connection()source abstract public
connection( null|PDO $connection null )
Возвращает правильный ресурс или объект подключения, который используется внутри. Если первый аргумент передан,
Параметры
- null|PDO
$connectionнеобязательно null - Объект подключения
Возвращает
PDOdisableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Получает SQL для отключения внешних ключей
Возвращает
stringenableAutoQuoting()source public
enableAutoQuoting( boolean $enable true )
Устанавливает, будет ли этот драйвер автоматически указывать идентификаторы в запросах.
Параметры
- boolean
$enableнеобязательно true - Включать или выключать автоматическое указание
Возвращает
$this
enableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Получает SQL для включения внешних ключей
Возвращает
stringisAutoQuotingEnabled()source public
isAutoQuotingEnabled( )
Возвращает, будет ли этот драйвер автоматически указывать идентификаторы в запросах
Возвращает
booleanlastInsertId()source public
lastInsertId( string|null $table null , string|null $column null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
Параметры
- string|null
$tableнеобязательный null - Имя таблицы или последовательности для получения последнего значения вставки
- string|null
$columnнеобязательный null - Имя столбца, представляющего первичный ключ
Возвращает
string|integernewCompiler()source public
newCompiler( )
Возвращает экземпляр QueryCompiler
Возвращает
Cake\Database\QueryCompilerqueryTranslator()source abstract public
queryTranslator( string $type )
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, преобразованного для соответствия особенностям используемого диалекта SQL.
Параметры
- string
$type Тип запроса, который нужно преобразовать (select, insert, update, delete)
Возвращает
callablequote()source abstract public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса.
Параметры
- mixed
$value - Значение для цитирования.
- string
$type - Тип для определения типа цитирования.
Возвращает
stringquoteIdentifier()source abstract public
quoteIdentifier( string $identifier )
Цитирует идентификатор базы данных (имя столбца, имя таблицы и т.д.) для безопасного использования в запросах без риска использования зарезервированных слов.
Параметры
- string
$identifier - Выражение идентификатора для цитирования.
Возвращает
stringreleaseSavePointSQL()source abstract public
releaseSavePointSQL( string $name )
Получение SQL для освобождения точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращает
stringrollbackSavePointSQL()source abstract public
rollbackSavePointSQL( string $name )
Получение SQL для отката точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращает
stringrollbackTransaction()source abstract public
rollbackTransaction( )
Откат транзакции
Возвращает
booleantrue при успехе, false в противном случае
savePointSQL()source abstract public
savePointSQL( string $name )
Получение SQL для создания точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращает
stringschemaDialect()source abstract public
schemaDialect( )
Получение диалекта схемы.
Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.
Если все таблицы, использующие этот драйвер, указывают свои схемы, то это может вернуть null.
Возвращает
Cake\Database\Schema\BaseSchemaschemaValue()source public
schemaValue( mixed $value )
Экранирует значения для использования в определениях схем.
Параметры
- mixed
$value - Значение для экранирования.
Возвращает
stringСтрока для использования в определениях схем.
supportsQuoting()source public
supportsQuoting( )
Проверка поддержки цитирования.
Возвращает
booleansupportsSavePoints()source public
supportsSavePoints( )
Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций
Возвращает
booleantrue, если точки сохранения поддерживаются, false в противном случае
Методы, используемые из Cake\Database\Driver\PDODriverTrait
_connect()source protected
_connect( string $dsn , array $config )
Установление соединения с сервером базы данных
Параметры
- string
$dsn - Драйвер-специфический PDO-DSN
- array
$config - Конфигурация, используемая для создания соединения
Возвращает
booleantrue при успехе
beginTransaction()source public
beginTransaction( )
Начало транзакции
Возвращает
booleantrue при успехе, false в противном случае
commitTransaction()source public
commitTransaction( )
Подтверждение транзакции
Возвращает
booleantrue при успехе, false в противном случае
connection()source public
connection( null|PDO $connection null )
Возвращает правильный ресурс или объект соединения, используемый внутри. Если передан первый аргумент, то он установит внутренний объект соединения или результат на переданное значение.
Параметры
- null|PDO
$connectionнеобязательный null - Экземпляр подключения PDO.
Возвращает
PDOобъект соединения, используемый внутри
lastInsertId()source public
lastInsertId( string|null $table null , string|null $column null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
Параметры
- string|null
$tableнеобязательно null - Имя таблицы или последовательности для получения последнего значения вставки
- string|null
$columnнеобязательно null - Имя столбца, представляющего первичный ключ
Возвращает
string|integerquote()source public
quote( mixed $value , string $type )
Возвращает значение в безопасном формате для использования в строке запроса
Параметры
- mixed
$value - Значение для цитирования.
- string
$type - Тип, используемый для определения типа цитирования
Возвращает
stringrollbackTransaction()source public
rollbackTransaction( )
Откатывает транзакцию
Возвращает
booleantrue при успехе, false в противном случае
supportsQuoting()source public
supportsQuoting( )
Проверяет, поддерживает ли драйвер цитирование, так как PDO_ODBC его не поддерживает.
Возвращает
booleanМетоды, используемые из Cake\Database\Dialect\SqlserverDialectTrait
_expressionTranslators()source protected
_expressionTranslators( )
Возвращает словарь выражений, которые должны быть преобразованы при компиляции запроса в SQL. Ключами массива являются имена методов, которые должны быть вызваны в этом классе
Возвращает
array_pagingSubquery()source protected
_pagingSubquery( Cake\Database\Query $original , integer $limit , integer $offset )
Генерирует подзапрос для постраничной навигации для более старых версий SQLServer.
До SQLServer 2012 не было эквивалента LIMIT OFFSET, поэтому необходимо использовать подзапрос.
Параметры
- Cake\Database\Query
$original - Запрос, который нужно обернуть в подзапрос.
- integer
$limit - Количество строк для извлечения.
- integer
$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 для освобождения ранее созданной точки сохранения
Параметры
- string
$name - Имя точки сохранения
Возвращает
stringrollbackSavePointSQL()source public
rollbackSavePointSQL( string $name )
Возвращает фрагмент SQL для отката ранее созданной точки сохранения
Параметры
- string
$name - Имя точки сохранения
Возвращает
stringsavePointSQL()source public
savePointSQL( string $name )
Возвращает фрагмент SQL для создания новой точки сохранения транзакции
Параметры
- string
$name - Имя точки сохранения
Возвращает
stringschemaDialect()source public
schemaDialect( )
Получить диалект схемы.
Используется пакетом Cake\Schema для отражения схемы и генерации схемы.
Возвращает
Cake\Database\Schema\SqlserverSchemaПодробное описание свойств
$_baseConfigsource
protected array
Базовые настройки конфигурации для драйвера Sqlserver
[
'host' => 'localhost\SQLEXPRESS',
'username' => '',
'password' => '',
'database' => 'cake',
// PDO::SQLSRV_ENCODING_UTF8
'encoding' => 65001,
'flags' => [],
'init' => [],
'settings' => [],
'attributes' => [],
'app' => null,
'connectionPooling' => null,
'failoverPartner' => null,
'loginTimeout' => null,
'multiSubnetFailover' => null,
]
© 2005–2017 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.4/class-Cake.Database.Driver.Sqlserver.html