Spec-Zone.ru › CakePHP 3.8

Класс Sqlserver

Драйвер SQLServer.

Cake\Database\Driver implements Cake\Database\DriverInterface
Расширенный Cake\Database\Driver\Sqlserver использует Cake\Database\Dialect\SqlserverDialectTrait
Пространство имён: Cake\Database\Driver
Расположение: Database/Driver/Sqlserver.php

Краткое описание свойств

  • $_baseConfig protected
    array
    Базовые параметры конфигурации для драйвера Sqlserver

Унаследованные свойства

  • _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 драйверами. В результате вы не можете использовать параметр persistent при подключении к SQL Server (подробнее см.: https://github.com/Microsoft/msphpsql/issues/65).

Возвращает

boolean
true при успехе

Выбрасывает

InvalidArgumentException
если в конфигурации драйвера указано недопустимое значение

enabled()source public

enabled( )

Возвращает, может ли PHP использовать этот драйвер для подключения к базе данных

Возвращает

boolean
true, если использование этого драйвера допустимо

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( )

Возвращает, поддерживает ли драйвер добавление или удаление ограничений для уже созданных таблиц.

Возвращает

boolean
true, если драйвер поддерживает динамические ограничения.

Методы, унаследованные от Cake\Database\Driver

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

array $config необязательно []
Конфигурация драйвера.

Выбрасывает

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array

__destruct()source public

__destruct( )

Деструктор

_connect()source protected

_connect( string $dsn , array $config )

Устанавливает подключение к серверу базы данных

Параметры

string $dsn
Драйвер-специфичный PDO-DSN
array $config
конфигурация для создания подключения

Возвращает

boolean
true при успехе

autoQuoting()source public устаревший

autoQuoting( boolean|null $enable = null )

Возвращает, нужно ли автоматически заключать идентификаторы в запросах

Если вызвано с логическим аргументом, то переключает автоцитирование на переданное значение

Устаревший

3.4.0 используйте enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.

Параметры

boolean|null $enable необязательно null
Включить автоцитирование

Возвращает

boolean

beginTransaction()source public

beginTransaction( )

Начинает транзакцию.

Возвращает

boolean
True при успехе, иначе false.

Реализация

Cake\Database\DriverInterface::beginTransaction()

commitTransaction()source public

commitTransaction( )

Подтверждает транзакцию.

Возвращает

boolean
True при успехе, иначе false.

Реализация

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 устаревший

connection( mixed $connection = null )

Возвращает правильный ресурс или объект подключения, используемый внутри. Если первый аргумент передан, он установит внутренний объект подключения или результат в переданное значение.

Устаревший

3.6.0 Используйте getConnection()/setConnection() вместо этого.

Параметры

mixed $connection необязательно null
Экземпляр PDO-подключения.

Возвращает

mixed
Внутренний объект подключения.

disableAutoQuoting()source public

disableAutoQuoting( )

Отключает автоматическое цитирование идентификаторов в запросах.

Возвращает


$this

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

Получить SQL для отключения внешних ключей.

Возвращает

string

Реализация

Cake\Database\DriverInterface::disableForeignKeySQL()

disconnect()source public

disconnect( )

Отключается от сервера базы данных.

Реализация

Cake\Database\DriverInterface::disconnect()
END_OF_DOCUMENT_MARKER

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable = true )

Устанавливает, должен ли этот драйвер автоматически заключать идентификаторы в кавычки в запросах.

Параметры

boolean $enable optional 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 optional null
Имя таблицы или последовательности, для получения последнего значения вставки.
string|null $column optional 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
Истина при успехе, ложь в противном случае.

Реализация

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( )

Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.

Возвращает

boolean
Истина, если точки сохранения поддерживаются, ложь в противном случае.

Реализация

Cake\Database\DriverInterface::supportsSavePoints()

Методы, используемые из Cake\Database\Dialect\SqlserverDialectTrait

_expressionTranslators()source protected

_expressionTranslators( )

Возвращает словарь выражений, которые будут преобразовываться при компиляции Query в SQL. Ключами массива являются имена методов, которые необходимо вызвать в этом классе.

Возвращает

array
END_OF_DOCUMENT_MARKER

_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( )

newCompiler()source public

newCompiler( )

Возвращает

Cake\Database\SqlserverCompiler

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.8/class-Cake.Database.Driver.Sqlserver.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API