model

Feb 18, 2022

Changes in this version

type Client

+ func (r *Client) With(fn func(*Tx) error, labels ...string) (err error)

type DB

+ With func(fn func(*Tx) error, labels ...string) error

Jan 18, 2022

Changes in this version

+ type FilterOptions struct

+ Detail int

+ Page *Page

+ Predicate Predicate

+ Sort []int

+ func (l *FilterOptions) Build(md *Definition) (err error)

+ func (l *FilterOptions) Fields() (filtered []*Field)

+ func (l *FilterOptions) Param(name string, value interface{}) (p string)

+ func (l *FilterOptions) Params() []interface{}

Sep 15, 2021

Changes in this version

+ var DefaultDetail = 1

+ var DetailErr = errors.New("detail level must be <= MaxDetail")

+ var DetailRegex = regexp.MustCompile(`(d)([0-9]+)`)

+ type DataModel struct

+ func NewModel(models []interface{}) (dm *DataModel, err error)

+ func (r *DataModel) Add(md *Definition)

+ func (r *DataModel) DDL() (list []string, err error)

+ func (r *DataModel) Definitions() (list Definitions)

+ func (r *DataModel) Deleted(tx *Tx, model interface{}) (cascaded fb.Iterator, err error)

+ func (r *DataModel) Find(kind string) (md *Definition, found bool)

+ func (r *DataModel) FindWith(model interface{}) (md *Definition, found bool)

+ type Definition struct

+ Fields []*Field

+ Kind string

+ func Inspect(model interface{}) (md *Definition, err error)

+ func (r *Definition) Field(name string) *Field

+ func (r *Definition) Fks() []*FK

+ func (r *Definition) IsKind(kind string) bool

+ func (r *Definition) KeyFields() []*Field

+ func (r *Definition) MutableFields() []*Field

+ func (r *Definition) NewModel() (m interface{})

+ func (r *Definition) PkField() *Field

+ func (r *Definition) RealFields(fields []*Field) []*Field

+ type Definitions []*Definition

+ func (r *Definitions) Append(md *Definition)

+ func (r *Definitions) Delete(index int)

+ func (r *Definitions) Head(delete bool) (md *Definition)

+ func (r *Definitions) Pop() (md *Definition)

+ func (r *Definitions) Push(md *Definition)

+ func (r *Definitions) Reverse()

+ func (r *Definitions) Top() (md *Definition)

type FK

+ Cascade bool

+ Must bool

+ Owner *Field

+ type FkRef struct

+ type FkRelation struct

+ func (r *FkRelation) DDL(md *Definition) (ddl []string, err error)

+ func (r *FkRelation) Definitions() (list Definitions)

+ func (r *FkRelation) Referencing(md *Definition) (list []*FkRef)

Aug 19, 2021

Changes in this version

type Event

+ Labels []string

+ func (r *Event) HasLabel(label string) bool

Jul 23, 2021

Changes in this version

type Client

+ func (r *Client) Find(model interface{}, options ListOptions) (itr fb.Iterator, err error)

type DB

+ Find func(interface{}, ListOptions) (fb.Iterator, error)

type Table

+ func (t Table) Find(model interface{}, options ListOptions) (itr fb.Iterator, err error)

type Tx

+ func (r *Tx) Find(model interface{}, options ListOptions) (itr fb.Iterator, err error)

Jul 20, 2021

Changes in this version

type Journal

+ func (r *Journal) Report(staged *fb.List)

+ type Pool struct

+ func (p *Pool) Close() (err error)

+ func (p *Pool) Open(nWriter, nReader int, path string, journal *Journal) (err error)

+ func (p *Pool) Reader() *Session

+ func (p *Pool) Writer() *Session

+ type Session struct

+ func (s *Session) Begin() (tx *sql.Tx, err error)

+ func (s *Session) Return()

type Tx

+ func (r *Tx) Execute(sql string) (result sql.Result, err error)

Jun 21, 2021

Changes in this version

+ const MaxDetail

+ var PkRegex = regexp.MustCompile(`(pk)((\()(.+)(\)))?`)

type Field

+ Type *reflect.StructField

+ func (f *Field) Incremented() bool

+ func (f *Field) WithFields() (withFields map[string]bool)

+ type Labeled interface

+ Labels func() Labels

type Table

+ func (t Table) EnsurePk(fields []*Field)

