specv3

package
v4.1.0 Latest Latest
Warning

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

 Go to latest Published: Oct 19, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsSupportedNodeIDFunction 

func IsSupportedNodeIDFunction(function string) bool

func IsSupportedNodeIDValueType 

func IsSupportedNodeIDValueType(t ValueType) bool

func IsSupportedPropValueType 

func IsSupportedPropValueType(t ValueType) bool

Types

type Edge 

type Edge struct {
	Name  string       `yaml:"name"`
	Src   *EdgeNodeRef `yaml:"src"`
	Dst   *EdgeNodeRef `yaml:"dst"`
	Rank  *Rank        `yaml:"rank,omitempty"`
	Props Props        `yaml:"props,omitempty"`

	IgnoreExistedIndex *bool `yaml:"ignoreExistedIndex,omitempty"`

	Filter *specbase.Filter `yaml:"filter,omitempty"`

	Mode specbase.Mode `yaml:"mode,omitempty"`
	// contains filtered or unexported fields
}

func NewEdge 

func NewEdge(name string, opts ...EdgeOption) *Edge

func (*Edge) Complete 

func (e *Edge) Complete()

func (*Edge) Options 

func (e *Edge) Options(opts ...EdgeOption) *Edge

func (*Edge) Statement added in v4.1.0 

func (e *Edge) Statement(records ...Record) (statement string, nRecord int, err error)

func (*Edge) Validate 

func (e *Edge) Validate() error

type EdgeNodeRef 

type EdgeNodeRef struct {
	Name string  `yaml:"-"`
	ID   *NodeID `yaml:"id"`
}

func (*EdgeNodeRef) Complete 

func (n *EdgeNodeRef) Complete()

func (*EdgeNodeRef) IDValue 

func (n *EdgeNodeRef) IDValue(record Record) (string, error)

func (*EdgeNodeRef) Validate 

func (n *EdgeNodeRef) Validate() error

type EdgeOption 

type EdgeOption func(*Edge)

func WithEdgeDst 

func WithEdgeDst(dst *EdgeNodeRef) EdgeOption

func WithEdgeFilter added in v4.1.0 

func WithEdgeFilter(f *specbase.Filter) EdgeOption

func WithEdgeIgnoreExistedIndex 

func WithEdgeIgnoreExistedIndex(ignore bool) EdgeOption

func WithEdgeMode added in v4.1.0 

func WithEdgeMode(m specbase.Mode) EdgeOption

func WithEdgeProps 

func WithEdgeProps(props ...*Prop) EdgeOption

func WithEdgeSrc 

func WithEdgeSrc(src *EdgeNodeRef) EdgeOption

func WithRank 

func WithRank(rank *Rank) EdgeOption

type Edges 

type Edges []*Edge

func (Edges) Complete 

func (es Edges) Complete()

func (Edges) Validate 

func (es Edges) Validate() error

type Graph 

type Graph struct {
	Name  string `yaml:"name"`
	Nodes Nodes  `yaml:"tags,omitempty"`
	Edges Edges  `yaml:"edges,omitempty"`
}

func NewGraph 

func NewGraph(name string, opts ...GraphOption) *Graph

func (*Graph) AddEdges 

func (g *Graph) AddEdges(edges ...*Edge)

func (*Graph) AddNodes 

func (g *Graph) AddNodes(nodes ...*Node)

func (*Graph) Complete 

func (g *Graph) Complete()

func (*Graph) EdgeStatement added in v4.1.0 

func (g *Graph) EdgeStatement(e *Edge, records ...Record) (statement string, nRecord int, err error)

func (*Graph) EdgeStatementBuilder added in v4.1.0 

func (g *Graph) EdgeStatementBuilder(e *Edge) specbase.StatementBuilder

func (*Graph) GetEdgeByName 

func (g *Graph) GetEdgeByName(name string) (*Edge, bool)

func (*Graph) GetNodeByName 

func (g *Graph) GetNodeByName(name string) (*Node, bool)

func (*Graph) NodeStatement added in v4.1.0 

func (g *Graph) NodeStatement(n *Node, records ...Record) (statement string, nRecord int, err error)

func (*Graph) NodeStatementBuilder added in v4.1.0 

func (g *Graph) NodeStatementBuilder(n *Node) specbase.StatementBuilder

func (*Graph) Validate 

func (g *Graph) Validate() error

type GraphOption 

type GraphOption func(*Graph)

func WithGraphEdges 

func WithGraphEdges(edges ...*Edge) GraphOption

func WithGraphNodes 

func WithGraphNodes(nodes ...*Node) GraphOption

type Node 

type Node struct {
	Name  string  `yaml:"name"`
	ID    *NodeID `yaml:"id"`
	Props Props   `yaml:"props,omitempty"`

	IgnoreExistedIndex *bool `yaml:"ignoreExistedIndex,omitempty"`

	Filter *specbase.Filter `yaml:"filter,omitempty"`

	Mode specbase.Mode `yaml:"mode,omitempty"`
	// contains filtered or unexported fields
}

