explaintest

command
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 8, 2026 License: MIT Imports: 23 Imported by: 0

Documentation

Overview

Command explaintest runs EXPLAIN ANALYZE on OpenFGA test cases to show query execution plans, buffer statistics, and performance metrics.

By default, runs EXPLAIN with ANALYZE, BUFFERS, TIMING, VERBOSE, SETTINGS, and WAL options enabled to provide comprehensive query analysis including: - Execution plans with actual row counts and timing - Buffer cache hit/miss statistics - Configuration parameters affecting query planning - WAL (Write-Ahead Log) generation information - Verbose details like output columns and schema-qualified names

Usage:

explaintest <name>                      # Run EXPLAIN on specific test
explaintest --format json <name>        # JSON output
explaintest --assertion 3 <name>        # Single assertion only
explaintest --summary "^userset"        # Summary mode for pattern
explaintest --verbose=false <name>      # Disable verbose output
explaintest --settings=false <name>     # Disable settings output

Examples:

explaintest wildcard_direct
explaintest --format json computed_userset_simple
explaintest --assertion 1 wildcard_direct
explaintest --summary ".*"
explaintest --verbose=false --settings=false wildcard_direct

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL