session

Documentation

Index

• Variables
• func RegisterCatalog(database string, catalog builder.Catalog)
• type Adaptor
• type Database
  • func (d *Database) ApplyCatalog(name string, catalogs ...builder.Catalog)
  • func (d *Database) Catalog() builder.Catalog
  • func (d *Database) Init(ctx context.Context) error
  • func (d *Database) Name() string
  • func (d *Database) Run(ctx context.Context) error
  • func (d *Database) Session() Session
  • func (d *Database) SetDefault()
• type OptionFunc
  • func ReadOnly() OptionFunc
• type Session
  • func For(ctx context.Context, m any) Session
  • func FromContext(ctx context.Context, name string) Session
  • func New(a adaptor.Adaptor, name string) Session
  • func NewRO(rw adaptor.Adaptor, ro adaptor.Adaptor, name string) Session

Variables

var (
	Scan = scanner.Scan
	Open = adaptor.Open
)

Functions

func RegisterCatalog

func RegisterCatalog(database string, catalog builder.Catalog)

Types

type Adaptor

type Adaptor = adaptor.Adaptor

type Database

type Database struct {
	Endpoint datatypex.Endpoint
	Readonly datatypex.Endpoint

	AutoMigration   bool
	DryRun          bool
	CreateTableOnly bool
	// contains filtered or unexported fields
}

func (*Database) ApplyCatalog

func (d *Database) ApplyCatalog(name string, catalogs ...builder.Catalog)

func (*Database) Catalog

func (d *Database) Catalog() builder.Catalog

func (*Database) Init

func (d *Database) Init(ctx context.Context) error

func (*Database) Name

func (d *Database) Name() string

func (*Database) Run

func (d *Database) Run(ctx context.Context) error

func (*Database) Session

func (d *Database) Session() Session

func (*Database) SetDefault

func (d *Database) SetDefault()

type OptionFunc

type OptionFunc func(*option)

func ReadOnly

func ReadOnly() OptionFunc

type Session

type Session interface {
	// Database physically endpoint
	Database() string
	// Schema logically
	Schema() 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(...OptionFunc) adaptor.Adaptor
}

func For

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

func FromContext

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

func New

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

func NewRO

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