diff --git a/database/sqlmigrate/msmigrate/go.mod b/database/sqlmigrate/msmigrate/go.mod new file mode 100644 index 0000000..bc3d6b4 --- /dev/null +++ b/database/sqlmigrate/msmigrate/go.mod @@ -0,0 +1,17 @@ +module github.com/therootcompany/golib/database/sqlmigrate/msmigrate + +go 1.26.1 + +require ( + github.com/microsoft/go-mssqldb v1.9.8 + github.com/therootcompany/golib/database/sqlmigrate v1.0.1 +) + +require ( + github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9 // indirect + github.com/golang-sql/sqlexp v0.1.0 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/shopspring/decimal v1.4.0 // indirect + golang.org/x/crypto v0.48.0 // indirect + golang.org/x/text v0.34.0 // indirect +) diff --git a/database/sqlmigrate/msmigrate/go.sum b/database/sqlmigrate/msmigrate/go.sum new file mode 100644 index 0000000..6e6ab03 --- /dev/null +++ b/database/sqlmigrate/msmigrate/go.sum @@ -0,0 +1,46 @@ +github.com/Azure/azure-sdk-for-go/sdk/azcore v1.21.0 h1:fou+2+WFTib47nS+nz/ozhEBnvU96bKHy6LjRsY4E28= +github.com/Azure/azure-sdk-for-go/sdk/azcore v1.21.0/go.mod h1:t76Ruy8AHvUAC8GfMWJMa0ElSbuIcO03NLpynfbgsPA= +github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.13.1 h1:Hk5QBxZQC1jb2Fwj6mpzme37xbCDdNTxU7O9eb5+LB4= +github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.13.1/go.mod h1:IYus9qsFobWIc2YVwe/WPjcnyCkPKtnHAqUYeebc8z0= +github.com/Azure/azure-sdk-for-go/sdk/internal v1.11.2 h1:9iefClla7iYpfYWdzPCRDozdmndjTm8DXdpCzPajMgA= +github.com/Azure/azure-sdk-for-go/sdk/internal v1.11.2/go.mod h1:XtLgD3ZD34DAaVIIAyG3objl5DynM3CQ/vMcbBNJZGI= +github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys v1.4.0 h1:E4MgwLBGeVB5f2MdcIVD3ELVAWpr+WD6MUe1i+tM/PA= +github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys v1.4.0/go.mod h1:Y2b/1clN4zsAoUd/pgNAQHjLDnTis/6ROkUfyob6psM= +github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.2.0 h1:nCYfgcSyHZXJI8J0IWE5MsCGlb2xp9fJiXyxWgmOFg4= +github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.2.0/go.mod h1:ucUjca2JtSZboY8IoUqyQyuuXvwbMBVwFOm0vdQPNhA= +github.com/AzureAD/microsoft-authentication-library-for-go v1.6.0 h1:XRzhVemXdgvJqCH0sFfrBUTnUJSBrBf7++ypk+twtRs= +github.com/AzureAD/microsoft-authentication-library-for-go v1.6.0/go.mod h1:HKpQxkWaGLJ+D/5H8QRpyQXA1eKjxkFlOMwck5+33Jk= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/golang-jwt/jwt/v5 v5.3.1 h1:kYf81DTWFe7t+1VvL7eS+jKFVWaUnK9cB1qbwn63YCY= +github.com/golang-jwt/jwt/v5 v5.3.1/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE= +github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9 h1:au07oEsX2xN0ktxqI+Sida1w446QrXBRJ0nee3SNZlA= +github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9/go.mod h1:8vg3r2VgvsThLBIFL93Qb5yWzgyZWhEmBwUJWevAkK0= +github.com/golang-sql/sqlexp v0.1.0 h1:ZCD6MBpcuOVfGVqsEmY5/4FtYiKz6tSyUv9LPEDei6A= +github.com/golang-sql/sqlexp v0.1.0/go.mod h1:J4ad9Vo8ZCWQ2GMrC4UCQy1JpCbwU9m3EOqtpKwwwHI= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= +github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= +github.com/microsoft/go-mssqldb v1.9.8 h1:d4IFMvF/o+HdpXUqbBfzHvn/NlFA75YGcfHUUvDFJEM= +github.com/microsoft/go-mssqldb v1.9.8/go.mod h1:eGSRSGAW4hKMy5YcAenhCDjIRm2rhqIdmmwgciMzLus= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/shopspring/decimal v1.4.0 h1:bxl37RwXBklmTi0C79JfXCEBD1cqqHt0bbgBAGFp81k= +github.com/shopspring/decimal v1.4.0/go.mod h1:gawqmDU56v4yIKSwfBSFip1HdCCXN8/+DMd9qYNcwME= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/therootcompany/golib/database/sqlmigrate v1.0.1 h1:yhQb4KSwSny1WSC1Y1Z6oHT7V1lznKuj1vzZkF6MqFo= +github.com/therootcompany/golib/database/sqlmigrate v1.0.1/go.mod h1:7PQUjwT78Hx+SftcIKI2PH4zSFlrSO0V9h618PJqC38= +golang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts= +golang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos= +golang.org/x/net v0.51.0 h1:94R/GTO7mt3/4wIKpcR5gkGmRLOuE/2hNGeWq/GBIFo= +golang.org/x/net v0.51.0/go.mod h1:aamm+2QF5ogm02fjy5Bb7CQ0WMt1/WVM7FtyaTLlA9Y= +golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k= +golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/text v0.34.0 h1:oL/Qq0Kdaqxa1KbNeMKwQq0reLCCaFtqu2eNuSeNHbk= +golang.org/x/text v0.34.0/go.mod h1:homfLqTYRFyVYemLBFl5GgL/DWEiH5wcsQ5gSh1yziA= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/database/sqlmigrate/msmigrate/msmigrate.go b/database/sqlmigrate/msmigrate/msmigrate.go new file mode 100644 index 0000000..91daaef --- /dev/null +++ b/database/sqlmigrate/msmigrate/msmigrate.go @@ -0,0 +1,84 @@ +// Package msmigrate implements sqlmigrate.Migrator for Microsoft SQL Server +// using database/sql with github.com/microsoft/go-mssqldb. +// +// db, err := sql.Open("sqlserver", "sqlserver://user:pass@host:1433?database=mydb") +package msmigrate + +import ( + "context" + "database/sql" + "errors" + "fmt" + + mssql "github.com/microsoft/go-mssqldb" + + "github.com/therootcompany/golib/database/sqlmigrate" +) + +// Migrator implements sqlmigrate.Migrator using a *sql.DB with SQL Server. +type Migrator struct { + DB *sql.DB +} + +// New creates a Migrator from the given database handle. +func New(db *sql.DB) *Migrator { + return &Migrator{DB: db} +} + +var _ sqlmigrate.Migrator = (*Migrator)(nil) + +// ExecUp runs the up migration SQL inside a transaction. +func (m *Migrator) ExecUp(ctx context.Context, mig sqlmigrate.Migration) error { + return m.execInTx(ctx, mig.Up) +} + +// ExecDown runs the down migration SQL inside a transaction. +func (m *Migrator) ExecDown(ctx context.Context, mig sqlmigrate.Migration) error { + return m.execInTx(ctx, mig.Down) +} + +func (m *Migrator) execInTx(ctx context.Context, sqlStr string) error { + tx, err := m.DB.BeginTx(ctx, nil) + if err != nil { + return fmt.Errorf("%w: begin: %w", sqlmigrate.ErrExecFailed, err) + } + defer func() { _ = tx.Rollback() }() + + if _, err := tx.ExecContext(ctx, sqlStr); err != nil { + return fmt.Errorf("%w: exec: %w", sqlmigrate.ErrExecFailed, err) + } + + if err := tx.Commit(); err != nil { + return fmt.Errorf("%w: commit: %w", sqlmigrate.ErrExecFailed, err) + } + + return nil +} + +// Applied returns all applied migrations from the _migrations table. +// Returns an empty slice if the table does not exist (SQL Server error 208). +func (m *Migrator) Applied(ctx context.Context) ([]sqlmigrate.AppliedMigration, error) { + rows, err := m.DB.QueryContext(ctx, "SELECT id, name FROM _migrations ORDER BY name") + if err != nil { + // SQL Server error 208: "Invalid object name '_migrations'" + if msErr, ok := errors.AsType[mssql.Error](err); ok && msErr.Number == 208 { + return nil, nil + } + return nil, fmt.Errorf("%w: %w", sqlmigrate.ErrQueryApplied, err) + } + defer rows.Close() + + var applied []sqlmigrate.AppliedMigration + for rows.Next() { + var a sqlmigrate.AppliedMigration + if err := rows.Scan(&a.ID, &a.Name); err != nil { + return nil, fmt.Errorf("%w: scanning row: %w", sqlmigrate.ErrQueryApplied, err) + } + applied = append(applied, a) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("%w: reading rows: %w", sqlmigrate.ErrQueryApplied, err) + } + + return applied, nil +}