database

Documentation

Index

• Constants
• type Admin
• type CloseFunc
• type CreateDBRequest
• type CreateDBResponse
• type Database
• type Info
• type Status

Constants

const (
	LabelPostgres = "postgres"
	LabelPGWeb    = "pgweb"
	LabelRedis    = "redis"
	LabelTesting  = "testing"
)

Types

type Admin

type Admin interface {
	CreateDB(ctx context.Context, req *CreateDBRequest) (*CreateDBResponse, error)
	RemoveDB(ctx context.Context, uri string) error
}

type CloseFunc

type CloseFunc func(ctx context.Context) error

type CreateDBRequest

type CreateDBRequest struct {
	Migrations string
	Fixtures   string

	WithDefaultMigrations bool
}

type CreateDBResponse

type CreateDBResponse struct {
	URI string
}

type Database

type Database interface {
	Start(ctx context.Context, detach bool) error
	Stop(ctx context.Context) error
	WaitForStart(ctx context.Context, timeout time.Duration) error
	URI() string
}

type Info

type Info struct {
	ID     string
	Type   string
	Status Status
}

type Status

type Status int

const (
	Running Status = iota
	Stoped
)