v1

Documentation

Overview

Package v1 implements helpers to access data defined by API v1.

Index

• Variables
• func DecodeFieldFlag(key []byte) (*databasev1.FieldSpec, time.Duration, error)
• func DecodeFieldValue(fieldValue []byte, fieldSpec *databasev1.FieldSpec) (*modelv1.FieldValue, error)
• func EncodeFamily(familySpec *databasev1.TagFamilySpec, family *modelv1.TagFamilyForWrite) ([]byte, error)
• func EncoderFieldFlag(fieldSpec *databasev1.FieldSpec, interval time.Duration) []byte
• func FieldValueTypeConv(fieldValue *modelv1.FieldValue) (tagType databasev1.FieldType, isNull bool)
• func FindTagByName(families []*databasev1.TagFamilySpec, tagName string) (int, int, *databasev1.TagSpec)
• func MarshalTagValue(tagValue *modelv1.TagValue) ([]byte, error)
• func ParseMaxModRevision(indexRules []*databasev1.IndexRule) (maxRevisionForIdxRules int64)
• type TagValue
  • func ParseTagValue(tagValue *modelv1.TagValue) (TagValue, error)
  • func (fv TagValue) GetArr() [][]byte
  • func (fv TagValue) GetValue() []byte

Variables

var (
	// TagFlag is a flag suffix to identify the encoding method.
	TagFlag = make([]byte, fieldFlagLength)
)

Functions

func DecodeFieldFlag

func DecodeFieldFlag(key []byte) (*databasev1.FieldSpec, time.Duration, error)

DecodeFieldFlag decodes the encoding method, compression method, and interval from bytes.

func DecodeFieldValue

func DecodeFieldValue(fieldValue []byte, fieldSpec *databasev1.FieldSpec) (*modelv1.FieldValue, error)

DecodeFieldValue decodes bytes to field value based on its specification.

func EncodeFamily

func EncodeFamily(familySpec *databasev1.TagFamilySpec, family *modelv1.TagFamilyForWrite) ([]byte, error)

EncodeFamily encodes a tag family to bytes by referring to its specification.

func EncoderFieldFlag

func EncoderFieldFlag(fieldSpec *databasev1.FieldSpec, interval time.Duration) []byte

EncoderFieldFlag encodes the encoding method, compression method, and interval into bytes.

func FieldValueTypeConv

func FieldValueTypeConv(fieldValue *modelv1.FieldValue) (tagType databasev1.FieldType, isNull bool)

FieldValueTypeConv recognizes the field type from its value.

func FindTagByName

func FindTagByName(families []*databasev1.TagFamilySpec, tagName string) (int, int, *databasev1.TagSpec)

FindTagByName finds TagSpec in several tag families by its name. The tag name should be unique in these families.

func MarshalTagValue

func MarshalTagValue(tagValue *modelv1.TagValue) ([]byte, error)

MarshalTagValue encodes modelv1.TagValue to bytes.

func ParseMaxModRevision

func ParseMaxModRevision(indexRules []*databasev1.IndexRule) (maxRevisionForIdxRules int64)

ParseMaxModRevision parses the index rule's max revision field from its metadata.

Types

type TagValue

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

TagValue seels single value and array value.

func ParseTagValue

func ParseTagValue(tagValue *modelv1.TagValue) (TagValue, error)

ParseTagValue decodes modelv1.TagValue to TagValue.

func (TagValue) GetArr

func (fv TagValue) GetArr() [][]byte

GetArr returns the array value.

func (TagValue) GetValue

func (fv TagValue) GetValue() []byte

GetValue returns the single value.