session

Documentation

Index

• Constants
• Variables
• func Carry(session Session) contextx.Carrier
• func With(ctx context.Context, session Session) context.Context
• 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 Endpoint
  • func ParseEndpoint(text string) (*Endpoint, error)
  • func (e Endpoint) Hostname() string
  • func (e Endpoint) IsZero() bool
  • func (e Endpoint) MarshalText() ([]byte, error)
  • func (e Endpoint) SecurityString() string
  • func (e Endpoint) String() string
  • func (e *Endpoint) UnmarshalText(text []byte) error
• type OptionFunc
  • func ReadOnly() OptionFunc
• type Password
  • func (p Password) SecurityString() string
  • func (p Password) String() string
• type Session
  • func For(ctx context.Context, m any) Session
  • func From(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

Constants

const MaskedPassword = "--------"

Variables

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

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 Adaptor

type Adaptor = adaptor.Adaptor

type Database

type Database struct {
	Endpoint Endpoint
	Readonly Endpoint

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

func (*Database) ApplyCatalog

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

ApplyCatalog should do before endpoint initialization

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 Endpoint

type Endpoint struct {
	Scheme   string
	Host     string
	Port     uint16
	Base     string
	Username string
	Password Password
	Param    url.Values
}

func ParseEndpoint

func ParseEndpoint(text string) (*Endpoint, error)

func (Endpoint) Hostname

func (e Endpoint) Hostname() string

func (Endpoint) IsZero

func (e Endpoint) IsZero() bool

func (Endpoint) MarshalText

func (e Endpoint) MarshalText() ([]byte, error)

func (Endpoint) SecurityString

func (e Endpoint) SecurityString() string

func (Endpoint) String

func (e Endpoint) String() string

func (*Endpoint) UnmarshalText

func (e *Endpoint) UnmarshalText(text []byte) error

type OptionFunc

type OptionFunc func(*option)

func ReadOnly

func ReadOnly() OptionFunc

type Password

type Password string

func (Password) SecurityString

func (p Password) SecurityString() string

func (Password) String

func (p Password) String() string

type Session

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

func For

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

For retrieves Session by session name or table

func From

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

From retrieve Session from ctx by Session.Name

func New

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

func NewRO

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