Подключение

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

Свойства

protected PDO	$pdo	Активное подключение PDO.
protected PDO	$readPdo	Активное подключение PDO, используемое для чтения.
protected callable	$reconnector	Объект переподключения для подключения.
protected Грамматика запросов	$queryGrammar	Реализация грамматики запросов.
protected Грамматика схемы	$schemaGrammar	Реализация грамматики схемы.
protected Обработчик запросов	$postProcessor	Реализация пост-обработчика запросов.
protected Диспечер событий	$events	Экземпляр диспечера событий.
protected int	$fetchMode	Режим извлечения по умолчанию для подключения.
protected mixed	$fetchArgument	Аргумент для режима извлечения.
protected array	$fetchConstructorArgument	Аргументы конструктора для режима извлечения PDO::FETCH_CLASS.
protected int	$transactions	Количество активных транзакций.
protected array	$queryLog	Все запросы, выполненные к подключению.
protected bool	$loggingQueries	Указывает, ведется ли логирование запросов.
protected bool	$pretending	Указывает, находится ли подключение в режиме "сухого запуска".
protected string	$database	Имя подключенной базы данных.
protected Connection	$doctrineConnection	Экземпляр подключения Doctrine.
protected string	$tablePrefix	Префикс таблицы для подключения.
protected array	$config	Параметры конфигурации подключения к базе данных.

Методы

bool	causedByLostConnection(Exception $e) Определить, было ли вызвано данное исключение потерей соединения.	из DetectsLostConnections
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() Получить новый экземпляр построителя запросов.
Expression	raw(mixed $value) Получить новое выражение для необработанного запроса.
mixed	selectOne(string $query, array $bindings = []) Выполнить инструкцию 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 в базе данных и вернуть генератор.
PDO	getPdoForSelect(bool $useReadPdo = true) Получить PDO соединение для использования в запросе select.
bool	insert(string $query, array $bindings = []) Выполнить инструкцию insert в базе данных.
int	update(string $query, array $bindings = []) Выполнить инструкцию update в базе данных.
int	delete(string $query, array $bindings = []) Выполнить инструкцию delete в базе данных.
bool	statement(string $query, array $bindings = []) Выполнить SQL инструкцию и вернуть булевый результат.
int	affectingStatement(string $query, array $bindings = []) Выполнить SQL инструкцию и получить количество затронутых строк.
bool	unprepared(string $query) Выполнить необработанный запрос к PDO соединению.
array	prepareBindings(array $bindings) Подготовить параметры запроса для выполнения.
mixed	transaction(Closure $callback) Выполнить Closure внутри транзакции.
void	beginTransaction() Начать новую транзакцию базы данных.
void	commit() Зафиксировать активную транзакцию базы данных.
void	rollBack() Откатить активную транзакцию базы данных.
int	transactionLevel() Получить количество активных транзакций.
array	pretend(Closure $callback) Выполнить заданный callback в режиме "пробного запуска".
mixed	run(string $query, array $bindings, Closure $callback) Выполнить SQL инструкцию и залогировать контекст её выполнения.
mixed	runQueryCallback(string $query, array $bindings, Closure $callback) Выполнить SQL инструкцию.
mixed	tryAgainIfCausedByLostConnection(QueryException $e, string $query, array $bindings, Closure $callback) Обработать исключение запроса, произошедшее во время выполнения запроса.
void	disconnect() Отключиться от базового PDO соединения.
void	reconnect() Переподключиться к базе данных.
void	reconnectIfMissingConnection() Переподключиться к базе данных, если отсутствует PDO соединение.
void	logQuery(string $query, array $bindings, float\|null $time = null) Залогировать запрос в логе запросов соединения.
void	listen(Closure $callback) Зарегистрировать слушателя запроса базы данных в соединении.
void	fireConnectionEvent(string $event) Сгенерировать событие для этого соединения.
float	getElapsedTime(int $start) Получить прошедшее время с заданной начальной точки.
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\|null $pdo) Установить PDO-соединение.
$this	setReadPdo(PDO\|null $pdo) Установить PDO-соединение, используемое для чтения.
$this	setReconnector(callable $reconnector) Установить экземпляр повторного подключения к соединению.
string\|null	getName() Получить имя подключения к базе данных.
mixed	getConfig(string $option) Получить параметр из параметров конфигурации.
string	getDriverName() Получить имя драйвера PDO.
Grammar	getQueryGrammar() Получить синтаксический анализатор запросов, используемый подключением.
void	setQueryGrammar(Grammar $grammar) Установить синтаксический анализатор запросов, используемый подключением.
Grammar	getSchemaGrammar() Получить синтаксический анализатор схем, используемый подключением.
void	setSchemaGrammar(Grammar $grammar) Установить синтаксический анализатор схем, используемый подключением.
Processor	getPostProcessor() Получить постпроцессор запросов, используемый подключением.
void	setPostProcessor(Processor $processor) Установить постпроцессор запросов, используемый подключением.
Dispatcher	getEventDispatcher() Получить диспетчер событий, используемый подключением.
void	setEventDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий для подключения.
bool	pretending() Определить, находится ли соединение в режиме "сухого запуска".
int	getFetchMode() Получить режим выборки по умолчанию для подключения.
mixed	getFetchArgument() Получить аргумент выборки, который будет применён при выборке.
array	getFetchConstructorArgument() Получить пользовательские аргументы конструктора для режима выборки PDO::FETCH_CLASS.
int	setFetchMode(int $fetchMode, mixed $fetchArgument = null, array $fetchConstructorArgument = []) Установить режим выборки по умолчанию для подключения и необязательные аргументы для данного режима выборки.
array	getQueryLog() Получить журнал запросов подключения.
void	flushQueryLog() Очистить журнал запросов.
void	enableQueryLog() Включить журнал запросов для подключения.
void	disableQueryLog() Выключить журнал запросов для подключения.
bool	logging() Определить, ведётся ли протоколирование запросов.
string	getDatabaseName() Получить имя подключенной базы данных.
string	setDatabaseName(string $database) Установить имя подключенной базы данных.
string	getTablePrefix() Получить префикс таблиц для подключения.
void	setTablePrefix(string $prefix) Установить префикс таблиц, используемый подключением.
Grammar	withTablePrefix(Grammar $grammar) Установить префикс таблиц и вернуть синтаксический анализатор.

