xorm/xorm
xorm/xorm
61
364
Fork 214
Code Issues 387 Pull Requests 19 Actions Releases 35 Activity

add table & column comment for postgres（add table comment for mysql） #2067

Merged
lunny merged 12 commits from fanybook/xorm:master into master 2021-11-12 12:58:06 +00:00
Conversation 10 Commits 12 Files Changed 7 +148 -8
fanybook commented 2021-11-04 06:38:28 +00:00
Contributor
Copy Link

让 postgres 支持字段注释，只在 v1.2.5 上测试过（不知道怎么 import master）

发现 master 分支好像大改了？模式表名带 schema 了

使用方式和 mysql 相同

	type User struct {
		Id int64	`xorm:"pk autoincr"`
		Name string `json:"name" xorm:"not null default '' varchar(50) index(name_age) comment('用户 (it''s) 1; 名')"`
		Salt string
		Age int		`json:"age" xorm:"not null default 0 int(10) index(name_age) comment('年龄')"`
		Passwd string `xorm:"varchar(200)"`
		CreatedAt time.Time `xorm:"created"`
		UpdatedAt time.Time `xorm:"updated"`
	}

	_ = engine.Sync(new(User))
    
    
    func (model User) TableComment() string {
    	return "表注释"
    }
让 postgres 支持字段注释，只在 v1.2.5 上测试过（不知道怎么 import master） 发现 master 分支好像大改了？模式表名带 schema 了 使用方式和 mysql 相同 ```go type User struct { Id int64 `xorm:"pk autoincr"` Name string `json:"name" xorm:"not null default '' varchar(50) index(name_age) comment('用户 (it''s) 1; 名')"` Salt string Age int `json:"age" xorm:"not null default 0 int(10) index(name_age) comment('年龄')"` Passwd string `xorm:"varchar(200)"` CreatedAt time.Time `xorm:"created"` UpdatedAt time.Time `xorm:"updated"` } _ = engine.Sync(new(User)) func (model User) TableComment() string { return "表注释" } ```
fanybook added 1 commit 2021-11-04 06:38:29 +00:00
add column comment for postgres
All checks were successful
continuous-integration/drone/pr Build is passing
Details
6fb5873890
lunny commented 2021-11-05 03:58:07 +00:00
Owner
Copy Link

You should change dialects/postgres.go but not there.

You should change `dialects/postgres.go` but not there.
lunny requested changes 2021-11-05 03:58:34 +00:00
lunny left a comment
Owner
Copy Link

per my comment above.

per my comment above.
fanybook added 1 commit 2021-11-05 07:22:30 +00:00
增加创建表时支持注释，创建字段和修改字段时支持注释
Some checks failed
continuous-integration/drone/pr Build is failing
Details
49a62df21e
fanybook requested review from lunny 2021-11-05 07:23:27 +00:00
fanybook commented 2021-11-05 07:25:35 +00:00
Author
Contributor
Copy Link

@lunny 已经移到 dialects 了，感觉 master 代码和 v1.2.5 相差很多，接口都变了

现在支持了字段注释和表注释

我发现 dialects/mysql.go 貌似没有用到 schema？mysql 里的库也相当于 pgsql 里的 schema

@lunny 已经移到 dialects 了，感觉 master 代码和 v1.2.5 相差很多，接口都变了 现在支持了字段注释和表注释 我发现 dialects/mysql.go 貌似没有用到 schema？mysql 里的库也相当于 pgsql 里的 schema
fanybook added 1 commit 2021-11-05 07:35:52 +00:00
fixed hand error
Some checks failed
continuous-integration/drone/pr Build is failing
Details
c9a1093af6
fanybook changed title from add column comment for postgres to add table & column comment for postgres 2021-11-05 07:37:17 +00:00
fanybook changed title from add table & column comment for postgres to add table & column comment for postgres（add table comment for mysql） 2021-11-05 07:37:49 +00:00
fanybook added 1 commit 2021-11-05 07:43:12 +00:00
fixed hand error2
All checks were successful
continuous-integration/drone/pr Build is passing
Details
b1d6ec1db5
lunny Comment%!(EXTRA template.HTML=2021-11-07 03:51:42 +00:00)
tags/parser.go Outdated
@ -90,6 +90,14 @@ func (parser *Parser) ParseWithCache(v reflect.Value) (*schemas.Table, error) {
return nil, err
}
// if bean has Comment Method, then set table.Comment
lunny commented 2021-11-07 03:51:42 +00:00
Owner
Copy Link

This should be moved into parser.Parse

This should be moved into `parser.Parse`
lunny added the
kind
feature
 label 2021-11-07 03:52:12 +00:00
lunny commented 2021-11-07 03:52:42 +00:00
Owner
Copy Link

Thank you very much! Could you add some tests here? I think we have some with comment for MySQL.

Thank you very much! Could you add some tests here? I think we have some with comment for MySQL.
fanybook added 1 commit 2021-11-08 03:40:26 +00:00
Modify Comment to TableComment & moved into parser.Parse
Some checks failed
continuous-integration/drone/pr Build is failing
Details
72efd4ed00
lunny Comment%!(EXTRA template.HTML=2021-11-08 03:52:18 +00:00)
names/table_name.go Outdated
@ -58,0 +67,4 @@
return v.Interface().(TableComment).TableComment()
}
return ""
lunny commented 2021-11-08 03:52:17 +00:00
Owner
Copy Link

You should also consider it's a pointer method.

if v.Kind() == reflect.Ptr {
	v = v.Elem()
You should also consider it's a pointer method. ```go if v.Kind() == reflect.Ptr { v = v.Elem() ```
lunny marked this conversation as resolved
lunny Comment%!(EXTRA template.HTML=2021-11-08 03:52:28 +00:00)
session_schema.go Outdated
@ -351,6 +351,7 @@ func (session *Session) Sync(beans ...interface{}) error {
if err = session.addColumn(col.Name); err != nil {
return err
}
lunny commented 2021-11-08 03:52:28 +00:00
Owner
Copy Link

unnecessary change.

unnecessary change.
lunny marked this conversation as resolved
lunny Comment%!(EXTRA template.HTML=2021-11-08 03:53:09 +00:00)
tags/parser_test.go Outdated
@ -26,6 +26,10 @@ func (p ParseTableName2) TableName() string {
return "p_parseTableName"
}
func (p ParseTableName2) TableComment() string {
lunny commented 2021-11-08 03:53:09 +00:00
Owner
Copy Link

Please also add a pointer method

Please also add a pointer method
lunny marked this conversation as resolved
lunny commented 2021-11-08 03:53:57 +00:00
Owner
Copy Link

How about also add simliar test cases for postgres?

How about also add simliar test cases for postgres?
fanybook added 1 commit 2021-11-08 03:58:33 +00:00
fmt
All checks were successful
continuous-integration/drone/pr Build is passing
Details
9c081d1648
fanybook added 1 commit 2021-11-08 05:58:18 +00:00
add some test cases
Some checks failed
continuous-integration/drone/pr Build is failing
Details
92b12f29a7
fanybook added 1 commit 2021-11-08 06:02:39 +00:00
remove unnecessary change
Some checks failed
continuous-integration/drone/pr Build is failing
Details
b2e1f1c241
fanybook commented 2021-11-08 06:11:11 +00:00
Author
Contributor
Copy Link

How about also add simliar test cases for postgres?

parser.Parse only set table.Commet, it will be used in dialects

i don't know how to import master branch in my project

> How about also add simliar test cases for postgres? parser.Parse only set table.Commet, it will be used in dialects i don't know how to import master branch in my project
fanybook added 1 commit 2021-11-08 06:14:13 +00:00
remove unnecessary chinese change
Some checks failed
continuous-integration/drone/pr Build is failing
Details
e6817a5423
fanybook added 1 commit 2021-11-08 06:50:17 +00:00
remove unnecessary empty line
Some checks failed
continuous-integration/drone/pr Build is failing
Details
6a1a245c48
fanybook added 1 commit 2021-11-08 09:40:30 +00:00
fixed test case
All checks were successful
continuous-integration/drone/pr Build is passing
Details
b46dc622ff
fanybook commented 2021-11-09 05:38:42 +00:00
Author
Contributor
Copy Link

@lunny 看一下，能合并了么

@lunny 看一下，能合并了么
lunny Comment%!(EXTRA template.HTML=2021-11-09 09:58:10 +00:00)
dialects/postgres.go Outdated
@ -1001,0 +1021,4 @@
modifyColumnSQL = fmt.Sprintf("ALTER TABLE %s.%s ALTER COLUMN %s TYPE %s", quoter.Quote(db.getSchema()), quoter.Quote(tableName), quoter.Quote(col.Name), db.SQLType(col))
commentSQL += fmt.Sprintf("COMMENT ON COLUMN %s.%s.%s IS '%s'", quoter.Quote(db.getSchema()), quoter.Quote(tableName), quoter.Quote(col.Name), col.Comment)
return modifyColumnSQL + commentSQL
lunny commented 2021-11-09 09:58:10 +00:00
Owner
Copy Link

need a space between two SQLs

need a space between two SQLs
lunny marked this conversation as resolved
fanybook commented 2021-11-10 07:28:32 +00:00
Author
Contributor
Copy Link

@lunny has space and semicolon

commentSQL := "; "
commentSQL += "xxxx"
@lunny has space and semicolon ```go commentSQL := "; " commentSQL += "xxxx" ```
lunny commented 2021-11-10 14:49:31 +00:00
Owner
Copy Link

@lunny has space and semicolon

commentSQL := "; "
commentSQL += "xxxx"

I mean in function ModifyColumnSQL

> @lunny has space and semicolon > > ```go > commentSQL := "; " > commentSQL += "xxxx" > ``` I mean in function `ModifyColumnSQL`
fanybook commented 2021-11-10 15:26:25 +00:00
Author
Contributor
Copy Link

@lunny has space and semicolon

commentSQL := "; "
commentSQL += "xxxx"

I mean in function ModifyColumnSQL

@lunny 我不太明白，应该在哪加空格，请指点一下

func (db *postgres) ModifyColumnSQL(tableName string, col *schemas.Column) string {
	quoter := db.dialect.Quoter()
	modifyColumnSQL := ""
	commentSQL := "; "

	if len(db.getSchema()) == 0 || strings.Contains(tableName, ".") {
		modifyColumnSQL = fmt.Sprintf("ALTER TABLE %s ALTER COLUMN %s TYPE %s", quoter.Quote(tableName), quoter.Quote(col.Name), db.SQLType(col))
		commentSQL += fmt.Sprintf("COMMENT ON COLUMN %s.%s IS '%s'", quoter.Quote(tableName), quoter.Quote(col.Name), col.Comment)
		return modifyColumnSQL + commentSQL
	}

	modifyColumnSQL = fmt.Sprintf("ALTER TABLE %s.%s ALTER COLUMN %s TYPE %s", quoter.Quote(db.getSchema()), quoter.Quote(tableName), quoter.Quote(col.Name), db.SQLType(col))
	commentSQL += fmt.Sprintf("COMMENT ON COLUMN %s.%s.%s IS '%s'", quoter.Quote(db.getSchema()), quoter.Quote(tableName), quoter.Quote(col.Name), col.Comment)
	return modifyColumnSQL + commentSQL
}
> > @lunny has space and semicolon > > > > ```go > > commentSQL := "; " > > commentSQL += "xxxx" > > ``` > > I mean in function `ModifyColumnSQL` @lunny 我不太明白，应该在哪加空格，请指点一下 ```go func (db *postgres) ModifyColumnSQL(tableName string, col *schemas.Column) string { quoter := db.dialect.Quoter() modifyColumnSQL := "" commentSQL := "; " if len(db.getSchema()) == 0 || strings.Contains(tableName, ".") { modifyColumnSQL = fmt.Sprintf("ALTER TABLE %s ALTER COLUMN %s TYPE %s", quoter.Quote(tableName), quoter.Quote(col.Name), db.SQLType(col)) commentSQL += fmt.Sprintf("COMMENT ON COLUMN %s.%s IS '%s'", quoter.Quote(tableName), quoter.Quote(col.Name), col.Comment) return modifyColumnSQL + commentSQL } modifyColumnSQL = fmt.Sprintf("ALTER TABLE %s.%s ALTER COLUMN %s TYPE %s", quoter.Quote(db.getSchema()), quoter.Quote(tableName), quoter.Quote(col.Name), db.SQLType(col)) commentSQL += fmt.Sprintf("COMMENT ON COLUMN %s.%s.%s IS '%s'", quoter.Quote(db.getSchema()), quoter.Quote(tableName), quoter.Quote(col.Name), col.Comment) return modifyColumnSQL + commentSQL } ```
fanybook commented 2021-11-12 03:32:56 +00:00
Author
Contributor
Copy Link

@lunny 受累看一下能合并了么，之前您说在 ModifyColumnSQL 里，两段 sql 之前应该有一个空格

但是在 commentSQL 初始化的时候，这个空格就已经有了，还有一个分号

like this

commentSQL := "; "
commentSQL += "xxxx"

return modifyColumnSQL + commentSQL
@lunny 受累看一下能合并了么，之前您说在 ModifyColumnSQL 里，两段 sql 之前应该有一个空格 但是在 commentSQL 初始化的时候，这个空格就已经有了，还有一个分号 like this ```go commentSQL := "; " commentSQL += "xxxx" return modifyColumnSQL + commentSQL ```
lunny added 1 commit 2021-11-12 03:35:10 +00:00
Merge branch 'master' into master
All checks were successful
continuous-integration/drone/pr Build is passing
Details
64fbfd0e4b
lunny merged commit aea91cc7de into master 2021-11-12 12:58:06 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
lunny
Labels
Clear labels   
backport/done

   
backport/v1

   
blocked
  
db
oracle

  
db
sqlserver

  
duplicate
  
feature
cache

  
frontport/done

   
frontport/main

   
invalid
  
kind
breaking

  
kind
bug

  
kind
build

  
kind
dependencies

  
kind
docs

  
kind
driver

  
kind
enhancement

  
kind
feature

  
kind
performance

  
kind
proposal

  
kind
question

  
kind
refactor

  
kind
testing

  
need
feedback

  
need
test

  
proposal:accepted

   
RaspBerry Pi

   
regression

   
skip-changelog

   
upstream

   
wip

   
wontfix
No Label
backport/done
backport/v1
blocked
db
oracle
db
sqlserver
duplicate
feature
cache
frontport/done
frontport/main
invalid
kind
breaking
kind
bug
kind
build
kind
dependencies
kind
docs
kind
driver
kind
enhancement
kind
feature
kind
performance
kind
proposal
kind
question
kind
refactor
kind
testing
need
feedback
need
test
proposal:accepted
RaspBerry Pi
regression
skip-changelog
upstream
wip
wontfix
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: xorm/xorm#2067
No description provided.
Delete Branch "fanybook/xorm:master"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?