Spec-Zone.ru › Laravel 6

Подключение

класс Подключение реализует 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(Exception $e)

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

из DetectsConcurrencyErrors
bool causedByLostConnection(Throwable $e)

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

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

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

из ManagesTransactions
void handleTransactionException(Exception $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(Exception $e, int $currentAttempt, int $maxAttempts)

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

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

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

из ManagesTransactions
void performRollBack(int $toLevel)

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

из ManagesTransactions
void handleRollBackException(Exception $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)

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

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

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

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

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

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

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

PDOStatement prepared(PDOStatement $statement)

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

PDO getPdoForSelect(bool $useReadPdo = true)

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

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

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

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)

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

Обработчик getPostProcessor()

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

$this setPostProcessor(Обработчик $processor)

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

Диспечер событий getEventDispatcher()

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

$this setEventDispatcher(Диспечер событий $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)

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

Грамматика withTablePrefix(Грамматика $grammar)

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

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

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

static mixed getResolver(string $driver)

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

Подробности

protected bool causedByConcurrencyError(Exception $e)

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

Параметры

Exception $e

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

bool

protected bool causedByLostConnection(Throwable $e)

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

Параметры

Throwable $e

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

bool

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

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

Параметры

Closure $callback
int $attempts

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

mixed

Исключения

Throwable

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

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

Параметры

Exception $e
int $currentAttempt
int $maxAttempts

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

void

Исключения

Exception

void beginTransaction()

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

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

void

Исключения

Exception

protected void createTransaction()

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

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

void

protected void createSavepoint()

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

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

void

protected void handleBeginTransactionException(Throwable $e)

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

Параметры

Throwable $e

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

void

Исключения

Exception

void commit()

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

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

void

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

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

Параметры

Exception $e
int $currentAttempt
int $maxAttempts

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

void

void rollBack(int|null $toLevel = null)

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

Параметры

int|null $toLevel

Значение результата

void

Исключения

Exception

protected void performRollBack(int $toLevel)

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

Параметры

int $toLevel

Значение результата

void

protected void handleRollBackException(Exception $e)

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

Параметры

Exception $e

Значение результата

void

Исключения

Exception

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.

Параметры

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-запроса и возврат логического результата.

Параметры

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
строка $query
массив $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)

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

Параметры

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, используемое для чтения.

Параметры

PDO|Closure|null $pdo

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

$this

$this setReconnector(callable $reconnector)

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

Параметры

callable $reconnector

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

$this

строка|null getName()

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

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

строка|null

смешанный тип getConfig(строка|null $option = null)

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

Параметры

строка|null $option

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

смешанный тип

строка getDriverName()

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

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

строка

Грамматика getQueryGrammar()

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

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

Грамматика

$this setQueryGrammar(Грамматика $grammar)

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

Параметры

Грамматика $grammar

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

$this

Грамматика getSchemaGrammar()

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

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

Грамматика

$this setSchemaGrammar(Грамматика $grammar)

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

Параметры

Грамматика $grammar

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

$this

Обработчик getPostProcessor()

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

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

Обработчик

$this setPostProcessor(Обработчик $processor)

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

Параметры

Обработчик $processor

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

$this

Диспечер событий getEventDispatcher()

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

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

Диспечер событий

$this setEventDispatcher(Диспечер событий $events)

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

Параметры

Диспечер событий $events

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

$this

пустое значение unsetEventDispatcher()

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

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

пустое значение

логическое значение pretending()

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

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

логическое значение

массив getQueryLog()

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

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

массив

пустое значение flushQueryLog()

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

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

пустое значение

пустое значение enableQueryLog()

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

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

пустое значение

пустое значение disableQueryLog()

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

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

пустое значение

логическое значение logging()

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

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

логическое значение

строка getDatabaseName()

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

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

строка

$this setDatabaseName(строка $database)

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

Параметры

строка $database

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

$this

строка getTablePrefix()

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

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

строка

$this setTablePrefix(строка $prefix)

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

Параметры

строка $prefix

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

$this

Грамматика withTablePrefix(Грамматика $grammar)

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

Параметры

Грамматика $grammar

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

Грамматика

статический void resolverFor(string $driver, Closure $callback)

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

Параметры

string $driver
Closure $callback

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

void

статический mixed getResolver(string $driver)

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

Параметры

string $driver

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

mixed

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

Spec-Zone.ru

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