Spec-Zone.ru › Laravel 7

Подключение

класс Подключение реализует ConnectionInterface (Просмотреть исходный код)

Трейты

Обнаружение конфликтов одновременного доступа
Обнаружение потерянных подключений
Управление транзакциями

Свойства

protected PDO|Closure $pdo

Активное подключение PDO.

protected PDO|Closure $readPdo

Активное подключение PDO, используемое для чтения.

protected string $database

Имя подключенной базы данных.

protected string $tablePrefix

Префикс таблицы для подключения.

protected array $config

Параметры конфигурации подключения к базе данных.

protected callable $reconnector

Объект повторного подключения для соединения.

protected Grammar $queryGrammar

Реализация грамматики запросов.

protected Grammar $schemaGrammar

Реализация грамматики схем.

protected Processor $postProcessor

Реализация постпроцессора запросов.

protected Dispatcher $events

Объект диспетчера событий.

protected int $fetchMode

Режим извлечения по умолчанию для соединения.

protected int $transactions

Количество активных транзакций.

protected int $recordsModified

Указывает, были ли внесены изменения в базу данных.

protected array $queryLog

Все запросы, выполненные к соединению.

protected bool $loggingQueries

Указывает, ведется ли протоколирование запросов.

protected bool $pretending

Указывает, находится ли соединение в режиме "сухого запуска".

protected Connection $doctrineConnection

Экземпляр подключения Doctrine.

static protected array $resolvers

Решатели подключений.

Методы

bool causedByConcurrencyError(Throwable $e)

Определить, вызвана ли данная исключительная ситуация ошибкой конкурентного доступа, такой как тупиковая ситуация или сбой сериализации.

из DetectsConcurrencyErrors
bool causedByLostConnection(Throwable $e)

Определить, вызвана ли данная исключительная ситуация потерей соединения.

из DetectsLostConnections
mixed transaction(Closure $callback, int $attempts = 1)

Выполнить лямбда-выражение в рамках транзакции.

из ManagesTransactions
void handleTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)

Обработать исключение, возникшее при выполнении транзакционного оператора.

из ManagesTransactions
void beginTransaction()

Начать новую базу данных транзакции.

из ManagesTransactions
void createTransaction()

Создать транзакцию в базе данных.

из ManagesTransactions
void createSavepoint()

Создать точку сохранения в базе данных.

из ManagesTransactions
void handleBeginTransactionException(Throwable $e)

Обработать исключение при начале транзакции.

из ManagesTransactions
void commit()

Зафиксировать активную базу данных транзакцию.

из ManagesTransactions
void handleCommitTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)

Обработать исключение, возникшее при фиксации транзакции.

из ManagesTransactions
void rollBack(int|null $toLevel = null)

Отменить активную базу данных транзакцию.

из ManagesTransactions
void performRollBack(int $toLevel)

Выполнить откат в базе данных.

из ManagesTransactions
void handleRollBackException(Throwable $e)

Обработать исключение при отмене.

из ManagesTransactions
int transactionLevel()

Получить количество активных транзакций.

из ManagesTransactions
void __construct(PDO|Closure $pdo, string $database = '', string $tablePrefix = '', array $config = [])

Создать новый экземпляр подключения к базе данных.

void useDefaultQueryGrammar()

Установить синтаксический анализатор запросов по умолчанию.

Grammar getDefaultQueryGrammar()

Получить экземпляр синтаксического анализатора запросов по умолчанию.

void useDefaultSchemaGrammar()

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

Grammar getDefaultSchemaGrammar()

Получить экземпляр синтаксического анализатора схемы по умолчанию.

void useDefaultPostProcessor()

Установить обработчик запросов по умолчанию.

Processor getDefaultPostProcessor()

Получить экземпляр обработчика запросов по умолчанию.

Builder getSchemaBuilder()

Получить экземпляр генератора схемы для подключения.

Builder table(Closure|Builder|string $table, string|null $as = null)

Начать флуентный запрос к таблице базы данных.

Builder query()

Получить новый экземпляр билдера запросов.

mixed selectOne(string $query, array $bindings = [], bool $useReadPdo = true)

Выполнить оператор select и вернуть один результат.

array selectFromWriteConnection(string $query, array $bindings = [])

Выполнить оператор select в базе данных.

array select(string $query, array $bindings = [], bool $useReadPdo = true)

Выполнить оператор select в базе данных.

Generator cursor(string $query, array $bindings = [], bool $useReadPdo = true)

Выполнить оператор select в базе данных и вернуть генератор.

PDOStatement prepared(PDOStatement $statement)

Настроить подготовленное утверждение PDO.

