Spec-Zone.ru › Laravel 10

Подключение

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

Трейты

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

Свойства

статический защищённый массив $macros

Зарегистрированные строковые макросы.

из Macroable
защищённый PDO|Closure $pdo

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

защищённый PDO|Closure $readPdo

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

защищённый строка $database

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

защищённый строка|null $readWriteType

Тип подключения.

защищённый строка $tablePrefix

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

защищённый массив $config

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

защищённый вызываемый $reconnector

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

защищённый Grammar $queryGrammar

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

защищённый Grammar $schemaGrammar

Реализация синтаксиса схемы.

защищённый Processor $postProcessor

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

защищённый Dispatcher $events

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

защищённый целое число $fetchMode

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

защищённый целое число $transactions

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

защищённый DatabaseTransactionsManager $transactionsManager

Объект менеджера транзакций.

защищённый булево $recordsModified

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

защищённый булево $readOnWriteConnection

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

защищённый массив $queryLog

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

защищённый булево $loggingQueries

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

защищённый число с плавающей запятой $totalQueryDuration

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

защищённый массив $queryDurationHandlers

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

защищённый булево $pretending

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

защищённый Closure[] $beforeStartingTransaction

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

защищённый Closure[] $beforeExecutingCallbacks

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

защищённый Подключение $doctrineConnection

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

защищённый массив<строка, строка> $doctrineTypeMappings

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

статический защищённый Closure[] $resolvers

Резолверы подключений.

Методы

bool causedByConcurrencyError(Throwable $e)

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

from DetectsConcurrencyErrors
bool causedByLostConnection(Throwable $e)

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

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

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

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

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

from ManagesTransactions
void beginTransaction()

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

from ManagesTransactions
void createTransaction()

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

from ManagesTransactions
void createSavepoint()

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

from ManagesTransactions
void handleBeginTransactionException(Throwable $e)

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

from ManagesTransactions
void commit()

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

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

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

from ManagesTransactions
void rollBack(int|null $toLevel = null)

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

from ManagesTransactions
void performRollBack(int $toLevel)

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

from ManagesTransactions
void handleRollBackException(Throwable $e)

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

from ManagesTransactions
int transactionLevel()

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

from ManagesTransactions
void afterCommit(callable $callback)

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

from ManagesTransactions
int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате UNIX.

from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразует его в экземпляр DateTime.

from InteractsWithTime
int currentTime()

Получить текущее системное время в формате UNIX.

from InteractsWithTime
static void macro(string $name, object|callable $macro)

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

from Macroable
static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

from Macroable
static bool hasMacro(string $name)

Проверяет, зарегистрирована ли макрокоманда.

from Macroable
static void flushMacros()

Очистить существующие макрокоманды.

from Macroable
static mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов класса.

from Macroable
mixed __call(string $method, array $parameters)

Динамическая обработка вызовов класса.

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

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

void useDefaultQueryGrammar()

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

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

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

void useDefaultSchemaGrammar()

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

Грамматика|null getDefaultSchemaGrammar()

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

void useDefaultPostProcessor()

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

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

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

Блокер getSchemaBuilder()

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

Блокер table(Closure|Блокер|string $table, string|null $as = null)

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

Блокер query()

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

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

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

mixed scalar(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 к базе данных.

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

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

Генератор 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 = [])

Выполнить запрос 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 pretend(Closure $callback)

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

