Spec-Zone.ru › Laravel 5.8

Соединение

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

Трейты

DetectsDeadlocks
DetectsLostConnections
ManagesTransactions

Свойства

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 causedByDeadlock(Exception $e)

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

из DetectsDeadlocks
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 rollBack(int|null $toLevel = null)

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

из ManagesTransactions
void performRollBack(int $toLevel)

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

из ManagesTransactions
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(string $table)

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

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

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

Получить текущее соединение 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 causedByDeadlock(Exception $e)

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

Параметры

Exception $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(Exception $e, int $currentAttempt, int $maxAttempts)

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

Параметры

Exception $e
int $currentAttempt
int $maxAttempts

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

void

Исключения

Exception

void beginTransaction()

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

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

void

Исключения

Exception

protected void createTransaction()

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

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

void
END_OF_DOCUMENT_MARKER

protected void createSavepoint()

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

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

void

protected void handleBeginTransactionException(Throwable $e)

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

Параметры

Throwable $e

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

void

Исключения

Exception

void commit()

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

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

void

void rollBack(int|null $toLevel = null)

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

Параметры

int|null $toLevel

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

void

Исключения

Exception

protected void performRollBack(int $toLevel)

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

Параметры

int $toLevel

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

void

protected handleRollBackException(Exception $e)

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

Параметры

Exception $e

Исключения

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(string $table)

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

Параметры

string $table

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

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 = [])

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

Параметры

string $query
array $bindings

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

bool

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

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

Параметры

string $query
array $bindings

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

int

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

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

Параметры

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)

Выполнить неподготовленный (raw) запрос к соединению 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)

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

Параметры

строка $event

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

array|null

protected void event(mixed $event)

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

Параметры

смешанный $event

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

void

Expression raw(mixed $value)

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

Параметры

смешанный $value

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

Expression

void recordsHaveBeenModified(bool $value = true)

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

Параметры

bool $value

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

void

bool isDoctrineAvailable()

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

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

bool

Column getDoctrineColumn(string $table, string $column)

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

Параметры

строка $table
строка $column

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

Column

AbstractSchemaManager getDoctrineSchemaManager()

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

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

AbstractSchemaManager

Connection getDoctrineConnection()

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

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

Connection

PDO getPdo()

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

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

PDO

PDO getReadPdo()

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

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

PDO

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

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

Параметры

вызываемый объект $reconnector

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

$this

string|null getName()

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

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

string|null

mixed getConfig(string|null $option = null)

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

Параметры

строка|null $option

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

смешанный

string getDriverName()

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

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

строка

Grammar getQueryGrammar()

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

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

Grammar

$this setQueryGrammar(Grammar $grammar)

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

Параметры

Grammar $grammar

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

$this

Grammar getSchemaGrammar()

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

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

Grammar

$this setSchemaGrammar(Grammar $grammar)

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

Параметры

Grammar $grammar

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

$this

Processor getPostProcessor()

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

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

Processor

$this setPostProcessor(Processor $processor)

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

Параметры

Processor $processor

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

$this

Dispatcher getEventDispatcher()

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

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

Dispatcher

$this setEventDispatcher(Dispatcher $events)

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

Параметры

Dispatcher $events

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

$this

void unsetEventDispatcher()

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

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

void

bool pretending()

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

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

bool

array getQueryLog()

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

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

array

void flushQueryLog()

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

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

void

void enableQueryLog()

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

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

void

void disableQueryLog()

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

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

void

bool logging()

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

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

bool

string getDatabaseName()

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

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

string

$this setDatabaseName(string $database)

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

Параметры

string $database

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

$this

string getTablePrefix()

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

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

string

$this setTablePrefix(string $prefix)

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

Параметры

string $prefix

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

$this

Grammar withTablePrefix(Grammar $grammar)

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

Параметры

Grammar $grammar

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

Grammar

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

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

Параметры

string $driver
Closure $callback

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

void

static 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/5.8/Illuminate/Database/Connection.html

Spec-Zone.ru

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