database

Documentation

Index

• type Database
• type Engine
  • func (c Engine) String() string
• type EntityCollection
  • func (e *EntityCollection) Add(entity *base.Entity)
  • func (e *EntityCollection) CreateEntityIterator() IEntityIterator
  • func (e *EntityCollection) GetEntities() []*base.Entity
• type EntityIterator
  • func (u *EntityIterator) GetNext() *base.Entity
  • func (u *EntityIterator) HasNext() bool
• type IEntityCollection
  • func NewEntityCollection(entities ...*base.Entity) IEntityCollection
• type IEntityIterator
• type ISubjectCollection
  • func NewSubjectCollection(subjects ...*base.Subject) ISubjectCollection
• type ISubjectIterator
• type ITupleCollection
• type ITupleIterator
• type SubjectCollection
  • func (s *SubjectCollection) Add(subject *base.Subject)
  • func (s *SubjectCollection) CreateSubjectIterator() ISubjectIterator
  • func (s *SubjectCollection) GetSubjects() []*base.Subject
• type SubjectIterator
  • func (u *SubjectIterator) GetNext() *base.Subject
  • func (u *SubjectIterator) HasNext() bool
• type TupleCollection
  • func NewTupleCollection(tuples ...*base.Tuple) *TupleCollection
  • func (t *TupleCollection) Add(tuple *base.Tuple)
  • func (t *TupleCollection) CreateTupleIterator() ITupleIterator
  • func (t *TupleCollection) GetTuples() []*base.Tuple
  • func (t *TupleCollection) ToSubjectCollection() ISubjectCollection
• type TupleIterator
  • func (i *TupleIterator) GetNext() *base.Tuple
  • func (i *TupleIterator) HasNext() bool

Types

type Database

type Database interface {
	// Migrate -
	Migrate(statements []string) error

	// IsReady returns true if the database is ready to be used.
	IsReady(ctx context.Context) (bool, error)

	// GetEngineType get the database type (e.g. postgres, memory, etc.).
	GetEngineType() string

	// Close the database connection.
	Close() error
}

Database - Db interface

type Engine

type Engine string

Engine - Type declaration of engine

const (
	POSTGRES Engine = "postgres"
	MEMORY   Engine = "memory"
)

func (Engine) String

func (c Engine) String() string

String - Convert to string

type EntityCollection

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

EntityCollection - Entity collection.

func (*EntityCollection) Add

func (e *EntityCollection) Add(entity *base.Entity)

Add - New subject to collection.

func (*EntityCollection) CreateEntityIterator

func (e *EntityCollection) CreateEntityIterator() IEntityIterator

CreateEntityIterator - Create entity iterator according to collection.

func (*EntityCollection) GetEntities

func (e *EntityCollection) GetEntities() []*base.Entity

GetEntities - Get entities

type EntityIterator

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

EntityIterator - Structure for entity iterator

func (*EntityIterator) GetNext

func (u *EntityIterator) GetNext() *base.Entity

GetNext - Get next entity

func (*EntityIterator) HasNext

func (u *EntityIterator) HasNext() bool

HasNext - Checks whether next entity exists

type IEntityCollection

type IEntityCollection interface {
	Add(entity *base.Entity)
	CreateEntityIterator() IEntityIterator
	GetEntities() []*base.Entity
}

IEntityCollection - Abstract entity collection.

func NewEntityCollection

func NewEntityCollection(entities ...*base.Entity) IEntityCollection

NewEntityCollection - Create new subject collection.

type IEntityIterator

type IEntityIterator interface {
	HasNext() bool
	GetNext() *base.Entity
}

IEntityIterator - Abstract subject iterator.

type ISubjectCollection

type ISubjectCollection interface {
	Add(subject *base.Subject)
	CreateSubjectIterator() ISubjectIterator
	GetSubjects() []*base.Subject
}

ISubjectCollection - Abstract subject collection.

func NewSubjectCollection

func NewSubjectCollection(subjects ...*base.Subject) ISubjectCollection

NewSubjectCollection - Create new subject collection.

type ISubjectIterator

type ISubjectIterator interface {
	HasNext() bool
	GetNext() *base.Subject
}

ISubjectIterator - Abstract subject iterator.

type ITupleCollection

type ITupleCollection interface {
	Add(tuple *base.Tuple)
	CreateTupleIterator() ITupleIterator
	GetTuples() []*base.Tuple
	ToSubjectCollection() ISubjectCollection
}

ITupleCollection - Abstract subject collection.

type ITupleIterator

type ITupleIterator interface {
	HasNext() bool
	GetNext() *base.Tuple
}

ITupleIterator - Abstract tuple iterator.

type SubjectCollection

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

SubjectCollection - Subject collection.

func (*SubjectCollection) Add

func (s *SubjectCollection) Add(subject *base.Subject)

Add - New subject to collection.

func (*SubjectCollection) CreateSubjectIterator

func (s *SubjectCollection) CreateSubjectIterator() ISubjectIterator

CreateSubjectIterator - Create subject iterator according to collection.

func (*SubjectCollection) GetSubjects

func (s *SubjectCollection) GetSubjects() []*base.Subject

GetSubjects - Get subject collection

type SubjectIterator

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

SubjectIterator - Structure for subject iterator

func (*SubjectIterator) GetNext

func (u *SubjectIterator) GetNext() *base.Subject

GetNext - Get next tuple

func (*SubjectIterator) HasNext

func (u *SubjectIterator) HasNext() bool

HasNext - Checks whether next subject exists

type TupleCollection

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

TupleCollection -Tuple collection.

func NewTupleCollection

func NewTupleCollection(tuples ...*base.Tuple) *TupleCollection

NewTupleCollection - Create new tuple collection.

func (*TupleCollection) Add

func (t *TupleCollection) Add(tuple *base.Tuple)

Add - New subject to collection.

func (*TupleCollection) CreateTupleIterator

func (t *TupleCollection) CreateTupleIterator() ITupleIterator

CreateTupleIterator- Create tuple iterator according to collection.

func (*TupleCollection) GetTuples

func (t *TupleCollection) GetTuples() []*base.Tuple

GetTuples - Get tuples

func (*TupleCollection) ToSubjectCollection

func (t *TupleCollection) ToSubjectCollection() ISubjectCollection

ToSubjectCollection - Converts new subject collection from given tuple collection

type TupleIterator

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

TupleIterator - Tuple iterator -

func (*TupleIterator) GetNext

func (i *TupleIterator) GetNext() *base.Tuple

GetNext - Get next tuple

func (*TupleIterator) HasNext

func (i *TupleIterator) HasNext() bool

HasNext - Checks whether next tuple exists