types

package
v0.7.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 22, 2017 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Overview

Package types is a generated protocol buffer package.

It is generated from these files: 

types/types.proto

It has these top-level messages: 

Posting
PostingList
Schema

Index

Constants

View Source 
const (
	// MinCellLevel is the smallest cell level (largest cell size) used by indexing
	MinCellLevel = 5 // Approx 250km x 380km
	// MaxCellLevel is the largest cell leve (smallest cell size) used by indexing
	MaxCellLevel = 16 // Approx 120m x 180m
	// MaxCells is the maximum number of cells to use when indexing regions.
	MaxCells = 18
)
View Source 
const (
	BinaryID   = TypeID(Posting_BINARY)
	Int32ID    = TypeID(Posting_INT32)
	FloatID    = TypeID(Posting_FLOAT)
	BoolID     = TypeID(Posting_BOOL)
	DateTimeID = TypeID(Posting_DATETIME)
	StringID   = TypeID(Posting_STRING)
	DateID     = TypeID(Posting_DATE)
	GeoID      = TypeID(Posting_GEO)
	UidID      = TypeID(Posting_UID)
	PasswordID = TypeID(Posting_PASSWORD)
	DefaultID  = TypeID(Posting_DEFAULT)
)

Note: These ids are stored in the posting lists to indicate the type of the data. The order *cannot* be changed without breaking existing data. When adding a new type *always* add to the end of this list. Never delete anything from this list even if it becomes unused.

View Source 
const EarthRadiusMeters = 1000 * 6371

EarthRadiusMeters is the radius of the earth in meters (in a spherical earth model).

Variables

View Source 
var (
	ErrInvalidLengthTypes = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTypes   = fmt.Errorf("proto: integer overflow")
)
View Source 
var Posting_ValType_name = map[int32]string{
	0:  "DEFAULT",
	1:  "BINARY",
	2:  "INT32",
	3:  "FLOAT",
	4:  "BOOL",
	5:  "DATE",
	6:  "DATETIME",
	7:  "GEO",
	8:  "UID",
	9:  "PASSWORD",
	10: "STRING",
}
View Source 
var Posting_ValType_value = map[string]int32{
	"DEFAULT":  0,
	"BINARY":   1,
	"INT32":    2,
	"FLOAT":    3,
	"BOOL":     4,
	"DATE":     5,
	"DATETIME": 6,
	"GEO":      7,
	"UID":      8,
	"PASSWORD": 9,
	"STRING":   10,
}

Functions

func EarthAngle added in v0.7.1 

func EarthAngle(dist float64) s1.Angle

EarthAngle converts a to distance on earth in meters to an angle

func Encrypt added in v0.7.3 

func Encrypt(plain string) (string, error)

func FilterGeoUids added in v0.7.1 

func FilterGeoUids(uids *task.List, values []*task.Value, q *GeoQueryData) *task.List

FilterGeoUids filters the uids based on the corresponding values and GeoQueryData.

func IndexGeoTokens added in v0.7.1 

func IndexGeoTokens(g geom.T) ([]string, error)

IndexTokens returns the tokens to be used in a geospatial index for the given geometry. If the geometry is not supported it returns an error.

func Intersects added in v0.7.1 

func Intersects(l1 *s2.Loop, l2 *s2.Loop) bool

Intersects returns true if the two loops intersect.

func IsGeoFunc added in v0.7.1 

func IsGeoFunc(str string) bool

IsGeoFunc returns if a function is of geo type.

func Less added in v0.7.1 

func Less(a, b Val) bool

Less returns true if a is strictly less than b.

func Marshal added in v0.7.1 

func Marshal(from Val, to *Val) error

func ObjectValue added in v0.7.1 

func ObjectValue(id TypeID, value interface{}) (*graph.Value, error)

ObjectValue converts into graph.Value.

func Sort added in v0.7.1 

func Sort(sID TypeID, v []Val, ul *task.List, desc bool) error

Sort sorts the given array in-place.

func VerifyPassword added in v0.7.3 

func VerifyPassword(plain, encrypted string) error

func WithinCapPolygon added in v0.7.1 

func WithinCapPolygon(g1 *s2.Loop, g2 *s2.Cap) bool

TODO(Ashwin): Improve this to make it more accurate.

func WithinPolygon added in v0.7.1 

func WithinPolygon(g1 *s2.Loop, g2 *s2.Loop) bool

WithinPolygon returns true if g1 is within g2 approximaltely. Note that this is very far from accurate within function and is a temporary fix. TODO(Ashwin): Improve this to make it more accurate.

Types

type Area added in v0.7.1 

type Area float64

