dsstore

Documentation

Overview

Package dsstore is a Datastore-based storage for DAM/IC.

Index

• type Entity
• type History
• type Key
• type Lock
  • func NewLock(client *datastore.Client, name string) *Lock
  • func (l *Lock) Acquire(ctx context.Context, end time.Time) error
  • func (l *Lock) Release(ctx context.Context) error
  • func (l *Lock) Reset(ctx context.Context) error
• type Meta
• type Store
  • func New(client *datastore.Client, project, service, path string) *Store
  • func NewStore(ctx context.Context, project, service, path string) *Store
  • func (s *Store) Delete(datatype, realm, user, id string, rev int64) error
  • func (s *Store) DeleteTx(datatype, realm, user, id string, rev int64, tx storage.Tx) (ferr error)
  • func (s *Store) Exists(datatype, realm, user, id string, rev int64) (bool, error)
  • func (s *Store) Info() map[string]string
  • func (s *Store) Init(ctx context.Context) error
  • func (s *Store) LockTx(lockName string, minFrequency time.Duration, tx storage.Tx) storage.Tx
  • func (s *Store) MultiDeleteTx(datatype, realm, user string, tx storage.Tx) error
  • func (s *Store) MultiReadTx(datatype, realm, user, id string, filters [][]storage.Filter, ...) (_ *storage.Results, ferr error)
  • func (s *Store) Read(datatype, realm, user, id string, rev int64, content proto.Message) error
  • func (s *Store) ReadHistory(datatype, realm, user, id string, content *[]proto.Message) error
  • func (s *Store) ReadHistoryTx(datatype, realm, user, id string, content *[]proto.Message, tx storage.Tx) (ferr error)
  • func (s *Store) ReadTx(datatype, realm, user, id string, rev int64, content proto.Message, ...) (ferr error)
  • func (s *Store) Tx(update bool) (storage.Tx, error)
  • func (s *Store) Wipe(ctx context.Context, realm string, batchNum, maxEntries int) (int, error)
  • func (s *Store) Write(datatype, realm, user, id string, rev int64, content proto.Message, ...) error
  • func (s *Store) WriteTx(datatype, realm, user, id string, rev int64, content proto.Message, ...) (ferr error)
• type Tx
  • func (tx *Tx) Finish() error
  • func (tx *Tx) IsUpdate() bool
  • func (tx *Tx) MakeUpdate() error
  • func (tx *Tx) Rollback() error

Types

type Entity

type Entity struct {
	Key      *datastore.Key `datastore:"__key__"`
	Service  string         `datastore:"service"`
	Datatype string         `datastore:"type"`
	Realm    string         `datastore:"realm"`
	User     string         `datastore:"user_id"`
	ID       string         `datastore:"id"`
	Rev      int64          `datastore:"rev"`
	Version  string         `datastore:"version,noindex"`
	Modified int64          `datastore:"modified"`
	Content  string         `datastore:"content,noindex"`
}

Entity is a datastore entity for data.

type History

type History struct {
	Key      *datastore.Key `datastore:"__key__"`
	Service  string         `datastore:"service"`
	Datatype string         `datastore:"type"`
	Realm    string         `datastore:"realm"`
	User     string         `datastore:"user_id"`
	ID       string         `datastore:"id"`
	Rev      int64          `datastore:"rev"`
	Version  string         `datastore:"version,noindex"`
	Modified int64          `datastore:"modified"`
	Content  string         `datastore:"content,noindex"`
}

History is an datastore entity for history.

type Key

type Key struct {
	Datatype string `datastore:"type"`
	Realm    string `datastore:"realm"`
	User     string `datastore:"user_id"`
	ID       string `datastore:"id"`
	Rev      int64  `datastore:"rev"`
}

Key is the key for items.

type Lock

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

Lock is the data for a lock.

func NewLock

func NewLock(client *datastore.Client, name string) *Lock

NewLock creates a new lock object.

func (*Lock) Acquire

func (l *Lock) Acquire(ctx context.Context, end time.Time) error

Acquire attempts to acquire the lock until the specified time. Warning: The times used are local times, be careful with cross process clock skew, stop assuming that you hold the lock slightly before you

func (*Lock) Release

func (l *Lock) Release(ctx context.Context) error

Release attempts to release the holding of the named lock.

func (*Lock) Reset

func (l *Lock) Reset(ctx context.Context) error

Reset clears the information about the lock from datastore.

type Meta

type Meta struct {
	Key   *datastore.Key `datastore:"__key__"`
	Name  string         `datastore:"name"`
	Value string         `datastore:"value,noindex"`
}