PDO getPdoForSelect(bool $useReadPdo = true)

Получить подключение PDO для запроса select.

bool insert(string $query, array $bindings = [])

Выполнить оператор insert в базе данных.

int update(string $query, array $bindings = [])

Выполнить оператор обновления в базе данных.

int delete(string $query, array $bindings = [])

Выполнить оператор удаления в базе данных.

bool statement(string $query, array $bindings = [])

Выполнить SQL-запрос и вернуть логическое значение результата.

int affectingStatement(string $query, array $bindings = [])

Выполнить SQL-запрос и получить количество изменённых строк.

bool unprepared(string $query)

Выполнить неподготовленный прямой запрос к подключению PDO.

array pretend(Closure $callback)

Выполнить заданный обратный вызов в режиме «сухого прогона».

array withFreshQueryLog(Closure $callback)

Выполнить заданный обратный вызов в режиме «сухого прогона».

void bindValues(PDOStatement $statement, array $bindings)

Связать значения с параметрами в данном операторе.

array prepareBindings(array $bindings)

Подготовить параметры связывания запроса для выполнения.

mixed run(string $query, array $bindings, Closure $callback)

Выполнить SQL-запрос и записать контекст его выполнения в журнал.

mixed runQueryCallback(string $query, array $bindings, Closure $callback)

Выполнить SQL-запрос.

void logQuery(string $query, array $bindings, float|null $time = null)

Записать запрос в журнал запросов подключения.

float getElapsedTime(int $start)

Получить время, прошедшее с заданной начальной точки.

mixed handleQueryException(QueryException $e, string $query, array $bindings, Closure $callback)

Обработать исключение запроса.

mixed tryAgainIfCausedByLostConnection(QueryException $e, string $query, array $bindings, Closure $callback)

Обработать исключение запроса, возникшее во время его выполнения.

void reconnect()

Переподключиться к базе данных.

void reconnectIfMissingConnection()

Переподключиться к базе данных, если отсутствует подключение PDO.

void disconnect()

Отключиться от базового подключения PDO.

void listen(Closure $callback)

Зарегистрировать слушателя запросов базы данных с подключением.

array|null fireConnectionEvent(string $event)

Вызвать событие для этого подключения.

void event(mixed $event)

Вызвать заданное событие, если это возможно.

Expression raw(mixed $value)

Получить новое выражение необработанного запроса.

void recordsHaveBeenModified(bool $value = true)

Указать, были ли изменены какие-либо записи.

bool isDoctrineAvailable()

Доступен ли Doctrine?

Column getDoctrineColumn(string $table, string $column)

Получить экземпляр Doctrine Schema Column.

AbstractSchemaManager getDoctrineSchemaManager()

Получить менеджер схемы Doctrine DBAL для подключения.

Connection getDoctrineConnection()

Получить экземпляр подключения к базе данных Doctrine DBAL.

PDO getPdo()

Получить текущее подключение PDO.

PDO|Closure|null getRawPdo()

Получить текущий параметр подключения PDO без выполнения логики переподключения.

PDO getReadPdo()

Получить текущее подключение PDO, используемое для чтения.

PDO|Closure|null getRawReadPdo()

Получить текущий параметр подключения к чтению PDO без выполнения логики переподключения.

$this setPdo(PDO|Closure|null $pdo)

Установить подключение PDO.

$this setReadPdo(PDO|Closure|null $pdo)

Установить подключение PDO, используемое для чтения.

$this setReconnector(callable $reconnector)

Установить экземпляр переподключения для подключения.

string|null getName()

Получить имя подключения к базе данных.

mixed getConfig(string|null $option = null)

Получить параметр из параметров конфигурации.

string getDriverName()

Получить имя драйвера PDO.

Grammar getQueryGrammar()

Получить используемую грамматику запроса для подключения.

$this setQueryGrammar(Grammar $grammar)

Установить используемую грамматику запроса для подключения.

Grammar getSchemaGrammar()

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

$this setSchemaGrammar(Grammar $grammar)

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

Processor getPostProcessor()

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

$this setPostProcessor(Processor $processor)

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

Dispatcher getEventDispatcher()

Получить диспетчер событий, используемый соединением.

$this setEventDispatcher(Dispatcher $events)

Установить экземпляр диспетчера событий для соединения.

void unsetEventDispatcher()

Удалить диспетчер событий для этого соединения.

bool pretending()

Определить, находится ли соединение в режиме "сухого запуска".

array getQueryLog()

Получить журнал запросов соединения.

void flushQueryLog()

Очистить журнал запросов.

void enableQueryLog()

Включить журнал запросов для соединения.

