storage

Sep 11, 2023

Changes in this version

type Context

+ func (ctx *Context) Metrics() metrics.Metrics

+ func (ctx *Context) WithMetrics(m metrics.Metrics) *Context

+ type Iterator interface

+ Next func() (*Update, error)

+ type MakeDirer interface

+ MakeDir func(context.Context, Transaction, Path) error

type Store

+ Truncate func(context.Context, Transaction, TransactionParams, Iterator) error

type TransactionParams

+ BasePaths []string

+ RootOverwrite bool

+ type Update struct

+ IsPolicy bool

+ Path Path

+ Value []byte

Jul 27, 2019

retracted

Changes in this version

+ type Context struct

+ func NewContext() *Context

+ func (ctx *Context) Get(key interface{}) interface{}

+ func (ctx *Context) Put(key, value interface{})

type TransactionParams

+ Context *Context

type TriggerEvent

+ Context *Context

Feb 19, 2019

retracted

Changes in this version

+ func NonEmpty(ctx context.Context, store Store, txn Transaction) func([]string) (bool, error)

Apr 30, 2018

retracted

Changes in this version

type Path

+ func ParsePathEscaped(str string) (path Path, ok bool)

Apr 11, 2018

retracted

Changes in this version

+ const WriteConflictErr

+ func IsWriteConflictError(err error) bool

+ func MakeDir(ctx context.Context, store Store, txn Transaction, path Path) (err error)

Oct 10, 2017

retracted

Changes in this version

+ func Txn(ctx context.Context, store Store, params TransactionParams, ...) error

Jul 24, 2017

retracted

Changes in this version

+ func ReadOne(ctx context.Context, store Store, path Path) (interface{}, error)

+ func WriteOne(ctx context.Context, store Store, op PatchOp, path Path, value interface{}) error

+ type DataEvent struct

+ Data interface{}

+ Path Path

+ Removed bool

+ type PolicyEvent struct

+ Data []byte

+ ID string

+ Removed bool

type TriggerEvent

+ Data []DataEvent

+ Policy []PolicyEvent

+ type TriggerHandle interface

+ Unregister func(ctx context.Context, txn Transaction)

Jul 5, 2017

retracted

Changes in this version

+ const InvalidTransactionErr

+ const PolicyNotSupportedErr

+ var WriteParams = TransactionParams

+ func IsIndexingNotSupported(err error) bool

+ func IsInvalidTransaction(err error) bool

type Index

+ Lookup func(ctx context.Context, txn Transaction, value interface{}, iter IndexIterator) error

+ type IndexIterator func(*ast.ValueMap) error

+ type Indexing interface

+ Build func(ctx context.Context, txn Transaction, ref ast.Ref) (Index, error)

+ type IndexingNotSupported struct

+ func (IndexingNotSupported) Build(context.Context, Transaction, ast.Ref) (Index, error)

+ type Policy interface

+ DeletePolicy func(context.Context, Transaction, string) error

+ GetPolicy func(context.Context, Transaction, string) ([]byte, error)

+ ListPolicies func(context.Context, Transaction) ([]string, error)

+ UpsertPolicy func(context.Context, Transaction, string, []byte) error

+ type PolicyNotSupported struct

+ func (PolicyNotSupported) DeletePolicy(context.Context, Transaction, string) error

+ func (PolicyNotSupported) GetPolicy(context.Context, Transaction, string) ([]byte, error)

+ func (PolicyNotSupported) ListPolicies(context.Context, Transaction) ([]string, error)

+ func (PolicyNotSupported) UpsertPolicy(context.Context, Transaction, string, []byte) error

type Store

+ Abort func(ctx context.Context, txn Transaction)

+ Commit func(ctx context.Context, txn Transaction) error

+ NewTransaction func(ctx context.Context, params ...TransactionParams) (Transaction, error)

type TransactionParams

+ Write bool

type TriggerConfig

+ OnCommit func(ctx context.Context, txn Transaction, event TriggerEvent)

+ type TriggerEvent int

