db

Documentation

Index

• func Create(url string) error
• func Drop(url string) error
• func GenerateMigration(name string, options ...migrationOption) error
• func RunMigrations(fs embed.FS, conn *sqlx.DB) error
• func UseMigrationFolder(folder string) migrationOption
• func WithDriver(name string) connectionOption
• type ConnFn
  • func ConnectionFn(url string, opts ...connectionOption) ConnFn

Functions

func Create

func Create(url string) error

Creates the database.

func Drop

func Drop(url string) error

Creates the database.

func GenerateMigration

func GenerateMigration(name string, options ...migrationOption) error

GenerateMigration in the migrations folder using the migrations template

func RunMigrations

func RunMigrations(fs embed.FS, conn *sqlx.DB) error

func UseMigrationFolder

func UseMigrationFolder(folder string) migrationOption

UseMigrationFolder sets the folder for migrations

func WithDriver

func WithDriver(name string) connectionOption

Types

type ConnFn

type ConnFn func() (*sqlx.DB, error)

ConnFn is the database connection builder function that will be used by the application based on the driver and connection string.

func ConnectionFn

func ConnectionFn(url string, opts ...connectionOption) ConnFn

ConnectionFn is the database connection builder function that will be used by the application based on the driver and connection string. It opens the connection only once and return the same connection on subsequent calls.