void disableQueryLog()

Отключить журнал запросов для соединения.

bool logging()

Определить, ведем ли мы журнал запросов.

string getDatabaseName()

Получить имя подключенной базы данных.

$this setDatabaseName(string $database)

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

string getTablePrefix()

Получить префикс таблицы для соединения.

$this setTablePrefix(string $prefix)

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

Grammar withTablePrefix(Grammar $grammar)

Установить префикс таблицы и вернуть грамматику.

static void resolverFor(string $driver, Closure $callback)

Зарегистрировать решатель соединения.

static mixed getResolver(string $driver)

Получить решатель соединения для указанного драйвера.

Подробности

protected bool causedByConcurrencyError(Throwable $e)

Определить, была ли данная ошибка вызвана ошибкой одновременного доступа, такой как тупик или сбой сериализации.

Параметры

Throwable $e

Возвращаемое значение

bool

protected bool causedByLostConnection(Throwable $e)

Определить, была ли данная ошибка вызвана потерей соединения.

Параметры

Throwable $e

Возвращаемое значение

bool

mixed transaction(Closure $callback, int $attempts = 1)

Выполнить замыкание в рамках транзакции.

Параметры

Closure $callback
int $attempts

Возвращаемое значение

mixed

Исключения

Throwable

protected void handleTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)

Обработать исключение, возникшее при выполнении транзакционного оператора.

Параметры

Throwable $e
int $currentAttempt
int $maxAttempts

Возвращаемое значение

void

Исключения

Throwable

void beginTransaction()

Начать новую транзакцию базы данных.

Возвращаемое значение

void

Исключения

Throwable

protected void createTransaction()

Создать транзакцию в базе данных.

Возвращаемое значение

void

Исключения

Throwable

protected void createSavepoint()

Создать точку сохранения в базе данных.

Возвращаемое значение

void

Исключения

Throwable

protected void handleBeginTransactionException(Throwable $e)

Обработать исключение при начале транзакции.

Параметры

Throwable $e

Возвращаемое значение

void

Исключения

Throwable

void commit()

Зафиксировать активную транзакцию базы данных.

Возвращаемое значение

void

Исключения

Throwable

protected void handleCommitTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)

Обработка исключения, возникшего при подтверждении транзакции.

Параметры

Throwable $e
int $currentAttempt
int $maxAttempts

Возвращаемое значение

void

Исключения

Throwable

void rollBack(int|null $toLevel = null)

Откатить активную базу данных транзакцию.

Параметры

int|null $toLevel

Возвращаемое значение

void

Исключения

Throwable

protected void performRollBack(int $toLevel)

Выполнить откат в базе данных.

Параметры

int $toLevel

Возвращаемое значение

void

Исключения

Throwable

protected void handleRollBackException(Throwable $e)

Обработать исключение из отката.

Параметры

Throwable $e

Возвращаемое значение

void

Исключения

Throwable

int transactionLevel()

Получить количество активных транзакций.

Возвращаемое значение

int

void __construct(PDO|Closure $pdo, string $database = '', string $tablePrefix = '', array $config = [])

Создать новый экземпляр подключения к базе данных.

Параметры

PDO|Closure $pdo
string $database
string $tablePrefix
array $config

Возвращаемое значение

void

void useDefaultQueryGrammar()

Установить синтаксический анализатор запросов по умолчанию.

Возвращаемое значение

void

protected Grammar getDefaultQueryGrammar()

Получить экземпляр синтаксического анализатора запросов по умолчанию.

Возвращаемое значение

Grammar

void useDefaultSchemaGrammar()

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

Возвращаемое значение

void

protected Grammar getDefaultSchemaGrammar()

Получить экземпляр синтаксического анализатора схемы по умолчанию.

Возвращаемое значение

Grammar

void useDefaultPostProcessor()

Установить обработчик запросов по умолчанию.

Возвращаемое значение

void

protected Processor getDefaultPostProcessor()

Получить экземпляр обработчика запросов по умолчанию.

Возвращаемое значение

Processor

Builder getSchemaBuilder()

Получить экземпляр генератора схемы для подключения.

Возвращаемое значение

Builder

Builder table(Closure|Builder|string $table, string|null $as = null)

Начать флуэнтный запрос к таблице базы данных.

Параметры

Closure|Builder|string $table
string|null $as

Возвращаемое значение

Builder

Builder query()

Получить новый экземпляр билдера запросов.

Возвращаемое значение

Builder

mixed selectOne(string $query, array $bindings = [], bool $useReadPdo = true)

Выполнить оператор select и вернуть единственный результат.

Параметры

string $query
array $bindings
bool $useReadPdo

