How to set singular name for a table in gorm

Question

type user struct {
    ID       int
    Username string `gorm:"size:255"`
    Name     string `gorm:"size:255"`
}

I want to create a table 'user' using this model. But the table name is automatically set to 'users'. I know it is gorm's default behavior. But I want the table name to be 'user'.

for sake of completeness: You can use `db.SingularTable(true)` to use singular tablenames globally. — Ralph Juhnke, Jun 24 '17 at 16:26

score 50 · Answer 1 · edited Mar 12 '21 at 22:11

50

Set method TableName for your struct.

func (user) TableName() string {
    return "user"
}

Link: https://gorm.io/docs/models.html#conventions

edited Mar 12 '21 at 22:11

Ether

53,118
13
86
159

answered Jun 16 '17 at 12:37

bayrinat

1,468
8
18

Just realized that OP was using `user` instead of `User`. – superarts.org Oct 29 '18 at 19:46
Would I also need to call this method or just declaring this way would do the work? – Anish Jain Jun 07 '22 at 07:24
https://gorm.io/docs/conventions.html#Pluralized-Table-Name Now the document about customized table name is placed here. – Gary Liao Jun 12 '23 at 02:28

score 21 · Answer 2 · edited Dec 26 '20 at 17:57

21

Gorm has a in-built method for that that will be set in global level so all tables will be singular.

For gorm v1, you could do:

db.SingularTable(true)

For v2, it's a little more verbose:

db, err := gorm.Open(postgres.Open(connStr), &gorm.Config{
    NamingStrategy: schema.NamingStrategy{
        SingularTable: true,
    },
})

edited Dec 26 '20 at 17:57

Ezequiel Muns

7,492
33
57

answered Apr 27 '18 at 21:45

Sivalingam

841
11
16

score 0 · Answer 3 · answered Dec 02 '22 at 20:09

To explicitly set a table name, you would have to create an interface Tabler with TableName method, and then create a receiver method (defined in the interface) for the struct:

type user struct {
    ID       int
    Username string `gorm:"size:255"`
    Name     string `gorm:"size:255"`
}

type Tabler interface {
  TableName() string
}

// TableName overrides the table name used by User to `profiles`
func (user) TableName() string {
  return "user"
}

How to set singular name for a table in gorm

3 Answers3

Linked