xgorm

Documentation

Index

• type Adapter
  • func NewAdapter(db *gorm.DB, drv database.Driver, retryCount int) (*Adapter, error)
  • func (g *Adapter) Do(ctx context.Context, db *gorm.DB, ...) error
  • func (g *Adapter) Driver() database.Driver
  • func (g *Adapter) Err(err error) error
  • func (g *Adapter) Health(ctx context.Context) error
• type Driver
  • func NewDriver(baseDriver database.Driver) (*Driver, error)
  • func (d *Driver) CanRetry(err error) bool
  • func (d *Driver) DriverName() string
  • func (d *Driver) ErrorCode(err error) cgerrors.ErrorCode

Types

type Adapter

type Adapter struct {
	DB         *gorm.DB
	RetryCount int
	// contains filtered or unexported fields
}

Adapter is the gorm structure used as a template for the gorm based adapters.

func NewAdapter

func NewAdapter(db *gorm.DB, drv database.Driver, retryCount int) (*Adapter, error)

NewAdapter creates a new gorm based adapter. If the input driver is not a GORM driver, it would be wrapped by the xgorm.driver.

func (*Adapter) Do

func (g *Adapter) Do(ctx context.Context, db *gorm.DB, f func(ctx context.Context, db *gorm.DB) error) error

Do executes given function 'f' so that if there would be a connection error it would try to retry the query up to the limit set on initialization.

func (*Adapter) Driver

func (g *Adapter) Driver() database.Driver

Driver gets the adapter driver.

func (*Adapter) Err

func (g *Adapter) Err(err error) error

Err parses err using adapter driver.

func (*Adapter) Health

func (g *Adapter) Health(ctx context.Context) error

Health implements health check for the service.

type Driver

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

Driver is the gorm implementation for the driver name.

func NewDriver

func NewDriver(baseDriver database.Driver) (*Driver, error)

NewDriver creates a new gorm driver.

func (*Driver) CanRetry

func (d *Driver) CanRetry(err error) bool

CanRetry checks if the error relted query could be retried.

func (*Driver) DriverName

func (d *Driver) DriverName() string

DriverName gets the name of the driver.

func (*Driver) ErrorCode

func (d *Driver) ErrorCode(err error) cgerrors.ErrorCode

ErrorCode gets the error code for given error.