Skip to main content
Version: 0.7.0

Multi-Tenancy API Reference

Tenant Strategies

StrategyDescriptionUse Case
DatabasePerTenantSeparate DB per tenantStrong isolation, regulatory
SchemaPerTenantSchema per tenantMedium isolation, shared pool
RowLevelSecurityWHERE tenant_id filterShared table, simple scaling

TenantRouter

NewTenantRouter(config, resolver, factory) *TenantRouter

router := quark.NewTenantRouter(
quark.TenantConfig{
Strategy: quark.SchemaPerTenant,
BaseClient: baseClient,
MaxCachedPools: 100, // For DatabasePerTenant
},
func(ctx context.Context) string {
return ctx.Value("tenant_id").(string) // Extract from context
},
func(tenantID string) (*quark.Client, error) {
// Create tenant-specific client
return quark.New("postgres", fmt.Sprintf(".../tenant_%s", tenantID))
},
)

Usage with Queries

// RowLevelSecurity: WHERE tenant_id = 'acme' is auto-injected
users, _ := quark.For[User](ctx, router).List()

// SchemaPerTenant: queries "acme.users"
orders, _ := quark.For[Order](ctx, router).List()

Tenant Router Methods

MethodDescription
ResolveTenant(ctx) (string, error)Extract tenant ID from context
GetClient(ctx) (*Client, error)Get tenant-specific client
ActiveTenants() []stringList cached tenant connections