Page MenuHomePhorge
Diviner Tech Docs AphrontBaseMySQLDatabaseConnection

abstract class AphrontBaseMySQLDatabaseConnection
Phorge Technical Documentation (Storage)

This class is not documented.

Tasks

Transaction Management

Other Methods

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

abstract public function getInsertID()
Inherited

This method is not documented.
Return
wild

abstract public function getAffectedRows()
Inherited

This method is not documented.
Return
wild

public function selectAllResults()

This method is not documented.
Return
wild

public function executeQuery($query)

This method is not documented.
Parameters
PhutilQueryString$query
Return
wild

public function executeRawQueries($raw_queries)

This method is not documented.
Parameters
array$raw_queries
Return
wild

public function close()

This method is not documented.
Return
wild

public function openConnection()

This method is not documented.
Return
wild

public function __destruct()
Inherited

This method is not documented.
Return
wild

final public function setLastActiveEpoch($epoch)
Inherited

This method is not documented.
Parameters
$epoch
Return
wild

final public function getLastActiveEpoch()
Inherited

This method is not documented.
Return
wild

final public function setPersistent($persistent)
Inherited

This method is not documented.
Parameters
$persistent
Return
wild

final public function getPersistent()
Inherited

This method is not documented.
Return
wild

public function queryData($pattern)
Inherited

This method is not documented.
Parameters
$pattern
Return
wild

public function query($pattern)
Inherited

This method is not documented.
Parameters
$pattern
Return
wild

public function supportsAsyncQueries()
Inherited

This method is not documented.
Return
wild

public function supportsParallelQueries()
Inherited

This method is not documented.
Return
wild

public function setReadOnly($read_only)
Inherited

This method is not documented.
Parameters
$read_only
Return
wild

public function getReadOnly()
Inherited

This method is not documented.
Return
wild

public function setQueryTimeout($query_timeout)
Inherited

This method is not documented.
Parameters
$query_timeout
Return
wild

public function getQueryTimeout()
Inherited

This method is not documented.
Return
wild

public function asyncQuery($raw_query)
Inherited

This method is not documented.
Parameters
$raw_query
Return
wild

public static function resolveAsyncQueries($conns, $asyncs)
Inherited

This method is not documented.
Parameters
array$conns
array$asyncs
Return
wild

public function isIdle()
Inherited

AphrontDatabaseConnection

Is this connection idle and safe to close?

A connection is "idle" if it can be safely closed without loss of state. Connections inside a transaction or holding locks are not idle, even though they may not actively be executing queries.

Return
boolTrue if the connection is idle and can be safely closed.

public function rememberLock($lock)
Inherited

This method is not documented.
Parameters
$lock
Return
wild

public function forgetLock($lock)
Inherited

This method is not documented.
Parameters
$lock
Return
wild

public function forgetAllLocks()
Inherited

This method is not documented.
Return
wild

public function isHoldingAnyLock()
Inherited

This method is not documented.
Return
wild

public function openTransaction()
Inherited

AphrontDatabaseConnection

Begin a transaction, or set a savepoint if the connection is already transactional.

Return
this

public function saveTransaction()
Inherited

AphrontDatabaseConnection

Commit a transaction, or stage a savepoint for commit once the entire transaction completes if inside a transaction stack.

Return
this

public function killTransaction()
Inherited

AphrontDatabaseConnection

Rollback a transaction, or unstage the last savepoint if inside a transaction stack.

Return
this

public function isInsideTransaction()
Inherited

AphrontDatabaseConnection

Returns true if the connection is transactional.

Return
boolTrue if the connection is currently transactional.

protected function getTransactionState()
Inherited

AphrontDatabaseConnection

Get the current AphrontDatabaseTransactionState object, or create one if none exists.

Return
AphrontDatabaseTransactionStateCurrent transaction state.

public function beginReadLocking()
Inherited

This method is not documented.
Return
wild

public function endReadLocking()
Inherited

This method is not documented.
Return
wild

public function isReadLocking()
Inherited

This method is not documented.
Return
wild

public function beginWriteLocking()
Inherited

This method is not documented.
Return
wild

public function endWriteLocking()
Inherited

This method is not documented.
Return
wild

public function isWriteLocking()
Inherited

This method is not documented.
Return
wild

abstract protected function connect()

This method is not documented.
Return
wild

abstract protected function rawQuery($raw_query)

This method is not documented.
Parameters
$raw_query
Return
wild

abstract protected function rawQueries($raw_queries)

This method is not documented.
Parameters
array$raw_queries
Return
wild

abstract protected function fetchAssoc($result)

This method is not documented.
Parameters
$result
Return
wild

abstract protected function getErrorCode($connection)

This method is not documented.
Parameters
$connection
Return
wild

abstract protected function getErrorDescription($connection)

This method is not documented.
Parameters
$connection
Return
wild

abstract protected function closeConnection()

This method is not documented.
Return
wild

abstract protected function freeResult($result)

This method is not documented.
Parameters
$result
Return
wild

public function __construct($configuration)

This method is not documented.
Parameters
array$configuration
Return
this//Implicit.//

public function __clone()

This method is not documented.
Return
wild

public function escapeColumnName($name)

This method is not documented.
Parameters
$name
Return
wild

public function escapeMultilineComment($comment)

This method is not documented.
Parameters
$comment
Return
wild

public function escapeStringForLikeClause($value)

This method is not documented.
Parameters
$value
Return
wild

protected function getConfiguration($key, $default)

This method is not documented.
Parameters
$key
$default
Return
wild

private function establishConnection()

This method is not documented.
Return
wild

protected function requireConnection()

This method is not documented.
Return
wild

protected function beginAsyncConnection()

This method is not documented.
Return
wild

protected function endAsyncConnection($connection)

This method is not documented.
Parameters
$connection
Return
wild

protected function processResult($result)

This method is not documented.
Parameters
$result
Return
wild

protected function checkWrite($raw_query)

This method is not documented.
Parameters
$raw_query
Return
wild

protected function throwQueryException($connection)

This method is not documented.
Parameters
$connection
Return
wild

private function throwCommonException($errno, $error)

This method is not documented.
Parameters
$errno
$error
Return
wild

protected function throwConnectionException($errno, $error, $user, $host)

This method is not documented.
Parameters
$errno
$error
$user
$host
Return
wild

protected function throwQueryCodeException($errno, $error)

This method is not documented.
Parameters
$errno
$error
Return
wild

public function simulateErrorOnNextQuery($error)

Force the next query to fail with a simulated error. This should be used ONLY for unit tests.

Parameters
$error
Return
wild

protected function validateUTF8String($string)

Check inserts for characters outside of the BMP. Even with the strictest settings, MySQL will silently truncate data when it encounters these, which can lead to data loss and security problems.

Parameters
$string
Return
wild