Jun 7, 2021

Changes in this version

type EventHandler

+ Options func() WatchOptions

type StockEventHandler

+ func (r *StockEventHandler) Options() WatchOptions

+ type WatchOptions struct

+ Snapshot bool

Apr 23, 2021

Changes in this version

+ var IndexRegex = regexp.MustCompile(`(index)(\()(.+)(\))`)

type Client

+ func (r *Client) Execute(sql string) (sql.Result, error)

type DB

+ Execute func(sql string) (sql.Result, error)

type Field

+ func (f *Field) Index() []string

type Table

+ func (t Table) IndexDDL(model interface{}, fields []*Field) (list []string, err error)

+ func (t Table) KeyIndexDDL(model interface{}, fields []*Field) (list []string, err error)

+ func (t Table) TableDDL(model interface{}, fields []*Field) (list []string, err error)

type TmplData

+ Index string

Apr 20, 2021

Changes in this version

+ func Describe(model Model) string

type Tx

+ func (r *Tx) Iter(model interface{}, options ListOptions) (itr fb.Iterator, err error)

Apr 16, 2021

Changes in this version

+ var Started uint8 = 0x00

type Event

+ ID uint64

+ func (r *Event) String() string

+ type Serial struct

type Watch

+ func (w *Watch) String() string

Apr 13, 2021

Changes in this version

type Client

+ func (r *Client) Iter(model interface{}, options ListOptions) (fb.Iterator, error)

type DB

+ Iter func(interface{}, ListOptions) (fb.Iterator, error)

type Journal

+ func (r *Journal) Committed()

+ func (r *Journal) Reset()

type Table

+ func (t Table) Iter(model interface{}, options ListOptions) (itr fb.Iterator, err error)

Mar 29, 2021

Changes in this version

+ var End int8 = 0x02

+ var Error int8 = 0x01

type Journal

+ func (r *Journal) Close() (err error)

+ type StockEventHandler struct

+ func (r *StockEventHandler) Created(Event)

+ func (r *StockEventHandler) Deleted(Event)

+ func (r *StockEventHandler) End()

+ func (r *StockEventHandler) Error(error)

+ func (r *StockEventHandler) Parity()

+ func (r *StockEventHandler) Started()

+ func (r *StockEventHandler) Updated(Event)

type Watch

+ func (w *Watch) Alive() bool

Mar 18, 2021

Changes in this version

+ var Parity int8 = 0x00

type EventHandler

+ Parity func()

type StubEventHandler

+ func (r *StubEventHandler) Parity()

Feb 2, 2021

Changes in this version

type EventHandler

+ Started func()

+ type StubEventHandler struct

+ func (r *StubEventHandler) Created(Event)

+ func (r *StubEventHandler) Deleted(Event)

+ func (r *StubEventHandler) End()

+ func (r *StubEventHandler) Error(error)

+ func (r *StubEventHandler) Started()

+ func (r *StubEventHandler) Updated(Event)

Jan 27, 2021

Changes in this version

type Model

+ func Clone(model Model) Model

Jan 12, 2021

Changes in this version

type Field

+ func (f *Field) Detail() (level int)

+ func (f *Field) Encoded() (encoded bool)

+ func (f *Field) MatchDetail(level int) bool

+ func (f *Field) Virtual() bool

type ListOptions

+ Detail int

+ func (l *ListOptions) Fields() (filtered []*Field)

type Table

+ func (t Table) RealFields(fields []*Field) []*Field

Nov 23, 2020

Changes in this version

type Client

+ func (r *Client) EndWatch(watch *Watch)

type DB

+ EndWatch func(watch *Watch)

+ type Labeler struct

+ func (r *Labeler) Delete(table Table, model Model) error

+ func (r *Labeler) Insert(table Table, model Model) error

+ func (r *Labeler) Replace(table Table, model Model) error

type Tx

+ func (r *Tx) Count(model Model, predicate Predicate) (int64, error)

+ func (r *Tx) Delete(model Model) error

+ func (r *Tx) Get(model Model) error

+ func (r *Tx) Insert(model Model) error

+ func (r *Tx) List(list interface{}, options ListOptions) error

+ func (r *Tx) Update(model Model) error

Sep 21, 2020

Changes in this version

+ const Pragma

+ const Tag

+ var Created int8 = 0x01

