From d150d85bfdd020b6ec6747bad030303aca2b7c0a Mon Sep 17 00:00:00 2001 From: greenhandatsjtu Date: Sat, 14 May 2022 15:17:38 +0800 Subject: [PATCH 1/3] Append column comments to `create table` sentence when using postgres --- client/orm/models.go | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/client/orm/models.go b/client/orm/models.go index e2acd866..11e12305 100644 --- a/client/orm/models.go +++ b/client/orm/models.go @@ -432,8 +432,9 @@ func (mc *_modelCache) getDbCreateSQL(al *alias) (queries []string, tableIndexes columns := make([]string, 0, len(mi.fields.fieldsDB)) sqlIndexes := [][]string{} + var commentIndexes []int // store comment indexes for postgres - for _, fi := range mi.fields.fieldsDB { + for i, fi := range mi.fields.fieldsDB { column := fmt.Sprintf(" %s%s%s ", Q, fi.column, Q) col := getColumnTyp(al, fi) @@ -475,7 +476,11 @@ func (mc *_modelCache) getDbCreateSQL(al *alias) (queries []string, tableIndexes } if fi.description != "" && al.Driver != DRSqlite { - column += " " + fmt.Sprintf("COMMENT '%s'", fi.description) + if al.Driver == DRPostgres { + commentIndexes = append(commentIndexes, i) + } else { + column += " " + fmt.Sprintf("COMMENT '%s'", fi.description) + } } columns = append(columns, column) @@ -515,6 +520,19 @@ func (mc *_modelCache) getDbCreateSQL(al *alias) (queries []string, tableIndexes } sql += ";" + if al.Driver == DRPostgres && len(commentIndexes) > 0 { + // append comments for postgres only + for _, index := range commentIndexes { + sql += fmt.Sprintf("\nCOMMENT ON COLUMN %s%s%s.%s%s%s is '%s';", + Q, + mi.table, + Q, + Q, + mi.fields.fieldsDB[index].column, + Q, + mi.fields.fieldsDB[index].description) + } + } queries = append(queries, sql) if mi.model != nil { From a539289b208a5dc4360fbebddf625ab05d70938e Mon Sep 17 00:00:00 2001 From: greenhandatsjtu Date: Thu, 19 May 2022 14:26:23 +0800 Subject: [PATCH 2/3] Add unit test for getDbCreateSQL() --- CHANGELOG.md | 1 + client/orm/model_test.go | 69 ++++++++++++++++++++++++++++++++++++++++ client/orm/models.go | 1 - 3 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 client/orm/model_test.go diff --git a/CHANGELOG.md b/CHANGELOG.md index 2cc19889..644a0fc5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ - [Add httplib OpenTelemetry Filter](https://github.com/beego/beego/pull/4888, https://github.com/beego/beego/pull/4915) - [Support NewBeegoRequestWithCtx in httplib](https://github.com/beego/beego/pull/4895) - [Support lifecycle callback](https://github.com/beego/beego/pull/4918) +- [Append column comments to create table sentence when using postgres](https://github.com/beego/beego/pull/4940) # v2.0.2 See v2.0.2-beta.1 diff --git a/client/orm/model_test.go b/client/orm/model_test.go new file mode 100644 index 00000000..3be5bb82 --- /dev/null +++ b/client/orm/model_test.go @@ -0,0 +1,69 @@ +// Copyright 2022 +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package orm + +import ( + "fmt" + "github.com/stretchr/testify/assert" + "testing" +) + +type ModelWithComments struct { + Id int `orm:"description(user id)"` + UserName string `orm:"size(30);unique;description(user name)"` + Email string `orm:"size(100)"` + Password string `orm:"size(100)"` +} + +func TestGetDbCreateSQLWithComment(t *testing.T) { + al := getDbAlias("default") + modelCache.clean() + RegisterModel(&ModelWithComments{}) + queries, _, _ := modelCache.getDbCreateSQL(al) + header := `-- -------------------------------------------------- +-- Table Structure for ` + fmt.Sprintf("`%s`", modelCache.allOrdered()[0].fullName) + ` +-- --------------------------------------------------` + if al.Driver == DRPostgres { + assert.Equal(t, queries, []string{header + ` +CREATE TABLE IF NOT EXISTS "model_with_comments" ( + "id" serial NOT NULL PRIMARY KEY, + "user_name" varchar(30) NOT NULL DEFAULT '' UNIQUE, + "email" varchar(100) NOT NULL DEFAULT '' , + "password" varchar(100) NOT NULL DEFAULT '' +); +COMMENT ON COLUMN "model_with_comments"."id" is 'user id'; +COMMENT ON COLUMN "model_with_comments"."user_name" is 'user name';`, + }) + } else if al.Driver == DRMySQL { + assert.Equal(t, queries, []string{header + ` +CREATE TABLE IF NOT EXISTS ` + "`model_with_comments`" + ` ( + ` + "`id`" + ` integer AUTO_INCREMENT NOT NULL PRIMARY KEY COMMENT 'user id', + ` + "`user_name`" + ` varchar(30) NOT NULL DEFAULT '' UNIQUE COMMENT 'user name', + ` + "`email`" + ` varchar(100) NOT NULL DEFAULT '' , + ` + "`password`" + ` varchar(100) NOT NULL DEFAULT '' +) ENGINE=INNODB;`, + }) + } else if al.Driver == DRSqlite { + assert.Equal(t, queries, []string{header + ` +CREATE TABLE IF NOT EXISTS ` + "`model_with_comments`" + ` ( + ` + "`id`" + ` integer NOT NULL PRIMARY KEY AUTOINCREMENT, + ` + "`user_name`" + ` varchar(30) NOT NULL DEFAULT '' UNIQUE, + ` + "`email`" + ` varchar(100) NOT NULL DEFAULT '' , + ` + "`password`" + ` varchar(100) NOT NULL DEFAULT '' +);`, + }) + } + modelCache.clean() +} diff --git a/client/orm/models.go b/client/orm/models.go index 11e12305..5f4e833c 100644 --- a/client/orm/models.go +++ b/client/orm/models.go @@ -435,7 +435,6 @@ func (mc *_modelCache) getDbCreateSQL(al *alias) (queries []string, tableIndexes var commentIndexes []int // store comment indexes for postgres for i, fi := range mi.fields.fieldsDB { - column := fmt.Sprintf(" %s%s%s ", Q, fi.column, Q) col := getColumnTyp(al, fi) From ada107b3fe7ad735c499f35c5261132efb2db6b3 Mon Sep 17 00:00:00 2001 From: greenhandatsjtu Date: Sat, 21 May 2022 19:55:33 +0800 Subject: [PATCH 3/3] refine unit tests for getDbCreateSQL --- client/orm/model_test.go | 85 ++++++++++++++++++++++------------------ 1 file changed, 47 insertions(+), 38 deletions(-) diff --git a/client/orm/model_test.go b/client/orm/model_test.go index 3be5bb82..8aee8d89 100644 --- a/client/orm/model_test.go +++ b/client/orm/model_test.go @@ -15,55 +15,64 @@ package orm import ( - "fmt" - "github.com/stretchr/testify/assert" "testing" + + "github.com/stretchr/testify/assert" ) type ModelWithComments struct { - Id int `orm:"description(user id)"` + ID int `orm:"column(id);description(user id)"` UserName string `orm:"size(30);unique;description(user name)"` + Email string `orm:"size(100);description(email)"` + Password string `orm:"size(100);description(password)"` +} + +type ModelWithoutComments struct { + ID int `orm:"column(id)"` + UserName string `orm:"size(30);unique"` Email string `orm:"size(100)"` Password string `orm:"size(100)"` } +type ModelWithEmptyComments struct { + ID int `orm:"column(id);description()"` + UserName string `orm:"size(30);unique;description()"` + Email string `orm:"size(100);description()"` + Password string `orm:"size(100);description()"` +} + func TestGetDbCreateSQLWithComment(t *testing.T) { + type TestCase struct { + name string + model interface{} + wantSQL string + wantErr error + } al := getDbAlias("default") - modelCache.clean() - RegisterModel(&ModelWithComments{}) - queries, _, _ := modelCache.getDbCreateSQL(al) - header := `-- -------------------------------------------------- --- Table Structure for ` + fmt.Sprintf("`%s`", modelCache.allOrdered()[0].fullName) + ` --- --------------------------------------------------` - if al.Driver == DRPostgres { - assert.Equal(t, queries, []string{header + ` -CREATE TABLE IF NOT EXISTS "model_with_comments" ( - "id" serial NOT NULL PRIMARY KEY, - "user_name" varchar(30) NOT NULL DEFAULT '' UNIQUE, - "email" varchar(100) NOT NULL DEFAULT '' , - "password" varchar(100) NOT NULL DEFAULT '' -); -COMMENT ON COLUMN "model_with_comments"."id" is 'user id'; -COMMENT ON COLUMN "model_with_comments"."user_name" is 'user name';`, - }) - } else if al.Driver == DRMySQL { - assert.Equal(t, queries, []string{header + ` -CREATE TABLE IF NOT EXISTS ` + "`model_with_comments`" + ` ( - ` + "`id`" + ` integer AUTO_INCREMENT NOT NULL PRIMARY KEY COMMENT 'user id', - ` + "`user_name`" + ` varchar(30) NOT NULL DEFAULT '' UNIQUE COMMENT 'user name', - ` + "`email`" + ` varchar(100) NOT NULL DEFAULT '' , - ` + "`password`" + ` varchar(100) NOT NULL DEFAULT '' -) ENGINE=INNODB;`, - }) - } else if al.Driver == DRSqlite { - assert.Equal(t, queries, []string{header + ` -CREATE TABLE IF NOT EXISTS ` + "`model_with_comments`" + ` ( - ` + "`id`" + ` integer NOT NULL PRIMARY KEY AUTOINCREMENT, - ` + "`user_name`" + ` varchar(30) NOT NULL DEFAULT '' UNIQUE, - ` + "`email`" + ` varchar(100) NOT NULL DEFAULT '' , - ` + "`password`" + ` varchar(100) NOT NULL DEFAULT '' -);`, + testModelCache := NewModelCacheHandler() + var testCases []TestCase + switch al.Driver { + case DRMySQL: + testCases = append(testCases, TestCase{name: "model with comments for MySQL", model: &ModelWithComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS `model_with_comments` (\n `id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY COMMENT 'user id',\n `user_name` varchar(30) NOT NULL DEFAULT '' UNIQUE COMMENT 'user name',\n `email` varchar(100) NOT NULL DEFAULT '' COMMENT 'email',\n `password` varchar(100) NOT NULL DEFAULT '' COMMENT 'password'\n) ENGINE=INNODB;", wantErr: nil}) + testCases = append(testCases, TestCase{name: "model without comments for MySQL", model: &ModelWithoutComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithoutComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS `model_without_comments` (\n `id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY,\n `user_name` varchar(30) NOT NULL DEFAULT '' UNIQUE,\n `email` varchar(100) NOT NULL DEFAULT '' ,\n `password` varchar(100) NOT NULL DEFAULT '' \n) ENGINE=INNODB;", wantErr: nil}) + testCases = append(testCases, TestCase{name: "model with empty comments for MySQL", model: &ModelWithEmptyComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithEmptyComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS `model_with_empty_comments` (\n `id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY,\n `user_name` varchar(30) NOT NULL DEFAULT '' UNIQUE,\n `email` varchar(100) NOT NULL DEFAULT '' ,\n `password` varchar(100) NOT NULL DEFAULT '' \n) ENGINE=INNODB;", wantErr: nil}) + case DRPostgres: + testCases = append(testCases, TestCase{name: "model with comments for Postgres", model: &ModelWithComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS \"model_with_comments\" (\n \"id\" serial NOT NULL PRIMARY KEY,\n \"user_name\" varchar(30) NOT NULL DEFAULT '' UNIQUE,\n \"email\" varchar(100) NOT NULL DEFAULT '' ,\n \"password\" varchar(100) NOT NULL DEFAULT '' \n);\nCOMMENT ON COLUMN \"model_with_comments\".\"id\" is 'user id';\nCOMMENT ON COLUMN \"model_with_comments\".\"user_name\" is 'user name';\nCOMMENT ON COLUMN \"model_with_comments\".\"email\" is 'email';\nCOMMENT ON COLUMN \"model_with_comments\".\"password\" is 'password';", wantErr: nil}) + testCases = append(testCases, TestCase{name: "model without comments for Postgres", model: &ModelWithoutComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithoutComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS \"model_without_comments\" (\n \"id\" serial NOT NULL PRIMARY KEY,\n \"user_name\" varchar(30) NOT NULL DEFAULT '' UNIQUE,\n \"email\" varchar(100) NOT NULL DEFAULT '' ,\n \"password\" varchar(100) NOT NULL DEFAULT '' \n);", wantErr: nil}) + testCases = append(testCases, TestCase{name: "model with empty comments for Postgres", model: &ModelWithEmptyComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithEmptyComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS \"model_with_empty_comments\" (\n \"id\" serial NOT NULL PRIMARY KEY,\n \"user_name\" varchar(30) NOT NULL DEFAULT '' UNIQUE,\n \"email\" varchar(100) NOT NULL DEFAULT '' ,\n \"password\" varchar(100) NOT NULL DEFAULT '' \n);", wantErr: nil}) + case DRSqlite: + testCases = append(testCases, TestCase{name: "model with comments for Sqlite", model: &ModelWithComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS `model_with_comments` (\n `id` integer NOT NULL PRIMARY KEY AUTOINCREMENT,\n `user_name` varchar(30) NOT NULL DEFAULT '' UNIQUE,\n `email` varchar(100) NOT NULL DEFAULT '' ,\n `password` varchar(100) NOT NULL DEFAULT '' \n);", wantErr: nil}) + testCases = append(testCases, TestCase{name: "model without comments for Sqlite", model: &ModelWithoutComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithoutComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS `model_without_comments` (\n `id` integer NOT NULL PRIMARY KEY AUTOINCREMENT,\n `user_name` varchar(30) NOT NULL DEFAULT '' UNIQUE,\n `email` varchar(100) NOT NULL DEFAULT '' ,\n `password` varchar(100) NOT NULL DEFAULT '' \n);", wantErr: nil}) + testCases = append(testCases, TestCase{name: "model with empty comments for Sqlite", model: &ModelWithEmptyComments{}, wantSQL: "-- --------------------------------------------------\n-- Table Structure for `github.com/beego/beego/v2/client/orm.ModelWithEmptyComments`\n-- --------------------------------------------------\nCREATE TABLE IF NOT EXISTS `model_with_empty_comments` (\n `id` integer NOT NULL PRIMARY KEY AUTOINCREMENT,\n `user_name` varchar(30) NOT NULL DEFAULT '' UNIQUE,\n `email` varchar(100) NOT NULL DEFAULT '' ,\n `password` varchar(100) NOT NULL DEFAULT '' \n);", wantErr: nil}) + } + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + testModelCache.clean() + err := testModelCache.register("", true, tc.model) + assert.NoError(t, err) + queries, _, err := testModelCache.getDbCreateSQL(al) + assert.Equal(t, tc.wantSQL, queries[0]) + assert.Equal(t, tc.wantErr, err) }) } - modelCache.clean() }