packages/sql-semantics-mysql/resources/models/Value/IndexHintDefinitionWithUseSymKeyOrIndexIndexHintClauseOptKeyUsageList_39427321.php

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The index_hint_definition SQL value; generated by bin/build-models.php.
9 *
10 * @visibility public
11 * @example Accept a structured SQL value
12 *     $write = static fn (\SqlSemantics\Statement\Model\MySql\Value\IndexHintDefinitionWithUseSymKeyOrIndexIndexHintClauseOptKeyUsageList_39427321 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class IndexHintDefinitionWithUseSymKeyOrIndexIndexHintClauseOptKeyUsageList_39427321 implements \SqlSemantics\Statement\Model\MySql\Role\IndexHintDefinitionForm, \SqlSemantics\Statement\Model\MySql\Role\IndexHintsListForm, \SqlSemantics\Statement\Model\MySql\Role\OptIndexHintsListForm, \SqlSemantics\Statement\Model\MySql\Role\OptKeyDefinitionForm
16{
17    use \SqlSemantics\Statement\Assertion;
18
19    /**
20     * Supplies the SQL values of this form; comments are kept by the position of the symbol each precedes.
21     */
22    public function __construct(
23        public readonly \SqlSemantics\Statement\Model\MySql\Role\KeyOrIndexForm $keyOrIndex,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\IndexHintClauseForm $indexHintClause,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptKeyUsageListForm $optKeyUsageList,
26        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
27    ) {
28        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($keyOrIndex), 'The keyOrIndex must be a generated immutable SQL value.');
29        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($indexHintClause), 'The indexHintClause must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optKeyUsageList), 'The optKeyUsageList must be a generated immutable SQL value.');
31    }
32
33    /**
34     * Writes SQL entirely from this value's fields.
35     */
36    public function write(\SqlSemantics\Statement\Writer $writer): void
37    {
38        $writer->comments($this->comments, 0);
39        $writer->append('USE');
40        $writer->comments($this->comments, 1);
41        $this->keyOrIndex->write($writer);
42        $writer->comments($this->comments, 2);
43        $this->indexHintClause->write($writer);
44        $writer->comments($this->comments, 3);
45        $writer->append('(');
46        $writer->comments($this->comments, 4);
47        $this->optKeyUsageList->write($writer);
48        $writer->comments($this->comments, 5);
49        $writer->append(')');
50    }
51
52    /**
53     * Returns a copy with a new keyOrIndex, preserving every other field.
54     */
55    public function withKeyOrIndex(\SqlSemantics\Statement\Model\MySql\Role\KeyOrIndexForm $keyOrIndex): self
56    {
57        return new self($keyOrIndex, $this->indexHintClause, $this->optKeyUsageList, $this->comments);
58    }
59
60    /**
61     * Returns a copy with a new indexHintClause, preserving every other field.
62     */
63    public function withIndexHintClause(\SqlSemantics\Statement\Model\MySql\Role\IndexHintClauseForm $indexHintClause): self
64    {
65        return new self($this->keyOrIndex, $indexHintClause, $this->optKeyUsageList, $this->comments);
66    }
67
68    /**
69     * Returns a copy with a new optKeyUsageList, preserving every other field.
70     */
71    public function withOptKeyUsageList(\SqlSemantics\Statement\Model\MySql\Role\OptKeyUsageListForm $optKeyUsageList): self
72    {
73        return new self($this->keyOrIndex, $this->indexHintClause, $optKeyUsageList, $this->comments);
74    }
75
76    /**
77     * Returns a copy with a new comments, preserving every other field.
78     */
79    public function withComments(\SqlSemantics\Statement\Comments $comments): self
80    {
81        return new self($this->keyOrIndex, $this->indexHintClause, $this->optKeyUsageList, $comments);
82    }
83}
84