xrefs

Documentation

Overview

Package xrefs provides a high-performance table-based implementation of the xrefs.Service.

Table format:

decor:<ticket>         -> srvpb.FileDecorations
docs:<ticket>          -> srvpb.Document
xrefs:<ticket>         -> srvpb.PagedCrossReferences
xrefPages:<page_key>   -> srvpb.PagedCrossReferences_Page

Index

• Constants
• func CrossReferencesKey(ticket string) []byte
• func CrossReferencesPageKey(key string) []byte
• func DecorationsKey(ticket string) []byte
• func DefaultResolvePath(cp *cpb.CorpusPath) string
• func DocumentationKey(ticket string) []byte
• func NewService(ctx context.Context, t keyvalue.DB) xrefs.Service
• type ColumnarTable
  • func NewColumnarTable(t keyvalue.DB) *ColumnarTable
  • func (c *ColumnarTable) CrossReferences(ctx context.Context, req *xpb.CrossReferencesRequest) (*xpb.CrossReferencesReply, error)
  • func (c *ColumnarTable) Decorations(ctx context.Context, req *xpb.DecorationsRequest) (*xpb.DecorationsReply, error)
• type MultiFilePatcher
• type PathResolver
• type SplitTable
  • func (s *SplitTable) Close(ctx context.Context) (err error)
• type Table
  • func NewCombinedTable(t table.Proto) *Table
  • func NewSplitTable(c *SplitTable) *Table
  • func (t *Table) CrossReferences(ctx context.Context, req *xpb.CrossReferencesRequest) (*xpb.CrossReferencesReply, error)
  • func (t *Table) Decorations(ctx context.Context, req *xpb.DecorationsRequest) (*xpb.DecorationsReply, error)
  • func (t *Table) Documentation(ctx context.Context, req *xpb.DocumentationRequest) (*xpb.DocumentationReply, error)

Constants

const ColumnarTableKeyMarker = "kythe:columnar"

ColumnarTableKeyMarker is stored within a Kythe columnar table to differentiate it from the legacy combined table format.

Functions

func CrossReferencesKey

func CrossReferencesKey(ticket string) []byte

CrossReferencesKey returns the cross-references CombinedTable key for the given node ticket.

func CrossReferencesPageKey

func CrossReferencesPageKey(key string) []byte

CrossReferencesPageKey returns the cross-references page CombinedTable key for the given key.

func DecorationsKey

func DecorationsKey(ticket string) []byte

DecorationsKey returns the decorations CombinedTable key for the given source location ticket.

func DefaultResolvePath

func DefaultResolvePath(cp *cpb.CorpusPath) string

DefaultResolvePath returns the default resolved path for the CorpusPath by joining its corpus, root, and path into a single filepath.

func DocumentationKey

func DocumentationKey(ticket string) []byte

DocumentationKey returns the documentation CombinedTable key for the given ticket.

func NewService

func NewService(ctx context.Context, t keyvalue.DB) xrefs.Service

NewService returns an xrefs.Service backed by the given table. The format of the table with be automatically detected.

Types

type ColumnarTable

type ColumnarTable struct {
	keyvalue.DB

	*Table // fallback non-columnar documentation
}

ColumnarTable implements an xrefs.Service backed by a columnar serving table.

func NewColumnarTable

func NewColumnarTable(t keyvalue.DB) *ColumnarTable

NewColumnarTable returns a table for the given columnar xrefs lookup table.

func (*ColumnarTable) CrossReferences

func (c *ColumnarTable) CrossReferences(ctx context.Context, req *xpb.CrossReferencesRequest) (*xpb.CrossReferencesReply, error)

CrossReferences implements part of the xrefs.Service interface.

func (*ColumnarTable) Decorations

func (c *ColumnarTable) Decorations(ctx context.Context, req *xpb.DecorationsRequest) (*xpb.DecorationsReply, error)

Decorations implements part of the xrefs.Service interface.

