session

Documentation

Index

• func Carry(session Session) contextx.Carrier
• func With(ctx context.Context, session Session) context.Context
• type AdaptorOption
• type AdaptorOptionApplier
  • func ReadOnly() AdaptorOptionApplier
• type HasSession
• type ModelWrapper
• type Session
  • func For(ctx context.Context, m any) (Session, bool)
  • func From(ctx context.Context, name string) (Session, bool)
  • func Must(ctx context.Context, name string) Session
  • func MustFor(ctx context.Context, m any) Session
  • func New(a adaptor.Adaptor, name string) Session
  • func NewReadonly(rw adaptor.Adaptor, ro adaptor.Adaptor, name string) Session
• type WithSession

Functions

func Carry

func Carry(session Session) contextx.Carrier

Carry returns context carrier

func With

func With(ctx context.Context, session Session) context.Context

With injects Session

Types

type AdaptorOption

type AdaptorOption struct {
	ReadOnly bool
}

type AdaptorOptionApplier

type AdaptorOptionApplier func(*AdaptorOption)

func ReadOnly

func ReadOnly() AdaptorOptionApplier

type HasSession

type HasSession interface {
	HasSession() Session
}

type ModelWrapper

type ModelWrapper interface {
	Unwrap() builder.Table
}

type Session

type Session interface {
	// Schema logically isolation
	Schema() string
	// Name returns session name
	Name() string
	// T picks table from session
	T(any) builder.Table
	// Tx exec query
	Tx(context.Context, func(context.Context) error) error
	// Adaptor returns session adaptor
	Adaptor(...AdaptorOptionApplier) adaptor.Adaptor
}

Session presents a connection to a rdb logically

func For

func For(ctx context.Context, m any) (Session, bool)

For retrieves Session by session name or table

func From

func From(ctx context.Context, name string) (Session, bool)

From retrieve Session from ctx by Session.Name

func Must

func Must(ctx context.Context, name string) Session

func MustFor

func MustFor(ctx context.Context, m any) Session

func New

func New(a adaptor.Adaptor, name string) Session

func NewReadonly

func NewReadonly(rw adaptor.Adaptor, ro adaptor.Adaptor, name string) Session

type WithSession

type WithSession interface {
	WithSession(Session)
}