mixed withoutPretending(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-запрос.

bool isUniqueConstraintError(Exception $exception)

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

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

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

float getElapsedTime(int $start)

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

void whenQueryingForLongerThan(DateTimeInterface|CarbonInterval|float|int $threshold, callable $handler)

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

void allowQueryDurationHandlersToRunAgain()

Разрешить повторное выполнение всех обработчиков длительности запросов, даже если они уже были выполнены.

float totalQueryDuration()

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

void resetTotalQueryDuration()

Сбросить продолжительность всех выполненных запросов.

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

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

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

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

mixed|false reconnect()

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

void reconnectIfMissingConnection()

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

void disconnect()

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

$this beforeStartingTransaction(Closure $callback)

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

$this beforeExecuting(Closure $callback)

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

void listen(Closure $callback)

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

array|null fireConnectionEvent(string $event)

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

void event(mixed $event)

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

Expression raw(mixed $value)

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

string escape(string|float|int|bool|null $value, bool $binary = false)

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

string escapeString(string $value)

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

string escapeBool(bool $value)

Обработать булево значение для безопасной вставки в SQL-запрос.

string escapeBinary(string $value)

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

bool hasModifiedRecords()

Определить, изменил ли объект базы данных какие-либо записи в базе данных.

void recordsHaveBeenModified(bool $value = true)

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

$this setRecordModificationState(bool $value)

Установить состояние изменения записей.

void forgetRecordModificationState()

Сбросить состояние изменения записей.

$this useWriteConnectionWhenReading(bool $value = true)

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

bool isDoctrineAvailable()

Doctrine доступен?

bool usingNativeSchemaOperations()

Указывает, будут ли использоваться собственные операции alter при удалении, переименовании или изменении столбцов, даже если Doctrine DBAL установлен.

Column getDoctrineColumn(string $table, string $column)

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

AbstractSchemaManager getDoctrineSchemaManager()

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

Connection getDoctrineConnection()

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

void registerDoctrineType(Type|string $class, string $name, string $type)

Зарегистрировать пользовательский тип отображения Doctrine.

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

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

string|null getNameWithReadWriteType()

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

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

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

$this setTransactionManager(DatabaseTransactionsManager $manager)

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

void unsetTransactionManager()

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

bool pretending()

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

array getQueryLog()

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

array getRawQueryLog()

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

void flushQueryLog()

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

void enableQueryLog()

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

void disableQueryLog()

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

bool logging()

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

string getDatabaseName()

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

$this setDatabaseName(string $database)

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

$this setReadWriteType(string|null $readWriteType)

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

string getTablePrefix()

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

$this setTablePrefix(string $prefix)

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

Grammar withTablePrefix(Grammar $grammar)

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

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

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

static mixed getResolver(string $driver)

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

Details

protected bool causedByConcurrencyError(Throwable $e)

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

Parameters

Throwable $e

Return Value

bool

protected bool causedByLostConnection(Throwable $e)

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

Parameters

Throwable $e

Return Value

bool

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

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

Parameters

Closure $callback
int $attempts

Return Value

mixed

Exceptions

Throwable

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

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

Parameters

Throwable $e
int $currentAttempt
int $maxAttempts

Return Value

void

Exceptions

Throwable

void beginTransaction()

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

Return Value

void

Exceptions

Throwable

protected void createTransaction()

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

Return Value

void

Exceptions

Throwable

protected void createSavepoint()

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

Return Value

void

Exceptions

Throwable

protected void handleBeginTransactionException(Throwable $e)

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

Parameters

Throwable $e

Return Value

void

Exceptions

Throwable

void commit()

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

Return Value

void

Exceptions

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 afterCommit(callable $callback)

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

Параметры

callable $callback

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

void

Исключения

RuntimeException

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданного DateTime.

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить метку времени «доступно в» в формате UNIX.

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int $delay

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

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время как метку времени UNIX.

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

int

static void macro(string $name, object|callable $macro)

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирована ли макрокоманда.

Параметры

string $name

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

bool

static void flushMacros()

Очистить существующие макрокоманды.

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

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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|null getDefaultSchemaGrammar()

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

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

Grammar|null

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)

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

Параметры

string $query
array $bindings
bool $useReadPdo

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

mixed

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

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

Параметры

string $query
array $bindings
bool $useReadPdo

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

mixed

Исключения

MultipleColumnsSelectedException

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

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

Параметры

string $query
array $bindings

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

array

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

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

Параметры

string $query
array $bindings
bool $useReadPdo

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

array

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

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

Параметры

string $query
array $bindings
bool $useReadPdo

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

array

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

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

Параметры

string $query
array $bindings
bool $useReadPdo

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

Generator

protected PDOStatement prepared(PDOStatement $statement)

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

Параметры

PDOStatement $statement

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

PDOStatement

protected PDO getPdoForSelect(bool $useReadPdo = true)

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

Параметры

bool $useReadPdo

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

PDO

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

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

Parameters

string $query
array $bindings

Return Value

bool

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

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

Parameters

string $query
array $bindings

Return Value

int

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

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

Parameters

string $query
array $bindings

Return Value

int

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

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

Parameters

string $query
array $bindings

Return Value

bool

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

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

Parameters

string $query
array $bindings

Return Value

int

bool unprepared(string $query)

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

