Documentation

Connection

in package

• Application

implements Checkpointable Uses Interaction, CanCheckpoint

Interfaces, Classes and Traits

Checkpointable

Contract for classes that want checkpoint/restore of their state.

Table of Contents

CONNECT_TIMEOUT_SECONDS  = 5

Seconds a single connect attempt may take before failing over.

CONNECTION_LOSS_ERROR_CODES  = [ 1047, // WSREP has not yet prepared node for application use 2002, // Can't connect through socket / connection refused 2003, // Can't connect to server on host 2006, // Server has gone away 2013, ]

Client/server error codes meaning this connection cannot serve the statement (endpoint moved by the mesh, node died, network blip, or a Galera node refusing service while desynced as an SST/IST donor).

RECONNECT_BACKOFF_CAP_US  = 2000000

RECONNECT_BACKOFF_STEP_US  = 400000

Reconnect backoff grows with the attempt (attempt x step, capped) so the budget spans a realistic failover window instead of burning out in milliseconds while the mesh is still promoting a healthy node.

RETRY_BACKOFF_MAX_US  = 50000

RETRY_BACKOFF_MIN_US  = 10000

Randomized backoff bounds (microseconds) slept between retry attempts.

RETRYABLE_ERROR_CODES  = [ 1213, // Deadlock found when trying to get lock 1205, ]

MySQL/MariaDB error codes that are safe to retry: the server has already rolled the offending statement back, so re-running it does not risk double-applying it. These are the transient contention errors typical of busy single-node and cluster (Galera) setups.

RETRYABLE_SQL_STATES  = ["40001"]

SQLSTATE values that are safe to retry (e.g. Galera certification conflicts).

$booter  : ZubZet

$callingModel  : Model|null

$connectTimeout  : int

$insertId  : int|string|null

$lastConnect  : int

$lastHeartbeat  : int

$maxRetries  : int

$queryBuilderConnection  : Connection

$result  : null|bool|mysqli_result

$conn  : mysqli

$database  : string|null

$password  : string|null

$persistent  : bool

$stmt  : mysqli_stmt

$user  : string|null

__construct()  : mixed

__destruct()  : mixed

Closes the database connection on exit

assertConnection()  : mixed

checkIfExists()  : bool

Checks if a value exists in a table.

checkIfUnique()  : bool

Checks if a value is already in a table. Can also ignore a dataset.

checkpointCurrentState()  : Checkpoint

Snapshot selected properties into a Checkpoint for later restore()

countResults()  : int

Returns the number of results in the last query

countTableEntries()  : int

Returns the number of datasets in a table

disconnect()  : void

Disconnect from the database

exec()  : Connection

Executes a query as prepared statement

execQuery()  : Connection

Executes a CakePHP Query object using ZubZet`s own value binder to extract the SQL and bindings, then executing it as a prepared statement

executeMultiQuery()  : bool

getDatabaseConnection()  : mysqli

getFullTable()  : array<string|int, array<string|int, mixed>>

Selects a full table or specified fields of it and returns the result as two dimensional array

getInsertId()  : int|string|null

Returns the id of the last inserted element

getTableWhere()  : array<string|int, array<string|int, mixed>>

Selects a full table of specified fields of it filtered with an additional where statement. It returns the result as two dimensional array

heartbeat()  : bool

Run a very lightweight query to keep the connection alive.

mergeAsGroup()  : array<string|int, array<string|int, mixed>>

Converts the result of the last query into a grouped array

resultToArray()  : array<string|int, array<string|int, mixed>>

Converts the result of the last query into an array and returns it

resultToLine()  : array<string|int, mixed>

Returns one line of the last query

switchUser()  : void

checkpointablePropertyNames()  : array<string|int, string>

attemptStatement()  : array<string|int, mixed>|null

Makes one attempt at the statement: reconnect when asked to, prepare, bind, execute. Returns null on success and a failure descriptor (see failure()) otherwise.

connect()  : mixed

execWithRecovery()  : void

Runs the statement until it succeeds, recovering two failure classes within the shared db_max_retries budget:

failure()  : array<string|int, mixed>

Failure descriptor for one statement attempt, carrying what the recovery decision needs and the ready-to-throw exception with the historical prefix: "SQL Error" for connect and prepare failures, "SQL Execution Error" for execute failures.

isRetryable()  : bool

Classifies an error as retryable. Retries are limited to transient contention errors where the server already discarded the statement, making a re-run safe. Pure decision, no side effects.

pingConnection()  : bool

Sends a lightweight query to check whether an already-established connection is still responding. Assumes a connection has been opened.

reconnectBackoffUs()  : int

Attempt-scaled backoff slept before a reconnect attempt.

shouldReconnect()  : bool

Whether a just-failed query should be recovered by reconnecting: there must be retry budget left and the error must mean the connection itself is gone.

shouldRetry()  : bool

Whether a just-failed query should be retried: there must be retry budget left and the error must be a transient, cluster-related one.

sqlStateOf()  : string|null

Reads the SQLSTATE from a thrown mysqli exception, where mysqli_sql_exception::getSqlState() only exists on PHP 8.1+.