+ var DeleteSQL = ...

+ var Deleted int8 = 0x04

+ var FieldTypeErr = errors.New("field type must be (int, str, bool")

+ var FkRegex = regexp.MustCompile(`(fk):(.+)(\()(.+)(\))`)

+ var GenPkTypeErr = errors.New("PK field must be `str` when generated")

+ var GetSQL = ...

+ var IndexDDL = ...

+ var InsertSQL = ...

+ var LabelSQL = ...

+ var ListSQL = ...

+ var MustBeObjectErr = errors.New("must be object")

+ var MustBePtrErr = errors.New("must be pointer")

+ var MustBeSlicePtrErr = errors.New("must be slice pointer")

+ var MustHavePkErr = errors.New("must have PK field")

+ var NotFound = sql.ErrNoRows

+ var PkTypeErr = errors.New("pk field must be (int, str)")

+ var PredicateRefErr = errors.New("predicate referenced unknown field")

+ var PredicateTypeErr = errors.New("predicate type not valid for field")

+ var PredicateValueErr = errors.New("predicate value not valid")

+ var TableDDL = ...

+ var TxInvalidError = errors.New("transaction not valid")

+ var UniqueRegex = regexp.MustCompile(`(unique)(\()(.+)(\))`)

+ var UpdateSQL = ...

+ var Updated int8 = 0x02

+ type AndPredicate struct

+ func And(predicates ...Predicate) *AndPredicate

+ func (p *AndPredicate) Build(options *ListOptions) error

+ func (p *AndPredicate) Expr() string

+ type Base struct

+ Object string

+ PK string

+ func (m *Base) Pk() string

+ type Client struct

+ func (r *Client) Begin() (*Tx, error)

+ func (r *Client) Close(purge bool) error

+ func (r *Client) Count(model Model, predicate Predicate) (int64, error)

+ func (r *Client) Delete(model Model) error

+ func (r *Client) Get(model Model) error

+ func (r *Client) GetForUpdate(model Model) (*Tx, error)

+ func (r *Client) Insert(model Model) error

+ func (r *Client) Journal() *Journal

+ func (r *Client) List(list interface{}, options ListOptions) error

+ func (r *Client) Open(purge bool) error

+ func (r *Client) Update(model Model) error

+ func (r *Client) Watch(model Model, handler EventHandler) (*Watch, error)

+ type CompoundPredicate struct

+ Predicates []Predicate

+ type DB interface

+ Begin func() (*Tx, error)

+ Close func(bool) error

+ Count func(Model, Predicate) (int64, error)

+ Delete func(Model) error

+ Get func(Model) error

+ GetForUpdate func(Model) (*Tx, error)

+ Insert func(Model) error

+ Journal func() *Journal

+ List func(interface{}, ListOptions) error

+ Open func(bool) error

+ Update func(Model) error

+ Watch func(Model, EventHandler) (*Watch, error)

+ func New(path string, models ...interface{}) DB

+ type DBTX interface

+ Exec func(string, ...interface{}) (sql.Result, error)

+ Query func(string, ...interface{}) (*sql.Rows, error)

+ QueryRow func(string, ...interface{}) *sql.Row

+ type EqPredicate struct

+ func Eq(field string, value interface{}) *EqPredicate

+ func (p *EqPredicate) Build(options *ListOptions) error

+ func (p *EqPredicate) Expr() string

+ type Event struct

+ Action int8

+ Model Model

+ Updated Model

+ type EventHandler interface

+ Created func(Event)

+ Deleted func(Event)

+ End func()

+ Error func(error)

+ Updated func(Event)

+ type FK struct

+ Field string

+ Table string

+ func (f *FK) DDL(field *Field) string

+ type Field struct

+ Name string

+ Tag string

+ Value *reflect.Value

+ func (f *Field) AsValue(object interface{}) (value interface{}, err error)

+ func (f *Field) DDL() string

+ func (f *Field) Fk() *FK

+ func (f *Field) Key() bool

+ func (f *Field) Mutable() bool

+ func (f *Field) Param() string

+ func (f *Field) Pk() bool

+ func (f *Field) Ptr() interface{}

+ func (f *Field) Pull() interface{}

+ func (f *Field) Push()

+ func (f *Field) Unique() []string

+ func (f *Field) Validate() error

+ type GtPredicate struct

