sqlite

Documentation

Overview

Package sqlite provides a SQLite3 database utils.

Index

• func Compact(ctx context.Context, db *sql.DB) error
• func Open(file string, opts ...OpOption) (*sql.DB, error)
• func OpenTestDB(t *testing.T) (*sql.DB, *sql.DB, func())
• func ReadDBSize(ctx context.Context, db *sql.DB) (uint64, error)
• func RecordDelete(tookSeconds float64)
• func RecordInsertUpdate(tookSeconds float64)
• func RecordSelect(tookSeconds float64)
• func Register(reg *prometheus.Registry) error
• type Metrics
  • func ReadMetrics(gatherer prometheus.Gatherer) (Metrics, error)
  • func (m Metrics) IsZero() bool
  • func (prev Metrics) QPS(cur Metrics) (insertUpdateAvgQPS float64, deleteAvgQPS float64, selectAvgQPS float64)
• type Op
• type OpOption
  • func WithReadOnly(b bool) OpOption

Functions

func Compact

func Compact(ctx context.Context, db *sql.DB) error

func Open

func Open(file string, opts ...OpOption) (*sql.DB, error)

Helper function to open a SQLite3 database.

func OpenTestDB

func OpenTestDB(t *testing.T) (*sql.DB, *sql.DB, func())

func ReadDBSize

func ReadDBSize(ctx context.Context, db *sql.DB) (uint64, error)

func RecordDelete

func RecordDelete(tookSeconds float64)

func RecordInsertUpdate

func RecordInsertUpdate(tookSeconds float64)

func RecordSelect

func RecordSelect(tookSeconds float64)

func Register

func Register(reg *prometheus.Registry) error

Types

type Metrics

type Metrics struct {
	Time time.Time

	// The total number of inserts and updates in cumulative count.
	InsertUpdateTotal        int64
	InsertUpdateSecondsTotal float64
	InsertUpdateSecondsAvg   float64

	// The total number of deletes in cumulative count.
	DeleteTotal        int64
	DeleteSecondsTotal float64
	DeleteSecondsAvg   float64

	// The total number of selects in cumulative count.
	SelectTotal        int64
	SelectSecondsTotal float64
	SelectSecondsAvg   float64
}

func ReadMetrics

func ReadMetrics(gatherer prometheus.Gatherer) (Metrics, error)

func (Metrics) IsZero

func (m Metrics) IsZero() bool

func (Metrics) QPS

func (prev Metrics) QPS(cur Metrics) (insertUpdateAvgQPS float64, deleteAvgQPS float64, selectAvgQPS float64)

Computes the QPS for insert/updates, deletes, and selects, based on the previous and current metrics time.

type Op

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

type OpOption

type OpOption func(*Op)

func WithReadOnly

func WithReadOnly(b bool) OpOption

ref. https://github.com/mattn/go-sqlite3/issues/1179#issuecomment-1638083995