db

Documentation

Index

• func ByID(tbl Table, idv ...string) error
• func Db() *sql.DB
• func FindOptionsFactory(tbl Table, uid string, param url.Values, idv []string) (*FindOptions, *ParamError)
• func Init() error
• func Pk(tbl Table) (f []string)
• func TaggedFields(tbl Table, tagName string, tagValues []string) ([]string, error)
• type BaseTable
  • func (BaseTable) Dig()
  • func (BaseTable) Scope(uid string, t ...Table) map[string]string
• type ConflictError
• type FetchOptions
  • func FetchOptionsFactory(tbl Table, uid string, param url.Values, parents ...Table) *FetchOptions
• type FetchResultSetMeta
  • func Fetch(fo *FetchOptions) (FetchResultSetMeta, []interface{}, error)
• type FindOptions
• type FindResultSetMeta
  • func Find(fo *FindOptions) (FindResultSetMeta, interface{}, error)
• type NotAllowedError
• type NotFoundError
• type ParamError
• type Table
• type TableMeta
  • func GetTableMeta(tbl Table) (meta TableMeta)

Functions

func ByID

func ByID(tbl Table, idv ...string) error

ByID exported

func Db

func Db() *sql.DB

Db returns the db handler

func FindOptionsFactory

func FindOptionsFactory(tbl Table, uid string, param url.Values, idv []string) (*FindOptions, *ParamError)

FindOptionsFactory exported

func Init

func Init() error

Init tests the db connection and saves the db handler

func Pk

func Pk(tbl Table) (f []string)

Returns a slice of db fields tagged as `pk:"1"`

func TaggedFields

func TaggedFields(tbl Table, tagName string, tagValues []string) ([]string, error)

TaggedFields returns a slice of db fields sharing a tag name (tn) such fields must be tagged as tn:"tv" the tagName value is passed in the tn parameter tagValues options are passed in the tv parameter ie.:

type User struct {
	 UserID    int64     `db:"user_id"   auth:"id"    json:"user_id"   pk:"1"`
	 RoleID    *int64    `db:"role_id"   auth:"role"  json:"role_id"`
	 Email     string    `db:"email"     auth:"usr"   json:"email"`
}

v ar m User f, _ := TaggedFields(m, "auth", []string{"id","role","usr"}) f -> []string{"user_id","role_id","email"}

Types

type BaseTable

type BaseTable struct{}

func (BaseTable) Dig

func (BaseTable) Dig()

Dig exported

func (BaseTable) Scope

func (BaseTable) Scope(uid string, t ...Table) map[string]string

Scope exported

type ConflictError

type ConflictError struct {
	msg.Message
}

ConflictError exported

type FetchOptions

type FetchOptions struct {
	Table            Table
	UID              string  // ID from jwt, used to set scope in find, fetch, etc.
	Parents          []Table // Also used to set scope in find, fetch, etc.
	Column           []string
	IsNull           []string
	IsNotNull        []string
	In               map[string][]interface{}
	NotIn            map[string][]interface{}
	Equal            map[string]string
	NotEqual         map[string]string
	GreaterThan      map[string]string
	LessThan         map[string]string
	GreaterEqualThan map[string]string
	LessEqualThan    map[string]string
	Order            []string
	Offset           int
	Limit            int
	Checksum         int
	Dig              int // Flag used to include (or not) parent data in find, fetch, etc.
}

FetchOptions exported

func FetchOptionsFactory

func FetchOptionsFactory(tbl Table, uid string, param url.Values, parents ...Table) *FetchOptions

FetchOptionsFactory exported

type FetchResultSetMeta

type FetchResultSetMeta struct {
	Range    string
	Checksum string
}

FetchResultSetMeta exported

func Fetch

func Fetch(fo *FetchOptions) (FetchResultSetMeta, []interface{}, error)

Fetch exported

type FindOptions

type FindOptions struct {
	Table    Table
	Where    map[string]string
	Checksum int
	Dig      int
	UID      string
}

FindOptions exported

type FindResultSetMeta

type FindResultSetMeta struct {
	Checksum string
}

FindResultSetMeta exported

func Find

func Find(fo *FindOptions) (FindResultSetMeta, interface{}, error)

Find exported

type NotAllowedError

type NotAllowedError struct {
	msg.Message
}

NotAllowedError exported

type NotFoundError

type NotFoundError struct {
	msg.Message
}

NotFoundError exported

type ParamError

type ParamError struct {
	msg.Message
}

ParamError exported

type Table

type Table interface {

	// Must return the table name
	Name() string

	// Must attach foreign table data if available
	Dig()

	// Must set conditions to filter out content
	// not intended for the user making the request
	Scope(uid string, t ...Table) map[string]string
}

Table exported

type TableMeta

type TableMeta struct {
	Fields   []string
	Primary  []string
	Serial   []string
	View     []string
	Writable []string
}

TableMeta exported

func GetTableMeta

func GetTableMeta(tbl Table) (meta TableMeta)

Returns the TableMeta object for tbl param. The underlying tbl struct must be properly annotated with Table related tags. TableMeta supports the tags: db, pk, view, serial.