postgresgorm

Documentation

Index

• func Bundle() sen.Plugin
• type Config
• type Plugin
  • func (p *Plugin) Initialize() error

Functions

func Bundle

func Bundle() sen.Plugin

Bundle is a sen.Plugin that provides both Config and gorm.DB for convenience.

Usage

app.With(postgresgorm.Bundle())

Types

type Config

type Config struct {
	DSN string `env:"POSTGRESQL_DSN,required"`
}

Config includes configuration to initialize a gorm.DB to a PostgreSQL server.

type Plugin

type Plugin struct {
	Hub    sen.Hub `inject:"hub"`
	Config *Config `inject:"postgresgorm.config"`
}

Plugin is a plugin that provides an instance of gorm.DB. Check gorm.io to see how to use gorm to work with databases. The plugin requires Config is registered in advance.

Usage

app.With(&postgresgorm.Plugin{})

func (*Plugin) Initialize

func (p *Plugin) Initialize() error

Initialize creates a new instance of *gorm.DB with the given configuration. And then registers it into the application as `gorm`.