db

package

v1.3.0 Latest Latest Go to latest Published: Apr 25, 2024 License: MIT Imports: 12 Imported by: 3

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/leapkit/core

Links

Open Source Insights

Documentation ¶

Index ¶

func Create(url string) error
func Drop(url string) error
func GenerateMigration(name string, options ...migrations.Option) error
func RunMigrations(fs embed.FS, conn *sqlx.DB) error
func WithDriver(name string) connectionOption
type ConnFn
- func ConnectionFn(url string, opts ...connectionOption) ConnFn
type Manager

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Create ¶

func Create(url string) error

Create a new database based on the passed URL.

func GenerateMigration ¶

func GenerateMigration(name string, options ...migrations.Option) error

GenerateMigration in the migrations folder using the migrations template

func RunMigrations ¶

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

RunMigrations by checking in the migrations database table, each of the adapters take care of this.

func WithDriver ¶

func WithDriver(name string) connectionOption

WithDriver allows to specify the driver to use driver defaults to postgres.

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.

type Manager ¶ added in v1.2.10

type Manager interface {
	Create() error
	Drop() error
}

Manager is the interface that wraps the basic methods to create and drop a database.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
migrations
postgres
sqlite

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