Класс 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( )
Устанавливает соединение с сервером базы данных
Возвращаемое значение
booleantrue при успехе
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
$configoptional [] - Конфигурация для драйвера.
Исключения
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращаемое значение
arrayautoQuoting()source public
autoQuoting( boolean|null $enable null )
Возвращает, следует ли этому драйверу автоматически заключать идентификаторы в запросы
Если вызван с аргументом boolean, он переключит настройку автоматического заключения в прошедшее значение
Параметры
- boolean|null
$enableoptional 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
$connectionoptional null - Объект соединения
disableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Получает SQL-код для отключения внешних ключей
Возвращаемое значение
stringenableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Получает SQL-код для включения внешних ключей
Возвращаемое значение
stringisConnected()source public
isConnected( )
Проверяет, подключен ли драйвер.
Возвращаемое значение
booleanlastInsertId()source public
lastInsertId( string|null $table null , string|null $column null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
Параметры
- string|null
$tableoptional null - имя таблицы или последовательности для получения последнего значения вставки
- string|null
$columnoptional null - имя столбца, представляющего первичный ключ
Возвращаемое значение
string|integernewCompiler()source public
newCompiler( )
Возвращает экземпляр QueryCompiler
Возвращаемое значение
Cake\Database\QueryCompilerqueryTranslator()source abstract public
queryTranslator( string $type )
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, преобразованного для соответствия особенностям используемого диалекта SQL.
Параметры
- строка
$type тип запроса, который необходимо преобразовать (select, insert, update, delete)
Возвращает
вызываемую функциюquote()source abstract public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса
Параметры
- смешанное
$value - Значение, которое необходимо привести к цитируемому виду.
- строка
$type - Тип, используемый для определения типа цитирования.
Возвращает
строкаquoteIdentifier()source abstract public
quoteIdentifier( string $identifier )
Приводит имя базы данных (имя столбца, имя таблицы и т. д.) к цитируемому виду для безопасного использования в запросах без риска использования зарезервированных слов
Параметры
- строка
$identifier - Выражение идентификатора, которое необходимо привести к цитируемому виду.
Возвращает
строкаreleaseSavePointSQL()source abstract public
releaseSavePointSQL( string $name )
Получение SQL для отмены сохранения точки.
Параметры
- строка
$name - Имя таблицы
Возвращает
строкаrollbackSavePointSQL()source abstract public
rollbackSavePointSQL( string $name )
Получение SQL для отката сохранения точки.
Параметры
- строка
$name - Имя таблицы
Возвращает
строкаrollbackTransaction()source abstract public
rollbackTransaction( )
Откатывает транзакцию
Возвращает
логическое значениеtrue в случае успеха, иначе false
savePointSQL()source abstract public
savePointSQL( string $name )
Получение SQL для создания сохранения точки.
Параметры
- строка
$name - Имя таблицы
Возвращает
строкаschemaDialect()source abstract public
schemaDialect( )
Получение диалекта схемы.
Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.
Если все таблицы, использующие этот драйвер, указывают свои собственные схемы, то это может вернуть null.
Возвращает
Cake\Database\Schema\BaseSchemaschemaValue()source public
schemaValue( mixed $value )
Экранирование значений для использования в определениях схемы.
Параметры
- смешанное
$value - Значение, которое необходимо экранировать.
Возвращает
строкаСтрока для использования в определениях схемы.
supportsQuoting()source public
supportsQuoting( )
Проверка поддержки цитирования.
Возвращает
логическое значениеsupportsSavePoints()source public
supportsSavePoints( )
Возвращает, поддерживает ли этот драйвер сохранения точек для вложенных транзакций
Возвращает
логическое значениеtrue, если сохранение точек поддерживается, иначе false
Методы, используемые из Cake\Database\Driver\PDODriverTrait
_connect()source protected
_connect( string $dsn , array $config )
Устанавливает соединение с сервером базы данных
Параметры
- строка
$dsn - Специфичное для драйвера PDO-DSN
- массив
$config - Настройки, которые будут использоваться для создания соединения
Возвращает
логическое значениеtrue в случае успеха
beginTransaction()source public
beginTransaction( )
Начинает транзакцию
Возвращает
логическое значениеtrue в случае успеха, иначе false
commitTransaction()source public
commitTransaction( )
Подтверждает транзакцию
Возвращает
логическое значениеtrue в случае успеха, иначе false
connection()source public
connection( null|PDO $connection null )
Возвращает правильный ресурс или объект соединения, используемый внутри. Если передан первый аргумент, он установит внутренний объект соединения или результат до переданного значения.
Параметры
- null|PDO
$connectionопционально null - Экземпляр соединения PDO.
Возвращает
PDOобъект соединения, используемый внутри
isConnected()source public
isConnected( )
Проверка подключения к драйверу.
Возвращает
логическое значениеlastInsertId()source public
lastInsertId( string|null $table null , string|null $column null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
Параметры
- строка|null
$tableопционально null - Имя таблицы или последовательности для получения последнего значения вставки
- строка|null
$columnопционально null - Имя столбца, представляющего первичный ключ
Возвращает
строка или целое числоquote()source public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса
Параметры
- смешанное
$value - Значение, которое необходимо привести к цитируемому виду.
- строка
$type - Тип, используемый для определения типа цитирования.
Возвращает
строкаrollbackTransaction()source public
rollbackTransaction( )
Откатывает транзакцию
Возвращает
логическое значениеtrue в случае успеха, иначе false
supportsQuoting()source public
supportsQuoting( )
Проверяет, поддерживает ли драйвер цитирование, так как PDO_ODBC его не поддерживает.
Возвращает
логическое значениеМетоды, используемые из Cake\Database\Dialect\SqlserverDialectTrait
_expressionTranslators()source protected
_expressionTranslators( )
Возвращает словарь выражений, которые должны быть преобразованы при компиляции запроса в SQL. Ключи массива — имена методов, которые необходимо вызвать в этом классе.
Возвращает
массив_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( )
Получить версию SQLServer, к которой мы подключены.
Возвращает
целое число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\MysqlSchemaПодробности свойств
$_baseConfigsource
protected массив
Базовые параметры конфигурации для драйвера Sqlserver
[
'persistent' => false,
'host' => 'localhost\SQLEXPRESS',
'username' => '',
'password' => '',
'database' => 'cake',
// PDO::SQLSRV_ENCODING_UTF8
'encoding' => 65001,
'flags' => [],
'init' => [],
'settings' => [],
]
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Database.Driver.Sqlserver.html