sqlcon

Documentation

Index

• Variables
• func HandleError(err error) error
• func HelpMessage() string
• func MigratorSQLCmd(path, name string, logger logrus.FieldLogger, runners map[string]SchemaCreator) *cobra.Command
• type Opt
  • func WithAllowRoot() Opt
  • func WithDistributedTracing() Opt
  • func WithOmitArgsFromTraceSpans() Opt
  • func WithRandomDriverName() Opt
• type SQLConnection
  • func NewSQLConnection(db string, l logrus.FieldLogger, opts ...Opt) (*SQLConnection, error)
  • func (c *SQLConnection) GetDatabase() *sqlx.DB
  • func (c *SQLConnection) GetDatabaseRetry(maxWait time.Duration, failAfter time.Duration) (*sqlx.DB, error)
• type SchemaCreator

Variables

var (
	ErrUniqueViolation = &herodot.DefaultError{
		CodeField:   http.StatusConflict,
		StatusField: http.StatusText(http.StatusConflict),
		ErrorField:  "Unable to insert or update resource because a resource with that value exists already",
	}
	ErrNoRows = &herodot.DefaultError{
		CodeField:   http.StatusNotFound,
		StatusField: http.StatusText(http.StatusNotFound),
		ErrorField:  "Unable to locate the resource",
	}
)

Functions

func HandleError

func HandleError(err error) error

func HelpMessage

func HelpMessage() string

func MigratorSQLCmd

func MigratorSQLCmd(path, name string, logger logrus.FieldLogger, runners map[string]SchemaCreator) *cobra.Command

Types

type Opt

type Opt func(*options)

func WithAllowRoot

func WithAllowRoot() Opt

WithAllowRoot will make it so that root spans will be created if a trace could not be found using opentracing's SpanFromContext method

func WithDistributedTracing

func WithDistributedTracing() Opt

WithDistributedTracing will make it so that a wrapped driver is used that supports the opentracing API

func WithOmitArgsFromTraceSpans

func WithOmitArgsFromTraceSpans() Opt

WithOmitArgsFromTraceSpans will make it so that query arguments are omitted from tracing spans

func WithRandomDriverName

func WithRandomDriverName() Opt

This option is specifically for writing tests as you can't register a driver with the same name more than once

type SQLConnection

type SQLConnection struct {
	URL *url.URL
	L   logrus.FieldLogger
	// contains filtered or unexported fields
}

func NewSQLConnection

func NewSQLConnection(db string, l logrus.FieldLogger, opts ...Opt) (*SQLConnection, error)

func (*SQLConnection) GetDatabase

func (c *SQLConnection) GetDatabase() *sqlx.DB

func (*SQLConnection) GetDatabaseRetry

func (c *SQLConnection) GetDatabaseRetry(maxWait time.Duration, failAfter time.Duration) (*sqlx.DB, error)

type SchemaCreator

type SchemaCreator interface {
	CreateSchemas(db *sqlx.DB) (int, error)
}