github.com

classExplainStmtWithDescribeCommandOptExplainOptionsIntoIdentOrTextExplainableStmt_6a8d8cd5

packages/sql-semantics-mysql/resources/models/Value/ExplainStmtWithDescribeCommandOptExplainOptionsIntoIdentOrTextExplainableStmt_6a8d8cd5.php:15
final class ExplainStmtWithDescribeCommandOptExplainOptionsIntoIdentOrTextExplainableStmt_6a8d8cd5
    implements EvSqlStmtForm, EvSqlStmtInnerForm, ExplainStmtForm, SimpleStatementForm, SimpleStatementOrBeginForm, SpProcStmtForm, SpProcStmtStatementForm, StoredRoutineBodyForm, Command
    uses Assertion
Public API: explicitly declared with @visibility public.

The explain_stmt SQL value; generated by bin/build-models.php.

Accept a structured SQL valuedoctest
$write = static fn (\SqlSemantics\Statement\Model\MySql\Value\ExplainStmtWithDescribeCommandOptExplainOptionsIntoIdentOrTextExplainableStmt_6a8d8cd5 $value): string => \SqlSemantics\Statement\Writer::render($value);
    $write instanceof \Closure // => true

Properties§

public DescribeCommandForm $describeCommand
source§
public OptExplainOptionsForm $optExplainOptions
source§
public IdentOrTextForm $identOrText
source§
public ExplainableStmtForm $explainableStmt
source§
public Comments $comments = new \SqlSemantics\Statement\Comments()
source§

Methods§

public function __construct(
    public DescribeCommandForm $describeCommand,
    public OptExplainOptionsForm $optExplainOptions,
    public IdentOrTextForm $identOrText,
    public ExplainableStmtForm $explainableStmt,
    public Comments $comments = new \SqlSemantics\Statement\Comments(),
)
source§

Supplies the SQL values of this form; comments are kept by the position of the symbol each precedes.

Parameters

$describeCommandDescribeCommandForm
$optExplainOptionsOptExplainOptionsForm
$identOrTextIdentOrTextForm
$explainableStmtExplainableStmtForm
$commentsComments
Calls 3
public function write(Writer $writer): void
source§

Writes SQL entirely from this value's fields.

Parameters

$writerWriter
Calls 6
public function withDescribeCommand(DescribeCommandForm $describeCommand): self
source§

Returns a copy with a new describeCommand, preserving every other field.

Parameters

$describeCommandDescribeCommandForm

Returns

self
Calls 1
public function withOptExplainOptions(OptExplainOptionsForm $optExplainOptions): self
source§

Returns a copy with a new optExplainOptions, preserving every other field.

Parameters

$optExplainOptionsOptExplainOptionsForm

Returns

self
Calls 1
public function withIdentOrText(IdentOrTextForm $identOrText): self
source§

Returns a copy with a new identOrText, preserving every other field.

Parameters

$identOrTextIdentOrTextForm

Returns

self
Calls 1
public function withExplainableStmt(ExplainableStmtForm $explainableStmt): self
source§

Returns a copy with a new explainableStmt, preserving every other field.

Parameters

$explainableStmtExplainableStmtForm

Returns

self
Calls 1
public function withComments(Comments $comments): self
source§

Returns a copy with a new comments, preserving every other field.

Parameters

$commentsComments

Returns

self
Calls 1