Update mds examples

Author: DanielLiu1123

examples/mds/README.md

@@ -3,6 +3,13 @@ mds means MyBatis Dynamic SQL.
 
 ## Run
 
+start databases:
+
+```shell
+cd e2e/mds
+bash db.sh
+```
+
 ```shell
 cd e2e/mds
 go run ../../cmd/gencoder/main.go generate

examples/mds/db.sh

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+
+# create MySQL
+docker rm -f test_mysql && docker run --name test_mysql -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=testdb -p 3306:3306 -p 33060:33060 -id mysql:latest && sleep 10 && docker exec -i test_mysql mysql -uroot -proot -e "\
+    CREATE TABLE testdb.user ( \
+        id INT AUTO_INCREMENT PRIMARY KEY, \
+        username VARCHAR(64) NOT NULL COMMENT 'Username, required', \
+        password VARCHAR(128) NOT NULL, \
+        email VARCHAR(128) NOT NULL DEFAULT '' COMMENT 'User email, required', \
+        first_name VARCHAR(64) COMMENT 'First name of the user', \
+        last_name VARCHAR(64) COMMENT 'Last name of the user', \
+        created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP COMMENT 'Record creation timestamp', \
+        updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'Record update timestamp', \
+        status ENUM('active', 'inactive', 'suspended') DEFAULT 'active' COMMENT 'Account status', \
+        INDEX idx_name (username), \
+        UNIQUE INDEX idx_email (email), \
+        INDEX idx_status_created (status, created_at), \
+        INDEX idx_full_name (first_name, last_name) \
+    ) COMMENT='User account information';"
+
+# create PostgreSQL
+docker rm -f test_postgres && docker run --name test_postgres -e POSTGRES_USER=root -e POSTGRES_PASSWORD=root -e POSTGRES_DB=testdb -p 5432:5432 -id postgres:latest && sleep 5 && docker exec -i test_postgres psql -U root -d testdb -c "\
+    CREATE TABLE \"user\" ( \
+        id SERIAL PRIMARY KEY, \
+        username VARCHAR(64) NOT NULL, \
+        password VARCHAR(128) NOT NULL, \
+        email VARCHAR(128) NOT NULL DEFAULT '', \
+        first_name VARCHAR(64), \
+        last_name VARCHAR(64), \
+        created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, \
+        updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, \
+        status VARCHAR(9) DEFAULT 'active' CHECK (status IN ('active', 'inactive', 'suspended')), \
+        CONSTRAINT unique_email UNIQUE (email) \
+    ); \
+    CREATE INDEX idx_name ON \"user\" (username); \
+    CREATE INDEX idx_status_created ON \"user\" (status, created_at); \
+    CREATE INDEX idx_full_name ON \"user\" (first_name, last_name); \
+    COMMENT ON COLUMN \"user\".username IS 'Username, required'; \
+    COMMENT ON COLUMN \"user\".email IS 'User email, required'; \
+    COMMENT ON COLUMN \"user\".first_name IS 'First name of the user'; \
+    COMMENT ON COLUMN \"user\".last_name IS 'Last name of the user'; \
+    COMMENT ON COLUMN \"user\".created_at IS 'Record creation timestamp'; \
+    COMMENT ON COLUMN \"user\".updated_at IS 'Record update timestamp'; \
+    COMMENT ON COLUMN \"user\".status IS 'Account status'; \
+    COMMENT ON TABLE \"user\" IS 'User account information';"
+
+# create MSSQL
+docker rm -f test_sqlserver && \
+docker run --name test_sqlserver -e ACCEPT_EULA=Y -e MSSQL_SA_PASSWORD=Sa123456.. -p 1433:1433 -id mcr.microsoft.com/mssql/server:2022-latest && sleep 10 && \
+docker exec -i test_sqlserver /opt/mssql-tools18/bin/sqlcmd -S localhost -U sa -P 'Sa123456..' -No -Q "CREATE DATABASE testdb;" && \
+docker exec -i test_sqlserver /opt/mssql-tools18/bin/sqlcmd -S localhost -U sa -P 'Sa123456..' -No -d 'testdb' -Q "\
+    CREATE TABLE [user] (
+		id         INT IDENTITY (1,1) PRIMARY KEY,
+		username   NVARCHAR(64)  NOT NULL,
+		password   NVARCHAR(128) NOT NULL,
+		email      NVARCHAR(128) NOT NULL DEFAULT '',
+		first_name NVARCHAR(64),
+		last_name  NVARCHAR(64),
+		created_at DATETIME               DEFAULT CURRENT_TIMESTAMP,
+		updated_at DATETIME               DEFAULT CURRENT_TIMESTAMP,
+		status     NVARCHAR(9)            DEFAULT 'active' CHECK (status IN ('active', 'inactive', 'suspended')),
+		deleted_at DATETIME      NULL,
+		CONSTRAINT unique_email UNIQUE (email)
+	); \
+    CREATE INDEX idx_name ON [user] (username); \
+    CREATE INDEX idx_status_created ON [user] (status, created_at); \
+    CREATE INDEX idx_full_name ON [user] (first_name, last_name); \
+    EXEC sp_addextendedproperty @name = N'MS_Description', @value = N'User account information', @level0type = N'SCHEMA', @level0name = 'dbo', @level1type = N'TABLE', @level1name = 'user'; \
+    EXEC sp_addextendedproperty @name = N'MS_Description', @value = N'Username, required', @level0type = N'SCHEMA', @level0name = 'dbo', @level1type = N'TABLE', @level1name = 'user', @level2type = N'COLUMN', @level2name = 'username'; \
+    EXEC sp_addextendedproperty @name = N'MS_Description', @value = N'User email, required', @level0type = N'SCHEMA', @level0name = 'dbo', @level1type = N'TABLE', @level1name = 'user', @level2type = N'COLUMN', @level2name = 'email'; \
+    EXEC sp_addextendedproperty @name = N'MS_Description', @value = N'First name of the user', @level0type = N'SCHEMA', @level0name = 'dbo', @level1type = N'TABLE', @level1name = 'user', @level2type = N'COLUMN', @level2name = 'first_name'; \
+    EXEC sp_addextendedproperty @name = N'MS_Description', @value = N'Last name of the user', @level0type = N'SCHEMA', @level0name = 'dbo', @level1type = N'TABLE', @level1name = 'user', @level2type = N'COLUMN', @level2name = 'last_name'; \
+    EXEC sp_addextendedproperty @name = N'MS_Description', @value = N'Record creation timestamp', @level0type = N'SCHEMA', @level0name = 'dbo', @level1type = N'TABLE', @level1name = 'user', @level2type = N'COLUMN', @level2name = 'created_at'; \
+    EXEC sp_addextendedproperty @name = N'MS_Description', @value = N'Record update timestamp', @level0type = N'SCHEMA', @level0name = 'dbo', @level1type = N'TABLE', @level1name = 'user', @level2type = N'COLUMN', @level2name = 'updated_at'; \
+    EXEC sp_addextendedproperty @name = N'MS_Description', @value = N'Account status', @level0type = N'SCHEMA', @level0name = 'dbo', @level1type = N'TABLE', @level1name = 'user', @level2type = N'COLUMN', @level2name = 'status';"

examples/mds/gencoder.yaml

@@ -25,3 +25,14 @@ databases:
       - name: 'user'
         ignoreColumns:
           - deleted_at
+  - name: mssql
+    dsn: 'mssql://sa:Sa123456..@localhost:1433/testdb?encrypt=disable'
+    schema: dbo
+    properties:
+      entityPkg: com.example.entity.mssql
+      mapperPkg: com.example.mapper.mssql
+      dynamicSQLPkg: com.example.mapper.mssql
+    tables:
+      - name: 'user'
+        ignoreColumns:
+          - deleted_at

pkg/db/mssql_test.go

@@ -21,7 +21,7 @@ func TestGenMssqlTable(t *testing.T) {
 
 	ctx := context.Background()
 	mssqlContainer, err := mssql.Run(ctx,
-		"mcr.microsoft.com/mssql/server:latest",
+		"mcr.microsoft.com/mssql/server:2022-latest",
 		mssql.WithAcceptEULA(),
 		mssql.WithPassword("Sa123456.."),
 	)

pkg/util/util.go

@@ -218,11 +218,14 @@ func getSchema(tbCfg *model.TableConfig, dbCfg *model.DatabaseConfig, u *dburl.U
 	if u.Driver == "mysql" {
 		arr := strings.Split(u.Path, "/")
 		if len(arr) > 1 {
-			return arr[1]
+			return arr[1] // database name as schema in MySQL
 		}
 	}
 	if u.Driver == "postgres" {
-		return "public"
+		return "public" // default schema in PostgreSQL
+	}
+	if u.Driver == "sqlserver" {
+		return "dbo" // default schema in SQL Server
 	}
 	return ""
 }
@@ -233,6 +236,8 @@ func generateTable(conn *sql.DB, driver, schema string, tbCfg *model.TableConfig
 		return db.GenMySQLTable(context.Background(), conn, schema, tbCfg.Name, tbCfg.IgnoreColumns)
 	case "postgres":
 		return db.GenPostgresTable(context.Background(), conn, schema, tbCfg.Name, tbCfg.IgnoreColumns)
+	case "sqlserver":
+		return db.GenMssqlTable(context.Background(), conn, schema, tbCfg.Name, tbCfg.IgnoreColumns)
 	default:
 		return nil, fmt.Errorf("unsupported driver: %s", driver)
 	}

pkg/util/util_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"github.com/DanielLiu1123/gencoder/pkg/model"
+	_ "github.com/go-sql-driver/mysql"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/testcontainers/testcontainers-go/modules/mysql"
@@ -12,8 +13,6 @@ import (
 	"os/exec"
 	"path/filepath"
 	"testing"
-
-	_ "github.com/go-sql-driver/mysql"
 )
 
 func TestReadConfig(t *testing.T) {
@@ -151,3 +150,78 @@ func TestCollectRenderContexts(t *testing.T) {
 	assert.Equal(t, "v01", contexts[0].Properties["k1"])
 	assert.Equal(t, "v2", contexts[0].Properties["k2"])
 }
+
+func Test_getSchema_whenDBUsingMySQL(t *testing.T) {
+	d := &model.DatabaseConfig{
+		Name:       "mysql",
+		Dsn:        "mysql://user:password@localhost:3306/dbname",
+		Properties: map[string]string{},
+		Tables: []*model.TableConfig{
+			{
+				Name: "user1",
+			},
+			{
+				Schema: "schema1",
+				Name:   "user2",
+			},
+		},
+	}
+	u, err := dburl.Parse(d.Dsn)
+	require.NoError(t, err)
+
+	schema := getSchema(d.Tables[0], d, u)
+	assert.Equal(t, "dbname", schema) // MySQL uses the database name as the schema.
+
+	schema = getSchema(d.Tables[1], d, u)
+	assert.Equal(t, "schema1", schema)
+}
+
+func Test_getSchema_whenDBUsingPostgres(t *testing.T) {
+	d := &model.DatabaseConfig{
+		Name:       "postgres",
+		Dsn:        "postgres://user:password@localhost:5432/dbname",
+		Properties: map[string]string{},
+		Tables: []*model.TableConfig{
+			{
+				Name: "user1",
+			},
+			{
+				Schema: "schema1",
+				Name:   "user2",
+			},
+		},
+	}
+	u, err := dburl.Parse(d.Dsn)
+	require.NoError(t, err)
+
+	schema := getSchema(d.Tables[0], d, u)
+	assert.Equal(t, "public", schema) // Default schema in PostgreSQL is "public" if not specified.
+
+	schema = getSchema(d.Tables[1], d, u)
+	assert.Equal(t, "schema1", schema)
+}
+
+func Test_getSchema_whenDBUsingMSSQL(t *testing.T) {
+	d := &model.DatabaseConfig{
+		Name:       "mssql",
+		Dsn:        "mssql://user:password@localhost:1433/dbname",
+		Properties: map[string]string{},
+		Tables: []*model.TableConfig{
+			{
+				Name: "user1",
+			},
+			{
+				Schema: "schema1",
+				Name:   "user2",
+			},
+		},
+	}
+	u, err := dburl.Parse(d.Dsn)
+	require.NoError(t, err)
+
+	schema := getSchema(d.Tables[0], d, u)
+	assert.Equal(t, "dbo", schema) // Default schema in MSSQL is "dbo" if not specified.
+
+	schema = getSchema(d.Tables[1], d, u)
+	assert.Equal(t, "schema1", schema)
+}