class UpdateStatement extends Statement (View source)

UPDATE statement.

UPDATE [LOW_PRIORITY] [IGNORE] table_reference [INNER JOIN | LEFT JOIN | JOIN] T1 ON T1.C1 = T2.C1 SET col_name1={expr1|DEFAULT} [, col_name2={expr2|DEFAULT}] ... [WHERE where_condition] [ORDER BY ...] [LIMIT row_count]

or

UPDATE [LOW_PRIORITY] [IGNORE] table_references SET col_name1={expr1|DEFAULT} [, col_name2={expr2|DEFAULT}] ... [WHERE where_condition]

Constants

protected ADD_CLAUSE

protected ADD_KEYWORD

Properties

static array<string,int|array<int,int|string>> $statementOptions

Options for UPDATE statements and their slot ID.

static array $clauses

The clauses of this statement, in order.

OptionsArray|null $options

The options of this query.

from  Statement
int|null $first

The index of the first token used in this statement.

from  Statement
int|null $last

The index of the last token used in this statement.

from  Statement
Expression[]|null $tables

Tables used as sources for this statement.

SetOperation[]|null $set

The updated values.

Condition[]|null $where

Conditions used for filtering each row of the result set.

OrderKeyword[]|null $order

Specifies the order of the rows in the result set.

Limit|null $limit

Conditions used for limiting the size of the result set.

JoinKeyword[]|null $join Joins.

Methods

__construct(Parser|null $parser = null, TokensList|null $list = null)

No description

string
build()

Builds the string representation of this statement.

void
parse(Parser $parser, TokensList $list)

Parses the statements defined by the tokens list.

void
before(Parser $parser, TokensList $list, Token $token)

Function called before the token is processed.

void
after(Parser $parser, TokensList $list, Token $token)

Function called after the token was processed.

array
getClauses()

Gets the clauses of this statement.

array
getClauseOrder()

Gets the clause order of this statement as an array with clause as key and index as value.

string
__toString()

Builds the string representation of this statement.

bool
validateClauseOrder(Parser $parser, TokensList $list)

Validates the order of the clauses in parsed statement Ideally this should be called after successfully completing the parsing of each statement.

Details

__construct(Parser|null $parser = null, TokensList|null $list = null)

No description

Parameters

Parser|null $parser

the instance that requests parsing

TokensList|null $list

the list of tokens to be parsed

Exceptions

ParserException

string build()

Builds the string representation of this statement.

Return Value

string

void parse(Parser $parser, TokensList $list)

Parses the statements defined by the tokens list.

Parameters

Parser $parser

the instance that requests parsing

TokensList $list

the list of tokens to be parsed

Return Value

void

Exceptions

ParserException

void before(Parser $parser, TokensList $list, Token $token)

Function called before the token is processed.

Parameters

Parser $parser

the instance that requests parsing

TokensList $list

the list of tokens to be parsed

Token $token

the token that is being parsed

Return Value

void

void after(Parser $parser, TokensList $list, Token $token)

Function called after the token was processed.

In the update statement, this is used to check that at least one assignment has been set to throw an error if a query like UPDATE acme SET WHERE 1; is parsed.

Parameters

Parser $parser

the instance that requests parsing

TokensList $list

the list of tokens to be parsed

Token $token

the token that is being parsed

Return Value

void

Exceptions

ParserException

array getClauses()

Gets the clauses of this statement.

Return Value

array

array getClauseOrder()

Gets the clause order of this statement as an array with clause as key and index as value.

Return Value

array

string __toString()

Builds the string representation of this statement.

Return Value

string

See also

static::build

bool validateClauseOrder(Parser $parser, TokensList $list)

Validates the order of the clauses in parsed statement Ideally this should be called after successfully completing the parsing of each statement.

Parameters

Parser $parser

the instance that requests parsing

TokensList $list

the list of tokens to be parsed

Return Value

bool

Exceptions

ParserException