Area denotes an area on Earth

func EarthArea added in v0.7.1 

func EarthArea(a float64) Area

EarthArea converts an area on the unit sphere to an area on earth in sq. meters.

func (Area) String added in v0.7.1 

func (a Area) String() string

String converts the area to human readable units

type GeoQueryData added in v0.7.1 

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

GeoQueryData is internal data used by the geo query filter to additionally filter the geometries.

func GetGeoTokens added in v0.7.1 

func GetGeoTokens(funcArgs []string) ([]string, *GeoQueryData, error)

GetGeoTokens returns the corresponding index keys based on the type of function.

func (GeoQueryData) MatchesFilter added in v0.7.1 

func (q GeoQueryData) MatchesFilter(g geom.T) bool

MatchesFilter applies the query filter to a geo value

type Length added in v0.7.1 

type Length float64

Length denotes a length on Earth

func EarthDistance added in v0.7.1 

func EarthDistance(angle s1.Angle) Length

EarthDistance converts an angle to distance on earth in meters.

func (Length) String added in v0.7.1 

func (l Length) String() string

String converts the length to human readable units

type Posting added in v0.7.1 

type Posting struct {
	Uid     uint64          `protobuf:"fixed64,1,opt,name=uid,proto3" json:"uid,omitempty"`
	Value   []byte          `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	ValType Posting_ValType `protobuf:"varint,3,opt,name=val_type,json=valType,proto3,enum=types.Posting_ValType" json:"val_type,omitempty"`
	Lang    string          `protobuf:"bytes,4,opt,name=lang,proto3" json:"lang,omitempty"`
	Label   string          `protobuf:"bytes,5,opt,name=label,proto3" json:"label,omitempty"`
	Commit  uint64          `protobuf:"varint,6,opt,name=commit,proto3" json:"commit,omitempty"`
	Facets  []*facets.Facet `protobuf:"bytes,7,rep,name=facets" json:"facets,omitempty"`
	// TODO: op is only used temporarily. See if we can remove it from here.
	Op uint32 `protobuf:"varint,12,opt,name=op,proto3" json:"op,omitempty"`
}

func (*Posting) Descriptor added in v0.7.1 

func (*Posting) Descriptor() ([]byte, []int)

func (*Posting) GetCommit added in v0.7.3 

func (m *Posting) GetCommit() uint64

func (*Posting) GetFacets added in v0.7.3 

func (m *Posting) GetFacets() []*facets.Facet

func (*Posting) GetLabel added in v0.7.3 

func (m *Posting) GetLabel() string

func (*Posting) GetLang added in v0.7.3 

func (m *Posting) GetLang() string

func (*Posting) GetOp added in v0.7.3 

func (m *Posting) GetOp() uint32

func (*Posting) GetUid added in v0.7.3 

func (m *Posting) GetUid() uint64

func (*Posting) GetValType added in v0.7.3 

func (m *Posting) GetValType() Posting_ValType

func (*Posting) GetValue added in v0.7.3 

func (m *Posting) GetValue() []byte

func (*Posting) Marshal added in v0.7.1 

func (m *Posting) Marshal() (dAtA []byte, err error)

func (*Posting) MarshalTo added in v0.7.1 

func (m *Posting) MarshalTo(dAtA []byte) (int, error)

func (*Posting) ProtoMessage added in v0.7.1 

func (*Posting) ProtoMessage()

func (*Posting) Reset added in v0.7.1 

func (m *Posting) Reset()

func (*Posting) Size added in v0.7.1 

func (m *Posting) Size() (n int)

func (*Posting) String added in v0.7.1 

func (m *Posting) String() string

func (*Posting) Unmarshal added in v0.7.1 

func (m *Posting) Unmarshal(dAtA []byte) error

type PostingList added in v0.7.1 

type PostingList struct {
	Postings []*Posting `protobuf:"bytes,1,rep,name=postings" json:"postings,omitempty"`
	Checksum []byte     `protobuf:"bytes,2,opt,name=checksum,proto3" json:"checksum,omitempty"`
	Commit   uint64     `protobuf:"varint,3,opt,name=commit,proto3" json:"commit,omitempty"`
}

func (*PostingList) Descriptor added in v0.7.1 

func (*PostingList) Descriptor() ([]byte, []int)

func (*PostingList) GetChecksum added in v0.7.3 

func (m *PostingList) GetChecksum() []byte

func (*PostingList) GetCommit added in v0.7.3 

func (m *PostingList) GetCommit() uint64

func (*PostingList) GetPostings added in v0.7.1 

func (m *PostingList) GetPostings() []*Posting

func (*PostingList) Marshal added in v0.7.1 

func (m *PostingList) Marshal() (dAtA []byte, err error)

func (*PostingList) MarshalTo added in v0.7.1 

func (m *PostingList) MarshalTo(dAtA []byte) (int, error)

func (*PostingList) ProtoMessage added in v0.7.1 

func (*PostingList) ProtoMessage()

func (*PostingList) Reset added in v0.7.1 

func (m *PostingList) Reset()

func (*PostingList) Size added in v0.7.1 

func (m *PostingList) Size() (n int)

func (*PostingList) String added in v0.7.1 

func (m *PostingList) String() string

func (*PostingList) Unmarshal added in v0.7.1 

func (m *PostingList) Unmarshal(dAtA []byte) error

type Posting_ValType added in v0.7.1 

type Posting_ValType int32
const (
	Posting_DEFAULT  Posting_ValType = 0
	Posting_BINARY   Posting_ValType = 1
	Posting_INT32    Posting_ValType = 2
	Posting_FLOAT    Posting_ValType = 3
	Posting_BOOL     Posting_ValType = 4
	Posting_DATE     Posting_ValType = 5
	Posting_DATETIME Posting_ValType = 6
	Posting_GEO      Posting_ValType = 7
	Posting_UID      Posting_ValType = 8
	Posting_PASSWORD Posting_ValType = 9
	Posting_STRING   Posting_ValType = 10
)

func (Posting_ValType) EnumDescriptor added in v0.7.1 

func (Posting_ValType) EnumDescriptor() ([]byte, []int)

func (Posting_ValType) String added in v0.7.1 

func (x Posting_ValType) String() string

type QueryType added in v0.7.1 

type QueryType byte

QueryType indicates the type of geo query. 

const (
	// QueryTypeWithin finds all points that are within the given geometry
	QueryTypeWithin QueryType = iota
	// QueryTypeContains finds all polygons that contain the given point
	QueryTypeContains
	// QueryTypeIntersects finds all objects that intersect the given geometry
	QueryTypeIntersects
	// QueryTypeNear finds all points that are within the given distance from the given point.
	QueryTypeNear
)

type Schema added in v0.7.3 

type Schema struct {
	ValueType uint32 `protobuf:"varint,1,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
	Reverse   bool   `protobuf:"varint,2,opt,name=reverse,proto3" json:"reverse,omitempty"`
	Tokenizer string `protobuf:"bytes,3,opt,name=tokenizer,proto3" json:"tokenizer,omitempty"`
}

