1. class
  2. PhpMyAdmin
  3. \
  4. SqlParser
  5. \
  6. Statements
  7. \
  8. CreateStatement

CreateStatement

class CreateStatement extends Statement (View source)

CREATE statement.

Constants

protected ADD_CLAUSE

protected ADD_KEYWORD

private DATABASE_OPTIONS

All database options.
private TABLE_OPTIONS

All table options.
private FUNCTION_OPTIONS

All function options.
private TRIGGER_OPTIONS

All trigger options.

Properties

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

Options for CREATE statements.
static array $clauses

The clauses of this statement, in order.

 from  Statement
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 $name

The name of the entity that is created.
OptionsArray|null $entityOptions

The options of the entity (table, procedure, function, etc.).
CreateDefinition[]|ArrayObj|null $fields

If CREATE TABLE, a list of columns and keys.
WithStatement|null $with

If CREATE TABLE WITH.
SelectStatement|null $select

If CREATE TABLE ... SELECT.
Expression|null $like

If CREATE TABLE ... LIKE.
string|null $partitionBy

Expression used for partitioning.
int|null $partitionsNum

The number of partitions.
string|null $subpartitionBy

Expression used for subpartitioning.
int|null $subpartitionsNum

The number of subpartitions.
PartitionDefinition[]|null $partitions

The partition of the new table.
Expression|null $table

If CREATE TRIGGER the name of the table.
DataType|null $return

The return data type of this routine.
ParameterDefinition[]|null $parameters

The parameters of this routine.
Token[] $body

The body of this function or procedure.

Methods

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

No description

from  Statement
string
build()

Builds the string representation of this statement.

void
parse(Parser $parser, TokensList $list)

No description

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

Function called before the token is processed.

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

Function called after the token was processed.

from  Statement
array
getClauses()

Gets the clauses of this statement.

from  Statement
array
getClauseOrder()

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

from  Statement
string
__toString()

Builds the string representation of this statement.

from  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.

from  Statement
array
getForeignKeys()

No description

Details

in Statement at line 91
__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

at line 387
string build()

Builds the string representation of this statement.

Return Value

string

at line 506
void parse(Parser $parser, TokensList $list)

No description

Parameters

Parser $parser

the instance that requests parsing
TokensList $list

the list of tokens to be parsed

Return Value

void

in Statement at line 344
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

in Statement at line 355
void after(Parser $parser, TokensList $list, Token $token)

Function called after the token was 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

in Statement at line 364
array getClauses()

Gets the clauses of this statement.

Return Value

array

in Statement at line 375
array getClauseOrder()

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

Return Value

array

in Statement at line 398
string __toString()

Builds the string representation of this statement.

Return Value

string

See also

static::build

in Statement at line 413
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

at line 782
array getForeignKeys()

No description

Return Value

array