Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

saas

package module

Go to main page

Versions in this module

v0

v0.6.3

Nov 1, 2023

Changes in this version

type TenantConfig

+ PlanKey string

v0.6.2

Oct 8, 2023

v0.6.1

Aug 4, 2023

v0.6.0

Dec 24, 2022

v0.5.1

Oct 2, 2022

Changes in this version

+ var ErrTenantNotFound = errors.New("tenant not found")

+ func NewCurrentTenant(ctx context.Context, id, name string) context.Context

+ func NewCurrentTenantInfo(ctx context.Context, info TenantInfo) context.Context

+ func NewTenantConfigContext(ctx context.Context, tenantId string, cfg *TenantConfig) context.Context

+ func NewTenantResolveRes(ctx context.Context, t *TenantResolveResult) context.Context

+ func WithDatabaseStyle(databaseStyle DatabaseStyleType) option

+ func WithEnabled(isEnabled bool) option

+ type BasicTenantInfo struct

+ Id string

+ Name string

+ func NewBasicTenantInfo(id string, name string) *BasicTenantInfo

+ func (b *BasicTenantInfo) GetId() string

+ func (b *BasicTenantInfo) GetName() string

+ type Cache struct

+ func NewCache(opts ...Option) *Cache[K, V]

+ func (c *Cache[K, V]) Delete(key K)

+ func (c *Cache[K, V]) Flush() error

+ func (c *Cache[K, V]) Get(key K) (zero V, _ bool)

+ func (c *Cache[K, V]) GetOrSet(key K, factory func() (V, error)) (zero V, set bool, err error)

+ func (c *Cache[K, V]) Keys() []K

+ func (c *Cache[K, V]) Len() int

+ func (c *Cache[K, V]) Set(key K, val V)

+ type ClientProvider interface

+ Get func(ctx context.Context, dsn string) (TClient, error)

+ type ClientProviderFunc func(ctx context.Context, dsn string) (TClient, error)

+ func (c ClientProviderFunc[TClient]) Get(ctx context.Context, dsn string) (TClient, error)

+ type ConnStrGenerator interface

+ Gen func(ctx context.Context, tenant TenantInfo) (string, error)

+ type Context struct

+ HasHandled bool

+ TenantIdOrName string

+ func NewTenantResolveContext(ctx context.Context) *Context

+ func (t *Context) Context() context.Context

+ func (t *Context) HasResolved() bool

+ func (t *Context) WithContext(ctx context.Context)

+ type ContextContrib struct

+ func (c *ContextContrib) Name() string

+ func (c *ContextContrib) Resolve(ctx *Context) error

+ type DatabaseStyleType int32

+ const Multi

+ const PerTenant

+ const Single

+ type DbProvider interface

+ Get func(ctx context.Context, key string) TClient

+ type DefaultConnStrGenerator struct

+ func NewConnStrGenerator(format string) *DefaultConnStrGenerator

+ func (d *DefaultConnStrGenerator) Gen(ctx context.Context, tenant TenantInfo) (string, error)

+ type DefaultDbProvider struct

+ func NewDbProvider(cs data.ConnStrResolver, cp ClientProvider[TClient]) (d *DefaultDbProvider[TClient])

+ func (d *DefaultDbProvider[TClient]) Get(ctx context.Context, key string) TClient

+ type DefaultTenantConfigProvider struct

+ func (d *DefaultTenantConfigProvider) Get(ctx context.Context) (TenantConfig, context.Context, error)

+ type DefaultTenantResolver struct

+ func (d *DefaultTenantResolver) Resolve(ctx context.Context) (TenantResolveResult, context.Context, error)

+ type MemoryTenantStore struct

+ TenantConfig []TenantConfig

+ func NewMemoryTenantStore(t []TenantConfig) *MemoryTenantStore

+ func (m *MemoryTenantStore) GetByNameOrId(_ context.Context, nameOrId string) (*TenantConfig, error)

+ type MultiTenancyConnStrResolver struct

+ func NewMultiTenancyConnStrResolver(ts TenantStore, fallback data.ConnStrResolver) *MultiTenancyConnStrResolver

+ func (m *MultiTenancyConnStrResolver) Resolve(ctx context.Context, key string) (string, error)

+ type MultiTenancyOption struct

+ DatabaseStyle DatabaseStyleType

+ IsEnabled bool

+ func DefaultMultiTenancyOption() *MultiTenancyOption

+ func NewMultiTenancyOption(opts ...option) *MultiTenancyOption

+ type MultiTenancySide int32

+ const Both

+ const Host

+ const Tenant

+ func GetMultiTenantSide(ctx context.Context) MultiTenancySide

+ type Option func(*options)

+ func WithCapacity(cap int) Option

+ type ResolveOption func(resolveOption *TenantResolveOption)

+ func AppendContribs(c ...TenantResolveContrib) ResolveOption

+ func RemoveContribs(c ...TenantResolveContrib) ResolveOption

+ type TenantConfig struct

+ Conn data.ConnStrings

+ ID string

+ Name string

+ Region string

+ func FromTenantConfigContext(ctx context.Context, tenantId string) (*TenantConfig, bool)

+ func NewTenantConfig(id string, name string, region string) *TenantConfig

+ type TenantConfigProvider interface

+ Get func(ctx context.Context) (TenantConfig, context.Context, error)

+ func NewDefaultTenantConfigProvider(tr TenantResolver, ts TenantStore) TenantConfigProvider

+ type TenantInfo interface

+ GetId func() string

+ GetName func() string

+ func FromCurrentTenant(ctx context.Context) (TenantInfo, bool)

+ type TenantNormalizerContrib struct

+ func NewTenantNormalizerContrib(ts TenantStore) *TenantNormalizerContrib

+ func (t *TenantNormalizerContrib) Name() string

+ func (t *TenantNormalizerContrib) Resolve(ctx *Context) error

+ type TenantResolveContrib interface

+ Name func() string

+ Resolve func(ctx *Context) error

+ type TenantResolveOption struct

+ Resolvers []TenantResolveContrib

+ func NewTenantResolveOption(c ...TenantResolveContrib) *TenantResolveOption

+ func (opt *TenantResolveOption) AppendContribs(c ...TenantResolveContrib)

+ func (opt *TenantResolveOption) RemoveContribs(c ...TenantResolveContrib)

+ type TenantResolveResult struct

+ AppliedResolvers []string

+ TenantIdOrName string

+ func FromTenantResolveRes(ctx context.Context) *TenantResolveResult

+ type TenantResolver interface

+ Resolve func(ctx context.Context) (TenantResolveResult, context.Context, error)

+ func NewDefaultTenantResolver(opt ...ResolveOption) TenantResolver

+ type TenantStore interface

+ GetByNameOrId func(ctx context.Context, nameOrId string) (*TenantConfig, error)