scopes

Documentation

Index

• func WithTenantSchema(tenant string) func(db *gorm.DB) *gorm.DB

Functions

func WithTenantSchema

func WithTenantSchema(tenant string) func(db *gorm.DB) *gorm.DB

WithTenantSchema alters the table name to prefix it with the tenant schema. It will also set the tenant in the context using the TenantKey key.

The table name is retrieved from the statement if set manually, otherwise attempts to get it from the model or destination.

Example with table name set manually:

type Book struct { ... } // does not implement Tabler interface, must set TableName manually

db.Table("books").Scopes(scopes.WithTenantSchema("tenant1")).Find(&Book{})
// SELECT * FROM tenant1.books;

Example with Tabler interface:

type Book struct { ... }

func (u *Book) TableName() string { return "books" } // implements Tabler interface, no need to set TableName manually

db.Scopes(scopes.WithTenantSchema("tenant2")).Find(&Book{})
// SELECT * FROM tenant2.books;

Example with model set manually:

type Book struct { ... }

db.Model(&Book{}).Scopes(scopes.WithTenantSchema("tenant3")).Find(&Book{}) // model is set manually.
// SELECT * FROM tenant3.books;