database

Documentation

Index

• func IsErrNotFound(err error) bool
• type ErrNotFound
  • func (e *ErrNotFound) Error() string
• type ExecutionDB
• type ExecutionTransaction
• type InstanceDB
• type LevelDBExecutionDB
  • func NewExecutionDB(path string) (*LevelDBExecutionDB, error)
  • func (db *LevelDBExecutionDB) Close() error
  • func (db *LevelDBExecutionDB) Find(executionHash hash.Hash) (*execution.Execution, error)
  • func (db *LevelDBExecutionDB) OpenTransaction() (ExecutionTransaction, error)
  • func (db *LevelDBExecutionDB) Save(execution *execution.Execution) error
• type LevelDBExecutionTransaction
  • func (tx *LevelDBExecutionTransaction) Commit() error
  • func (tx *LevelDBExecutionTransaction) Discard()
  • func (tx *LevelDBExecutionTransaction) Find(executionHash hash.Hash) (*execution.Execution, error)
  • func (tx *LevelDBExecutionTransaction) Save(execution *execution.Execution) error
• type LevelDBInstanceDB
  • func NewInstanceDB(path string) (*LevelDBInstanceDB, error)
  • func (d *LevelDBInstanceDB) Close() error
  • func (d *LevelDBInstanceDB) Delete(hash hash.Hash) error
  • func (d *LevelDBInstanceDB) Get(hash hash.Hash) (*instance.Instance, error)
  • func (d *LevelDBInstanceDB) GetAll() ([]*instance.Instance, error)
  • func (d *LevelDBInstanceDB) Save(i *instance.Instance) error
• type LevelDBServiceDB
  • func NewServiceDB(path string) (*LevelDBServiceDB, error)
  • func (d *LevelDBServiceDB) All() ([]*service.Service, error)
  • func (d *LevelDBServiceDB) Close() error
  • func (d *LevelDBServiceDB) Delete(hash hash.Hash) error
  • func (d *LevelDBServiceDB) Get(hash hash.Hash) (*service.Service, error)
  • func (d *LevelDBServiceDB) Save(s *service.Service) error
• type ServiceDB

Functions

func IsErrNotFound

func IsErrNotFound(err error) bool

IsErrNotFound returns true if err is type of ErrNotFound, false otherwise.

Types

type ErrNotFound

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

ErrNotFound is an not found error.

func (*ErrNotFound) Error

func (e *ErrNotFound) Error() string

type ExecutionDB

type ExecutionDB interface {
	Find(executionHash hash.Hash) (*execution.Execution, error)
	Save(execution *execution.Execution) error
	OpenTransaction() (ExecutionTransaction, error)
	io.Closer
}

ExecutionDB exposes all the functionalities

type ExecutionTransaction

type ExecutionTransaction interface {
	Find(executionHash hash.Hash) (*execution.Execution, error)
	Save(execution *execution.Execution) error
	Commit() error
	Discard()
}

ExecutionTransaction is the transaction handle.

type InstanceDB

type InstanceDB interface {
	// Get retrives instance by instance hash.
	Get(hash hash.Hash) (*instance.Instance, error)

	// GetAll retrieves all instances.
	GetAll() ([]*instance.Instance, error)

	// Save saves instance to database.
	Save(i *instance.Instance) error

	// Delete an instance by instance hash.
	Delete(hash hash.Hash) error

	// Close closes underlying database connection.
	Close() error
}

InstanceDB describes the API of Instance database.

type LevelDBExecutionDB

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

LevelDBExecutionDB is a concrete implementation of the DB interface

func NewExecutionDB

func NewExecutionDB(path string) (*LevelDBExecutionDB, error)

NewExecutionDB creates a new DB instance

func (*LevelDBExecutionDB) Close

func (db *LevelDBExecutionDB) Close() error

Close closes database.

func (*LevelDBExecutionDB) Find

