schema

Documentation

Overview

Package schema implements a framework to sync schema info from the metadata repository.

Index

• type EventKind
• type EventType
• type Group
• type MetadataEvent
• type Metrics
  • func NewMetrics(factory *observability.Factory) *Metrics
• type Repository
  • func NewPortableRepository(metadata metadata.Repo, l *logger.Logger, supplier ResourceSchemaSupplier, ...) Repository
  • func NewRepository(metadata metadata.Repo, l *logger.Logger, resourceSupplier ResourceSupplier, ...) Repository
• type Resource
• type ResourceSchema
• type ResourceSchemaSupplier
• type ResourceSupplier
• type Supplier

Types

type EventKind

type EventKind uint8

EventKind defines category of events.

const (
	EventKindGroup EventKind = iota
	EventKindResource
	EventKindTopNAgg
)

This framework groups events to a hierarchy. A group is the root node.

type EventType

type EventType uint8

EventType defines actions of events.

const (
	EventAddOrUpdate EventType = iota
	EventDelete
)

EventType support Add/Update and Delete. All events are idempotent.

type Group

type Group interface {
	GetSchema() *commonv1.Group
	SupplyTSDB() io.Closer
}

Group is the root node, allowing get resources from its sub nodes.

type MetadataEvent

type MetadataEvent struct {
	Metadata ResourceSchema
	Typ      EventType
	Kind     EventKind
}

MetadataEvent is the syncing message between metadata repo and this framework.

type Metrics

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

Metrics is a collection of metrics.

func NewMetrics

func NewMetrics(factory *observability.Factory) *Metrics

NewMetrics creates a new Metrics.

type Repository

type Repository interface {
	Watcher()
	Init(schema.Kind) []int64
	SendMetadataEvent(MetadataEvent)
	LoadGroup(name string) (Group, bool)
	LoadResource(metadata *commonv1.Metadata) (Resource, bool)
	Close()
	StopCh() <-chan struct{}
}

Repository is the collection of several hierarchies groups by a "Group".

func NewPortableRepository

func NewPortableRepository(
	metadata metadata.Repo,
	l *logger.Logger,
	supplier ResourceSchemaSupplier,
	metrics *Metrics,
) Repository

NewPortableRepository return a new Repository without tsdb.

func NewRepository

func NewRepository(
	metadata metadata.Repo,
	l *logger.Logger,
	resourceSupplier ResourceSupplier,
	metrics *Metrics,
) Repository

NewRepository return a new Repository.

type Resource

type Resource interface {
	io.Closer
	IndexRules() []*databasev1.IndexRule
	TopN() []*databasev1.TopNAggregation
	Schema() ResourceSchema
	Delegated() io.Closer
}

Resource allows access metadata from a local cache.

type ResourceSchema

type ResourceSchema interface {
	GetMetadata() *commonv1.Metadata
}

ResourceSchema allows get the metadata.

type ResourceSchemaSupplier

type ResourceSchemaSupplier interface {
	ResourceSchema(metadata *commonv1.Metadata) (ResourceSchema, error)
	OpenResource(shardNum uint32, supplier Supplier, spec Resource) (io.Closer, error)
}

ResourceSchemaSupplier allows get a ResourceSchema from the metadata.

type ResourceSupplier

type ResourceSupplier interface {
	ResourceSchemaSupplier
	OpenDB(groupSchema *commonv1.Group) (io.Closer, error)
}

ResourceSupplier allows open a resource and its embedded tsdb.

type Supplier

type Supplier interface {
	SupplyTSDB() io.Closer
}

Supplier allows open a tsdb.