index

Documentation

Index

• Variables
• func New(parent charm.Command, f *flag.FlagSet) (charm.Command, error)
• type Command
  • func (c *Command) Run(args []string) error

Variables

var Cmd = &charm.Spec{
	Name:  "index",
	Usage: "index [subcommand]",
	Short: "create and drop indexes, index data",
	Long: `
The index subcommands control the creation, management, and deletion
of search indexes in a Zed lake.  Unlike traditional approaches to search
based on a consolidated inverted index pointing at documents, Zed indexes
are highly modular where each index rule creates an index object per data obejct.
Each index is incrementally built and transactionally attached to
its immutable data object.  While objects are indexed, queries may run with
or without the presence of such indexes.  The planner uses an object's indexes
to prune the object from the query when possible, making queries run faster
when an object's index indicated that it can be skipped.

The Zed lake service does not automatically apply index rules to newly
loaded data.  Instead, the creation of indexes is driven by agents
external to the service, e.g., different orchestration logic can be deployed
for different workloads allowing out-of-order data, for instance, to
"settle down" and be "rolled up" before being indexed.

Index rules are organized into name sets so a set of indexes can be easily
applied to one or more data objects with the "index apply" command.
Once an rule set has been applied to an object, any changes to the named rules
do not have an immediate effect and the named set
must be reapplied.  In this case, "index apply" creates only the needed
new index objects to reflect the change.
`, New: New,
}

Functions

func New

func New(parent charm.Command, f *flag.FlagSet) (charm.Command, error)

Types

type Command

type Command struct {
	*root.Command
}

func (*Command) Run

func (c *Command) Run(args []string) error