dataset

Documentation

Index

• type ArrayType
• type BooleanType
• type DataPath
  • func (l *DataPath) HasBoolCount() bool
  • func (l *DataPath) HasFloatCount() bool
  • func (l *DataPath) HasIntCount() bool
  • func (l *DataPath) HasNumCount() bool
  • func (l *DataPath) HasStringCount() bool
  • func (l *DataPath) Merge(r DataPath) *DataPath
• type DataSet
  • func (d *DataSet) GetSize() uint64
• type FloatType
• type IntType
• type NullType
• type ObjectType
• type StringType

Types

type ArrayType

type ArrayType struct {
	// An optional count of how many documents have the given type at the path
	Count   *uint64
	MinSize *uint64
	MaxSize *uint64
}

ArrayType represents a possible Array type of a DataPath. The type may be augmented with statistics about the distribution of the data

type BooleanType

type BooleanType struct {
	// An optional count of how many documents have the given type at the path
	Count      *uint64
	FalseCount *uint64
	TrueCount  *uint64
}

BooleanType represents a possible Boolean type of a DataPath. The type may be augmented with statistics about the distribution of the data

type DataPath

type DataPath struct {
	// The Path expression of the Path
	Path string
	// Information about the existence and distribution of string values
	Stringtype *StringType
	// Information about the existence and distribution of float values
	Floattype *FloatType
	// Information about the existence and distribution of integer values
	Inttype *IntType
	// Information about the existence and distribution of bool values
	Booltype *BooleanType
	// Information about the existence and distribution of null values
	Nulltype *NullType
	// Information about the existence and distribution of object values
	Objecttype *ObjectType
	// Information about the existence and distribution of array values
	Arraytype *ArrayType
	// Information about the existence of the path
	Count *uint64
}

A DataPath represents a single path within a document of a DataSet.

func (*DataPath) HasBoolCount

func (l *DataPath) HasBoolCount() bool

func (*DataPath) HasFloatCount

func (l *DataPath) HasFloatCount() bool

func (*DataPath) HasIntCount

func (l *DataPath) HasIntCount() bool

func (*DataPath) HasNumCount

func (l *DataPath) HasNumCount() bool

func (*DataPath) HasStringCount

func (l *DataPath) HasStringCount() bool

func (*DataPath) Merge

func (l *DataPath) Merge(r DataPath) *DataPath

Merge merges two DataPaths and accumulates their statistics. They have to represent the same path. If not, nil is returned.

type DataSet

type DataSet struct {
	// The Name/ID of the dataset
	Name string
	// The real number of documents in the dataset. Should be set if known
	Count *uint64
	// The expected number of documents
	ExpectedCount uint64
	// The merged pathinformation of all documents in the dataset
	Paths map[string]*DataPath
	// The parent DataSet, if it exists
	DerivedFrom *DataSet
}

DataSet represents a set of documents from the source query system It serves as an abstractions of the DBMS/Data Processor/... specific table/dataset/collection/...

func (*DataSet) GetSize

func (d *DataSet) GetSize() uint64

GetSize returns the expected or actual number of documents in the dataset

type FloatType

type FloatType struct {
	// An optional count of how many documents have the given type at the path
	Count  *uint64
	Min    *float64
	Max    *float64
	Unique *uint64
}

FloatType represents a possible Float type of a DataPath. The type may be augmented with statistics about the distribution of the data

type IntType

type IntType struct {
	// An optional count of how many documents have the given type at the path
	Count  *uint64
	Min    *int64
	Max    *int64
	Unique *uint64
}

IntType represents a possible integer type of a DataPath. The type may be augmented with statistics about the distribution of the data

type NullType

type NullType struct {
	// An optional count of how many documents have the given type at the path
	Count *uint64
}

NullType represents a possible Null type of a DataPath. The type may be augmented with statistics about the distribution of the data

type ObjectType

type ObjectType struct {
	// An optional count of how many documents have the given type at the path
	Count      *uint64
	MinMembers *uint64
	MaxMembers *uint64
}

ObjectType represents a possible object type of a DataPath. The type may be augmented with statistics about the distribution of the data

type StringType

type StringType struct {
	// An optional count of how many documents have the given type at the path
	Count    *uint64
	Min      *string
	Max      *string
	Unique   *uint64
	Prefixes []string
}

StringType represents a possible String type of a DataPath. The type may be augmented with statistics about the distribution of the data