elasticsearch

Documentation

Overview

Package elasticsearch is a package of utilities to store a PackageGraph's state in an ElasticSearch index. This allows indexing once and in a distributed fashion, and querying the ElasticSearch separately.

Index

• Constants
• func FilterF(client Client) func(string, int64) bool
• func LoadGraphToElastic(pg goref.PackageGraph, client Client) error
• func PackageExists(loadpath string, version int64, client Client) bool
• type Client
  • func NewClient(client *elastic.Client, index string) Client
• type File

Constants

const (
	PackageType = "package"
	RefType     = "ref"
	FileType    = "file"
)

Types in the Elastic search index

Functions

func FilterF

func FilterF(client Client) func(string, int64) bool

FilterF returns a function suitable for goref.PackageGraph.FilterF that returns false if a package exists in this ElasticSearch index.

func LoadGraphToElastic

func LoadGraphToElastic(pg goref.PackageGraph, client Client) error

LoadGraphToElastic loads all Packages and Refs from a PackageGraph to the provided ES index.

func PackageExists

func PackageExists(loadpath string, version int64, client Client) bool

PackageExists returns whether the provided loadpath + version tuple exists in this index.

Types

type Client

type Client interface {
	// GetPackage retrieves a package by docID.
	GetPackage(ctx context.Context, docID string) (*elastic.GetResult, error)

	// CreatePackage creates a goref.Package entry in the index.
	CreatePackage(ctx context.Context, p *goref.Package) error

	// CreateFile creates a File entry in the index.
	CreateFile(ctx context.Context, f File) (*elastic.IndexResponse, error)

	// CreateRef creates a goref.Ref entry in the index.
	CreateRef(ctx context.Context, r *goref.Ref) (*elastic.IndexResponse, error)
}

Client is an abstraction over the underlying elastic.Client that provides higher-order methods to manipulate data stored in elasticsearch.

func NewClient

func NewClient(client *elastic.Client, index string) Client

NewClient initializes a clientImpl

type File

type File struct {
	Filename string `json:"filename"`
	Package  string `json:"package"`
}

File represents a mapping of a file in a package