feat: postgresql vacuum

This commit is contained in:
Richard Ramos 2023-08-09 13:14:02 -04:00 committed by richΛrd
parent ee2af4646c
commit 05d8cfdc65
6 changed files with 37 additions and 13 deletions

View File

@ -290,7 +290,7 @@ var (
}) })
StoreMessageDBVacuum = altsrc.NewBoolFlag(&cli.BoolFlag{ StoreMessageDBVacuum = altsrc.NewBoolFlag(&cli.BoolFlag{
Name: "store-message-db-vacuum", Name: "store-message-db-vacuum",
Usage: "Enable database vacuuming at start. Only supported by SQLite database engine.", Usage: "Enable database vacuuming at start.",
Destination: &options.Store.Vacuum, Destination: &options.Store.Vacuum,
EnvVars: []string{"WAKUNODE2_STORE_MESSAGE_DB_VACUUM"}, EnvVars: []string{"WAKUNODE2_STORE_MESSAGE_DB_VACUUM"},
}) })

View File

@ -98,7 +98,7 @@ func Execute(options NodeOptions) {
var migrationFn func(*sql.DB) error var migrationFn func(*sql.DB) error
if requiresDB(options) && options.Store.Migration { if requiresDB(options) && options.Store.Migration {
dbSettings := dbutils.DBSettings{ dbSettings := dbutils.DBSettings{
SQLiteVacuum: options.Store.Vacuum, Vacuum: options.Store.Vacuum,
} }
db, migrationFn, err = dbutils.ExtractDBAndMigration(options.Store.DatabaseURL, dbSettings, logger) db, migrationFn, err = dbutils.ExtractDBAndMigration(options.Store.DatabaseURL, dbSettings, logger)
failOnErr(err, "Could not connect to DB") failOnErr(err, "Could not connect to DB")

View File

@ -131,7 +131,7 @@ func NewNode(configJSON string) error {
if *config.EnableStore { if *config.EnableStore {
var db *sql.DB var db *sql.DB
var migrationFn func(*sql.DB) error var migrationFn func(*sql.DB) error
db, migrationFn, err = dbutils.ExtractDBAndMigration(*config.DatabaseURL, dbutils.DBSettings{SQLiteVacuum: true}, utils.Logger()) db, migrationFn, err = dbutils.ExtractDBAndMigration(*config.DatabaseURL, dbutils.DBSettings{Vacuum: true}, utils.Logger())
if err != nil { if err != nil {
return err return err
} }

View File

@ -10,10 +10,11 @@ import (
"github.com/waku-org/go-waku/waku/persistence" "github.com/waku-org/go-waku/waku/persistence"
"github.com/waku-org/go-waku/waku/persistence/migrate" "github.com/waku-org/go-waku/waku/persistence/migrate"
"github.com/waku-org/go-waku/waku/persistence/postgres/migrations" "github.com/waku-org/go-waku/waku/persistence/postgres/migrations"
"go.uber.org/zap"
) )
// WithDB is a DBOption that lets you use a postgresql DBStore and run migrations // WithDB is a DBOption that lets you use a postgresql DBStore and run migrations
func WithDB(dburl string, migrate bool) persistence.DBOption { func WithDB(dburl string, migrate bool, shouldVacuum bool) persistence.DBOption {
return func(d *persistence.DBStore) error { return func(d *persistence.DBStore) error {
driverOption := persistence.WithDriver("pgx", dburl) driverOption := persistence.WithDriver("pgx", dburl)
err := driverOption(d) err := driverOption(d)
@ -35,13 +36,30 @@ func WithDB(dburl string, migrate bool) persistence.DBOption {
} }
} }
func executeVacuum(db *sql.DB, logger *zap.Logger) error {
logger.Info("starting PostgreSQL database vacuuming")
_, err := db.Exec("VACUUM")
if err != nil {
return err
}
logger.Info("finished PostgreSQL database vacuuming")
return nil
}
// NewDB connects to postgres DB in the specified path // NewDB connects to postgres DB in the specified path
func NewDB(dburl string) (*sql.DB, func(*sql.DB) error, error) { func NewDB(dburl string, shouldVacuum bool, logger *zap.Logger) (*sql.DB, func(*sql.DB) error, error) {
db, err := sql.Open("pgx", dburl) db, err := sql.Open("pgx", dburl)
if err != nil { if err != nil {
return nil, nil, err return nil, nil, err
} }
if shouldVacuum {
err := executeVacuum(db, logger)
if err != nil {
return nil, nil, err
}
}
return db, Migrate, nil return db, Migrate, nil
} }

View File

@ -56,6 +56,16 @@ func WithDB(dburl string, migrate bool) persistence.DBOption {
} }
} }
func executeVacuum(db *sql.DB, logger *zap.Logger) error {
logger.Info("starting sqlite database vacuuming")
_, err := db.Exec("VACUUM")
if err != nil {
return err
}
logger.Info("finished sqlite database vacuuming")
return nil
}
// NewDB creates a sqlite3 DB in the specified path // NewDB creates a sqlite3 DB in the specified path
func NewDB(dburl string, shouldVacuum bool, logger *zap.Logger) (*sql.DB, func(*sql.DB) error, error) { func NewDB(dburl string, shouldVacuum bool, logger *zap.Logger) (*sql.DB, func(*sql.DB) error, error) {
db, err := sql.Open("sqlite3", addSqliteURLDefaults(dburl)) db, err := sql.Open("sqlite3", addSqliteURLDefaults(dburl))
@ -66,17 +76,13 @@ func NewDB(dburl string, shouldVacuum bool, logger *zap.Logger) (*sql.DB, func(*
// Disable concurrent access as not supported by the driver // Disable concurrent access as not supported by the driver
db.SetMaxOpenConns(1) db.SetMaxOpenConns(1)
logger.Info("starting sqlite database vacuuming")
if shouldVacuum { if shouldVacuum {
_, err := db.Exec("VACUUM") err := executeVacuum(db, logger)
if err != nil { if err != nil {
return nil, nil, err return nil, nil, err
} }
} }
logger.Info("finished sqlite database vacuuming")
return db, Migrate, nil return db, Migrate, nil
} }

View File

@ -21,7 +21,7 @@ func validateDBUrl(val string) error {
// DBSettings hold db specific configuration settings required during the db initialization // DBSettings hold db specific configuration settings required during the db initialization
type DBSettings struct { type DBSettings struct {
SQLiteVacuum bool Vacuum bool
} }
// ExtractDBAndMigration will return a database connection, and migration function that should be used depending on a database connection string // ExtractDBAndMigration will return a database connection, and migration function that should be used depending on a database connection string
@ -49,9 +49,9 @@ func ExtractDBAndMigration(databaseURL string, dbSettings DBSettings, logger *za
dbParams := dbURLParts[1] dbParams := dbURLParts[1]
switch dbEngine { switch dbEngine {
case "sqlite3": case "sqlite3":
db, migrationFn, err = sqlite.NewDB(dbParams, dbSettings.SQLiteVacuum, logger) db, migrationFn, err = sqlite.NewDB(dbParams, dbSettings.Vacuum, logger)
case "postgresql": case "postgresql":
db, migrationFn, err = postgres.NewDB(dbURL) db, migrationFn, err = postgres.NewDB(dbURL, dbSettings.Vacuum, logger)
default: default:
err = errors.New("unsupported database engine") err = errors.New("unsupported database engine")
} }