constructor

Documentation

Index

• Constants
• func NewClient(ctx context.Context, c driver.Config) (*gorm.DB, error)
• type DBClient
  • func (dbc *DBClient) GetClient(instanceName string) (*gorm.DB, error)
  • func (dbc *DBClient) GetDefaultClient() (*gorm.DB, error)
  • func (dbc *DBClient) GetDefaultGeneratedConfig() (dbDriver.Config, error)
  • func (dbc *DBClient) GetDriverInstance() *dbinstance.Instance
  • func (dbc *DBClient) GetInstanceConfig(instanceName string) (dbDriver.Config, error)
  • func (dbc *DBClient) New(config dbDriver.Config) (*gorm.DB, error)
  • func (dbc *DBClient) NewClient(instanceName string) (*gorm.DB, error)

Constants

const CockroachDriver = "cockroach"

const MySQLDriver = "mysql"

const PostGRESDriver = "postgres"

const SQLiteDriver = "sqlite"

Functions

func NewClient

func NewClient(
	ctx context.Context,
	c driver.Config,
) (*gorm.DB, error)

Types

type DBClient

type DBClient struct {
	DriverType string

	Ctx context.Context
	// contains filtered or unexported fields
}

func (*DBClient) GetClient

func (dbc *DBClient) GetClient(
	instanceName string,
) (*gorm.DB, error)

GetClient -> it returns an existing client

func (*DBClient) GetDefaultClient

func (dbc *DBClient) GetDefaultClient() (*gorm.DB, error)

GetDefaultClient -> it returns the default client based on the existing app configuration

func (*DBClient) GetDefaultGeneratedConfig

func (dbc *DBClient) GetDefaultGeneratedConfig() (dbDriver.Config, error)

func (*DBClient) GetDriverInstance

func (dbc *DBClient) GetDriverInstance() *dbinstance.Instance

func (*DBClient) GetInstanceConfig

func (dbc *DBClient) GetInstanceConfig(instanceName string) (dbDriver.Config, error)

func (*DBClient) New

func (dbc *DBClient) New(
	config dbDriver.Config,
) (*gorm.DB, error)

New -> Creates totally a new DB Client, this is the root function!

func (*DBClient) NewClient

func (dbc *DBClient) NewClient(
	instanceName string,
) (*gorm.DB, error)

NewClient -> it creates a new DB Client based on the existing app configuration