class LoadStatement extends Statement (View source)

LOAD statement.

LOAD DATA [LOW_PRIORITY | CONCURRENT] [LOCAL] INFILE 'file_name' [REPLACE | IGNORE] INTO TABLE tbl_name [PARTITION (partition_name,...)] [CHARACTER SET charset_name] [{FIELDS | COLUMNS} [TERMINATED BY 'string'] [[OPTIONALLY] ENCLOSED BY 'char'] [ESCAPED BY 'char'] ] [LINES [STARTING BY 'string'] [TERMINATED BY 'string'] ] [IGNORE number {LINES | ROWS}] [(col_name_or_user_var,...)] [SET col_name = expr,...]

Constants

protected ADD_CLAUSE

protected ADD_KEYWORD

private STATEMENT_FIELDS_OPTIONS

FIELDS/COLUMNS Options for LOAD DATA...INFILE statements.

private STATEMENT_LINES_OPTIONS

LINES Options for LOAD DATA...INFILE statements.

Properties

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

Options for LOAD statements and their slot ID.

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 $fileName

File name being used to load data.

Expression|null $table

Table used as destination for this statement.

ArrayObj|null $partition

Partitions used as source for this statement.

Expression|null $charsetName

Character set used in this statement.

OptionsArray|null $fieldsOptions

Options for FIELDS/COLUMNS keyword.

string|null $fieldsKeyword

Whether to use FIELDS or COLUMNS while building.

OptionsArray|null $linesOptions

Options for OPTIONS keyword.

Expression[]|null $columnNamesOrUserVariables

Column names or user variables.

SetOperation[]|null $set

SET clause's updated values(optional).

Expression|null $ignoreNumber

Ignore 'number' LINES/ROWS.

string|null $replaceIgnore

REPLACE/IGNORE Keyword.

string|null $linesRows

LINES/ROWS Keyword.

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)

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

void
parseFileOptions(Parser $parser, TokensList $list, string $keyword = 'FIELDS')

No description

int
parseKeywordsAccordingToState(Parser $parser, TokensList $list, int $state)

No description

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)

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

void parseFileOptions(Parser $parser, TokensList $list, string $keyword = 'FIELDS')

No description

Parameters

Parser $parser

The parser

TokensList $list

A token list

string $keyword

The keyword

Return Value

void

int parseKeywordsAccordingToState(Parser $parser, TokensList $list, int $state)

No description

Parameters

Parser $parser
TokensList $list
int $state

Return Value

int