diff options
Diffstat (limited to 'internal')
| -rw-r--r-- | internal/db/bundb/bundb.go | 267 | ||||
| -rw-r--r-- | internal/db/bundb/driver_nopostgres.go (renamed from internal/db/bundb/drivers.go) | 13 | ||||
| -rw-r--r-- | internal/db/bundb/driver_nosqlite.go | 32 | ||||
| -rw-r--r-- | internal/db/bundb/driver_postgres.go | 167 | ||||
| -rw-r--r-- | internal/db/bundb/driver_sqlite.go | 174 |
5 files changed, 380 insertions, 273 deletions
diff --git a/internal/db/bundb/bundb.go b/internal/db/bundb/bundb.go index 39547b1ae..619ea1316 100644 --- a/internal/db/bundb/bundb.go +++ b/internal/db/bundb/bundb.go @@ -19,18 +19,10 @@ package bundb import ( "context" - "crypto/tls" - "crypto/x509" "database/sql" - "encoding/pem" - "errors" "fmt" - "math" - "net/url" - "os" "runtime" "strings" - "time" "code.superseriousbusiness.org/gotosocial/internal/config" "code.superseriousbusiness.org/gotosocial/internal/db" @@ -40,14 +32,8 @@ import ( "code.superseriousbusiness.org/gotosocial/internal/log" "code.superseriousbusiness.org/gotosocial/internal/observability" "code.superseriousbusiness.org/gotosocial/internal/state" - "codeberg.org/gruf/go-bytesize" - "github.com/google/uuid" - "github.com/jackc/pgx/v5" - "github.com/jackc/pgx/v5/stdlib" "github.com/uptrace/bun" "github.com/uptrace/bun/dialect" - "github.com/uptrace/bun/dialect/pgdialect" - "github.com/uptrace/bun/dialect/sqlitedialect" "github.com/uptrace/bun/migrate" "github.com/uptrace/bun/schema" ) @@ -355,74 +341,6 @@ func bunDB(sqldb *sql.DB, dialect func() schema.Dialect) *bun.DB { return db } -func pgConn(ctx context.Context) (*sql.DB, func() schema.Dialect, error) { - opts, err := deriveBunDBPGOptions() //nolint:contextcheck - if err != nil { - return nil, nil, fmt.Errorf("could not create bundb postgres options: %w", err) - } - - cfg := stdlib.RegisterConnConfig(opts) - - sqldb, err := sql.Open("pgx-gts", cfg) - if err != nil { - return nil, nil, fmt.Errorf("could not open postgres db: %w", err) - } - - // Tune db connections for postgres, see: - // - https://bun.uptrace.dev/guide/running-bun-in-production.html#database-sql - // - https://www.alexedwards.net/blog/configuring-sqldb - sqldb.SetMaxOpenConns(maxOpenConns()) // x number of conns per CPU - sqldb.SetMaxIdleConns(2) // assume default 2; if max idle is less than max open, it will be automatically adjusted - sqldb.SetConnMaxLifetime(5 * time.Minute) // fine to kill old connections - - // ping to check the db is there and listening - if err := sqldb.PingContext(ctx); err != nil { - return nil, nil, fmt.Errorf("postgres ping: %w", err) - } - - log.Info(ctx, "connected to POSTGRES database") - return sqldb, func() schema.Dialect { return pgdialect.New() }, nil -} - -func sqliteConn(ctx context.Context) (*sql.DB, func() schema.Dialect, error) { - // validate db address has actually been set - address := config.GetDbAddress() - if address == "" { - return nil, nil, fmt.Errorf("'%s' was not set when attempting to start sqlite", config.DbAddressFlag) - } - - // Build SQLite connection address with prefs. - address, inMem := buildSQLiteAddress(address) - - // Open new DB instance - sqldb, err := sql.Open("sqlite-gts", address) - if err != nil { - return nil, nil, fmt.Errorf("could not open sqlite db with address %s: %w", address, err) - } - - // Tune db connections for sqlite, see: - // - https://bun.uptrace.dev/guide/running-bun-in-production.html#database-sql - // - https://www.alexedwards.net/blog/configuring-sqldb - sqldb.SetMaxOpenConns(maxOpenConns()) // x number of conns per CPU - sqldb.SetMaxIdleConns(1) // only keep max 1 idle connection around - if inMem { - log.Warn(nil, "using sqlite in-memory mode; all data will be deleted when gts shuts down; this mode should only be used for debugging or running tests") - // Don't close aged connections as this may wipe the DB. - sqldb.SetConnMaxLifetime(0) - } else { - sqldb.SetConnMaxLifetime(5 * time.Minute) - } - - // ping to check the db is there and listening - if err := sqldb.PingContext(ctx); err != nil { - return nil, nil, fmt.Errorf("sqlite ping: %w", err) - } - - log.Infof(ctx, "connected to SQLITE database with address %s", address) - - return sqldb, func() schema.Dialect { return sqlitedialect.New() }, nil -} - /* HANDY STUFF */ @@ -448,188 +366,3 @@ func maxOpenConns() int { return multiplier * runtime.GOMAXPROCS(0) } - -// deriveBunDBPGOptions takes an application config and returns either a ready-to-use set of options -// with sensible defaults, or an error if it's not satisfied by the provided config. -func deriveBunDBPGOptions() (*pgx.ConnConfig, error) { - // If database URL is defined, ignore - // other DB-related configuration fields. - if url := config.GetDbPostgresConnectionString(); url != "" { - return pgx.ParseConfig(url) - } - - // these are all optional, the db adapter figures out defaults - address := config.GetDbAddress() - - // validate database - database := config.GetDbDatabase() - if database == "" { - return nil, errors.New("no database set") - } - - var tlsConfig *tls.Config - switch config.GetDbTLSMode() { - case "", "disable": - break // nothing to do - case "enable": - tlsConfig = &tls.Config{ - InsecureSkipVerify: true, //nolint:gosec - } - case "require": - tlsConfig = &tls.Config{ - InsecureSkipVerify: false, - ServerName: address, - MinVersion: tls.VersionTLS12, - } - } - - if certPath := config.GetDbTLSCACert(); tlsConfig != nil && certPath != "" { - // load the system cert pool first -- we'll append the given CA cert to this - certPool, err := x509.SystemCertPool() - if err != nil { - return nil, fmt.Errorf("error fetching system CA cert pool: %s", err) - } - - // open the file itself and make sure there's something in it - caCertBytes, err := os.ReadFile(certPath) - if err != nil { - return nil, fmt.Errorf("error opening CA certificate at %s: %s", certPath, err) - } - if len(caCertBytes) == 0 { - return nil, fmt.Errorf("ca cert at %s was empty", certPath) - } - - // make sure we have a PEM block - caPem, _ := pem.Decode(caCertBytes) - if caPem == nil { - return nil, fmt.Errorf("could not parse cert at %s into PEM", certPath) - } - - // parse the PEM block into the certificate - caCert, err := x509.ParseCertificate(caPem.Bytes) - if err != nil { - return nil, fmt.Errorf("could not parse cert at %s into x509 certificate: %w", certPath, err) - } - - // we're happy, add it to the existing pool and then use this pool in our tls config - certPool.AddCert(caCert) - tlsConfig.RootCAs = certPool - } - - cfg, _ := pgx.ParseConfig("") - if address != "" { - cfg.Host = address - } - if port := config.GetDbPort(); port > 0 { - if port > math.MaxUint16 { - return nil, errors.New("invalid port, must be in range 1-65535") - } - cfg.Port = uint16(port) // #nosec G115 -- Just validated above. - } - if u := config.GetDbUser(); u != "" { - cfg.User = u - } - if p := config.GetDbPassword(); p != "" { - cfg.Password = p - } - if tlsConfig != nil { - cfg.TLSConfig = tlsConfig - } - cfg.Database = database - cfg.RuntimeParams["application_name"] = config.GetApplicationName() - - return cfg, nil -} - -// buildSQLiteAddress will build an SQLite address string from given config input, -// appending user defined SQLite connection preferences (e.g. cache_size, journal_mode etc). -// The returned bool indicates whether this is an in-memory address or not. -func buildSQLiteAddress(addr string) (string, bool) { - // Notes on SQLite preferences: - // - // - SQLite by itself supports setting a subset of its configuration options - // via URI query arguments in the connection. Namely `mode` and `cache`. - // This is the same situation for our supported SQLite implementations. - // - // - Both implementations have a "shim" around them in the form of a - // `database/sql/driver.Driver{}` implementation. - // - // - The SQLite shims we interface with add support for setting ANY of the - // configuration options via query arguments, through using a special `_pragma` - // query key that specifies SQLite PRAGMAs to set upon opening each connection. - // As such you will see below that most config is set with the `_pragma` key. - // - // - As for why we're setting these PRAGMAs by connection string instead of - // directly executing the PRAGMAs ourselves? That's to ensure that all of - // configuration options are set across _all_ of our SQLite connections, given - // that we are a multi-threaded (not directly in a C way) application and that - // each connection is a separate SQLite instance opening the same database. - // And the `database/sql` package provides transparent connection pooling. - // Some data is shared between connections, for example the `journal_mode` - // as that is set in a bit of the file header, but to be sure with the other - // settings we just add them all to the connection URI string. - // - // - We specifically set the `busy_timeout` PRAGMA before the `journal_mode`. - // When Write-Ahead-Logging (WAL) is enabled, in order to handle the issues - // that may arise between separate concurrent read/write threads racing for - // the same database file (and write-ahead log), SQLite will sometimes return - // an `SQLITE_BUSY` error code, which indicates that the query was aborted - // due to a data race and must be retried. The `busy_timeout` PRAGMA configures - // a function handler that SQLite can use internally to handle these data races, - // in that it will attempt to retry the query until the `busy_timeout` time is - // reached. And for whatever reason (:shrug:) SQLite is very particular about - // setting this BEFORE the `journal_mode` is set, otherwise you can end up - // running into more of these `SQLITE_BUSY` return codes than you might expect. - - // Drop anything fancy from DB address - addr = strings.Split(addr, "?")[0] // drop any provided query strings - addr = strings.TrimPrefix(addr, "file:") // we'll prepend this later ourselves - - // build our own SQLite preferences - // as a series of URL encoded values - prefs := make(url.Values) - - // use immediate transaction lock mode to fail quickly if tx can't lock - // see https://pkg.go.dev/modernc.org/sqlite#Driver.Open - prefs.Add("_txlock", "immediate") - - inMem := false - if addr == ":memory:" { - // Use random name for in-memory instead of ':memory:', so - // multiple in-mem databases can be created without conflict. - inMem = true - addr = "/" + uuid.NewString() - prefs.Add("vfs", "memdb") - } - - if dur := config.GetDbSqliteBusyTimeout(); dur > 0 { - // Set the user provided SQLite busy timeout - // NOTE: MUST BE SET BEFORE THE JOURNAL MODE. - prefs.Add("_pragma", fmt.Sprintf("busy_timeout(%d)", dur.Milliseconds())) - } - - if mode := config.GetDbSqliteJournalMode(); mode != "" { - // Set the user provided SQLite journal mode. - prefs.Add("_pragma", fmt.Sprintf("journal_mode(%s)", mode)) - } - - if mode := config.GetDbSqliteSynchronous(); mode != "" { - // Set the user provided SQLite synchronous mode. - prefs.Add("_pragma", fmt.Sprintf("synchronous(%s)", mode)) - } - - if sz := config.GetDbSqliteCacheSize(); sz > 0 { - // Set the user provided SQLite cache size (in kibibytes) - // Prepend a '-' character to this to indicate to sqlite - // that we're giving kibibytes rather than num pages. - // https://www.sqlite.org/pragma.html#pragma_cache_size - prefs.Add("_pragma", fmt.Sprintf("cache_size(-%d)", uint64(sz/bytesize.KiB))) - } - - var b strings.Builder - b.WriteString("file:") - b.WriteString(addr) - b.WriteString("?") - b.WriteString(prefs.Encode()) - return b.String(), inMem -} diff --git a/internal/db/bundb/drivers.go b/internal/db/bundb/driver_nopostgres.go index e4f60ff6c..8b20d9fa0 100644 --- a/internal/db/bundb/drivers.go +++ b/internal/db/bundb/driver_nopostgres.go @@ -15,17 +15,18 @@ // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. +//go:build nopostgres + package bundb import ( + "context" "database/sql" + "errors" - "code.superseriousbusiness.org/gotosocial/internal/db/postgres" - "code.superseriousbusiness.org/gotosocial/internal/db/sqlite" + "github.com/uptrace/bun/schema" ) -func init() { - // register our SQL driver implementations. - sql.Register("pgx-gts", &postgres.Driver{}) - sql.Register("sqlite-gts", &sqlite.Driver{}) +func pgConn(ctx context.Context) (*sql.DB, func() schema.Dialect, error) { + return nil, nil, errors.New("gotosocial was compiled without postgres support") } diff --git a/internal/db/bundb/driver_nosqlite.go b/internal/db/bundb/driver_nosqlite.go new file mode 100644 index 000000000..fc8cddbbf --- /dev/null +++ b/internal/db/bundb/driver_nosqlite.go @@ -0,0 +1,32 @@ +// GoToSocial +// Copyright (C) GoToSocial Authors admin@gotosocial.org +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see <http://www.gnu.org/licenses/>. + +//go:build nosqlite + +package bundb + +import ( + "context" + "database/sql" + "errors" + + "github.com/uptrace/bun/schema" +) + +func sqliteConn(ctx context.Context) (*sql.DB, func() schema.Dialect, error) { + return nil, nil, errors.New("gotosocial was compiled without sqlite support") +} diff --git a/internal/db/bundb/driver_postgres.go b/internal/db/bundb/driver_postgres.go new file mode 100644 index 000000000..b16fb798e --- /dev/null +++ b/internal/db/bundb/driver_postgres.go @@ -0,0 +1,167 @@ +// GoToSocial +// Copyright (C) GoToSocial Authors admin@gotosocial.org +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see <http://www.gnu.org/licenses/>. + +//go:build !nopostgres + +package bundb + +import ( + "context" + "crypto/tls" + "crypto/x509" + "database/sql" + "encoding/pem" + "errors" + "fmt" + "math" + "os" + "time" + + "code.superseriousbusiness.org/gotosocial/internal/config" + "code.superseriousbusiness.org/gotosocial/internal/db/postgres" + "code.superseriousbusiness.org/gotosocial/internal/log" + "github.com/jackc/pgx/v5" + "github.com/jackc/pgx/v5/stdlib" + "github.com/uptrace/bun/dialect/pgdialect" + "github.com/uptrace/bun/schema" +) + +func init() { + // register our SQL driver implementations. + sql.Register("pgx-gts", &postgres.Driver{}) +} + +func pgConn(ctx context.Context) (*sql.DB, func() schema.Dialect, error) { + opts, err := deriveBunDBPGOptions() //nolint:contextcheck + if err != nil { + return nil, nil, fmt.Errorf("could not create bundb postgres options: %w", err) + } + + cfg := stdlib.RegisterConnConfig(opts) + + sqldb, err := sql.Open("pgx-gts", cfg) + if err != nil { + return nil, nil, fmt.Errorf("could not open postgres db: %w", err) + } + + // Tune db connections for postgres, see: + // - https://bun.uptrace.dev/guide/running-bun-in-production.html#database-sql + // - https://www.alexedwards.net/blog/configuring-sqldb + sqldb.SetMaxOpenConns(maxOpenConns()) // x number of conns per CPU + sqldb.SetMaxIdleConns(2) // assume default 2; if max idle is less than max open, it will be automatically adjusted + sqldb.SetConnMaxLifetime(5 * time.Minute) // fine to kill old connections + + // ping to check the db is there and listening + if err := sqldb.PingContext(ctx); err != nil { + return nil, nil, fmt.Errorf("postgres ping: %w", err) + } + + log.Info(ctx, "connected to POSTGRES database") + return sqldb, func() schema.Dialect { return pgdialect.New() }, nil +} + +// deriveBunDBPGOptions takes an application config and returns either a ready-to-use set of options +// with sensible defaults, or an error if it's not satisfied by the provided config. +func deriveBunDBPGOptions() (*pgx.ConnConfig, error) { + // If database URL is defined, ignore + // other DB-related configuration fields. + if url := config.GetDbPostgresConnectionString(); url != "" { + return pgx.ParseConfig(url) + } + + // these are all optional, the db adapter figures out defaults + address := config.GetDbAddress() + + // validate database + database := config.GetDbDatabase() + if database == "" { + return nil, errors.New("no database set") + } + + var tlsConfig *tls.Config + switch config.GetDbTLSMode() { + case "", "disable": + break // nothing to do + case "enable": + tlsConfig = &tls.Config{ + InsecureSkipVerify: true, //nolint:gosec + } + case "require": + tlsConfig = &tls.Config{ + InsecureSkipVerify: false, + ServerName: address, + MinVersion: tls.VersionTLS12, + } + } + + if certPath := config.GetDbTLSCACert(); tlsConfig != nil && certPath != "" { + // load the system cert pool first -- we'll append the given CA cert to this + certPool, err := x509.SystemCertPool() + if err != nil { + return nil, fmt.Errorf("error fetching system CA cert pool: %s", err) + } + + // open the file itself and make sure there's something in it + caCertBytes, err := os.ReadFile(certPath) + if err != nil { + return nil, fmt.Errorf("error opening CA certificate at %s: %s", certPath, err) + } + if len(caCertBytes) == 0 { + return nil, fmt.Errorf("ca cert at %s was empty", certPath) + } + + // make sure we have a PEM block + caPem, _ := pem.Decode(caCertBytes) + if caPem == nil { + return nil, fmt.Errorf("could not parse cert at %s into PEM", certPath) + } + + // parse the PEM block into the certificate + caCert, err := x509.ParseCertificate(caPem.Bytes) + if err != nil { + return nil, fmt.Errorf("could not parse cert at %s into x509 certificate: %w", certPath, err) + } + + // we're happy, add it to the existing pool and then use this pool in our tls config + certPool.AddCert(caCert) + tlsConfig.RootCAs = certPool + } + + cfg, _ := pgx.ParseConfig("") + if address != "" { + cfg.Host = address + } + if port := config.GetDbPort(); port > 0 { + if port > math.MaxUint16 { + return nil, errors.New("invalid port, must be in range 1-65535") + } + cfg.Port = uint16(port) // #nosec G115 -- Just validated above. + } + if u := config.GetDbUser(); u != "" { + cfg.User = u + } + if p := config.GetDbPassword(); p != "" { + cfg.Password = p + } + if tlsConfig != nil { + cfg.TLSConfig = tlsConfig + } + cfg.Database = database + cfg.RuntimeParams["application_name"] = config.GetApplicationName() + + return cfg, nil +} diff --git a/internal/db/bundb/driver_sqlite.go b/internal/db/bundb/driver_sqlite.go new file mode 100644 index 000000000..6dc882361 --- /dev/null +++ b/internal/db/bundb/driver_sqlite.go @@ -0,0 +1,174 @@ +// GoToSocial +// Copyright (C) GoToSocial Authors admin@gotosocial.org +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see <http://www.gnu.org/licenses/>. + +//go:build !nosqlite + +package bundb + +import ( + "context" + "database/sql" + "fmt" + "net/url" + "strings" + "time" + + "code.superseriousbusiness.org/gotosocial/internal/config" + "code.superseriousbusiness.org/gotosocial/internal/db/sqlite" + "code.superseriousbusiness.org/gotosocial/internal/log" + "codeberg.org/gruf/go-bytesize" + "github.com/google/uuid" + "github.com/uptrace/bun/dialect/sqlitedialect" + "github.com/uptrace/bun/schema" +) + +func init() { + // register our SQL driver implementations. + sql.Register("sqlite-gts", &sqlite.Driver{}) +} + +func sqliteConn(ctx context.Context) (*sql.DB, func() schema.Dialect, error) { + // validate db address has actually been set + address := config.GetDbAddress() + if address == "" { + return nil, nil, fmt.Errorf("'%s' was not set when attempting to start sqlite", config.DbAddressFlag) + } + + // Build SQLite connection address with prefs. + address, inMem := buildSQLiteAddress(address) + + // Open new DB instance + sqldb, err := sql.Open("sqlite-gts", address) + if err != nil { + return nil, nil, fmt.Errorf("could not open sqlite db with address %s: %w", address, err) + } + + // Tune db connections for sqlite, see: + // - https://bun.uptrace.dev/guide/running-bun-in-production.html#database-sql + // - https://www.alexedwards.net/blog/configuring-sqldb + sqldb.SetMaxOpenConns(maxOpenConns()) // x number of conns per CPU + sqldb.SetMaxIdleConns(1) // only keep max 1 idle connection around + if inMem { + log.Warn(nil, "using sqlite in-memory mode; all data will be deleted when gts shuts down; this mode should only be used for debugging or running tests") + // Don't close aged connections as this may wipe the DB. + sqldb.SetConnMaxLifetime(0) + } else { + sqldb.SetConnMaxLifetime(5 * time.Minute) + } + + // ping to check the db is there and listening + if err := sqldb.PingContext(ctx); err != nil { + return nil, nil, fmt.Errorf("sqlite ping: %w", err) + } + + log.Infof(ctx, "connected to SQLITE database with address %s", address) + + return sqldb, func() schema.Dialect { return sqlitedialect.New() }, nil +} + +// buildSQLiteAddress will build an SQLite address string from given config input, +// appending user defined SQLite connection preferences (e.g. cache_size, journal_mode etc). +// The returned bool indicates whether this is an in-memory address or not. +func buildSQLiteAddress(addr string) (string, bool) { + // Notes on SQLite preferences: + // + // - SQLite by itself supports setting a subset of its configuration options + // via URI query arguments in the connection. Namely `mode` and `cache`. + // This is the same situation for our supported SQLite implementations. + // + // - Both implementations have a "shim" around them in the form of a + // `database/sql/driver.Driver{}` implementation. + // + // - The SQLite shims we interface with add support for setting ANY of the + // configuration options via query arguments, through using a special `_pragma` + // query key that specifies SQLite PRAGMAs to set upon opening each connection. + // As such you will see below that most config is set with the `_pragma` key. + // + // - As for why we're setting these PRAGMAs by connection string instead of + // directly executing the PRAGMAs ourselves? That's to ensure that all of + // configuration options are set across _all_ of our SQLite connections, given + // that we are a multi-threaded (not directly in a C way) application and that + // each connection is a separate SQLite instance opening the same database. + // And the `database/sql` package provides transparent connection pooling. + // Some data is shared between connections, for example the `journal_mode` + // as that is set in a bit of the file header, but to be sure with the other + // settings we just add them all to the connection URI string. + // + // - We specifically set the `busy_timeout` PRAGMA before the `journal_mode`. + // When Write-Ahead-Logging (WAL) is enabled, in order to handle the issues + // that may arise between separate concurrent read/write threads racing for + // the same database file (and write-ahead log), SQLite will sometimes return + // an `SQLITE_BUSY` error code, which indicates that the query was aborted + // due to a data race and must be retried. The `busy_timeout` PRAGMA configures + // a function handler that SQLite can use internally to handle these data races, + // in that it will attempt to retry the query until the `busy_timeout` time is + // reached. And for whatever reason (:shrug:) SQLite is very particular about + // setting this BEFORE the `journal_mode` is set, otherwise you can end up + // running into more of these `SQLITE_BUSY` return codes than you might expect. + + // Drop anything fancy from DB address + addr = strings.Split(addr, "?")[0] // drop any provided query strings + addr = strings.TrimPrefix(addr, "file:") // we'll prepend this later ourselves + + // build our own SQLite preferences + // as a series of URL encoded values + prefs := make(url.Values) + + // use immediate transaction lock mode to fail quickly if tx can't lock + // see https://pkg.go.dev/modernc.org/sqlite#Driver.Open + prefs.Add("_txlock", "immediate") + + inMem := false + if addr == ":memory:" { + // Use random name for in-memory instead of ':memory:', so + // multiple in-mem databases can be created without conflict. + inMem = true + addr = "/" + uuid.NewString() + prefs.Add("vfs", "memdb") + } + + if dur := config.GetDbSqliteBusyTimeout(); dur > 0 { + // Set the user provided SQLite busy timeout + // NOTE: MUST BE SET BEFORE THE JOURNAL MODE. + prefs.Add("_pragma", fmt.Sprintf("busy_timeout(%d)", dur.Milliseconds())) + } + + if mode := config.GetDbSqliteJournalMode(); mode != "" { + // Set the user provided SQLite journal mode. + prefs.Add("_pragma", fmt.Sprintf("journal_mode(%s)", mode)) + } + + if mode := config.GetDbSqliteSynchronous(); mode != "" { + // Set the user provided SQLite synchronous mode. + prefs.Add("_pragma", fmt.Sprintf("synchronous(%s)", mode)) + } + + if sz := config.GetDbSqliteCacheSize(); sz > 0 { + // Set the user provided SQLite cache size (in kibibytes) + // Prepend a '-' character to this to indicate to sqlite + // that we're giving kibibytes rather than num pages. + // https://www.sqlite.org/pragma.html#pragma_cache_size + prefs.Add("_pragma", fmt.Sprintf("cache_size(-%d)", uint64(sz/bytesize.KiB))) + } + + var b strings.Builder + b.WriteString("file:") + b.WriteString(addr) + b.WriteString("?") + b.WriteString(prefs.Encode()) + return b.String(), inMem +} |