Diviner Tech Docs PhabricatorWorkerLeaseQuery

final class PhabricatorWorkerLeaseQuery
Phorge Technical Documentation (Daemons)

Select and lease tasks from the worker task queue.

Tasks

Formatting Query Clauses

protected function formatWhereClause($conn, $parts)
protected function formatSelectClause($conn, $parts)
protected function formatJoinClause($conn, $parts)
protected function formatHavingClause($conn, $parts)
private function flattenSubclause($parts)

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
public function execute()
public static function getDefaultWaitBeforeRetry()
public static function getDefaultLeaseDuration()
public function setSkipLease($skip) — Set this flag to select tasks from the top of the queue without leasing them.
public function withIDs($ids)
public function withObjectPHIDs($phids)
public function withLeasedTasks($leased) — Select only leased tasks, only unleased tasks, or both types of task.
public function setLimit($limit)
protected function buildCustomWhereClause($conn, $phase)
private function buildUpdateWhereClause($conn, $phase, $rows)
private function buildOrderClause($conn_w, $phase)
private function buildLimitClause($conn_w, $limit)
private function getLeaseOwnershipName()

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	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function execute()

This method is not documented.

Return

wild

protected function formatWhereClause($conn, $parts)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
array	$parts

Return

wild

protected function formatSelectClause($conn, $parts)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
array	$parts

Return

wild

protected function formatJoinClause($conn, $parts)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
array	$parts

Return

wild

protected function formatHavingClause($conn, $parts)
Inherited

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
array	$parts

Return

wild

private function flattenSubclause($parts)
Inherited

This method is not documented.

Parameters

array

$parts

Return

wild

public static function getDefaultWaitBeforeRetry()

This method is not documented.

Return

wild

public static function getDefaultLeaseDuration()

This method is not documented.

Return

wild

public function setSkipLease($skip)

Set this flag to select tasks from the top of the queue without leasing them.

This can be used to show which tasks are coming up next without altering the queue's behavior.

Parameters

bool

$skip

True to skip the lease acquisition step.

Return

wild

public function withIDs($ids)

This method is not documented.

Parameters

array

$ids

Return

wild

public function withObjectPHIDs($phids)

This method is not documented.

Parameters

array

$phids

Return

wild

public function withLeasedTasks($leased)

Select only leased tasks, only unleased tasks, or both types of task.

By default, queries select only unleased tasks (equivalent to passing false to this method). You can pass true to select only leased tasks, or null to ignore the lease status of tasks.

If your result set potentially includes leased tasks, you must disable leasing using setSkipLease(). These options are intended for use when displaying task status information.

Parameters

mixed

$leased

`true` to select only leased tasks, `false` to select only unleased tasks (default), or `null` to select both.

Return

this

public function setLimit($limit)

This method is not documented.

Parameters

$limit

Return

wild

protected function buildCustomWhereClause($conn, $phase)

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
	$phase

Return

wild

private function buildUpdateWhereClause($conn, $phase, $rows)

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn
	$phase
array	$rows

Return

wild

private function buildOrderClause($conn_w, $phase)

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn_w
	$phase

Return

wild

private function buildLimitClause($conn_w, $limit)

This method is not documented.

Parameters

AphrontDatabaseConnection	$conn_w
	$limit

Return

wild

private function getLeaseOwnershipName()

This method is not documented.

Return

wild

Defined: src/infrastructure/daemon/workers/query/PhabricatorWorkerLeaseQuery.php:6
Extends: PhobjectPhabricatorQuery

final class PhabricatorWorkerLeaseQueryPhorge Technical Documentation (Daemons)

Tasks

Formatting Query Clauses

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function execute()

protected function formatWhereClause($conn, $parts)Inherited

protected function formatSelectClause($conn, $parts)Inherited

protected function formatJoinClause($conn, $parts)Inherited

protected function formatHavingClause($conn, $parts)Inherited

private function flattenSubclause($parts)Inherited

public static function getDefaultWaitBeforeRetry()

public static function getDefaultLeaseDuration()

public function setSkipLease($skip)

public function withIDs($ids)

public function withObjectPHIDs($phids)

public function withLeasedTasks($leased)

public function setLimit($limit)

protected function buildCustomWhereClause($conn, $phase)

private function buildUpdateWhereClause($conn, $phase, $rows)

private function buildOrderClause($conn_w, $phase)

private function buildLimitClause($conn_w, $limit)

private function getLeaseOwnershipName()

final class PhabricatorWorkerLeaseQuery
Phorge Technical Documentation (Daemons)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

protected function formatWhereClause($conn, $parts)
Inherited

protected function formatSelectClause($conn, $parts)
Inherited

protected function formatJoinClause($conn, $parts)
Inherited

protected function formatHavingClause($conn, $parts)
Inherited

private function flattenSubclause($parts)
Inherited