Spec-Zone.ru › CakePHP 3.5

Класс Sqlserver

Драйвер SQLServer.

Cake\Database\Driver
Extended by Cake\Database\Driver\Sqlserver использует Cake\Database\Driver\PDODriverTrait , Cake\Database\Dialect\SqlserverDialectTrait
Пространство имён: Cake\Database\Driver
Расположение: Database/Driver/Sqlserver.php

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

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

Наследованные магические свойства

  • _connection

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

  • _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).

Возвращает

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

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Возвращает

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

Наследованные методы из Cake\Database\Driver

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

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

Выбрасывает

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__destruct()source public

__destruct( )

Деструктор

autoQuoting()source public

autoQuoting( boolean|null $enable null )

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

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

Устарело

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

Параметры

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

Возвращает

boolean

beginTransaction()source abstract public

beginTransaction( )

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

Возвращает

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

commitTransaction()source abstract public

commitTransaction( )

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

Возвращает

boolean
true при успехе, иначе 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 optional null
Объект соединения

Возвращает

PDO

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

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

Возвращает

string

disconnect()source abstract public

disconnect( )

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

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable true )

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

Параметры

boolean $enable optional true
Включить авто-цитирование

Возвращает


$this

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

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

Возвращает

string

isAutoQuotingEnabled()source public

isAutoQuotingEnabled( )

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

Возвращает

boolean
END_OF_DOCUMENT_MARKER

isConnected()source public

isConnected( )

Проверка подключения драйвера.

Возвращает

boolean

lastInsertId()source public

lastInsertId( string|null $table null , string|null $column null )

Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных

Параметры

string|null $table необязательно null
Имя таблицы или последовательности для получения последнего значения вставки
string|null $column необязательно null
Имя столбца, представляющего первичный ключ

Возвращает

string|integer

newCompiler()source public

newCompiler( )

Возвращает экземпляр QueryCompiler

Возвращает

Cake\Database\QueryCompiler

queryTranslator()source abstract public

queryTranslator( string $type )

Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, преобразованного для соответствия особенностям используемого диалекта SQL.

Параметры

string $type

Тип запроса, который должен быть преобразован (select, insert, update, delete)

Возвращает

callable

quote()source abstract public

quote( mixed $value , string $type )

Возвращает значение в безопасном представлении для использования в строке запроса

Параметры

mixed $value
Значение для цитирования.
string $type
Тип, используемый для определения вида цитирования

Возвращает

string

quoteIdentifier()source abstract public

quoteIdentifier( string $identifier )

Цитирует идентификатор базы данных (имя столбца, имя таблицы и т.д.) для безопасного использования в запросах без риска использования зарезервированных слов

Параметры

string $identifier
Выражение идентификатора для цитирования.

Возвращает

string

releaseSavePointSQL()source abstract public

releaseSavePointSQL( string $name )

Получение SQL для освобождения точки сохранения.

Параметры

string $name
Имя таблицы

Возвращает

string

rollbackSavePointSQL()source abstract public

rollbackSavePointSQL( string $name )

Получение SQL для отката точки сохранения.

Параметры

string $name
Имя таблицы

Возвращает

string

rollbackTransaction()source abstract public

rollbackTransaction( )

Откат транзакции

Возвращает

boolean
истина при успехе, ложь в противном случае

savePointSQL()source abstract public

savePointSQL( string $name )

Получение SQL для создания точки сохранения.

Параметры

string $name
Имя таблицы

Возвращает

string

schema()source public

schema( )

Возвращает имя схемы, используемой в данный момент

Возвращает

string

schemaDialect()source abstract public

schemaDialect( )

Получение диалекта схемы.

Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.

Если все таблицы, использующие этот драйвер, указывают свои собственные схемы, то это может вернуть null.

Возвращает

Cake\Database\Schema\BaseSchema

schemaValue()source public

schemaValue( mixed $value )

Экранирует значения для использования в определениях схемы.

Параметры

mixed $value
Значение для экранирования.

Возвращает

string
Строка для использования в определениях схемы.

supportsQuoting()source public

supportsQuoting( )

Проверка поддержки цитирования.

Возвращает

boolean

supportsSavePoints()source public

supportsSavePoints( )

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

Возвращает

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

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

_connect()source protected

_connect( string $dsn , array $config )

Установление соединения с сервером базы данных

Параметры

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

Возвращает

boolean
истина при успехе

beginTransaction()source public

beginTransaction( )

Начало транзакции

Возвращает

boolean
истина при успехе, ложь в противном случае

commitTransaction()source public

commitTransaction( )

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

Возвращает

boolean
истина при успехе, ложь в противном случае

connection()source public

connection( null|PDO $connection null )

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

Параметры

null|PDO $connection необязательно null
Экземпляр соединения PDO.

Возвращает

PDO
объект соединения, используемый внутри

disconnect()source public

disconnect( )

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

isConnected()source public

isConnected( )

Проверка подключения драйвера.

Возвращает

boolean

lastInsertId()source public

lastInsertId( string|null $table null , string|null $column null )

Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных

Параметры

string|null $table необязательный null
Имя таблицы или последовательности, для получения последнего значения вставки
string|null $column необязательный null
Имя столбца, представляющего первичный ключ

Возвращает

string|integer

quote()source public

quote( mixed $value , string $type )

Возвращает значение в безопасном представлении для использования в строке запроса

Параметры

mixed $value
Значение для цитирования.
string $type
Тип, используемый для определения типа цитирования

Возвращает

string

rollbackTransaction()source public

rollbackTransaction( )

Отменить транзакцию

Возвращает

boolean
true при успехе, 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( )

newCompiler()source public

newCompiler( )

Возвращает

Cake\Database\SqlserverCompiler

releaseSavePointSQL()source public

releaseSavePointSQL( string $name )

Возвращает фрагмент SQL для освобождения ранее созданной точки сохранения

Параметры

string $name
имя точки сохранения

Возвращает

string

rollbackSavePointSQL()source public

rollbackSavePointSQL( string $name )

Возвращает фрагмент SQL для отката ранее созданной точки сохранения

Параметры

string $name
имя точки сохранения

Возвращает

string

savePointSQL()source public

savePointSQL( string $name )

Возвращает фрагмент SQL для создания новой точки сохранения транзакции

Параметры

string $name
имя точки сохранения

Возвращает

string

schemaDialect()source public

schemaDialect( )

Получить диалект схемы.

Используется пакетом Cake\Schema для отражения схемы и генерации схемы.

Возвращает

Cake\Database\Schema\SqlserverSchema

Подробности свойств

$_baseConfigsource

protected array

Базовые настройки конфигурации для драйвера 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–2018 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.5/class-Cake.Database.Driver.Sqlserver.html

Spec-Zone.ru

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