graph

package
Version: v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2014 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrQuadExists   = errors.New("Quad exists")
	ErrQuadNotExist = errors.New("Quad doesn't exist")
)
View Source
var ErrCannotBulkLoad = errors.New("triplestore: cannot bulk load")

Functions

func ContainsLogIn added in v0.3.1

func ContainsLogIn(it Iterator, val Value)

Utility logging functions for when an iterator gets called Next upon, or Contains upon, as well as what they return. Highly useful for tracing the execution path of a query.

func ContainsLogOut added in v0.3.1

func ContainsLogOut(it Iterator, val Value, good bool) bool

func Height added in v0.4.0

func Height(it Iterator, until Type) int

Height is a convienence function to measure the height of an iterator tree.

func InitTripleStore added in v0.3.1

func InitTripleStore(name, dbpath string, opts Options) error

func IsPersistent added in v0.4.0

func IsPersistent(name string) bool

func Next added in v0.3.1

func Next(it Iterator) bool

Next is a convenience function that conditionally calls the Next method of an Iterator if it is a Nexter. If the Iterator is not a Nexter, Next returns false.

func NextLogIn

func NextLogIn(it Iterator)

func NextLogOut

func NextLogOut(it Iterator, val Value, ok bool) bool

func PrintResultTreeEvaluator

func PrintResultTreeEvaluator(it Nexter)

func RegisterTripleStore added in v0.3.1

func RegisterTripleStore(name string, persists bool, newFunc NewStoreFunc, initFunc InitStoreFunc)

func RegisterWriter added in v0.4.0

func RegisterWriter(name string, newFunc NewQuadWriterFunc)

func StringResultTreeEvaluator

func StringResultTreeEvaluator(it Nexter) string

func TripleStores added in v0.3.1

func TripleStores() []string

func WriterMethods added in v0.4.0

func WriterMethods() []string

Types

type BulkLoader added in v0.3.1

type BulkLoader interface {
	// BulkLoad loads Quads from a quad.Unmarshaler in bulk to the TripleStore.
	// It returns ErrCannotBulkLoad if bulk loading is not possible. For example if
	// you cannot load in bulk to a non-empty database, and the db is non-empty.
	BulkLoad(quad.Unmarshaler) error
}

type Delta added in v0.4.0

type Delta struct {
	ID        int64
	Quad      quad.Quad
	Action    Procedure
	Timestamp time.Time
}

type FixedIterator

type FixedIterator interface {
	Iterator
	Add(Value)
}

FixedIterator wraps iterators that are modifiable by addition of fixed value sets.

type Handle added in v0.4.0

type Handle struct {
	QuadStore  TripleStore
	QuadWriter QuadWriter
}

func (*Handle) Close added in v0.4.0

func (h *Handle) Close()

type InitStoreFunc added in v0.3.1

type InitStoreFunc func(string, Options) error

type Iterator

type Iterator interface {
	Tagger() *Tagger

	// Fills a tag-to-result-value map.
	TagResults(map[string]Value)

	// Returns the current result.
	Result() Value

	// DEPRECATED -- Fills a ResultTree struct with Result().
	ResultTree() *ResultTree

	// These methods are the heart and soul of the iterator, as they constitute
	// the iteration interface.
	//
	// To get the full results of iteration, do the following:
	//
	//  for graph.Next(it) {
	//  	val := it.Result()
	//  	... do things with val.
	//  	for it.NextPath() {
	//  		... find other paths to iterate
	//  	}
	//  }
	//
	// All of them should set iterator.Last to be the last returned value, to
	// make results work.
	//
	// NextPath() advances iterators that may have more than one valid result,
	// from the bottom up.
	NextPath() bool

	// Contains returns whether the value is within the set held by the iterator.
	Contains(Value) bool

	// Start iteration from the beginning
	Reset()

	// Create a new iterator just like this one
	Clone() Iterator

	// These methods relate to choosing the right iterator, or optimizing an
	// iterator tree
	//
	// Stats() returns the relative costs of calling the iteration methods for
	// this iterator, as well as the size. Roughly, it will take NextCost * Size
	// "cost units" to get everything out of the iterator. This is a wibbly-wobbly
	// thing, and not exact, but a useful heuristic.
	Stats() IteratorStats

	// Helpful accessor for the number of things in the iterator. The first return
	// value is the size, and the second return value is whether that number is exact,
	// or a conservative estimate.
	Size() (int64, bool)

	// Returns a string relating to what the function of the iterator is. By
	// knowing the names of the iterators, we can devise optimization strategies.
	Type() Type

	// Optimizes an iterator. Can replace the iterator, or merely move things
	// around internally. if it chooses to replace it with a better iterator,
	// returns (the new iterator, true), if not, it returns (self, false).
	Optimize() (Iterator, bool)

	// Return a slice of the subiterators for this iterator.
	SubIterators() []Iterator

	// Return a string representation of the iterator, indented by the given amount.
	DebugString(int) string

	// Close the iterator and do internal cleanup.
	Close()

	// UID returns the unique identifier of the iterator.
	UID() uint64
}

type IteratorStats

type IteratorStats struct {
	ContainsCost int64
	NextCost     int64
	Size         int64
	Next         int64
	Contains     int64
	ContainsNext int64
}

type NewQuadWriterFunc added in v0.4.0

type NewQuadWriterFunc func(TripleStore, Options) (QuadWriter, error)

type NewStoreFunc added in v0.3.1

type NewStoreFunc func(string, Options) (TripleStore, error)

type Nexter added in v0.3.1

