scopes

func WithTenantSchema ¶

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

WithTenantSchema returns a GORM scope function that prefixes the table name with the specified tenant schema.

The function supports different strategies for determining the table name, which are attempted in the following order:

1. Direct specification via gorm.DB.Table.
2. Model type set via gorm.DB.Model implementing driver.TenantTabler.
3. Destination type implementing driver.TenantTabler.

If the table name cannot be determined, an error is added to the DB instance.

Examples (assuming the following model):

type Book struct { ... }
var _ driver.TenantTabler = new(Book)
func (Book) TableName() string { return "books" }
func (Book) IsSharedModel() bool { ... }

Direct table specification:

db.Table("books").Scopes(WithTenantSchema("tenant1")).Find(...)
// SELECT * FROM "tenant1"."books"

Inferred from `Model` call:

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

Inferred from the destination type:

db.Scopes(WithTenantSchema("tenant1")).Find(&[]Book{})
// SELECT * FROM "tenant1"."books"

package main

import (
	"fmt"

	"github.com/bartventer/gorm-multitenancy/v8/pkg/scopes"
	"gorm.io/gorm"
	"gorm.io/gorm/utils/tests"
)

type Book struct {
	ID    uint
	Title string
}

func (Book) TableName() string   { return "books" }
func (Book) IsSharedModel() bool { return true }

func main() {
	db, err := gorm.Open(tests.DummyDialector{})
	if err != nil {
		panic(err)
	}

	queryFn := func(tx *gorm.DB) *gorm.DB {
		return tx.Scopes(scopes.WithTenantSchema("tenant1")).Find(&Book{})
	}

	sqlstr := db.ToSQL(queryFn)
	fmt.Println(sqlstr)

}

Output:

SELECT * FROM `tenant1`.`books`