class CreateStatement extends Statement (View source)

CREATE statement.

Properties

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

Options for CREATE statements.

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

The clauses of this statement, in order.

from  Statement
static array<string,int|array<int,int|string>> $END_OPTIONS 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
static array<string,int|array<int,int|string>> $DB_OPTIONS

All database options.

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

All table options.

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

All function options.

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

All trigger options.

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[]|string $body

The body of this function or procedure.

Methods

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

No description

string
build()

No description

void
parse(Parser $parser, TokensList $list)

No description

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<string,array<int,int|string>>
getClauses()

Gets the clauses of this statement.

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

string build()

No description

Return Value

string

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

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.

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

array<string,array<int,int|string>> getClauses()

Gets the clauses of this statement.

Return Value

array<string,array<int,int|string>>

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