metadata

Documentation

Overview

Package metadata implements a Raft-based distributed metadata storage system. Powered by etcd.

Index

• Constants
• type IndexFilter
• type Repo
• type Service
  • func NewClient(forceRegisterNode bool) (Service, error)

Constants

const (
	// DefaultNamespace is the default namespace of the metadata stored in etcd.
	DefaultNamespace = "banyandb"
	// FlagEtcdEndpointsName is the default flag name for etcd endpoints.
	FlagEtcdEndpointsName = "etcd-endpoints"
)

Types

type IndexFilter

type IndexFilter interface {
	// IndexRules fetches v1.IndexRule by subject defined in IndexRuleBinding
	IndexRules(ctx context.Context, subject *commonv1.Metadata) ([]*databasev1.IndexRule, error)
	// Subjects fetches Subject(s) by index rule
	Subjects(ctx context.Context, indexRule *databasev1.IndexRule, catalog commonv1.Catalog) ([]schema.Spec, error)
}

IndexFilter provides methods to find a specific index related objects and vice versa.

type Repo

type Repo interface {
	IndexFilter
	StreamRegistry() schema.Stream
	IndexRuleRegistry() schema.IndexRule
	IndexRuleBindingRegistry() schema.IndexRuleBinding
	MeasureRegistry() schema.Measure
	GroupRegistry() schema.Group
	TopNAggregationRegistry() schema.TopNAggregation
	PropertyRegistry() schema.Property
	RegisterHandler(string, schema.Kind, schema.EventHandler)
}

Repo is the facade to interact with the metadata repository.

type Service

type Service interface {
	Repo
	run.PreRunner
	run.Service
	run.Config
	SchemaRegistry() schema.Registry
}

Service is the metadata repository.

func NewClient

func NewClient(forceRegisterNode bool) (Service, error)

NewClient returns a new metadata client.