type MultiFilePatcher

type MultiFilePatcher interface {
	// AddFile adds a file to current set of files to patch against.
	AddFile(context.Context, *srvpb.FileInfo) error

	// PatchAnchors updates the set of anchors given to match their referenced
	// files' state as known by the MultiLinePatcher, usually based on a
	// Workspace.  If an anchor no longer exists, it will be ellided from the
	// returned set.  Otherwise, the ordering of the anchors will be retained.
	PatchAnchors(context.Context, []*xpb.Anchor) ([]*xpb.Anchor, error)

	// PatchRelatedAnchors updates the set of related anchors given to match their
	// referenced files' state as known by the MultiLinePatcher, usually based on
	// a Workspace.  If an anchor no longer exists, it will be ellided from the
	// returned set.  Otherwise, the ordering of the anchors will be retained.
	PatchRelatedAnchors(context.Context, []*xpb.CrossReferencesReply_RelatedAnchor) ([]*xpb.CrossReferencesReply_RelatedAnchor, error)

	// Close releases any resources used the patcher.  Further calls to the
	// patcher will become invalid.
	Close() error
}

A MultiFilePatcher provides an interface to patch sets of xref anchors to an underlying baseline, usually a Workspace.

After creation, the client is required to call AddFile for each possible file referenced by any anchors that will be patched. After the files are added, a set of anchors may be passed to PatchAnchors.

type PathResolver

type PathResolver func(*cpb.CorpusPath) string

A PathResolver resolves a CorpusPath into a single filepath.

type SplitTable

type SplitTable struct {
	// Decorations is a table of srvpb.FileDecorations keyed by their source
	// location tickets.
	Decorations table.Proto

	// CrossReferences is a table of srvpb.PagedCrossReferences keyed by their
	// source node tickets.
	CrossReferences table.Proto

	// CrossReferencePages is a table of srvpb.PagedCrossReferences_Pages keyed by
	// their page keys.
	CrossReferencePages table.Proto

	// Documentation is a table of srvpb.Documents keyed by their node ticket.
	Documentation table.Proto

	// RewriteEdgeLabel is an optional callback to rewrite edge labels.
	// It will be called once per request; the function it returns will then be
	// called once per edge.
	RewriteEdgeLabel func(context.Context) func(string) string
}

SplitTable implements the xrefs Service interface using separate static lookup tables for each API component.

func (*SplitTable) Close

func (s *SplitTable) Close(ctx context.Context) (err error)

Close closes each underlying table.Proto.

type Table

type Table struct {

	// MakePatcher returns a patching client that targets a Workspace.
	MakePatcher func(context.Context, *xpb.Workspace) (MultiFilePatcher, error)

	// ResolvePath is used to resolve CorpusPaths for filtering.  If unset,
	// DefaultResolvePath will be used.
	ResolvePath PathResolver
	// contains filtered or unexported fields
}

Table implements the xrefs Service interface using static lookup tables.

func NewCombinedTable

func NewCombinedTable(t table.Proto) *Table

NewCombinedTable returns a table for the given combined xrefs lookup table. The table's keys are expected to be constructed using only the *Key functions.

func NewSplitTable

func NewSplitTable(c *SplitTable) *Table

NewSplitTable returns a table based on the given serving tables for each API component.

func (*Table) CrossReferences

func (t *Table) CrossReferences(ctx context.Context, req *xpb.CrossReferencesRequest) (*xpb.CrossReferencesReply, error)

CrossReferences implements part of the xrefs.Service interface.

func (*Table) Decorations

func (t *Table) Decorations(ctx context.Context, req *xpb.DecorationsRequest) (*xpb.DecorationsReply, error)

Decorations implements part of the xrefs Service interface.

func (*Table) Documentation

func (t *Table) Documentation(ctx context.Context, req *xpb.DocumentationRequest) (*xpb.DocumentationReply, error)

Documentation implements part of the xrefs Service interface.