schema

Documentation

Index

• Variables
• type DimensionTransformFunction
• type FieldOption
• type SchemaBuilder
  • func NewSchemaBuilder() *SchemaBuilder
  • func (b *SchemaBuilder) Build() (*schema.Schema, error)
  • func (b *SchemaBuilder) NewDimension(name string, maxDimensionSetSize uint32, opts ...FieldOption) *SchemaBuilder
  • func (b *SchemaBuilder) NewIntegerDimension(name string, maxDimensionValue uint32) *SchemaBuilder
  • func (b *SchemaBuilder) NewMetric(name string) *SchemaBuilder

Variables

var WithCollapsingLevel = schema.WithLevel

WithCollapsingLevel defines CollapsingLevel for a dimension. CollapsingLevel determines if specific dimension value should be aggregated into "AGGR" value. CollapsingLevel is specified as a percent of elements above threshold value for both staging and priority tables in corelation to maximum of elements between maximum and threshold config values for specific table. This is percent value and should be number within 0-100 range. More about collapsing algorithm in TableSizesLimits doc string.

var WithTransformFunction = schema.WithTransformFunction

WithTransformFunction defines pair of function which transform dimension raw value from []byte to LookupCode and from LookupCode to string when dimension value will be published Presence of this pair of functions assumes that dimension will be not stored in LookupTable and converted value will be directly encoded in tables key.

Types

type DimensionTransformFunction

type DimensionTransformFunction = schema.DimensionTransformFunction

type FieldOption

type FieldOption = schema.FieldOption

type SchemaBuilder

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

func NewSchemaBuilder

func NewSchemaBuilder() *SchemaBuilder

func (*SchemaBuilder) Build

func (b *SchemaBuilder) Build() (*schema.Schema, error)

func (*SchemaBuilder) NewDimension

func (b *SchemaBuilder) NewDimension(name string, maxDimensionSetSize uint32, opts ...FieldOption) *SchemaBuilder

NewDimension builds new dimension definition name - name of the dimension used later by publisher to build Dimension in MetricSet maxDimensionSetSize - cardinality of given dimension, specify maximal size of unique dimensions which will be accumulated

during publishing period, minimum value is 4, two elements are reserved for internal use

func (*SchemaBuilder) NewIntegerDimension

func (b *SchemaBuilder) NewIntegerDimension(name string, maxDimensionValue uint32) *SchemaBuilder

func (*SchemaBuilder) NewMetric

func (b *SchemaBuilder) NewMetric(name string) *SchemaBuilder