Details

protected bool causedByLostConnection(Exception $e)

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

Parameters

Exception

Return Value

bool

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

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

Parameters

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

Return Value

void

void useDefaultQueryGrammar()

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

Return Value

void

protected Grammar getDefaultQueryGrammar()

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

Return Value

Grammar

void useDefaultSchemaGrammar()

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

Return Value

void

protected Грамматика getDefaultSchemaGrammar()

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

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

Грамматика

void useDefaultPostProcessor()

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

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

void

protected Обработчик getDefaultPostProcessor()

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

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

Обработчик

Строитель getSchemaBuilder()

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

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

Строитель

Строитель table(string $table)

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

Параметры

string

$table

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

Строитель

Строитель query()

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

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

Строитель

Выражение raw(mixed $value)

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

Параметры

mixed

$value

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

Выражение

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

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

Параметры

string	$query
array	$bindings

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

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

Генератор cursor(string $query, array $bindings = [], bool $useReadPdo = true)

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

Параметры

string	$query
array	$bindings
bool	$useReadPdo

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

Генератор

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 prepareBindings(array $bindings)

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

Параметры

array

$bindings

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

array

mixed transaction(Замыкание $callback)

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

Параметры

Замыкание

$callback

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

mixed

Исключения

Throwable

void beginTransaction()

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

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

void

Исключения

Exception

void commit()

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

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

void

void rollBack()

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

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

void

int transactionLevel()

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

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

int

array pretend(Closure $callback)

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

Параметры

Closure

$callback

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

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

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

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

Параметры

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

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

mixed

Исключения

QueryException

void disconnect()

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

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

void

void reconnect()

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

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

void

Исключения

LogicException

protected void reconnectIfMissingConnection()

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

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

void

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

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

Параметры

string	$query
array	$bindings
float\|null	$time

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

void

void listen(Closure $callback)

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

Параметры

Closure

$callback

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

void

protected void fireConnectionEvent(string $event)

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

Параметры

string

$event

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

void

protected float getElapsedTime(int $start)

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

Параметры

int

$start

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

float

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

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

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

PDO

$this setPdo(PDO|null $pdo)

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

Параметры

PDO|null

$pdo

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

$this

Исключения

RuntimeException

$this setReadPdo(PDO|null $pdo)

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

Параметры

PDO|null

$pdo

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

$this

$this setReconnector(callable $reconnector)

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

Параметры

callable

$reconnector

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

$this

string|null getName()

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

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

string|null

mixed getConfig(string $option)

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

Параметры

string

$option

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

mixed

string getDriverName()

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

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

string

Grammar getQueryGrammar()

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

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

Grammar

void setQueryGrammar(Grammar $grammar)

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

Параметры

Grammar

$grammar

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

void

Grammar getSchemaGrammar()

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

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

Grammar

void setSchemaGrammar(Grammar $grammar)

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

Параметры

Grammar

$grammar

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

void

Processor getPostProcessor()

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

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

Processor

void setPostProcessor(Processor $processor)

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

Параметры

Processor

$processor

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

void

Dispatcher getEventDispatcher()

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

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

Dispatcher

void setEventDispatcher(Dispatcher $events)

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

Параметры

Dispatcher

$events

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

void

bool pretending()

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

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

bool

int getFetchMode()

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

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

int

mixed getFetchArgument()

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

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

mixed

array getFetchConstructorArgument()

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

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

array

int setFetchMode(int $fetchMode, mixed $fetchArgument = null, array $fetchConstructorArgument = [])

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

Параметры

int	$fetchMode
mixed	$fetchArgument
array	$fetchConstructorArgument

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

int

array getQueryLog()

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

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

array

void flushQueryLog()

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

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

void

void enableQueryLog()

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

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

void

void disableQueryLog()

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

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

void

bool logging()

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

Значение возвращаемого значения

bool

string getDatabaseName()

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

Значение возвращаемого значения

string

string setDatabaseName(string $database)

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

Параметры

string

$database

Значение возвращаемого значения

string

string getTablePrefix()

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

Значение возвращаемого значения

string

void setTablePrefix(string $prefix)

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

Параметры

string

$prefix

Значение возвращаемого значения

void

Grammar withTablePrefix(Grammar $grammar)

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

Параметры

Grammar

$grammar

Значение возвращаемого значения

Grammar

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