Возвращаемое значение

mixed

array selectFromWriteConnection(string $query, array $bindings = [])

Выполнить оператор select в базе данных.

Параметры

string $query
array $bindings

Возвращаемое значение

array

array select(string $query, array $bindings = [], bool $useReadPdo = true)

Выполнить оператор select в базе данных.

Параметры

string $query
array $bindings
bool $useReadPdo

Возвращаемое значение

array

Generator cursor(string $query, array $bindings = [], bool $useReadPdo = true)

Выполнить оператор select в базе данных и вернуть генератор.

Параметры

string $query
array $bindings
bool $useReadPdo

Значение возврата

Generator

protected PDOStatement prepared(PDOStatement $statement)

Настроить оператор PDO prepared.

Параметры

PDOStatement $statement

Значение возврата

PDOStatement

protected PDO getPdoForSelect(bool $useReadPdo = true)

Получить подключение PDO для запроса select.

Параметры

bool $useReadPdo

Значение возврата

PDO

bool insert(string $query, array $bindings = [])

Выполнить оператор insert в базе данных.

Параметры

string $query
array $bindings

Значение возврата

bool

int update(string $query, array $bindings = [])

Выполнить оператор update в базе данных.

Параметры

string $query
array $bindings

Значение возврата

int

int delete(string $query, array $bindings = [])

Выполнить оператор delete в базе данных.

Параметры

string $query
array $bindings

Значение возврата

int

bool statement(string $query, array $bindings = [])

Выполнить SQL оператор и вернуть boolean результат.

Параметры

string $query
array $bindings

Значение возврата

bool

int affectingStatement(string $query, array $bindings = [])

Выполнить SQL оператор и получить количество затронутых строк.

Параметры

string $query
array $bindings

Значение возврата

int

bool unprepared(string $query)

Выполнить неподготовленный запрос к подключению PDO.

Параметры

string $query

Значение возврата

bool

array pretend(Closure $callback)

Выполнить заданный коллбэк в режиме «сухого запуска».

Параметры

Closure $callback

Значение возврата

array

protected array withFreshQueryLog(Closure $callback)

Выполнить заданный коллбэк в режиме «сухого запуска».

Параметры

Closure $callback

Значение возврата

array

void bindValues(PDOStatement $statement, array $bindings)

Связать значения с их параметрами в данном операторе.

Параметры

PDOStatement $statement
array $bindings

Значение возврата

void

array prepareBindings(array $bindings)

Подготовить связывание значений запроса для выполнения.

Параметры

array $bindings

Значение возврата

array

protected mixed run(string $query, array $bindings, Closure $callback)

Выполнить SQL оператор и записать контекст его выполнения.

Параметры

string $query
array $bindings
Closure $callback

Значение возврата

mixed

Исключения

QueryException

protected mixed runQueryCallback(string $query, array $bindings, Closure $callback)

Выполнить SQL оператор.

Параметры

string $query
array $bindings
Closure $callback

Значение возврата

mixed

Исключения

QueryException

void logQuery(string $query, array $bindings, float|null $time = null)

Записать запрос в журнал запросов соединения.

Параметры

string $query
array $bindings
float|null $time

Значение возврата

void

protected float getElapsedTime(int $start)

Получить прошедшее время с указанной начальной точки.

Параметры

int $start

Значение возврата

float

protected mixed handleQueryException(QueryException $e, string $query, array $bindings, Closure $callback)

Обработать исключение запроса.

Параметры

QueryException $e
string $query
array $bindings
Closure $callback

Возвращаемое значение

mixed

Исключения

QueryException

protected mixed tryAgainIfCausedByLostConnection(QueryException $e, string $query, array $bindings, Closure $callback)

Обработать исключение запроса, произошедшее во время выполнения запроса.

Параметры

QueryException $e
string $query
array $bindings
Closure $callback

Возвращаемое значение

mixed

Исключения

QueryException

void reconnect()

Подключиться к базе данных заново.

Возвращаемое значение

void

Исключения

LogicException

protected void reconnectIfMissingConnection()

Подключиться к базе данных заново, если отсутствует соединение PDO.

Возвращаемое значение

void

void disconnect()

Отключиться от базового соединения PDO.

Возвращаемое значение

void

void listen(Closure $callback)

Зарегистрировать слушателя запросов базы данных в соединении.

Параметры

Closure $callback

Возвращаемое значение

void

protected array|null fireConnectionEvent(string $event)

Вызвать событие для этого соединения.

Параметры

string $event

Возвращаемое значение

array|null

protected void event(mixed $event)

Вызвать указанное событие, если возможно.

Параметры

