explain

Documentation

Index

• type Client
  • func NewClient(db *sql.DB, driver Driver) *Client
  • func (c *Client) Close() error
  • func (c *Client) Run(ctx context.Context, mode Mode, query string, args []string) (*Result, error)
• type Driver
• type Mode
  • func (m Mode) String() string
• type Result

Types

type Client

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

Client wraps a database connection for running EXPLAIN queries.

func NewClient

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

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

func (*Client) Close

func (c *Client) Close() error

Close closes the underlying database connection.

func (*Client) Run

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

type Driver int

Driver identifies the database driver for EXPLAIN syntax differences.

const (
	Postgres Driver = iota
	MySQL
	TiDB
)

type Mode

type Mode int

Mode selects between EXPLAIN and EXPLAIN ANALYZE.

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

func (Mode) String

func (m Mode) String() string

type Result

type Result struct {
	Plan     string
	Duration time.Duration
}

Result holds the output of an EXPLAIN query.