sparkl

package
v0.1.3 Latest Latest
Warning

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

 Go to latest Published: Jun 4, 2023 License: AGPL-3.0 Imports: 20 Imported by: 0

Documentation

Overview

Package sparkl provides facilities to generate an Index for a WissKI

Package sparkl implements a very primitive graph index

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Export 

func Export(pb *pathbuilder.Pathbuilder, index *Index, engine storages.BundleEngine, exporter exporter.Exporter) error

Export loads all top-level paths from the given path-builder from the index into the given engine. Afterwards it is exported into the given exporter.

func LoadPathbuilder 

func LoadPathbuilder(pb *pathbuilder.Pathbuilder, index *Index, engine storages.BundleEngine) (map[string][]Entity, error)

LoadPathbuilder loads all paths in the given pathbuilder

func ParsePredicateString 

func ParsePredicateString(target *[]URI, value string)

ParsePredicateString parses a value of comma-seperate value into a list of URIs

Types

type BundleEngine 

type BundleEngine = storages.BundleEngine

type BundleStorage 

type BundleStorage = storages.BundleStorage

func StoreBundle 

func StoreBundle(bundle *pathbuilder.Bundle, index *Index, engine BundleEngine) (BundleStorage, func() error, error)

StoreBundle loads all entities from the given bundle into a new storage, which is then returned.

Storages for any child bundles, and the bundle itself, are created using the makeStorage function. The storage for this bundle is returned.

func StoreBundles 

func StoreBundles(bundles []*pathbuilder.Bundle, index *Index, engine BundleEngine) ([]BundleStorage, func() error, error)

StoreBundles is like StoreBundle, but takes multiple bundles

type Cache 

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

Cache represents an easily accessible cache of WissKIObjects. It is held entirely in memory.

func NewCache 

func NewCache(Data map[string][]wisski.Entity, SameAs map[URI]URI) (c Cache, err error)

NewCache creates a new cache from a bundle-entity-map

func (Cache) Aliases 

func (c Cache) Aliases(uri URI) []URI

Aliases returns the Aliases of the given URI, excluding itself

func (Cache) Bundle 

func (c Cache) Bundle(uri URI) (string, bool)

Bundle returns the bundle of the given uri, if any

func (Cache) BundleNames 

func (cache Cache) BundleNames() []string

func (Cache) Canonical 

func (c Cache) Canonical(uri URI) URI

Canonical returns the canonical version of the given uri

func (*Cache) DecodeFrom 

func (cache *Cache) DecodeFrom(decoder *gob.Decoder) error

func (*Cache) EncodeTo 

func (cache *Cache) EncodeTo(encoder *gob.Encoder) error

EncodeTo encodes this cache object to the given gob.Encoder.

func (Cache) Entities 

func (cache Cache) Entities(bundle_machine string) []Entity

func (Cache) Entity 

func (c Cache) Entity(uri URI, bundle string) (*Entity, bool)

Entity looks up the given entity

func (Cache) FirstBundle 

func (c Cache) FirstBundle(uris ...URI) (uri URI, bundle string, ok bool)

FirstBundle returns the first bundle for which the given URI exists

type Context 

type Context struct {
	Index  *Index
	Engine BundleEngine
	// contains filtered or unexported fields
}

Context represents a context to extract bundle data from index into storages.

A Context must be opened, and eventually waited on. See [Open] and [Close].

func (*Context) Close 

func (context *Context) Close() (err error)

Close closes this context

func (*Context) Open 

func (context *Context) Open()

Open opens this context, and signals that multiple calls to Store() may follow.

Multiple calls to Open are invalid.

func (*Context) Store 

func (context *Context) Store(bundle *pathbuilder.Bundle) BundleStorage

Store creates a new Storage for the given bundle and schedules entities to be loaded. May only be called between calls [Open] and [Wait].

Any error that occurs is returned only by Wait.

func (*Context) Wait 

func (context *Context) Wait() error

Wait signals this context that no more bundles will be loaded. And then waits for all bundle extracting to finish.

Multiple calls to Wait() are invalid.

type DiskEngine 

type DiskEngine = igraph.DiskEngine[URI, any]

type Engine 

type Engine = igraph.Engine[URI, any]

func NewEngine 

func NewEngine(path string) Engine

NewEngine creates an engine that stores data at the specified path. When path is the empty string, stores data in memory.

type Entity 

type Entity = wisski.Entity

type Index 

type Index = igraph.IGraph[URI, any] // Index represents an index of a RDF Graph

func LoadIndex 

func LoadIndex(path string, predicates Predicates, engine Engine, p *progress.Progress) (*Index, error)

LoadIndex is like MakeIndex, but reads nquads from the given path. When err != nil, the caller must eventually close the index.

func MakeIndex 

func MakeIndex(source Source, predicates Predicates, engine Engine, p *progress.Progress) (*Index, error)

MakeIndex creates a new Index from the given source. When err != nil, the caller must eventually close the index.

type MemoryEngine 

type MemoryEngine = igraph.MemoryEngine[URI, any]

type Path 

type Path = igraph.Path[URI, any] // Singel Path in the index

type Paths 

type Paths = igraph.Paths[URI, any] // Set of Paths inside the index

type Predicates 

type Predicates struct {
	SameAs    []URI
	InverseOf []URI
}

Predicates represent special predicates

type QuadSource 

type QuadSource struct {
	Reader io.ReadSeeker
	// contains filtered or unexported fields
}

QuadSource reads triples from a quad file

func (*QuadSource) Close 

func (qs *QuadSource) Close() error

func (*QuadSource) Next 

func (qs *QuadSource) Next() Token

Next reads the next token from the QuadSource

func (*QuadSource) Open 

func (qs *QuadSource) Open() error

type Source 

type Source interface {
	// Open opens this data source.
	//
	// It is valid to call open more than once after Next() returns a token with err = io.EOF.
	// In this case the second call to open should reset the data source.
	Open() error

	// Close closes this source.
	// Close may only be called once a token with err != io.EOF is called.
	Close() error

	// Next scans the next token
	Next() Token
}

Source represents a source of triples

type Token 

type Token struct {
	Subject   URI
	Predicate URI
	Object    URI

	HasDatum bool
	Datum    any

	Err error
}

Token represents a token read from a triplestore file.

It can represent one of three states:

1. an error token 1. a (subject, predicate, object) token 2. a (subject, predicate, datum) token

In the case of 1, Error != nil. In the case of 2, Error == nil && HasDatum = False In the case of 3, Error == nil && HasDatum = True

type Triple 

type Triple = igraph.Triple[URI, any] // Triple inside the index

type URI 

type URI = wisski.URI

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.