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

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The opt_explain_options 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\OptExplainOptionsWithAnalyzeSymOptExplainFormat_62eae5e8 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class OptExplainOptionsWithAnalyzeSymOptExplainFormat_62eae5e8 implements \SqlSemantics\Statement\Model\MySql\Role\OptExplainOptionsForm
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\OptExplainFormatForm $optExplainFormat,
24        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
25    ) {
26        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optExplainFormat), 'The optExplainFormat must be a generated immutable SQL value.');
27    }
28
29    /**
30     * Writes SQL entirely from this value's fields.
31     */
32    public function write(\SqlSemantics\Statement\Writer $writer): void
33    {
34        $writer->comments($this->comments, 0);
35        $writer->append('ANALYZE');
36        $writer->comments($this->comments, 1);
37        $this->optExplainFormat->write($writer);
38    }
39
40    /**
41     * Returns a copy with a new optExplainFormat, preserving every other field.
42     */
43    public function withOptExplainFormat(\SqlSemantics\Statement\Model\MySql\Role\OptExplainFormatForm $optExplainFormat): self
44    {
45        return new self($optExplainFormat, $this->comments);
46    }
47
48    /**
49     * Returns a copy with a new comments, preserving every other field.
50     */
51    public function withComments(\SqlSemantics\Statement\Comments $comments): self
52    {
53        return new self($this->optExplainFormat, $comments);
54    }
55}
56