The highest tagged major version is v4.

database

package

v1.2.0 Latest Latest Go to latest Published: Aug 6, 2019 License: MIT Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fastbill/go-service-toolkit

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func EnsureMigrations(folder string, config Config) (returnErr error)
func SetupGORM(config Config, logger observance.Logger) (*gorm.DB, error)
type Config
- func (c *Config) ConnectionString() string
- func (c *Config) MigrationURL() string
type GormLogrus
- func (g GormLogrus) Print(v ...interface{})

Constants ¶

View Source

const (
	// DialectMysql is the mysql dialect.
	DialectMysql = "mysql"
	// DialectPostgres is the postgres dialect.
	DialectPostgres = "postgres"
)

Variables ¶

This section is empty.

Functions ¶

func EnsureMigrations ¶

func EnsureMigrations(folder string, config Config) (returnErr error)

EnsureMigrations checks which migrations from the given folder need to be executed It performs all missing migrations This implementation does not use an existing db instance since the lock release mechanism in "NewWithDatabaseInstance" is buggy

func SetupGORM ¶

func SetupGORM(config Config, logger observance.Logger) (*gorm.DB, error)

SetupGORM loads the ORM with the given configuration The setup includes sending a ping and creating the database if it didn't exist. A logger will be activated if logLevel is 'debug'.

Types ¶

type Config ¶

type Config struct {
	Dialect  string
	Host     string
	Port     string
	User     string
	Password string
	Name     string
	SSLMode  string // optional, only used for postgres
}

Config holds all configuration values for the DB setup

func (*Config) ConnectionString ¶

func (c *Config) ConnectionString() string

ConnectionString returns a valid string for sql.Open.

func (*Config) MigrationURL ¶

func (c *Config) MigrationURL() string

MigrationURL returns a database URL with database for migrations.

type GormLogrus ¶

type GormLogrus struct {
	observance.Logger
}

GormLogrus is a logrus logger that implements the gorm interface for logging.

func (GormLogrus) Print ¶

func (g GormLogrus) Print(v ...interface{})

Print implements the gorm.LogWriter interface, courtesy of https://gist.github.com/bnadland/2e4287b801a47dcfcc94.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL