gorm

Documentation

Overview

Package gorm provides a GORM plugin that records generated SQL as webpprof Query entries.

Index

• func Profile(db *gorm.DB, configs ...Config) error
• func ProfileWith(profiler *webpprof.Profiler, db *gorm.DB, configs ...Config) error
• type Config
• type Plugin
  • func New(configs ...Config) *Plugin
  • func NewWith(profiler *webpprof.Profiler, configs ...Config) *Plugin
  • func (p *Plugin) Initialize(db *gorm.DB) error
  • func (*Plugin) Name() string

Functions

func Profile

func Profile(db *gorm.DB, configs ...Config) error

Profile installs the plugin on db using the default profiler.

func ProfileWith

func ProfileWith(profiler *webpprof.Profiler, db *gorm.DB, configs ...Config) error

ProfileWith installs the plugin on db using an explicit profiler.

Types

type Config

type Config struct {
	Connection     string
	Database       string
	Explain        bool
	ExplainTimeout time.Duration
	ExplainMaxRows int
}

Config names the connection and database shown in captured Query entries and controls optional non-executing EXPLAIN capture.

type Plugin

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

Plugin implements gorm.Plugin.

func New

func New(configs ...Config) *Plugin

New creates a plugin using the default webpprof profiler.

func NewWith

func NewWith(profiler *webpprof.Profiler, configs ...Config) *Plugin

NewWith creates a plugin using an explicit profiler.

func (*Plugin) Initialize

func (p *Plugin) Initialize(db *gorm.DB) error

Initialize registers callbacks around every SQL-producing GORM operation.

func (*Plugin) Name

func (*Plugin) Name() string

Name identifies the plugin in GORM's plugin registry.