+ func (e *TriggerEvent) SetDataChanged()

+ func (e *TriggerEvent) SetPolicyChanged()

+ func (e TriggerEvent) DataChanged() bool

+ func (e TriggerEvent) IsZero() bool

+ func (e TriggerEvent) PolicyChanged() bool

Dec 20, 2016

retracted

Changes in this version

+ type Path []string

+ func MustParsePath(s string) Path

+ func NewPathForRef(ref ast.Ref) (path Path, err error)

+ func ParsePath(str string) (path Path, ok bool)

+ func (p Path) Compare(other Path) (cmp int)

+ func (p Path) Equal(other Path) bool

+ func (p Path) HasPrefix(other Path) bool

+ func (p Path) Ref(head *ast.Term) (ref ast.Ref)

+ func (p Path) String() string

type Storage

+ func (s *Storage) NewTransactionWithParams(ctx context.Context, params TransactionParams) (Transaction, error)

+ type TransactionParams struct

+ Paths []Path

+ func NewTransactionParams() TransactionParams

+ func (params TransactionParams) WithPaths(paths []Path) TransactionParams

Nov 7, 2016

retracted

Changes in this version

+ const IndexNotFoundErr

+ const IndexingNotSupportedErr

+ const InvalidPatchErr

+ const MountConflictErr

+ const TriggersNotSupportedErr

+ const WritesNotSupportedErr

+ func DeletePolicy(store *Storage, id string) error

+ func GetPolicy(store *Storage, id string) (*ast.Module, []byte, error)

+ func InsertPolicy(store *Storage, id string, mod *ast.Module, raw []byte, persist bool) error

+ func IsInvalidPatch(err error) bool

+ func ReadOrDie(store *Storage, path ast.Ref) interface

+ type Config struct

+ Builtin Store

+ PolicyDir string

+ func InMemoryConfig() Config

+ func InMemoryWithJSONConfig(data map[string]interface{}) Config

+ func (c Config) WithPolicyDir(dir string) Config

type DataStore

+ func NewDataStoreFromReader(r io.Reader) *DataStore

+ func (ds *DataStore) Begin(txn Transaction, refs []ast.Ref) error

+ func (ds *DataStore) Close(txn Transaction)

+ func (ds *DataStore) ID() string

+ func (ds *DataStore) Read(txn Transaction, path ast.Ref) (interface{}, error)

+ func (ds *DataStore) Register(id string, config TriggerConfig) error

+ func (ds *DataStore) SetMountPath(ref ast.Ref)

+ func (ds *DataStore) Unregister(id string)

+ func (ds *DataStore) Write(txn Transaction, op PatchOp, path ast.Ref, value interface{}) error

+ type Storage struct

+ func New(config Config) *Storage

+ func (s *Storage) BuildIndex(txn Transaction, ref ast.Ref) error

+ func (s *Storage) Close(txn Transaction)

+ func (s *Storage) DeletePolicy(txn Transaction, id string) error

+ func (s *Storage) GetPolicy(txn Transaction, id string) (*ast.Module, []byte, error)

+ func (s *Storage) Index(txn Transaction, ref ast.Ref, value interface{}, ...) error

+ func (s *Storage) IndexExists(ref ast.Ref) bool

+ func (s *Storage) InsertPolicy(txn Transaction, id string, module *ast.Module, raw []byte, persist bool) error

+ func (s *Storage) ListPolicies(txn Transaction) map[string]*ast.Module

+ func (s *Storage) Mount(backend Store, path ast.Ref) error

+ func (s *Storage) NewTransaction(refs ...ast.Ref) (Transaction, error)

+ func (s *Storage) Open() error

+ func (s *Storage) Read(txn Transaction, path ast.Ref) (interface{}, error)

+ func (s *Storage) Unmount(path ast.Ref) error

+ func (s *Storage) Write(txn Transaction, op PatchOp, ref ast.Ref, value interface{}) error

+ type Store interface

+ Begin func(txn Transaction, refs []ast.Ref) error

+ Close func(txn Transaction)