Meta is a datastore entity for meta.

type Store

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

Store is a datastore based implementation of storage.

func New

func New(client *datastore.Client, project, service, path string) *Store

New creates a new storage.

func NewStore

func NewStore(ctx context.Context, project, service, path string) *Store

NewStore creates a new datastore storace and initilizes it. TODO: create the client for datastore in the main and inject it.

func (*Store) Delete

func (s *Store) Delete(datatype, realm, user, id string, rev int64) error

Delete deletes a data entity.

func (*Store) DeleteTx

func (s *Store) DeleteTx(datatype, realm, user, id string, rev int64, tx storage.Tx) (ferr error)

DeleteTx deletes a data entity inside a transaction.

func (*Store) Exists

func (s *Store) Exists(datatype, realm, user, id string, rev int64) (bool, error)

Exists checks if a data entity with the given name exists.

func (*Store) Info

func (s *Store) Info() map[string]string

Info returns some information about the store. TODO: delete this and pass the information directly rather than through store.

func (*Store) Init

func (s *Store) Init(ctx context.Context) error

Init initilizes the store. It creates some metadata information about the store on datastore. If metada information already exists on datastore, it comapres to see if they are compatible with the metadata information of the current store.

func (*Store) LockTx

func (s *Store) LockTx(lockName string, minFrequency time.Duration, tx storage.Tx) storage.Tx

LockTx returns a storage-wide lock by the given name. Only one such lock should be requested at a time. If Tx is provided, it must be an update Tx. TODO: get rid of this function and fix the code using it. Note: This doesn't provide distributed mutual exclusion, don't use this.

func (*Store) MultiDeleteTx

func (s *Store) MultiDeleteTx(datatype, realm, user string, tx storage.Tx) error

MultiDeleteTx deletes many records of a certain data type within a realm. Is limited by maxRowsPerBatchOperation before needing to use an LRO instead. If user is "", deletes for all users.

func (*Store) MultiReadTx

func (s *Store) MultiReadTx(datatype, realm, user, id string, filters [][]storage.Filter, offset, pageSize int, typ proto.Message, tx storage.Tx) (_ *storage.Results, ferr error)

MultiReadTx reads a set of data entities matching the filters. MultiReadTx will not see the writes inside the transaction. If realm is "" reads all realms. if user is "" reads all users. Returns a results object and error.

func (*Store) Read

func (s *Store) Read(datatype, realm, user, id string, rev int64, content proto.Message) error

Read reads a data entity.

func (*Store) ReadHistory

func (s *Store) ReadHistory(datatype, realm, user, id string, content *[]proto.Message) error

ReadHistory reads the history.

func (*Store) ReadHistoryTx

func (s *Store) ReadHistoryTx(datatype, realm, user, id string, content *[]proto.Message, tx storage.Tx) (ferr error)

ReadHistoryTx reads the history inside a transaction.

func (*Store) ReadTx

func (s *Store) ReadTx(datatype, realm, user, id string, rev int64, content proto.Message, tx storage.Tx) (ferr error)

ReadTx reads a data entity inside a transaction. ReadTx will not see the writes inside the transaction.

func (*Store) Tx

func (s *Store) Tx(update bool) (storage.Tx, error)

Tx creates a new transaction for the store.

func (*Store) Wipe

func (s *Store) Wipe(ctx context.Context, realm string, batchNum, maxEntries int) (int, error)

Wipe deletes all data and history within a realm but no more than maxEntries. If realm is "" deletes for all realms; use all realms mode with caution as it will remove the master realm's config too. Returns count of deleted items and error.

func (*Store) Write

func (s *Store) Write(datatype, realm, user, id string, rev int64, content proto.Message, history proto.Message) error

Write writes a data entity.

func (*Store) WriteTx

func (s *Store) WriteTx(datatype, realm, user, id string, rev int64, content proto.Message, history proto.Message, tx storage.Tx) (ferr error)

WriteTx writes a data entity inside a transaction.

type Tx

type Tx struct {
	Tx *datastore.Transaction
	// contains filtered or unexported fields
}

Tx is a transaction.

func (*Tx) Finish

func (tx *Tx) Finish() error

Finish attempts to commit a transaction.

func (*Tx) IsUpdate

func (tx *Tx) IsUpdate() bool

IsUpdate tells if the transaction is an update or read-only.

func (*Tx) MakeUpdate

func (tx *Tx) MakeUpdate() error

MakeUpdate will upgrade a read-only transaction to an update transaction.

func (*Tx) Rollback

func (tx *Tx) Rollback() error

Rollback attempts to rollback a transaction.