db

package

v0.3.2 Latest Latest Go to latest Published: Jul 1, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

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/raystack/salt

Links

Open Source Insights

Documentation ¶

Index ¶

func RunMigrations(config Config, embeddedMigrations fs.FS, resourcePath string) error
func RunRollback(config Config, embeddedMigrations fs.FS, resourcePath string) error
type Client
- func New(cfg Config) (*Client, error)
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RunMigrations ¶

func RunMigrations(config Config, embeddedMigrations fs.FS, resourcePath string) error

func RunRollback ¶

func RunRollback(config Config, embeddedMigrations fs.FS, resourcePath string) error

Types ¶

type Client ¶

type Client struct {
	*sqlx.DB
	// contains filtered or unexported fields
}

func New ¶

func New(cfg Config) (*Client, error)

NewClient creates a new sqlx database client

func (*Client) Close ¶

func (c *Client) Close() error

Close closes the database connection

func (*Client) ConnectionURL ¶ added in v0.3.2

func (c *Client) ConnectionURL() string

ConnectionURL fetch the database connection url

func (Client) WithTimeout ¶

func (c Client) WithTimeout(ctx context.Context, op func(ctx context.Context) error) (err error)

func (Client) WithTxn ¶

func (c Client) WithTxn(ctx context.Context, txnOptions sql.TxOptions, txFunc func(*sqlx.Tx) error) (err error)

type Config ¶

type Config struct {
	Driver          string        `yaml:"driver" mapstructure:"driver"`
	URL             string        `yaml:"url" mapstructure:"url"`
	MaxIdleConns    int           `yaml:"max_idle_conns" mapstructure:"max_idle_conns" default:"10"`
	MaxOpenConns    int           `yaml:"max_open_conns" mapstructure:"max_open_conns" default:"10"`
	ConnMaxLifeTime time.Duration `yaml:"conn_max_life_time" mapstructure:"conn_max_life_time" default:"10ms"`
	MaxQueryTimeout time.Duration `yaml:"max_query_timeout" mapstructure:"max_query_timeout" default:"100ms"`
}

Source Files ¶

View all Source files

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