metadb

type IDGenerator interface {
	// GenMetricID generates the metric id in the memory
	GenMetricID(namespace, metricName string, limits *models.Limits) (metricID metric.ID, err error)
	// GenFieldID generates the field id in the memory
	// error-case1: field type doesn't match to before
	// error-case2: there are too many fields
	GenFieldID(namespace, metricName string, fieldName field.Name, fieldType field.Type, limits *models.Limits) (field.ID, error)
	// GenTagKeyID generates the tag key id in the memory
	GenTagKeyID(namespace, metricName, tagKey string, limits *models.Limits) (tag.KeyID, error)
}

type IDGetter interface {
	// GetMetricID gets the metric id by namespace and metric name,
	// if not exist return constants.ErrMetricIDNotFound
	GetMetricID(namespace, metricName string) (metricID metric.ID, err error)
	// GetTagKeyID gets the tag key id by namespace/metric name/tag key,
	// if not exist return constants.ErrTagKeyIDNotFound
	GetTagKeyID(namespace, metricName, tagKey string) (tagKeyID tag.KeyID, err error)
	// GetAllTagKeys returns the all tag keys by namespace/metric name,
	// if not exist return  constants.ErrMetricIDNotFound.
	GetAllTagKeys(namespace, metricName string) (tags tag.Metas, err error)
	// GetField gets the field meta by namespace/metric name/field name, if not exist return series.ErrNotFound
	GetField(namespace, metricName string, fieldName field.Name) (field field.Meta, err error)
	// GetAllFields returns the all visible fields by namespace/metric name,
	// if not exist return series.ErrNotFound
	GetAllFields(namespace, metricName string) (fields field.Metas, err error)
	// GetAllHistogramFields returns histogram-fields namespace/metric name,
	// if not exist return series.ErrNotFound
	GetAllHistogramFields(namespace, metricName string) (fields field.Metas, err error)
}

type Metadata interface {
	io.Closer
	DatabaseName() string
	// MetadataDatabase returns the metric level metadata
	MetadataDatabase() MetadataDatabase
	// TagMetadata returns the tag metadata
	TagMetadata() TagMetadata
	// Flush flushes the metadata to disk
	Flush() error
}

type MetadataBackend interface {
	io.Closer
	// contains filtered or unexported methods
}

type MetadataDatabase interface {
	io.Closer
	IDGetter
	IDGenerator
	series.MetricMetaSuggester

	// SuggestNamespace suggests the namespace by namespace's prefix
	SuggestNamespace(prefix string, limit int) (namespaces []string, err error)
	// Sync syncs the pending metadata update event
	Sync() error
}

type MetricMetadata interface {
	// contains filtered or unexported methods
}

type TagEntry interface {
	// contains filtered or unexported methods
}

type TagMetadata interface {
	// GenTagValueID generates the tag value id for spec tag key
	GenTagValueID(tagKeyID tag.KeyID, tagValue string) (uint32, error)
	// SuggestTagValues returns suggestions from given tag key id and prefix of tag value
	SuggestTagValues(tagKeyID tag.KeyID, tagValuePrefix string, limit int) []string
	// FindTagValueDsByExpr finds tag value ids by tag filter expr for spec tag key,
	// if not exist, return nil, constants.ErrNotFound, else returns tag value ids
	FindTagValueDsByExpr(tagKeyID tag.KeyID, expr stmt.TagFilter) (*roaring.Bitmap, error)
	// GetTagValueIDsForTag get tag value ids for spec tag key of metric,
	// if not exist, return nil, constants.ErrNotFound, else returns tag value ids
	GetTagValueIDsForTag(tagKeyID tag.KeyID) (tagValueIDs *roaring.Bitmap, err error)
	// CollectTagValues collects the tag values by tag value ids,
	CollectTagValues(tagKeyID tag.KeyID,
		tagValueIDs *roaring.Bitmap,
		tagValues map[uint32]string,
	) error
	// Flush flushes the memory tag metadata into kv store
	Flush() error
}

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