middleware

Documentation

Overview

Package middleware provides hooks that are called when executing sql queries.

Index

• func NewContext(ctx context.Context, queryName string) context.Context
• type End
• type Middleware
  • func (m Middleware) After(ctx context.Context, query string, args ...interface{}) (context.Context, error)
  • func (m Middleware) Before(ctx context.Context, query string, args ...interface{}) (context.Context, error)
  • func (m Middleware) OnError(ctx context.Context, queryErr error, query string, args ...interface{}) error
• type Start

Functions

func NewContext

func NewContext(ctx context.Context, queryName string) context.Context

NewContext returns a SQL middleware context with the query name embedded in it for downstream middleware. All contexts passed into the SQL middleware chain must have first called this function

Types

type End

type End func(ctx context.Context, queryName, query string, queryErr error, args ...interface{}) (context.Context, error)

End is called after the SQL query has completed

type Middleware

type Middleware []Start

Middleware aliases a list of SQL Middleware

func (Middleware) After

func (m Middleware) After(ctx context.Context, query string, args ...interface{}) (context.Context, error)

After satisfies the sqlhooks interface for hooks called after the query has completed

func (Middleware) Before

func (m Middleware) Before(ctx context.Context, query string, args ...interface{}) (context.Context, error)

Before satisfies the sqlhooks interface for hooks called before the query is executed

func (Middleware) OnError

func (m Middleware) OnError(ctx context.Context, queryErr error, query string, args ...interface{}) error

OnError satisfies the sqlhooks interface for hooks called when a query errors

type Start

type Start func(ctx context.Context, queryName, query string, args ...interface{}) (context.Context, End, error)

Start is called before the SQL query has started