highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-12-02 00:51:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

sqldb: separate migration execution from construction

Browse Source 
This commit separates the execution of SQL and in-code migrations
from their construction. This change is necessary because,
currently, the SQL schema is migrated during the construction
phase in the lncfg package. However, migrations are typically
executed when individual stores are constructed within the
configuration builder.
This commit is contained in:
Andras Banki-Horvath
2024-11-25 20:29:08 +01:00
parent b789fb2db3
commit 91c3e1496f
8 changed files with 137 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
sqldb/sqlite.go
View File

@@ -38,6 +38,9 @@ var (
// Make sure SqliteStore implements the MigrationExecutor interface.
_ MigrationExecutor = (*SqliteStore)(nil)
// Make sure SqliteStore implements the DB interface.
_ DB = (*SqliteStore)(nil)
)
// SqliteStore is a database store implementation that uses a sqlite backend.
@@ -49,9 +52,7 @@ type SqliteStore struct {
// NewSqliteStore attempts to open a new sqlite database based on the passed
// config.
func NewSqliteStore(cfg *SqliteConfig, dbPath string,
migrations []MigrationConfig) (*SqliteStore, error) {
func NewSqliteStore(cfg *SqliteConfig, dbPath string) (*SqliteStore, error) {
// The set of pragma options are accepted using query options. For now
// we only want to ensure that foreign key constraints are properly
// enforced.
@@ -138,17 +139,26 @@ func NewSqliteStore(cfg *SqliteConfig, dbPath string,
},
}
return s, nil
}
// GetBaseDB returns the underlying BaseDB instance for the SQLite store.
// It is a trivial helper method to comply with the sqldb.DB interface.
func (s *SqliteStore) GetBaseDB() *BaseDB {
return s.BaseDB
}
// ApplyAllMigrations applies both the SQLC and custom in-code migrations to the
// SQLite database.
func (s *SqliteStore) ApplyAllMigrations(ctx context.Context,
migrations []MigrationConfig) error {
// Execute migrations unless configured to skip them.
if !cfg.SkipMigrations {
err := ApplyMigrations(
context.Background(), s.BaseDB, s, migrations,
)
if err != nil {
return nil, err
}
if s.cfg.SkipMigrations {
return nil
}
return s, nil
return ApplyMigrations(ctx, s.BaseDB, s, migrations)
}
// ExecuteMigrations runs migrations for the sqlite database, depending on the
@@ -181,9 +191,13 @@ func NewTestSqliteDB(t *testing.T) *SqliteStore {
dbFileName := filepath.Join(t.TempDir(), "tmp.db")
sqlDB, err := NewSqliteStore(&SqliteConfig{
SkipMigrations: false,
}, dbFileName, GetMigrations())
}, dbFileName)
require.NoError(t, err)
require.NoError(t, sqlDB.ApplyAllMigrations(
context.Background(), GetMigrations()),
)
t.Cleanup(func() {
require.NoError(t, sqlDB.DB.Close())
})
@@ -204,7 +218,7 @@ func NewTestSqliteDBWithVersion(t *testing.T, version uint) *SqliteStore {
dbFileName := filepath.Join(t.TempDir(), "tmp.db")
sqlDB, err := NewSqliteStore(&SqliteConfig{
SkipMigrations: true,
}, dbFileName, nil)
}, dbFileName)
require.NoError(t, err)
err = sqlDB.ExecuteMigrations(TargetVersion(version))