github.com

classIndexHintDefinitionWithUseSymKeyOrIndexIndexHintClauseOptKeyUsageList_39427321

packages/sql-semantics-mysql/resources/models/Value/IndexHintDefinitionWithUseSymKeyOrIndexIndexHintClauseOptKeyUsageList_39427321.php:15
final class IndexHintDefinitionWithUseSymKeyOrIndexIndexHintClauseOptKeyUsageList_39427321
    implements IndexHintDefinitionForm, IndexHintsListForm, OptIndexHintsListForm, OptKeyDefinitionForm
    uses Assertion
Public API: explicitly declared with @visibility public.

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

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

Properties§

public KeyOrIndexForm $keyOrIndex
source§
public IndexHintClauseForm $indexHintClause
source§
public OptKeyUsageListForm $optKeyUsageList
source§
public Comments $comments = new \SqlSemantics\Statement\Comments()
source§

Methods§

public function __construct(
    public KeyOrIndexForm $keyOrIndex,
    public IndexHintClauseForm $indexHintClause,
    public OptKeyUsageListForm $optKeyUsageList,
    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

$keyOrIndexKeyOrIndexForm
$indexHintClauseIndexHintClauseForm
$optKeyUsageListOptKeyUsageListForm
$commentsComments
Calls 3
public function write(Writer $writer): void
source§

Writes SQL entirely from this value's fields.

Parameters

$writerWriter
Calls 5
public function withKeyOrIndex(KeyOrIndexForm $keyOrIndex): self
source§

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

Parameters

$keyOrIndexKeyOrIndexForm

Returns

self
Calls 1
public function withIndexHintClause(IndexHintClauseForm $indexHintClause): self
source§

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

Parameters

$indexHintClauseIndexHintClauseForm

Returns

self
Calls 1
public function withOptKeyUsageList(OptKeyUsageListForm $optKeyUsageList): self
source§

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

Parameters

$optKeyUsageListOptKeyUsageListForm

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