initial commit

Author: wangzuo

README.md

@@ -1 +1,89 @@
-# dbx
+# dbx
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/swiftcarrot/dbx.svg)](https://pkg.go.dev/github.com/swiftcarrot/dbx)
+[![Go Report Card](https://goreportcard.com/badge/github.com/swiftcarrot/dbx)](https://goreportcard.com/report/github.com/swiftcarrot/dbx)
+[![CI Status](https://github.com/swiftcarrot/dbx/workflows/CI/badge.svg)](https://github.com/swiftcarrot/dbx/actions)
+
+DBX is a powerful database schema migration library for Go that enables programmatic management of database schemas using Go code instead of raw SQL.
+
+## Features
+
+- **Schema-based migrations**: Define your database schema in Go code rather than raw SQL
+- **Automatic SQL generation**: Automatically generate SQL statements for schema changes
+- **Database inspection**: Introspect existing database schemas
+- **Schema comparison**: Compare schemas and generate migration statements
+- **Built on `database/sql`**: Works with standard Go database drivers
+- **Multiple dialect support**: PostgreSQL and MySQL supported, with more coming soon
+
+## Usage Examples
+
+### Database Inspection
+
+Introspect an existing database schema:
+
+```go
+import (
+	_ "github.com/lib/pq"
+	"github.com/swiftcarrot/dbx/postgresql"
+	"github.com/swiftcarrot/dbx/schema"
+)
+
+db, err := sql.Open("postgres", "postgres://")
+pg := postgresql.New()
+source, err := pg.Inspect(db)
+```
+
+### Schema Definition and Comparison
+
+Define a target schema and compare with current schema:
+
+```go
+target := schema.NewSchema()
+target.CreateTable("user", func(t *schema.Table) {
+	t.Column("name", "text", schema.NotNull)
+	t.Index("")
+})
+
+changes, err := schema.Diff(source, target)
+```
+
+### Applying Schema Changes
+
+Generate and execute SQL from schema changes:
+
+```go
+for _, change := range changes {
+	sql := pg.GenerateSQL(change)
+	_, err := db.Exec(sql)
+}
+```
+
+## Supported Dialects
+
+### PostgreSQL
+
+```go
+import (
+	_ "github.com/lib/pq"
+	"github.com/swiftcarrot/dbx/postgresql"
+)
+
+pg := postgresql.New()
+```
+
+### MySQL
+
+```go
+import (
+	_ "github.com/go-sql-driver/mysql"
+	"github.com/swiftcarrot/dbx/mysql"
+)
+
+my := mysql.New()
+```
+
+For other dialect support, feel free to [create an issue](https://github.com/swiftcarrot/dbx/issues/new).
+
+## License
+
+This project is licensed under the Apache License - see the LICENSE file for details.

go.mod

@@ -0,0 +1,23 @@
+module github.com/swiftcarrot/dbx
+
+go 1.21.9
+
+require (
+	github.com/lib/pq v1.10.9
+	github.com/urfave/cli/v2 v2.27.6
+)
+
+require (
+	filippo.io/edwards25519 v1.1.0 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.5 // indirect
+	github.com/go-sql-driver/mysql v1.9.2 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/testify v1.10.0
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,24 @@
+filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA=
+filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4=
+github.com/cpuguy83/go-md2man/v2 v2.0.5 h1:ZtcqGrnekaHpVLArFSe4HK5DoKx1T0rq2DwVB0alcyc=
+github.com/cpuguy83/go-md2man/v2 v2.0.5/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+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/go-sql-driver/mysql v1.9.2 h1:4cNKDYQ1I84SXslGddlsrMhc8k4LeDVj6Ad6WRjiHuU=
+github.com/go-sql-driver/mysql v1.9.2/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU=
+github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
+github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
+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/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/urfave/cli/v2 v2.27.6 h1:VdRdS98FNhKZ8/Az8B7MTyGQmpIr36O1EHybx/LaZ4g=
+github.com/urfave/cli/v2 v2.27.6/go.mod h1:3Sevf16NykTbInEnD0yKkjDAeZDS0A6bzhBH5hrMvTQ=
+github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4=
+github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/testutil/compare.go

@@ -0,0 +1,8 @@
+package testutil
+
+import "regexp"
+
+func FormatSQL(sql string) string {
+	re := regexp.MustCompile(`\s+`)
+	return re.ReplaceAllString(sql, " ")
+}

internal/testutil/mysql.go

@@ -0,0 +1,23 @@
+package testutil
+
+import (
+	"database/sql"
+	"log"
+
+	_ "github.com/go-sql-driver/mysql"
+)
+
+const MySQLTestConnString = "root@(localhost:3306)/dbx_test?parseTime=true&multiStatements=true"
+
+func GetMySQLTestConn() (*sql.DB, error) {
+	db, err := sql.Open("mysql", MySQLTestConnString)
+	if err != nil {
+		log.Fatal(err)
+	}
+	err = db.Ping()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	return db, err
+}

internal/testutil/postgresql.go

@@ -0,0 +1,23 @@
+package testutil
+
+import (
+	"database/sql"
+	"log"
+
+	_ "github.com/lib/pq"
+)
+
+const PGTestConnString = "postgres://postgres:postgres@localhost:5432/dbx_test?sslmode=disable"
+
+func GetPGTestConn() (*sql.DB, error) {
+	db, err := sql.Open("postgres", PGTestConnString)
+	if err != nil {
+		log.Fatal(err)
+	}
+	err = db.Ping()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	return db, err
+}

internal/testutil/schema.go

@@ -0,0 +1,77 @@
+package testutil
+
+import (
+	"github.com/swiftcarrot/dbx/schema"
+)
+
+// CreateUsersTableSchema creates a schema with a users table for testing.
+func CreateUsersTableSchema() *schema.Schema {
+	s := schema.NewSchema()
+	s.CreateTable("users", func(t *schema.Table) {
+		t.Column("id", "serial", schema.NotNull)
+		t.Column("username", "varchar(50)", schema.NotNull)
+		t.Column("email", "varchar(100)", schema.NotNull)
+		t.Column("created_at", "timestamp", schema.NotNull, schema.Default("CURRENT_TIMESTAMP"))
+		t.SetPrimaryKey("users_pkey", []string{"id"})
+		t.Index("users_email_idx", []string{"email"}, schema.Unique)
+		t.Index("users_username_idx", []string{"username"})
+	})
+	return s
+}
+
+// CreateUsersTableWithProfileSchema creates a schema with a users table that includes profile fields.
+func CreateUsersTableWithProfileSchema() *schema.Schema {
+	s := CreateUsersTableSchema()
+	table := s.Tables[0] // users table
+	table.Column("bio", "text", schema.Nullable)
+	table.Column("avatar_url", "varchar(255)", schema.Nullable)
+	return s
+}
+
+// CreateUsersAndPostsSchema creates a schema with users and posts tables.
+func CreateUsersAndPostsSchema() *schema.Schema {
+	s := CreateUsersTableSchema()
+	s.CreateTable("posts", func(t *schema.Table) {
+		t.Column("id", "serial", schema.NotNull)
+		t.Column("user_id", "integer", schema.NotNull)
+		t.Column("title", "varchar(200)", schema.NotNull)
+		t.Column("content", "text", schema.Nullable)
+		t.Column("published", "boolean", schema.NotNull, schema.Default("false"))
+		t.Column("created_at", "timestamp", schema.NotNull, schema.Default("CURRENT_TIMESTAMP"))
+		t.SetPrimaryKey("posts_pkey", []string{"id"})
+		t.Index("posts_user_id_idx", []string{"user_id"})
+		t.Index("posts_published_created_at_idx", []string{"published", "created_at"})
+		t.ForeignKey("fk_posts_user", []string{"user_id"}, "users", []string{"id"}, schema.OnDelete("CASCADE"))
+	})
+	return s
+}
+
+// CreateFullSchema creates a schema with users, posts, and comments tables.
+func CreateFullSchema() *schema.Schema {
+	s := CreateUsersAndPostsSchema()
+	s.CreateTable("comments", func(t *schema.Table) {
+		t.Column("post_id", "integer", schema.NotNull)
+		t.Column("user_id", "integer", schema.NotNull)
+		t.Column("content", "text", schema.NotNull)
+		t.Column("created_at", "timestamp", schema.NotNull, schema.Default("CURRENT_TIMESTAMP"))
+		t.SetPrimaryKey("comments_pkey", []string{"post_id", "user_id"})
+		t.ForeignKey("fk_comments_post", []string{"post_id"}, "posts", []string{"id"}, schema.OnDelete("CASCADE"))
+		t.ForeignKey("fk_comments_user", []string{"user_id"}, "users", []string{"id"}, schema.OnDelete("CASCADE"))
+	})
+	return s
+}
+
+// CreateUsersTableWithModifiedColumnSchema creates a users schema with modified columns.
+func CreateUsersTableWithModifiedColumnSchema() *schema.Schema {
+	s := schema.NewSchema()
+	s.CreateTable("users", func(t *schema.Table) {
+		t.Column("id", "serial", schema.NotNull)
+		t.Column("username", "varchar(50)", schema.Nullable) // Changed to nullable
+		t.Column("email", "varchar(255)", schema.NotNull)    // Changed length
+		t.Column("created_at", "timestamp", schema.NotNull, schema.Default("CURRENT_TIMESTAMP"))
+		t.SetPrimaryKey("users_pkey", []string{"id"})
+		t.Index("users_email_idx", []string{"email"}, schema.Unique)
+		t.Index("users_username_idx", []string{"username"})
+	})
+	return s
+}

migration/migration.go

@@ -0,0 +1,58 @@
+package migration
+
+import (
+	"time"
+
+	"github.com/swiftcarrot/dbx/schema"
+)
+
+// Migration represents a database schema migration similar to Rails migrations.
+// It includes version information, name, and methods to define schema changes.
+type Migration struct {
+	// Version represents the migration version (typically a timestamp)
+	Version string
+
+	// Name is a descriptive name for the migration
+	Name string
+
+	// CreatedAt represents when the migration was created
+	CreatedAt time.Time
+
+	// UpFn defines the schema changes for migrating up
+	UpFn func() *schema.Schema
+
+	// DownFn defines the schema changes for rolling back (migrating down)
+	DownFn func() *schema.Schema
+}
+
+// NewMigration creates a new migration with the given version and name
+func NewMigration(version, name string, upFn, downFn func() *schema.Schema) *Migration {
+	return &Migration{
+		Version:   version,
+		Name:      name,
+		CreatedAt: time.Now(),
+		UpFn:      upFn,
+		DownFn:    downFn,
+	}
+}
+
+// Up returns the schema for migrating up
+func (m *Migration) Up() *schema.Schema {
+	if m.UpFn != nil {
+		return m.UpFn()
+	}
+	return schema.NewSchema()
+}
+
+// Down returns the schema for migrating down (rolling back)
+func (m *Migration) Down() *schema.Schema {
+	if m.DownFn != nil {
+		return m.DownFn()
+	}
+	return schema.NewSchema()
+}
+
+// FullVersion returns the combined version and name (e.g., "20250504120000_create_users")
+func (m *Migration) FullVersion() string {
+	return m.Version + "_" + m.Name
+}