+ func Gt(field string, value interface{}) *GtPredicate

+ func (p *GtPredicate) Build(options *ListOptions) error

+ func (p *GtPredicate) Expr() string

+ type Journal struct

+ func (r *Journal) Commit()

+ func (r *Journal) Created(model Model)

+ func (r *Journal) Deleted(model Model)

+ func (r *Journal) Disable()

+ func (r *Journal) Enable()

+ func (r *Journal) Enabled() bool

+ func (r *Journal) End(watch *Watch)

+ func (r *Journal) Unstage()

+ func (r *Journal) Updated(model Model, updated Model)

+ func (r *Journal) Watch(model Model, handler EventHandler) (*Watch, error)

+ type Label struct

+ Kind string

+ Name string

+ PK string

+ Parent string

+ Value string

+ func (l *Label) Equals(other Model) bool

+ func (l *Label) Labels() Labels

+ func (l *Label) Pk() string

+ func (l *Label) String() string

+ type LabelPredicate struct

+ func Match(labels Labels) *LabelPredicate

+ func (p *LabelPredicate) Build(options *ListOptions) error

+ func (p *LabelPredicate) Expr() string

+ func (p *LabelPredicate) Kind() string

+ func (p *LabelPredicate) Len() int

+ func (p *LabelPredicate) List() []Label

+ func (p *LabelPredicate) Pk() *Field

+ type Labels map[string]string

+ type ListOptions struct

+ Page *Page

+ Predicate Predicate

+ Sort []int

+ func (l *ListOptions) Build(table string, fields []*Field) error

+ func (l *ListOptions) Param(name string, value interface{}) string

+ func (l *ListOptions) Params() []interface{}

+ type LtPredicate struct

+ func Lt(field string, value interface{}) *LtPredicate

+ func (p *LtPredicate) Build(options *ListOptions) error

+ func (p *LtPredicate) Expr() string

+ type Model interface

+ Equals func(other Model) bool

+ Labels func() Labels

+ Pk func() string

+ String func() string

+ type NeqPredicate struct

+ func Neq(field string, value interface{}) *NeqPredicate

+ func (p *NeqPredicate) Build(options *ListOptions) error

+ func (p *NeqPredicate) Expr() string

+ type OrPredicate struct

+ func Or(predicates ...Predicate) *OrPredicate

+ func (p *OrPredicate) Build(options *ListOptions) error

+ func (p *OrPredicate) Expr() string

+ type Page struct

+ Limit int

+ Offset int

+ func (p *Page) Slice(collection interface{})

+ type Predicate interface

+ Build func(*ListOptions) error

+ Expr func() string

+ type Row interface

+ Scan func(...interface{}) error

+ type SimplePredicate struct

+ Field string

+ Value interface{}

+ type Table struct

+ DB DBTX

+ func (t Table) Constraints(fields []*Field) []string

+ func (t Table) Count(model interface{}, predicate Predicate) (int64, error)

+ func (t Table) DDL(model interface{}) ([]string, error)

+ func (t Table) Delete(model interface{}) error

+ func (t Table) Fields(model interface{}) ([]*Field, error)

+ func (t Table) Get(model interface{}) error

+ func (t Table) Insert(model interface{}) error

+ func (t Table) KeyFields(fields []*Field) []*Field

+ func (t Table) List(list interface{}, options ListOptions) error

+ func (t Table) MutableFields(fields []*Field) []*Field

+ func (t Table) Name(model interface{}) string

+ func (t Table) Params(fields []*Field) []interface{}

+ func (t Table) PkField(fields []*Field) *Field

+ func (t Table) SetPk(fields []*Field) error

+ func (t Table) Update(model interface{}) error

+ func (t Table) Validate(fields []*Field) error

+ type TmplData struct

+ Constraints []string

+ Count bool

+ Fields []*Field

+ Keys []*Field

+ Options *ListOptions

+ Pk *Field

+ Table string

+ func (t TmplData) Page() *Page

+ func (t TmplData) Predicate() Predicate

+ func (t TmplData) Sort() []int

+ type Tx struct

+ func (r *Tx) Commit() error

+ func (r *Tx) End() error

+ type Watch struct

+ Handler EventHandler

+ Model Model

+ func (w *Watch) End()

+ func (w *Watch) Match(model Model) bool

+ func (w *Watch) Start()