Parameters

string $query

Return Value

bool

array pretend(Closure $callback)

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

Parameters

Closure $callback

Return Value

array

mixed withoutPretending(Closure $callback)

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

Parameters

Closure $callback

Return Value

mixed

protected array withFreshQueryLog(Closure $callback)

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

Parameters

Closure $callback

Return Value

array

void bindValues(PDOStatement $statement, array $bindings)

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

Parameters

PDOStatement $statement
array $bindings

Return Value

void

array prepareBindings(array $bindings)

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

Parameters

array $bindings

Return Value

array

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

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

Parameters

string $query
array $bindings
Closure $callback

Return Value

mixed

Exceptions

QueryException

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

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

Parameters

string $query
array $bindings
Closure $callback

Return Value

mixed

Exceptions

QueryException

protected bool isUniqueConstraintError(Exception $exception)

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

Parameters

Exception $exception

Return Value

bool

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

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

Parameters

string $query
array $bindings
float|null $time

Return Value

void

protected float getElapsedTime(int $start)

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

Parameters

int $start

Return Value

float

void whenQueryingForLongerThan(DateTimeInterface|CarbonInterval|float|int $threshold, callable $handler)

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

Parameters

DateTimeInterface|CarbonInterval|float|int $threshold
callable $handler

Return Value

void

void allowQueryDurationHandlersToRunAgain()

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

Return Value

void

float totalQueryDuration()

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

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

float

void resetTotalQueryDuration()

Сбросить продолжительность всех выполненных запросов.

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

void

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

mixed|false reconnect()

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

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

mixed|false

Исключения

LostConnectionException

void reconnectIfMissingConnection()

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

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

void

void disconnect()

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

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

void

$this beforeStartingTransaction(Closure $callback)

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

Параметры

Closure $callback

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

$this

$this beforeExecuting(Closure $callback)

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

Параметры

Closure $callback

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

$this

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

string escape(string|float|int|bool|null $value, bool $binary = false)

Экранировать значение для безопасной вставки в SQL.

Параметры

string|float|int|bool|null $value
bool $binary

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

string

protected string escapeString(string $value)

Экранировать строковое значение для безопасной вставки в SQL.

Параметры

string $value

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

string

protected string escapeBool(bool $value)

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

Параметры

bool $value

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

string

protected string escapeBinary(string $value)

Экранировать бинарное значение для безопасной вставки в SQL.

Параметры

string $value

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

string

bool hasModifiedRecords()

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

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

bool

void recordsHaveBeenModified(bool $value = true)

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

Параметры

bool $value

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

void

$this setRecordModificationState(bool $value)

Установить состояние изменения записи.

Параметры

bool $value

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

$this

void forgetRecordModificationState()

Сбросить состояние изменения записи.

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

void

$this useWriteConnectionWhenReading(bool $value = true)

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

Параметры

bool $value

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

$this

bool isDoctrineAvailable()

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

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

bool

bool usingNativeSchemaOperations()

Указывает, будут ли использоваться родные операции изменения схемы при удалении, переименовании или изменении столбцов, даже если Doctrine DBAL установлен.

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

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

void registerDoctrineType(Type|string $class, string $name, string $type)

Зарегистрировать пользовательский тип отображения Doctrine.

Параметры

Type|string $class
string $name
string $type

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

void

Исключения

Exception
RuntimeException

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

string|null getName()

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

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

string|null

string|null getNameWithReadWriteType()

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

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

string|null

mixed getConfig(string|null $option = null)

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

Параметры

string|null $option

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

mixed

string getDriverName()

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

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

string

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

$this setTransactionManager(DatabaseTransactionsManager $manager)

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

Параметры

DatabaseTransactionsManager $manager

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

$this

void unsetTransactionManager()

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

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

void

bool pretending()

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

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

bool

array getQueryLog()

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

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

array

array getRawQueryLog()

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

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

array

void flushQueryLog()

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

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

void

void enableQueryLog()

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

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

void

void disableQueryLog()

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

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

void

bool logging()

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

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

bool

string getDatabaseName()

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

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

string

$this setDatabaseName(string $database)

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

Параметры

string $database

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

$this

$this setReadWriteType(string|null $readWriteType)

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

Параметры

string|null $readWriteType

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

$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/10.x/Illuminate/Database/Connection.html

Spec-Zone.ru

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