Skip to content

refactor: postgresql explain config #2134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
norberttech merged 2 commits into from
Jan 7, 2026
Merged

refactor: postgresql explain config #2134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f28dd5
refactor: postgresql explain config
norberttech Jan 7, 2026
6470df3
fix: regenerated dsl definitions
norberttech Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
323 changes: 323 additions & 0 deletions src/lib/postgresql/src/Flow/PostgreSql/AST/Transformers/ExplainConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Flow\PostgreSql\AST\Transformers;

use Flow\PostgreSql\Exception\InvalidExplainConfigException;
use Flow\PostgreSql\QueryBuilder\Utility\ExplainFormat;

final readonly class ExplainConfig
Expand All @@ -20,6 +21,7 @@ public function __construct(
public bool $wal = false,
public ExplainFormat $format = ExplainFormat::JSON,
) {
$this->validate();
}

public static function forAnalysis() : self
Expand Down Expand Up @@ -53,4 +55,325 @@ public static function forEstimate() : self
format: ExplainFormat::JSON,
);
}

public function withAnalyze() : self
{
return new self(
analyze: true,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withBuffers() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: true,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withCosts() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: true,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withFormat(ExplainFormat $format) : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $format,
);
}

public function withMemory() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: true,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withoutAnalyze() : self
{
return new self(
analyze: false,
verbose: $this->verbose,
costs: $this->costs,
buffers: false,
timing: false,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: false,
format: $this->format,
);
}

public function withoutBuffers() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: false,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withoutCosts() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: false,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withoutMemory() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: false,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withoutSettings() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: false,
wal: $this->wal,
format: $this->format,
);
}

public function withoutSummary() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: false,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withoutTiming() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: false,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withoutVerbose() : self
{
return new self(
analyze: $this->analyze,
verbose: false,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withoutWal() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: false,
format: $this->format,
);
}

public function withSettings() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: true,
wal: $this->wal,
format: $this->format,
);
}

public function withSummary() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: true,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withTiming() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: true,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withVerbose() : self
{
return new self(
analyze: $this->analyze,
verbose: true,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: $this->wal,
format: $this->format,
);
}

public function withWal() : self
{
return new self(
analyze: $this->analyze,
verbose: $this->verbose,
costs: $this->costs,
buffers: $this->buffers,
timing: $this->timing,
summary: $this->summary,
memory: $this->memory,
settings: $this->settings,
wal: true,
format: $this->format,
);
}

private function validate() : void
{
if (!$this->analyze) {
if ($this->buffers) {
throw InvalidExplainConfigException::buffersRequiresAnalyze();
}

if ($this->timing) {
throw InvalidExplainConfigException::timingRequiresAnalyze();
}

if ($this->wal) {
throw InvalidExplainConfigException::walRequiresAnalyze();
}
}
}
}
32 changes: 13 additions & 19 deletions src/lib/postgresql/src/Flow/PostgreSql/AST/Transformers/ExplainModifier.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,28 +100,22 @@ private function wrapWithExplain(SelectStmt $stmt) : Node

$options[] = $this->createDefElemInt('costs', $this->config->costs ? 1 : 0);

if ($this->config->buffers) {
$options[] = $this->createDefElemInt('buffers', 1);
}

if ($this->config->timing) {
$options[] = $this->createDefElemInt('timing', 1);
}

if ($this->config->summary) {
$options[] = $this->createDefElemInt('summary', 1);
}
if ($this->config->analyze) {
$options[] = $this->createDefElemInt('buffers', $this->config->buffers ? 1 : 0);
$options[] = $this->createDefElemInt('timing', $this->config->timing ? 1 : 0);
$options[] = $this->createDefElemInt('summary', $this->config->summary ? 1 : 0);

if ($this->config->memory) {
$options[] = $this->createDefElemInt('memory', 1);
}
if ($this->config->memory) {
$options[] = $this->createDefElemInt('memory', 1);
}

if ($this->config->settings) {
$options[] = $this->createDefElemInt('settings', 1);
}
if ($this->config->settings) {
$options[] = $this->createDefElemInt('settings', 1);
}

if ($this->config->wal) {
$options[] = $this->createDefElemInt('wal', 1);
if ($this->config->wal) {
$options[] = $this->createDefElemInt('wal', 1);
}
}

$options[] = $this->createDefElemString('format', $this->config->format->value);
Expand Down
Loading
Loading