getmeta

Documentation

Overview

Package getmeta provides the local get meta graphql endpoint for Weaviate

Package getmeta provides the Local GetMeta graphql endpoint for Weaviate

Package getmeta provides the local get meta graphql endpoint for Weaviate

Index

• func Build(dbSchema *schema.Schema) (*graphql.Field, error)
• type MetaProperty
• type Params
• type Resolver
• type StatisticalAnalysis

Functions

func Build

func Build(dbSchema *schema.Schema) (*graphql.Field, error)

Build the local queries from the database schema.

Types

type MetaProperty

type MetaProperty struct {
	Name                schema.PropertyName
	StatisticalAnalyses []StatisticalAnalysis
}

MetaProperty is any property of a class that we want to retrieve meta information about

type Params

type Params struct {
	Kind             kind.Kind
	Filters          *common_filters.LocalFilter
	ClassName        schema.ClassName
	Properties       []MetaProperty
	IncludeMetaCount bool
}

Params to describe the Local->GetMeta->Kind->Class query. Will be passed to the individual connector methods responsible for resolving the GetMeta query.

type Resolver

type Resolver interface {
	LocalGetMeta(info *Params) (interface{}, error)
}

Resolver is a local interface that can be composed with other interfaces to form the overall GraphQL API main interface. All data-base connectors that want to support the GetMeta feature must implement this interface.

type StatisticalAnalysis

type StatisticalAnalysis string

StatisticalAnalysis is the desired computation that the database connector should perform on this property

const (
	// Type can be applied to any field and will return the type of the field,
	// such as "int" or "string"
	Type StatisticalAnalysis = "type"

	// Count the occurence of this property
	Count StatisticalAnalysis = "count"

	// Sum of all the values of the prop (i.e. sum of all Ints or Numbers)
	Sum StatisticalAnalysis = "sum"

	// Mean calculates the mean of an Int or Number
	Mean StatisticalAnalysis = "mean"

	// Maximum selects the maximum value of an Int or Number
	Maximum StatisticalAnalysis = "maximum"

	// Minimum selects the maximum value of an Int or Number
	Minimum StatisticalAnalysis = "minimum"

	// TotalTrue is the sum of all boolean fields, that are true
	TotalTrue StatisticalAnalysis = "totalTrue"

	// TotalFalse is the sum of all boolean fields, that are false
	TotalFalse StatisticalAnalysis = "totalFalse"

	// PercentageTrue is the percentage of all boolean fields, that are true
	PercentageTrue StatisticalAnalysis = "percentageTrue"

	// PercentageFalse is the percentage of all boolean fields, that are false
	PercentageFalse StatisticalAnalysis = "percentageFalse"

	// PointingTo is the list of all classes that this reference prop points to
	PointingTo StatisticalAnalysis = "pointingTo"

	// TopOccurrences of strings, selection can be made more specific with
	// TopOccurrencesValues for now. In the future there might also be other
	// sub-props.
	TopOccurrences StatisticalAnalysis = "topOccurrences"

	// TopOccurrencesValue is a sub-prop of TopOccurrences
	TopOccurrencesValue StatisticalAnalysis = "value"

	// TopOccurrencesOccurs is a sub-prop of TopOccurrences
	TopOccurrencesOccurs StatisticalAnalysis = "occurs"
)