Retracted: bugs in the whole module that result in crashes

db

package

v0.4.0 Latest Latest Go to latest Published: Nov 4, 2022 License: AGPL-3.0 Imports: 12 Imported by: 1

Details

View Source

const ContextKey string = "db"

ContextKey is the key that is used in a gin.Context to get the Middleware

This section is empty.

func SetupMigrator(prefix string, connection *pgx.Conn, migrations fs.FS) (mig *migrate.Migrator, err error)

SetupMigrator sets up the migrator to migrate the database.

type ConnGet func(string) *pgxpool.Conn

ConnGet is an function that returns an connection instance.

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

Middleware return a handler that sets the db into the context of every request. uri is an url in the form dbtype:connectargs

func NewMiddleware() *Middleware

NewMiddleware return an initialized Middleware Object.

func (m *Middleware) AddDB(name, uri string) (err error)

AddDB adds an db connection to the middleware.

func (*Middleware) Defaults() middleware.Config

Defaults returns an default config for connections

func (m *Middleware) GetConn(name string) *pgxpool.Conn

GetConn returns a connection from the specified database or if not found one of the default database.

func (m *Middleware) Gin(c *gin.Context)

Gin is the Entrypoint for Gin.

func (m *Middleware) Setup(mc middleware.Config)

Setup adds the connections from the configfile into the middleware

func (m *Middleware) Sites(sites []interface{}) (err error)

Sites is an function for getting the migrations of the site

func (m *Middleware) Teardown()

Teardown closes the DBConnection

type MigrationSite interface {
	Database() string
	Migrations(*pgx.Conn) (*migrate.Migrator, error)
}

MigrationSite is an interface for Sites that use an database. this enables sites to provide database migrations.