func (*Schema) Descriptor added in v0.7.3 

func (*Schema) Descriptor() ([]byte, []int)

func (*Schema) GetReverse added in v0.7.3 

func (m *Schema) GetReverse() bool

func (*Schema) GetTokenizer added in v0.7.3 

func (m *Schema) GetTokenizer() string

func (*Schema) GetValueType added in v0.7.3 

func (m *Schema) GetValueType() uint32

func (*Schema) Marshal added in v0.7.3 

func (m *Schema) Marshal() (dAtA []byte, err error)

func (*Schema) MarshalTo added in v0.7.3 

func (m *Schema) MarshalTo(dAtA []byte) (int, error)

func (*Schema) ProtoMessage added in v0.7.3 

func (*Schema) ProtoMessage()

func (*Schema) Reset added in v0.7.3 

func (m *Schema) Reset()

func (*Schema) Size added in v0.7.3 

func (m *Schema) Size() (n int)

func (*Schema) String added in v0.7.3 

func (m *Schema) String() string

func (*Schema) Unmarshal added in v0.7.3 

func (m *Schema) Unmarshal(dAtA []byte) error

type TypeID 

type TypeID Posting_ValType

func TypeForName 

func TypeForName(name string) (TypeID, bool)

TypeForName returns the type corresponding to the given name. If name is not recognized, it returns nil.

func (TypeID) IsScalar added in v0.7.1 

func (t TypeID) IsScalar() bool

func (TypeID) Name added in v0.7.1 

func (t TypeID) Name() string

type Val added in v0.7.1 

type Val struct {
	Tid   TypeID
	Value interface{}
}

Val is a value with type information.

func Convert added in v0.7.1 

func Convert(from Val, toID TypeID) (Val, error)

Convert converts the value to given scalar type.

func ValFor added in v0.7.3 

func ValFor(f *facets.Facet) (Val, error)

func ValueForType 

func ValueForType(id TypeID) Val

ValueForType returns the zero value for a type id

func (Val) MarshalJSON added in v0.7.1 

func (v Val) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package facets is a generated protocol buffer package.
 Package facets is a generated protocol buffer package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.