sql

package module
v2.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 20, 2022 License: MIT Imports: 12 Imported by: 2

README

GoZix SQL

Dependencies

Configuration example

{
  "sql": {
    "default": {
      "nodes": [
        "postgres://app:password@127.0.0.1:5432/app?sslmode=disable"
      ],
      "driver": "postgres",
      "max_open_conns": 10,
      "max_idle_conns": 10,
      "conn_max_lifetime": "10m"
    }
  }
}

Documentation

Index

Constants

View Source 
const BundleName = "sql"

BundleName is default definition name.

View Source 
const DEFAULT = "default"

DEFAULT is default connection name.

Variables

View Source 
var (
	// ErrUnknownConnection is error triggered when connection with provided name not founded.
	ErrUnknownConnection = errors.New("unknown connection")
)

Functions

This section is empty.

Types

type Bundle 

type Bundle struct{}

Bundle implements the glue.Bundle interface.

func NewBundle 

func NewBundle() *Bundle

NewBundle create bundle instance.

func (*Bundle) Build 

func (b *Bundle) Build(builder *di.Builder) error

Build implements the glue.Bundle interface.

func (*Bundle) DependsOn 

func (b *Bundle) DependsOn() []string

DependsOn implements the glue.DependsOn interface.

func (*Bundle) Name 

func (b *Bundle) Name() string

Key implements the glue.Bundle interface.

type Config 

type Config struct {
	Nodes           []string                      `json:"nodes"`
	Driver          string                        `json:"driver"`
	MaxOpenConns    int                           `json:"max_open_conns"`
	MaxIdleConns    int                           `json:"max_idle_conns"`
	ConnMaxLifetime time.Duration                 `json:"conn_max_lifetime"`
	AfterOpen       func(name string, db *nap.DB) `json:"-"`
}

Config is registry configuration item.

type Configs 

type Configs map[string]Config

Configs is registry configurations.

type DB 

type DB = nap.DB

DB is type alias to nap.DB.

type Registry 

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

Registry is database connection registry.

func NewRegistry 

func NewRegistry(conf Configs) (*Registry, error)

NewRegistry is registry constructor.

func (*Registry) Close 

func (r *Registry) Close() (err error)

Close is method for close connections.

func (*Registry) Connection 

func (r *Registry) Connection() (*nap.DB, error)

Connection is default connection getter.

func (*Registry) ConnectionWithName 

func (r *Registry) ConnectionWithName(name string) (_ *nap.DB, err error)

ConnectionWithName is connection getter by name.

func (*Registry) Driver 

func (r *Registry) Driver() (string, error)

Driver is default connection driver name getter.

func (*Registry) DriverWithName 

func (r *Registry) DriverWithName(name string) (string, error)

DriverWithName is driver name getter by name.

type Row 

type Row = sql.Row

Row is type alias of sql.Row.

type Rows 

type Rows = sql.Rows

Rows is type alias of sql.Row.

Source Files

View all Source files

Directories

Path Synopsis
internal
metric
Package metric describes prom collector for getting metrics from sql.DB
 Package metric describes prom collector for getting metrics from sql.DB

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.