func (db *LevelDBExecutionDB) Find(executionHash hash.Hash) (*execution.Execution, error)

Find the execution based on an executionHash, returns an error if not found

func (*LevelDBExecutionDB) OpenTransaction

func (db *LevelDBExecutionDB) OpenTransaction() (ExecutionTransaction, error)

OpenTransaction opens an atomic DB transaction. Only one transaction can be opened at a time.

func (*LevelDBExecutionDB) Save

func (db *LevelDBExecutionDB) Save(execution *execution.Execution) error

Save an instance of executable in the database Returns an error if anything from marshaling to database saving goes wrong

type LevelDBExecutionTransaction

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

LevelDBExecutionTransaction is the transaction handle.

func (*LevelDBExecutionTransaction) Commit

func (tx *LevelDBExecutionTransaction) Commit() error

Commit commits the transaction.

func (*LevelDBExecutionTransaction) Discard

func (tx *LevelDBExecutionTransaction) Discard()

Discard discards the transaction.

func (*LevelDBExecutionTransaction) Find

func (tx *LevelDBExecutionTransaction) Find(executionHash hash.Hash) (*execution.Execution, error)

Find the execution based on an executionHash, returns an error if not found

func (*LevelDBExecutionTransaction) Save

func (tx *LevelDBExecutionTransaction) Save(execution *execution.Execution) error

Save an instance of executable in the database Returns an error if anything from marshaling to database saving goes wrong

type LevelDBInstanceDB

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

LevelDBInstanceDB is a database for storing services' instances.

func NewInstanceDB

func NewInstanceDB(path string) (*LevelDBInstanceDB, error)

NewInstanceDB returns the database which is located under given path.

func (*LevelDBInstanceDB) Close

func (d *LevelDBInstanceDB) Close() error

Close closes database.

func (*LevelDBInstanceDB) Delete

func (d *LevelDBInstanceDB) Delete(hash hash.Hash) error

Delete deletes an instance from database.

func (*LevelDBInstanceDB) Get

func (d *LevelDBInstanceDB) Get(hash hash.Hash) (*instance.Instance, error)

Get retrives instance by instance hash.

func (*LevelDBInstanceDB) GetAll

func (d *LevelDBInstanceDB) GetAll() ([]*instance.Instance, error)

GetAll retrieves all instances.

func (*LevelDBInstanceDB) Save

func (d *LevelDBInstanceDB) Save(i *instance.Instance) error

Save saves instance to database.

type LevelDBServiceDB

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

LevelDBServiceDB is a database for storing service definition.

func NewServiceDB

func NewServiceDB(path string) (*LevelDBServiceDB, error)

NewServiceDB returns the database which is located under given path.

func (*LevelDBServiceDB) All

func (d *LevelDBServiceDB) All() ([]*service.Service, error)

All returns every service in database.

func (*LevelDBServiceDB) Close

func (d *LevelDBServiceDB) Close() error

Close closes database.

func (*LevelDBServiceDB) Delete

func (d *LevelDBServiceDB) Delete(hash hash.Hash) error

Delete deletes service from database.

func (*LevelDBServiceDB) Get

func (d *LevelDBServiceDB) Get(hash hash.Hash) (*service.Service, error)

Get retrives service from database.

func (*LevelDBServiceDB) Save

func (d *LevelDBServiceDB) Save(s *service.Service) error

Save stores service in database. If there is an another service that uses the same sid, it'll be deleted.

type ServiceDB

type ServiceDB interface {
	// Save saves a service to database.
	Save(s *service.Service) error

	// Get gets a service from database by its unique hash.
	Get(hash hash.Hash) (*service.Service, error)

	// Delete deletes a service from database by its unique hash.
	Delete(hash hash.Hash) error

	// All returns all services from database.
	All() ([]*service.Service, error)

	// Close closes underlying database connection.
	Close() error
}

ServiceDB describes the API of database package.