db

README

DB

XORM Plugin

Import

import (
    "github.com/fuyibing/db/v8"
)

Documentation

Overview

Package db database plugin based on xorm.

Index

• func Transaction(ctx context.Context, handlers ...TransactionHandler) error
• func TransactionWithSession(ctx context.Context, sess *xorm.Session, handlers ...TransactionHandler) (err error)
• type Configuration
  • func (o *Configuration) GetDatabase(key string) *Database
  • func (o *Configuration) GetDefault() *Database
  • func (o *Configuration) SetDatabase(key string, database *Database)
• type Connection
  • func (o *Connection) GetEngineGroup(keys ...string) (engine *xorm.EngineGroup)
  • func (o *Connection) GetMaster(keys ...string) *xorm.Session
  • func (o *Connection) GetMasterWithContext(ctx context.Context, keys ...string) *xorm.Session
  • func (o *Connection) GetSlave(keys ...string) *xorm.Session
  • func (o *Connection) GetSlaveWithContext(ctx context.Context, keys ...string) *xorm.Session
• type Database
  • func (o *Database) GetDataName() string
  • func (o *Database) GetMapper() names.Mapper
  • func (o *Database) GetUsername() string
  • func (o *Database) Undefined() bool
• type Service
  • func (o *Service) Master() *xorm.Session
  • func (o *Service) Slave() *xorm.Session
  • func (o *Service) Use(sessions ...*xorm.Session)
  • func (o *Service) UseConnection(connection string)
• type TransactionHandler

Functions

func Transaction

func Transaction(ctx context.Context, handlers ...TransactionHandler) error

func TransactionWithSession

func TransactionWithSession(ctx context.Context, sess *xorm.Session, handlers ...TransactionHandler) (err error)

Types

type Configuration

type Configuration struct {
	Databases map[string]*Database `yaml:"databases"`
	// contains filtered or unexported fields
}

var Config *Configuration

func (*Configuration) GetDatabase

func (o *Configuration) GetDatabase(key string) *Database

func (*Configuration) GetDefault

func (o *Configuration) GetDefault() *Database

func (*Configuration) SetDatabase

func (o *Configuration) SetDatabase(key string, database *Database)

type Connection

type Connection struct {
	// contains filtered or unexported fields
}

var Connector *Connection

func (*Connection) GetEngineGroup

func (o *Connection) GetEngineGroup(keys ...string) (engine *xorm.EngineGroup)

func (*Connection) GetMaster

func (o *Connection) GetMaster(keys ...string) *xorm.Session

func (*Connection) GetMasterWithContext

func (o *Connection) GetMasterWithContext(ctx context.Context, keys ...string) *xorm.Session

func (*Connection) GetSlave

func (o *Connection) GetSlave(keys ...string) *xorm.Session

func (*Connection) GetSlaveWithContext

func (o *Connection) GetSlaveWithContext(ctx context.Context, keys ...string) *xorm.Session

type Database

type Database struct {
	Driver        string   `yaml:"driver"`
	Dsn           []string `yaml:"dsn"`
	MaxIdle       int      `yaml:"max-idle"`
	MaxLifetime   int      `yaml:"max-lifetime"`
	MaxOpen       int      `yaml:"max-open"`
	Mapper        string   `yaml:"mapper"`
	EnableSession *bool    `yaml:"enable-session"`
	ShowSQL       *bool    `yaml:"show-sql"`
	// contains filtered or unexported fields
}

func (*Database) GetDataName

func (o *Database) GetDataName() string

func (*Database) GetMapper

func (o *Database) GetMapper() names.Mapper

func (*Database) GetUsername

func (o *Database) GetUsername() string

func (*Database) Undefined

func (o *Database) Undefined() bool

type Service

type Service struct {
	// contains filtered or unexported fields
}

func (*Service) Master

func (o *Service) Master() *xorm.Session

func (*Service) Slave

func (o *Service) Slave() *xorm.Session

func (*Service) Use

func (o *Service) Use(sessions ...*xorm.Session)

func (*Service) UseConnection

func (o *Service) UseConnection(connection string)

type TransactionHandler

type TransactionHandler func(ctx context.Context, sess *xorm.Session) error