mixed $event

Возвращаемое значение

void

Expression raw(mixed $value)

Получить новое выражение для необработанного запроса.

Параметры

mixed $value

Возвращаемое значение

Expression

void recordsHaveBeenModified(bool $value = true)

Указать, были ли изменены какие-либо записи.

Параметры

bool $value

Возвращаемое значение

void

bool isDoctrineAvailable()

Доступен ли Doctrine?

Возвращаемое значение

bool

Column getDoctrineColumn(string $table, string $column)

Получить экземпляр Doctrine Schema Column.

Параметры

string $table
string $column

Возвращаемое значение

Column

AbstractSchemaManager getDoctrineSchemaManager()

Получить менеджер схемы Doctrine DBAL для соединения.

Возвращаемое значение

AbstractSchemaManager

Connection getDoctrineConnection()

Получить экземпляр соединения базы данных Doctrine DBAL.

Возвращаемое значение

Connection

PDO getPdo()

Получить текущее соединение PDO.

Возвращаемое значение

PDO

PDO|Closure|null getRawPdo()

Получить текущее параметр соединения PDO без выполнения логики повторного подключения.

Возвращаемое значение

PDO|Closure|null

PDO getReadPdo()

Получить текущее соединение PDO, используемое для чтения.

Возвращаемое значение

PDO

PDO|Closure|null getRawReadPdo()

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

Возвращаемое значение

PDO|Closure|null

$this setPdo(PDO|Closure|null $pdo)

Установить соединение PDO.

Параметры

PDO|Closure|null $pdo

Возвращаемое значение

$this

$this setReadPdo(PDO|Closure|null $pdo)

Установить соединение PDO, используемое для чтения.

Parameters

PDO|Closure|null $pdo

Return Value

$this

$this setReconnector(callable $reconnector)

Установить экземпляр переподключения в соединении.

Parameters

callable $reconnector

Return Value

$this

string|null getName()

Получить имя подключения к базе данных.

Return Value

string|null

mixed getConfig(string|null $option = null)

Получить параметр из параметров конфигурации.

Parameters

string|null $option

Return Value

mixed

string getDriverName()

Получить имя драйвера PDO.

Return Value

string

Grammar getQueryGrammar()

Получить используемую грамматику запросов соединения.

Return Value

Grammar

$this setQueryGrammar(Grammar $grammar)

Установить используемую грамматику запросов соединения.

Parameters

Grammar $grammar

Return Value

$this

Grammar getSchemaGrammar()

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

Return Value

Grammar

$this setSchemaGrammar(Grammar $grammar)

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

Parameters

Grammar $grammar

Return Value

$this

Processor getPostProcessor()

Получить используемый процессор запросов соединения.

Return Value

Processor

$this setPostProcessor(Processor $processor)

Установить используемый процессор запросов соединения.

Parameters

Processor $processor

Return Value

$this

Dispatcher getEventDispatcher()

Получить используемый диспетчер событий соединения.

Return Value

Dispatcher

$this setEventDispatcher(Dispatcher $events)

Установить экземпляр диспетчера событий в соединении.

Parameters

Dispatcher $events

Return Value

$this

void unsetEventDispatcher()

Удалить диспетчер событий для этого соединения.

Return Value

void

bool pretending()

Определить, находится ли соединение в режиме "сухого запуска".

Return Value

bool

array getQueryLog()

Получить журнал запросов соединения.

Return Value

array

void flushQueryLog()

Очистить журнал запросов.

Return Value

void

void enableQueryLog()

Включить журнал запросов для соединения.

Return Value

void

void disableQueryLog()

Отключить журнал запросов для соединения.

Return Value

void

bool logging()

Определить, ведём ли мы логирование запросов.

Return Value

bool

string getDatabaseName()

Получить имя подключенной базы данных.

Return Value

string

$this setDatabaseName(string $database)

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

Parameters

string $database

Return Value

$this

string getTablePrefix()

Получить префикс таблицы для соединения.

Return Value

string

$this setTablePrefix(string $prefix)

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

Параметры

строка $prefix

Возвращаемое значение

$this

Grammar withTablePrefix(Grammar $grammar)

Установить префикс таблицы и вернуть грамматику.

Параметры

Grammar $grammar

Возвращаемое значение

Grammar

static void resolverFor(string $driver, Closure $callback)

Зарегистрировать решатель подключений.

Параметры

строка $driver
Closure $callback

Возвращаемое значение

void

static mixed getResolver(string $driver)

Получить решатель подключений для заданного драйвера.

Параметры

строка $driver

Возвращаемое значение

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Database/Connection.html

Spec-Zone.ru

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