type Nexter interface {
	// Next advances the iterator to the next value, which will then be available through
	// the Result method. It returns false if no further advancement is possible.
	Next() bool

	Iterator
}

type Options added in v0.3.1

type Options map[string]interface{}

func (Options) BoolKey added in v0.4.0

func (d Options) BoolKey(key string) (bool, bool)

func (Options) IntKey added in v0.3.1

func (d Options) IntKey(key string) (int, bool)

func (Options) StringKey added in v0.3.1

func (d Options) StringKey(key string) (string, bool)

type Procedure added in v0.4.0

type Procedure byte
const (
	Add Procedure = iota
	Delete
)

The different types of actions a transaction can do.

type QuadWriter added in v0.4.0

type QuadWriter interface {
	// Add a quad to the store.
	AddQuad(quad.Quad) error

	// Add a set of quads to the store, atomically if possible.
	AddQuadSet([]quad.Quad) error

	// Removes a quad matching the given one  from the database,
	// if it exists. Does nothing otherwise.
	RemoveQuad(quad.Quad) error

	// Cleans up replication and closes the writing aspect of the database.
	Close() error
}

func NewQuadWriter added in v0.4.0

func NewQuadWriter(name string, ts TripleStore, opts Options) (QuadWriter, error)

type ResultTree

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

func NewResultTree

func NewResultTree(result Value) *ResultTree

func (*ResultTree) AddSubtree

func (t *ResultTree) AddSubtree(sub *ResultTree)

func (*ResultTree) String added in v0.3.1

func (t *ResultTree) String() string

type StatsContainer added in v0.4.0

type StatsContainer struct {
	IteratorStats
	Kind   string
	Uid    uint64
	SubIts []StatsContainer
}

func DumpStats added in v0.4.0

func DumpStats(it Iterator) StatsContainer

type Tagger added in v0.3.1

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

func (*Tagger) Add added in v0.3.1

func (t *Tagger) Add(tag string)

Adds a tag to the iterator.

func (*Tagger) AddFixed added in v0.3.1

func (t *Tagger) AddFixed(tag string, value Value)

func (*Tagger) CopyFrom added in v0.3.1

func (t *Tagger) CopyFrom(src Iterator)

func (*Tagger) Fixed added in v0.3.1

func (t *Tagger) Fixed() map[string]Value

Returns the fixed tags. The returned value must not be mutated.

func (*Tagger) Tags added in v0.3.1

func (t *Tagger) Tags() []string

Returns the tags. The returned value must not be mutated.

type TripleStore

type TripleStore interface {
	// The only way in is through building a transaction, which
	// is done by a replication strategy.
	ApplyDeltas([]Delta) error

	// Given an opaque token, returns the triple for that token from the store.
	Quad(Value) quad.Quad

	// Given a direction and a token, creates an iterator of links which have
	// that node token in that directional field.
	TripleIterator(quad.Direction, Value) Iterator

	// Returns an iterator enumerating all nodes in the graph.
	NodesAllIterator() Iterator

	// Returns an iterator enumerating all links in the graph.
	TriplesAllIterator() Iterator

	// Given a node ID, return the opaque token used by the TripleStore
	// to represent that id.
	ValueOf(string) Value

	// Given an opaque token, return the node that it represents.
	NameOf(Value) string

	// Returns the number of triples currently stored.
	Size() int64

	// The last replicated transaction ID that this triplestore has verified.
	Horizon() int64

	// Creates a fixed iterator which can compare Values
	FixedIterator() FixedIterator

	// Optimize an iterator in the context of the triple store.
	// Suppose we have a better index for the passed tree; this
	// gives the TripleStore the opportunity to replace it
	// with a more efficient iterator.
	OptimizeIterator(it Iterator) (Iterator, bool)

	// Close the triple store and clean up. (Flush to disk, cleanly
	// sever connections, etc)
	Close()

	// Convenience function for speed. Given a triple token and a direction
	// return the node token for that direction. Sometimes, a TripleStore
	// can do this without going all the way to the backing store, and
	// gives the TripleStore the opportunity to make this optimization.
	//
	// Iterators will call this. At worst, a valid implementation is
	// ts.IdFor(ts.quad.Quad(id).Get(dir))
	TripleDirection(id Value, d quad.Direction) Value
}

func NewTripleStore added in v0.3.1

func NewTripleStore(name, dbpath string, opts Options) (TripleStore, error)

type Type added in v0.3.1

type Type int

Type enumerates the set of Iterator types.

const (
	Invalid Type = iota
	All
	And
	Or
	HasA
	LinksTo
	Comparison
	Null
	Fixed
	Not
	Optional
	Materialize
)

func RegisterIterator added in v0.3.1

func RegisterIterator(name string) Type

RegisterIterator adds a new iterator type to the set of acceptable types, returning the registered Type. Calls to Register are idempotent and must be made prior to use of the iterator. The conventional approach for use is to include a call to Register in a package init() function, saving the Type to a private package var.

func (Type) String added in v0.3.1

func (t Type) String() string

String returns a string representation of the Type.

type Value added in v0.3.1

type Value interface{}

Value defines an opaque "triple store value" type. However the backend wishes to implement it, a Value is merely a token to a triple or a node that the backing store itself understands, and the base iterators pass around.

For example, in a very traditional, graphd-style graph, these are int64s (guids of the primitives). In a very direct sort of graph, these could be pointers to structs, or merely triples, or whatever works best for the backing store.

These must be comparable, or implement a `Key() interface{}` function so that they may be stored in maps.

Directories

Path Synopsis
b
Package b implements a B+tree.
Package b implements a B+tree.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL