sqlc

Documentation

Index

• Variables
• type CacheFn
• type CachedConn
  • func NewConn(db *sqlx.DB, c cache.CacheConf, opts ...cache.Option) CachedConn
  • func NewConnWithCache(db *sqlx.DB, c cache.Cache) CachedConn
  • func NewNodeConn(db *sqlx.DB, rds *redis.Redis, opts ...cache.Option) CachedConn
  • func (cc CachedConn) DelCache(ctx context.Context, keys ...string) error
  • func (cc CachedConn) Exec(ctx context.Context, exec ExecFn, keys ...string) (lastInsertId, rowsAffected int64, err error)
  • func (cc CachedConn) ExecNoCache(ctx context.Context, q string, args ...interface{}) (sql.Result, error)
  • func (cc CachedConn) GetCache(ctx context.Context, key string, v interface{}) error
  • func (cc CachedConn) QueryRow(ctx context.Context, v interface{}, key string, query QueryFn) error
  • func (cc CachedConn) QueryRowIndex(ctx context.Context, v interface{}, key string, ...) error
  • func (cc CachedConn) QueryRowNoCache(ctx context.Context, v interface{}, q string, args ...interface{}) error
  • func (cc CachedConn) QueryRows(ctx context.Context, query KeysQueryFn, calVal CacheFn, keys ...string) error
  • func (cc CachedConn) QueryRowsNoCache(ctx context.Context, v interface{}, q string, args ...interface{}) error
  • func (cc CachedConn) SetCache(ctx context.Context, key string, val interface{}) error
  • func (cc CachedConn) Transact(ctx context.Context, fn func(c *sqlx.Tx) error) error
• type ExecFn
• type IndexQueryFn
• type KeysQueryFn
• type PrimaryQueryFn
• type QueryFn

Variables

var (
	// ErrNotFound is an alias of sqlx.ErrNotFound.
	ErrNotFound = sqlx.ErrNotFound
)

Types

type CacheFn

type CacheFn func(k, v string) (interface{}, error)

type CachedConn

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

A CachedConn is a DB connection with cache capability.

func NewConn

func NewConn(db *sqlx.DB, c cache.CacheConf, opts ...cache.Option) CachedConn

NewConn returns a CachedConn with a redis cluster cache.

func NewConnWithCache

func NewConnWithCache(db *sqlx.DB, c cache.Cache) CachedConn

NewConnWithCache returns a CachedConn with a custom cache.

func NewNodeConn

func NewNodeConn(db *sqlx.DB, rds *redis.Redis, opts ...cache.Option) CachedConn

NewNodeConn returns a CachedConn with a redis node cache.

func (CachedConn) DelCache

func (cc CachedConn) DelCache(ctx context.Context, keys ...string) error

DelCache deletes cache with keys.

func (CachedConn) Exec

func (cc CachedConn) Exec(ctx context.Context, exec ExecFn, keys ...string) (lastInsertId, rowsAffected int64, err error)

Exec runs given exec on given keys, and returns execution result.

func (CachedConn) ExecNoCache

func (cc CachedConn) ExecNoCache(ctx context.Context, q string, args ...interface{}) (
	sql.Result, error)

ExecNoCache runs exec with given sql statement, without affecting cache.

func (CachedConn) GetCache

func (cc CachedConn) GetCache(ctx context.Context, key string, v interface{}) error

GetCache unmarshals cache with given key into v.

func (CachedConn) QueryRow

func (cc CachedConn) QueryRow(ctx context.Context, v interface{}, key string, query QueryFn) error

QueryRow unmarshals into v with given key and query func.

func (CachedConn) QueryRowIndex

func (cc CachedConn) QueryRowIndex(ctx context.Context, v interface{}, key string,
	keyer func(primary interface{}) string, indexQuery IndexQueryFn,
	primaryQuery PrimaryQueryFn) error

QueryRowIndex unmarshals into v with given key.

func (CachedConn) QueryRowNoCache

func (cc CachedConn) QueryRowNoCache(ctx context.Context, v interface{}, q string,
	args ...interface{}) error

QueryRowNoCache unmarshals into v with given statement.

func (CachedConn) QueryRows

func (cc CachedConn) QueryRows(ctx context.Context, query KeysQueryFn, calVal CacheFn, keys ...string) error

QueryRows unmarshals into v with given key and query func.

func (CachedConn) QueryRowsNoCache

func (cc CachedConn) QueryRowsNoCache(ctx context.Context, v interface{}, q string,
	args ...interface{}) error

QueryRowsNoCache unmarshals into v with given statement. It doesn't use cache, because it might cause consistency problem.

func (CachedConn) SetCache

func (cc CachedConn) SetCache(ctx context.Context, key string, val interface{}) error

SetCache sets v into cache with given key.

func (CachedConn) Transact

func (cc CachedConn) Transact(ctx context.Context, fn func(c *sqlx.Tx) error) error

Transact runs given fn in transaction mode.

type ExecFn

type ExecFn func(ctx context.Context, conn *sqlx.DB) (int64, int64, error)

ExecFn defines the sql exec method.

type IndexQueryFn

type IndexQueryFn func(ctx context.Context, conn *sqlx.DB, v interface{}) (interface{}, error)

IndexQueryFn defines the query method that based on unique indexes.

type KeysQueryFn

type KeysQueryFn func(ctx context.Context, conn *sqlx.DB, keys ...string) (map[string]interface{}, error)

type PrimaryQueryFn

type PrimaryQueryFn func(ctx context.Context, conn *sqlx.DB, v, primary interface{}) error

PrimaryQueryFn defines the query method that based on primary keys.

type QueryFn

type QueryFn func(ctx context.Context, conn *sqlx.DB, v interface{}) error

QueryFn defines the query method.