gremlin_schema_query

Documentation

Overview

                         _       _
*__      _____  __ ___   ___  __ _| |_ ___
*\ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
* \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
*  \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
*
* Copyright © 2016 - 2019 Weaviate. All rights reserved.
* LICENSE: https://github.com/creativesoftwarefdn/weaviate/blob/develop/LICENSE.md
* DESIGN & CONCEPT: Bob van Luijt (@bobvanluijt)
* CONTACT: hello@creativesoftwarefdn.org

These package is a small DSL for doing schema modifications on JanusGraph. Note that under the hood, it uses a mutable buffer, so you cannot re-use partial queries.

Index

• type Cardinality
• type DataType
• type Multiplicity
• type SchemaQuery
  • func AwaitGraphIndicesAvailable(indices []string) SchemaQuery
  • func New() SchemaQuery

Types

type Cardinality

type Cardinality string

const CARDINALITY_SINGLE Cardinality = "SINGLE"

type DataType

type DataType string

const DATATYPE_BOOLEAN DataType = "Boolean"

const DATATYPE_DOUBLE DataType = "Double"

const DATATYPE_GEOSHAPE DataType = "Geoshape"

const DATATYPE_LONG DataType = "Long"

const DATATYPE_STRING DataType = "String"

type Multiplicity

type Multiplicity string

const MULTIPLICITY_MANY2ONE Multiplicity = "MANY2ONE"

const MULTIPLICITY_MULTI Multiplicity = "MULTI"

type SchemaQuery

type SchemaQuery interface {
	MakePropertyKey(name string, datatype DataType, cardinality Cardinality) SchemaQuery
	MakeIndexedPropertyKey(name string, datatype DataType, cardinality Cardinality, index string) SchemaQuery
	MakeIndexedPropertyKeyTextString(name string, datatype DataType, cardinality Cardinality, index string) SchemaQuery
	MakeEdgeLabel(name string, multiplicity Multiplicity) SchemaQuery
	MakeVertexLabel(name string) SchemaQuery

	// Add a graph wide composite index of potential a few properties.
	// If uniqueness is true, a uniqueness constraint will be placed on the combination of properties.
	AddGraphCompositeIndex(name string, propertyNames []string, uniqueness bool) SchemaQuery

	AddGraphMixedIndex(name string, propertyNames []string, indexName string) SchemaQuery
	AddGraphMixedIndexString(name string, propertyNames []string, indexName string) SchemaQuery

	Commit() SchemaQuery
	String() string
}

func AwaitGraphIndicesAvailable

func AwaitGraphIndicesAvailable(indices []string) SchemaQuery

func New

func New() SchemaQuery