Node is VERTEX in 3.x

func NewNode 

func NewNode(name string, opts ...NodeOption) *Node

func (*Node) Complete 

func (n *Node) Complete()

func (*Node) Options 

func (n *Node) Options(opts ...NodeOption) *Node

func (*Node) Statement added in v4.1.0 

func (n *Node) Statement(records ...Record) (statement string, nRecord int, err error)

func (*Node) Validate 

func (n *Node) Validate() error

type NodeID 

type NodeID struct {
	Name        string        `yaml:"-"`
	Type        ValueType     `yaml:"type"`
	Index       int           `yaml:"index"`
	ConcatItems []interface{} `yaml:"concatItems,omitempty"` // only support string and int, string for constant, int is for Index
	Function    *string       `yaml:"function"`
	// contains filtered or unexported fields
}

NodeID is the VID in 3.x

func (*NodeID) Complete 

func (id *NodeID) Complete()

func (*NodeID) Validate 

func (id *NodeID) Validate() error

func (*NodeID) Value 

func (id *NodeID) Value(record Record) (string, error)

type NodeOption 

type NodeOption func(*Node)

func WithNodeFilter added in v4.1.0 

func WithNodeFilter(f *specbase.Filter) NodeOption

func WithNodeID 

func WithNodeID(id *NodeID) NodeOption

func WithNodeIgnoreExistedIndex 

func WithNodeIgnoreExistedIndex(ignore bool) NodeOption

func WithNodeMode added in v4.1.0 

func WithNodeMode(m specbase.Mode) NodeOption

func WithNodeProps 

func WithNodeProps(props ...*Prop) NodeOption

type Nodes 

type Nodes []*Node

func (Nodes) Complete 

func (ns Nodes) Complete()

func (Nodes) Validate 

func (ns Nodes) Validate() error

type Prop 

type Prop struct {
	Name               string    `yaml:"name"`
	Type               ValueType `yaml:"type"`
	Index              int       `yaml:"index"`
	Nullable           bool      `yaml:"nullable"`
	NullValue          string    `yaml:"nullValue"`
	AlternativeIndices []int     `yaml:"alternativeIndices,omitempty"`
	DefaultValue       *string   `yaml:"defaultValue"`
	// contains filtered or unexported fields
}

func (*Prop) Complete 

func (p *Prop) Complete()

func (*Prop) SetValue added in v4.1.0 

func (p *Prop) SetValue(record Record) (string, error)

func (*Prop) Validate 

func (p *Prop) Validate() error

func (*Prop) Value 

func (p *Prop) Value(record Record) (string, error)

type Props 

type Props []*Prop

func (Props) Append 

func (ps Props) Append(props ...*Prop) Props

func (Props) Complete 

func (ps Props) Complete()

func (Props) NameList 

func (ps Props) NameList() []string

func (Props) SetValueList added in v4.1.0 

func (ps Props) SetValueList(record Record) ([]string, error)

func (Props) Validate 

func (ps Props) Validate() error

func (Props) ValueList 

func (ps Props) ValueList(record Record) ([]string, error)

type Rank 

type Rank struct {
	Index int `yaml:"index"`
	// contains filtered or unexported fields
}

func (*Rank) Complete 

func (*Rank) Complete()

func (*Rank) Validate 

func (r *Rank) Validate() error

func (*Rank) Value 

func (r *Rank) Value(record Record) (string, error)

type Record 

type Record = specbase.Record

type Records 

type Records = specbase.Records

type ValueType 

type ValueType string
const (
	ValueTypeBool          ValueType = "BOOL"
	ValueTypeInt           ValueType = "INT"
	ValueTypeString        ValueType = "STRING"
	ValueTypeFloat         ValueType = "FLOAT"
	ValueTypeDouble        ValueType = "DOUBLE"
	ValueTypeDate          ValueType = "DATE"
	ValueTypeTime          ValueType = "TIME"
	ValueTypeDateTime      ValueType = "DATETIME"
	ValueTypeTimestamp     ValueType = "TIMESTAMP"
	ValueTypeGeo           ValueType = "GEOGRAPHY"
	ValueTypeGeoPoint      ValueType = "GEOGRAPHY(POINT)"
	ValueTypeGeoLineString ValueType = "GEOGRAPHY(LINESTRING)"
	ValueTypeGeoPolygon    ValueType = "GEOGRAPHY(POLYGON)"

	ValueTypeDefault = ValueTypeString
)

func (ValueType) Equal 

func (t ValueType) Equal(vt ValueType) bool

func (ValueType) String 

func (t ValueType) String() string

Source Files

View all Source files

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.