+ ID func() string

+ Read func(txn Transaction, ref ast.Ref) (interface{}, error)

+ Write func(txn Transaction, op PatchOp, ref ast.Ref, value interface{}) error

+ type Transaction interface

+ ID func() uint64

+ func NewTransactionOrDie(store *Storage, refs ...ast.Ref) Transaction

+ type Trigger interface

+ Register func(id string, config TriggerConfig) error

+ Unregister func(id string)

+ type TriggerCallback func(txn Transaction, op PatchOp, path []interface{}, value interface{}) error

+ type TriggerConfig struct

+ After TriggerCallback

+ Before TriggerCallback

+ type TriggersNotSupported struct

+ func (TriggersNotSupported) Register(string, TriggerConfig) error

+ func (TriggersNotSupported) Unregister(string)

+ type WritesNotSupported struct

+ func (WritesNotSupported) Write(txn Transaction, op PatchOp, ref ast.Ref, value interface{}) error

Jul 14, 2016

retracted

Changes in this version

+ const AddOp

+ const RemoveOp

+ const ReplaceOp

+ func Dump(ds *DataStore, w io.Writer) error

+ func IsNotFound(err error) bool

+ func LoadPolicies(bufs map[string][]byte) (map[string]*ast.Module, error)

+ type Bindings struct

+ func NewBindings() *Bindings

+ func (b *Bindings) Copy() *Bindings

+ func (b *Bindings) Delete(k ast.Value)

+ func (b *Bindings) Equal(other *Bindings) bool

+ func (b *Bindings) Get(k ast.Value) ast.Value

+ func (b *Bindings) Hash() int

+ func (b *Bindings) Iter(iter func(ast.Value, ast.Value) bool) bool

+ func (b *Bindings) Put(k, v ast.Value)

+ func (b *Bindings) String() string

+ func (b *Bindings) Update(other *Bindings) *Bindings

+ type DataStore struct

+ Indices *Indices

+ func Load(r io.Reader) (*DataStore, error)

+ func NewDataStore() *DataStore

+ func NewDataStoreFromJSONObject(data map[string]interface{}) *DataStore

+ func (ds *DataStore) Get(path []interface{}) (interface{}, error)

+ func (ds *DataStore) GetRef(ref ast.Ref) (interface{}, error)

+ func (ds *DataStore) MakePath(path []interface{}) error

+ func (ds *DataStore) MustGet(path []interface{}) interface{}

+ func (ds *DataStore) Patch(op PatchOp, path []interface{}, value interface{}) error

+ func (ds *DataStore) String() string

+ type ErrCode int

+ const InternalErr

+ const NotFoundErr

+ type Error struct

+ Code ErrCode

+ Message string

+ func (err *Error) Error() string

+ type Index struct

+ func NewIndex() *Index

+ func (ind *Index) Add(val interface{}, bindings *Bindings)

+ func (ind *Index) Iter(val interface{}, iter func(*Bindings) error) error

+ func (ind *Index) String() string

+ type Indices struct

+ func NewIndices() *Indices

+ func (ind *Indices) Build(store *DataStore, ref ast.Ref) error

+ func (ind *Indices) Drop(ref ast.Ref)

+ func (ind *Indices) Get(ref ast.Ref) *Index

+ func (ind *Indices) Iter(iter func(ast.Ref, *Index) error) error

+ func (ind *Indices) String() string

+ type PatchOp int

+ type PolicyStore struct

+ func NewPolicyStore(store *DataStore, policyDir string) *PolicyStore

+ func (p *PolicyStore) Add(id string, mod *ast.Module, raw []byte, persist bool) error

+ func (p *PolicyStore) Get(id string) (*ast.Module, error)

+ func (p *PolicyStore) GetRaw(id string) ([]byte, error)

+ func (p *PolicyStore) List() map[string]*ast.Module

+ func (p *PolicyStore) Open(f func(map[string][]byte) (map[string]*ast.Module, error)) error

+ func (p *PolicyStore) Remove(id string) error