explain

package

v0.4.0 Latest Latest Go to latest Published: Oct 26, 2026 License: MIT Imports: 7 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	// contains filtered or unexported fields
}

Client wraps a database connection for running EXPLAIN queries.

func NewClient(db *sql.DB, driver Driver) *Client

NewClient creates a new Client from an existing *sql.DB.

func (c *Client) Close() error

Close closes the underlying database connection.

func (c *Client) Run(ctx context.Context, mode Mode, query string, args []string) (*Result, error)

Run executes EXPLAIN or EXPLAIN ANALYZE for the given query with optional args.

type Driver int

Driver identifies the database driver for EXPLAIN syntax differences.

const (
	Postgres Driver = iota
	MySQL
	TiDB
)

type Mode int

Mode selects between EXPLAIN and EXPLAIN ANALYZE.

const (
	Explain Mode = iota // EXPLAIN (plan only)
	Analyze             // EXPLAIN ANALYZE (plan + actual execution)
)

func (m Mode) String() string

type Result struct {
	Plan     string
	Duration time.Duration
}

Result holds the output of an EXPLAIN query.