packages/sql-semantics-postgres/resources/models/Value/ExplainStmtWithExplainAnalyzeKeywordOptVerboseExplainableStmt_a4d28e5b.php

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\PostgreSql\Value;
6
7/**
8 * The ExplainStmt 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\PostgreSql\Value\ExplainStmtWithExplainAnalyzeKeywordOptVerboseExplainableStmt_a4d28e5b $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class ExplainStmtWithExplainAnalyzeKeywordOptVerboseExplainableStmt_a4d28e5b implements \SqlSemantics\Statement\Model\PostgreSql\Role\ExplainStmtForm, \SqlSemantics\Statement\Model\PostgreSql\Role\ParseToplevelForm, \SqlSemantics\Statement\Model\PostgreSql\Role\RoutineBodyStmtForm, \SqlSemantics\Statement\Model\PostgreSql\Role\StmtForm, \SqlSemantics\Statement\Model\PostgreSql\Role\StmtmultiForm, \SqlSemantics\Statement\Model\PostgreSql\Role\ToplevelStmtForm, \SqlSemantics\Statement\Command
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\PostgreSql\Role\AnalyzeKeywordForm $analyzeKeyword,
24        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\OptVerboseForm $optVerbose,
25        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\ExplainableStmtForm $explainableStmt,
26        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
27    ) {
28        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($analyzeKeyword), 'The analyzeKeyword must be a generated immutable SQL value.');
29        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optVerbose), 'The optVerbose must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($explainableStmt), 'The explainableStmt 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('EXPLAIN');
40        $writer->comments($this->comments, 1);
41        $this->analyzeKeyword->write($writer);
42        $writer->comments($this->comments, 2);
43        $this->optVerbose->write($writer);
44        $writer->comments($this->comments, 3);
45        $this->explainableStmt->write($writer);
46    }
47
48    /**
49     * Returns a copy with a new analyzeKeyword, preserving every other field.
50     */
51    public function withAnalyzeKeyword(\SqlSemantics\Statement\Model\PostgreSql\Role\AnalyzeKeywordForm $analyzeKeyword): self
52    {
53        return new self($analyzeKeyword, $this->optVerbose, $this->explainableStmt, $this->comments);
54    }
55
56    /**
57     * Returns a copy with a new optVerbose, preserving every other field.
58     */
59    public function withOptVerbose(\SqlSemantics\Statement\Model\PostgreSql\Role\OptVerboseForm $optVerbose): self
60    {
61        return new self($this->analyzeKeyword, $optVerbose, $this->explainableStmt, $this->comments);
62    }
63
64    /**
65     * Returns a copy with a new explainableStmt, preserving every other field.
66     */
67    public function withExplainableStmt(\SqlSemantics\Statement\Model\PostgreSql\Role\ExplainableStmtForm $explainableStmt): self
68    {
69        return new self($this->analyzeKeyword, $this->optVerbose, $explainableStmt, $this->comments);
70    }
71
72    /**
73     * Returns a copy with a new comments, preserving every other field.
74     */
75    public function withComments(\SqlSemantics\Statement\Comments $comments): self
76    {
77        return new self($this->analyzeKeyword, $this->optVerbose, $this->explainableStmt, $comments);
78    }
79}
80