Table of Contents

Class GraphTraversal<TStart, TEnd>

Namespace
Gremlin.Net.Process.Traversal
Assembly
Gremlin.Net.dll

Graph traversals are the primary way in which graphs are processed.

public class GraphTraversal<TStart, TEnd> : DefaultTraversal<TStart, TEnd>, ITraversal<TStart, TEnd>, ITraversal, IEnumerator<TEnd?>, IEnumerator, IDisposable

Type Parameters

TStart
TEnd
Inheritance
DefaultTraversal<TStart, TEnd>
GraphTraversal<TStart, TEnd>
Implements
ITraversal<TStart, TEnd>
Inherited Members

Constructors

GraphTraversal()

Initializes a new instance of the GraphTraversal<TStart, TEnd> class.

public GraphTraversal()

GraphTraversal(ICollection<ITraversalStrategy>, Bytecode)

Initializes a new instance of the GraphTraversal<TStart, TEnd> class.

public GraphTraversal(ICollection<ITraversalStrategy> traversalStrategies, Bytecode bytecode)

Parameters

traversalStrategies ICollection<ITraversalStrategy>

The traversal strategies to be used by this graph traversal at evaluation time.

bytecode Bytecode

The Bytecode associated with the construction of this graph traversal.

Properties

Bytecode 

public override Bytecode Bytecode { get; }

Property Value

Bytecode

Methods

AddE(ITraversal)

Adds the addE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> AddE(ITraversal edgeLabelTraversal)

Parameters

edgeLabelTraversal ITraversal

Returns

GraphTraversal<TStart, Edge>

AddE(string)

Adds the addE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> AddE(string edgeLabel)

Parameters

edgeLabel string

Returns

GraphTraversal<TStart, Edge>

AddV()

Adds the addV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> AddV()

Returns

GraphTraversal<TStart, Vertex>

AddV(ITraversal)

Adds the addV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> AddV(ITraversal vertexLabelTraversal)

Parameters

vertexLabelTraversal ITraversal

Returns

GraphTraversal<TStart, Vertex>

AddV(string)

Adds the addV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> AddV(string vertexLabel)

Parameters

vertexLabel string

Returns

GraphTraversal<TStart, Vertex>

Aggregate(Scope, string)

Adds the aggregate step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Aggregate(Scope scope, string sideEffectKey)

Parameters

scope Scope
sideEffectKey string

Returns

GraphTraversal<TStart, TEnd>

Aggregate(string)

Adds the aggregate step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Aggregate(string sideEffectKey)

Parameters

sideEffectKey string

Returns

GraphTraversal<TStart, TEnd>

All(P?)

Adds the all step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> All(P? predicate)

Parameters

predicate P

Returns

GraphTraversal<TStart, TEnd>

And(params ITraversal[])

Adds the and step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> And(params ITraversal[] andTraversals)

Parameters

andTraversals ITraversal[]

Returns

GraphTraversal<TStart, TEnd>

Any(P?)

Adds the any step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Any(P? predicate)

Parameters

predicate P

Returns

GraphTraversal<TStart, TEnd>

As(string, params string[])

Adds the as step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> As(string stepLabel, params string[] stepLabels)

Parameters

stepLabel string
stepLabels string[]

Returns

GraphTraversal<TStart, TEnd>

AsDate()

Adds the asDate step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, DateTimeOffset> AsDate()

Returns

GraphTraversal<TStart, DateTimeOffset>

AsString()

Adds the asString step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> AsString()

Returns

GraphTraversal<TStart, string>

AsString<TNewEnd>(Scope)

Adds the asString step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> AsString<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Barrier()

Adds the barrier step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Barrier()

Returns

GraphTraversal<TStart, TEnd>

Barrier(IConsumer)

Adds the barrier step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Barrier(IConsumer barrierConsumer)

Parameters

barrierConsumer IConsumer

Returns

GraphTraversal<TStart, TEnd>

Barrier(int)

Adds the barrier step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Barrier(int maxBarrierSize)

Parameters

maxBarrierSize int

Returns

GraphTraversal<TStart, TEnd>

Both(params string?[])

Adds the both step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> Both(params string?[] edgeLabels)

Parameters

edgeLabels string[]

Returns

GraphTraversal<TStart, Vertex>

BothE(params string?[])

Adds the bothE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> BothE(params string?[] edgeLabels)

Parameters

edgeLabels string[]

Returns

GraphTraversal<TStart, Edge>

BothV()

Adds the bothV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> BothV()

Returns

GraphTraversal<TStart, Vertex>

Branch<TNewEnd>(IFunction?)

Adds the branch step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Branch<TNewEnd>(IFunction? function)

Parameters

function IFunction

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Branch<TNewEnd>(ITraversal)

Adds the branch step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Branch<TNewEnd>(ITraversal branchTraversal)

Parameters

branchTraversal ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

By()

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By()

Returns

GraphTraversal<TStart, TEnd>

By(IComparator)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(IComparator comparator)

Parameters

comparator IComparator

Returns

GraphTraversal<TStart, TEnd>

By(IFunction)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(IFunction function)

Parameters

function IFunction

Returns

GraphTraversal<TStart, TEnd>

By(IFunction, IComparator)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(IFunction function, IComparator comparator)

Parameters

function IFunction
comparator IComparator

Returns

GraphTraversal<TStart, TEnd>

By(ITraversal)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(ITraversal traversal)

Parameters

traversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

By(ITraversal, IComparator)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(ITraversal traversal, IComparator comparator)

Parameters

traversal ITraversal
comparator IComparator

Returns

GraphTraversal<TStart, TEnd>

By(Order)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(Order order)

Parameters

order Order

Returns

GraphTraversal<TStart, TEnd>

By(T)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(T token)

Parameters

token T

Returns

GraphTraversal<TStart, TEnd>

By(string?)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(string? key)

Parameters

key string

Returns

GraphTraversal<TStart, TEnd>

By(string?, IComparator)

Adds the by step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> By(string? key, IComparator comparator)

Parameters

key string
comparator IComparator

Returns

GraphTraversal<TStart, TEnd>

Call<TNewEnd>(string?)

Adds the call step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Call<TNewEnd>(string? service)

Parameters

service string

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Call<TNewEnd>(string?, ITraversal?)

Adds the call step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Call<TNewEnd>(string? service, ITraversal? t)

Parameters

service string
t ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Call<TNewEnd>(string?, IDictionary<object, object>?)

Adds the call step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Call<TNewEnd>(string? service, IDictionary<object, object>? m)

Parameters

service string
m IDictionary<object, object>

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Call<TNewEnd>(string?, IDictionary<object, object>?, ITraversal?)

Adds the call step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Call<TNewEnd>(string? service, IDictionary<object, object>? m, ITraversal? t)

Parameters

service string
m IDictionary<object, object>
t ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Cap<TNewEnd>(string, params string[])

Adds the cap step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Cap<TNewEnd>(string sideEffectKey, params string[] sideEffectKeys)

Parameters

sideEffectKey string
sideEffectKeys string[]

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Choose<TNewEnd>(IFunction)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(IFunction choiceFunction)

Parameters

choiceFunction IFunction

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Choose<TNewEnd>(IPredicate, ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(IPredicate choosePredicate, ITraversal trueChoice)

Parameters

choosePredicate IPredicate
trueChoice ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Choose<TNewEnd>(IPredicate, ITraversal, ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(IPredicate choosePredicate, ITraversal trueChoice, ITraversal falseChoice)

Parameters

choosePredicate IPredicate
trueChoice ITraversal
falseChoice ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Choose<TNewEnd>(ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(ITraversal choiceTraversal)

Parameters

choiceTraversal ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Choose<TNewEnd>(ITraversal, ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(ITraversal traversalPredicate, ITraversal trueChoice)

Parameters

traversalPredicate ITraversal
trueChoice ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Choose<TNewEnd>(ITraversal, ITraversal, ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(ITraversal traversalPredicate, ITraversal trueChoice, ITraversal falseChoice)

Parameters

traversalPredicate ITraversal
trueChoice ITraversal
falseChoice ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Clone()

Make a copy of a traversal that is reset for iteration.

public GraphTraversal<TStart, TEnd> Clone()

Returns

GraphTraversal<TStart, TEnd>

Coalesce<TNewEnd>(params ITraversal[])

Adds the coalesce step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Coalesce<TNewEnd>(params ITraversal[] coalesceTraversals)

Parameters

coalesceTraversals ITraversal[]

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Coin(double)

Adds the coin step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Coin(double probability)

Parameters

probability double

Returns

GraphTraversal<TStart, TEnd>

Combine(object)

Adds the combine step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Combine(object combineObject)

Parameters

combineObject object

Returns

GraphTraversal<TStart, TEnd>

Concat(ITraversal, params ITraversal[]?)

Adds the concat step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string> Concat(ITraversal concatTraversal, params ITraversal[]? otherConcatTraversals)

Parameters

concatTraversal ITraversal
otherConcatTraversals ITraversal[]

Returns

GraphTraversal<TStart, string>

Concat(params string?[])

Adds the concat step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string> Concat(params string?[] concatStrings)

Parameters

concatStrings string[]

Returns

GraphTraversal<TStart, string>

Conjoin(string)

Adds the conjoin step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd?> Conjoin(string delimiter)

Parameters

delimiter string

Returns

GraphTraversal<TStart, TEnd>

ConnectedComponent()

Adds the connectedComponent step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> ConnectedComponent()

Returns

GraphTraversal<TStart, TEnd>

Constant<TNewEnd>(TNewEnd)

Adds the constant step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Constant<TNewEnd>(TNewEnd e)

Parameters

e TNewEnd

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Count()

Adds the count step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, long> Count()

Returns

GraphTraversal<TStart, long>

Count(Scope)

Adds the count step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, long> Count(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, long>

CyclicPath()

Adds the cyclicPath step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> CyclicPath()

Returns

GraphTraversal<TStart, TEnd>

DateAdd(DT, int)

Adds the dateAdd step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, DateTimeOffset> DateAdd(DT dateToken, int value)

Parameters

dateToken DT
value int

Returns

GraphTraversal<TStart, DateTimeOffset>

DateDiff(ITraversal)

Adds the dateDiff step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, long> DateDiff(ITraversal dateTraversal)

Parameters

dateTraversal ITraversal

Returns

GraphTraversal<TStart, long>

DateDiff(DateTimeOffset)

Adds the dateDiff step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, long> DateDiff(DateTimeOffset value)

Parameters

value DateTimeOffset

Returns

GraphTraversal<TStart, long>

Dedup(Scope, params string?[])

Adds the dedup step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Dedup(Scope scope, params string?[] dedupLabels)

Parameters

scope Scope
dedupLabels string[]

Returns

GraphTraversal<TStart, TEnd>

Dedup(params string?[])

Adds the dedup step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Dedup(params string?[] dedupLabels)

Parameters

dedupLabels string[]

Returns

GraphTraversal<TStart, TEnd>

Difference(object)

Adds the difference step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Difference(object differenceObject)

Parameters

differenceObject object

Returns

GraphTraversal<TStart, TEnd>

Disjunct(object)

Adds the disjunct step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Disjunct(object disjunctObject)

Parameters

disjunctObject object

Returns

GraphTraversal<TStart, TEnd>

Drop()

Adds the drop step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Drop()

Returns

GraphTraversal<TStart, TEnd>

E(params object?[]?)

Adds the E step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> E(params object?[]? edgeIdsOrElements)

Parameters

edgeIdsOrElements object[]

Returns

GraphTraversal<TStart, Edge>

Element()

Adds the element step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Element> Element()

Returns

GraphTraversal<TStart, Element>

ElementMap<TNewEnd>(params string?[])

Adds the elementMap step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<object, TNewEnd>> ElementMap<TNewEnd>(params string?[] propertyKeys)

Parameters

propertyKeys string[]

Returns

GraphTraversal<TStart, IDictionary<object, TNewEnd>>

Type Parameters

TNewEnd

Emit()

Adds the emit step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Emit()

Returns

GraphTraversal<TStart, TEnd>

Emit(IPredicate)

Adds the emit step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Emit(IPredicate emitPredicate)

Parameters

emitPredicate IPredicate

Returns

GraphTraversal<TStart, TEnd>

Emit(ITraversal)

Adds the emit step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Emit(ITraversal emitTraversal)

Parameters

emitTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

Fail()

Adds the fail step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Fail()

Returns

GraphTraversal<TStart, TEnd>

Fail(string?)

Adds the fail step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Fail(string? msg)

Parameters

msg string

Returns

GraphTraversal<TStart, TEnd>

Fail(string?, IDictionary<string, object>)

Adds the fail step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Fail(string? msg, IDictionary<string, object> m)

Parameters

msg string
m IDictionary<string, object>

Returns

GraphTraversal<TStart, TEnd>

Filter(IPredicate?)

Adds the filter step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Filter(IPredicate? predicate)

Parameters

predicate IPredicate

Returns

GraphTraversal<TStart, TEnd>

Filter(ITraversal)

Adds the filter step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Filter(ITraversal filterTraversal)

Parameters

filterTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

FlatMap<TNewEnd>(IFunction?)

Adds the flatMap step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> FlatMap<TNewEnd>(IFunction? function)

Parameters

function IFunction

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

FlatMap<TNewEnd>(ITraversal)

Adds the flatMap step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> FlatMap<TNewEnd>(ITraversal flatMapTraversal)

Parameters

flatMapTraversal ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Fold()

Adds the fold step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IList<TEnd>> Fold()

Returns

GraphTraversal<TStart, IList<TEnd>>

Fold<TNewEnd>(TNewEnd, IBiFunction?)

Adds the fold step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Fold<TNewEnd>(TNewEnd seed, IBiFunction? foldFunction)

Parameters

seed TNewEnd
foldFunction IBiFunction

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Format(string)

Adds the format step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string> Format(string format)

Parameters

format string

Returns

GraphTraversal<TStart, string>

From(ITraversal)

Adds the from step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> From(ITraversal fromVertex)

Parameters

fromVertex ITraversal

Returns

GraphTraversal<TStart, TEnd>

From(Vertex?)

Adds the from step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> From(Vertex? fromVertex)

Parameters

fromVertex Vertex

Returns

GraphTraversal<TStart, TEnd>

From(string?)

Adds the from step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> From(string? fromStepLabel)

Parameters

fromStepLabel string

Returns

GraphTraversal<TStart, TEnd>

Group(string)

Adds the group step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Group(string sideEffectKey)

Parameters

sideEffectKey string

Returns

GraphTraversal<TStart, TEnd>

GroupCount(string)

Adds the groupCount step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> GroupCount(string sideEffectKey)

Parameters

sideEffectKey string

Returns

GraphTraversal<TStart, TEnd>

GroupCount<K>()

Adds the groupCount step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<K, long>> GroupCount<K>()

Returns

GraphTraversal<TStart, IDictionary<K, long>>

Type Parameters

K

Group<K, V>()

Adds the group step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<K, V>> Group<K, V>()

Returns

GraphTraversal<TStart, IDictionary<K, V>>

Type Parameters

K
V

Has(T, ITraversal)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(T accessor, ITraversal propertyTraversal)

Parameters

accessor T
propertyTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

Has(T, P?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(T accessor, P? predicate)

Parameters

accessor T
predicate P

Returns

GraphTraversal<TStart, TEnd>

Has(T, object?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(T accessor, object? value)

Parameters

accessor T
value object

Returns

GraphTraversal<TStart, TEnd>

Has(string?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(string? propertyKey)

Parameters

propertyKey string

Returns

GraphTraversal<TStart, TEnd>

Has(string?, ITraversal)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(string? propertyKey, ITraversal propertyTraversal)

Parameters

propertyKey string
propertyTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

Has(string?, P?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(string? propertyKey, P? predicate)

Parameters

propertyKey string
predicate P

Returns

GraphTraversal<TStart, TEnd>

Has(string?, object?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(string? propertyKey, object? value)

Parameters

propertyKey string
value object

Returns

GraphTraversal<TStart, TEnd>

Has(string?, string?, P?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(string? label, string? propertyKey, P? predicate)

Parameters

label string
propertyKey string
predicate P

Returns

GraphTraversal<TStart, TEnd>

Has(string?, string?, object?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Has(string? label, string? propertyKey, object? value)

Parameters

label string
propertyKey string
value object

Returns

GraphTraversal<TStart, TEnd>

HasId(P?)

Adds the hasId step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasId(P? predicate)

Parameters

predicate P

Returns

GraphTraversal<TStart, TEnd>

HasId(object?, params object?[]?)

Adds the hasId step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasId(object? id, params object?[]? otherIds)

Parameters

id object
otherIds object[]

Returns

GraphTraversal<TStart, TEnd>

HasKey(P?)

Adds the hasKey step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasKey(P? predicate)

Parameters

predicate P

Returns

GraphTraversal<TStart, TEnd>

HasKey(string?, params string?[]?)

Adds the hasKey step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasKey(string? label, params string?[]? otherLabels)

Parameters

label string
otherLabels string[]

Returns

GraphTraversal<TStart, TEnd>

HasLabel(P?)

Adds the hasLabel step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasLabel(P? predicate)

Parameters

predicate P

Returns

GraphTraversal<TStart, TEnd>

HasLabel(string?, params string?[]?)

Adds the hasLabel step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasLabel(string? label, params string?[]? otherLabels)

Parameters

label string
otherLabels string[]

Returns

GraphTraversal<TStart, TEnd>

HasNot(string?)

Adds the hasNot step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasNot(string? propertyKey)

Parameters

propertyKey string

Returns

GraphTraversal<TStart, TEnd>

HasValue(P?)

Adds the hasValue step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasValue(P? predicate)

Parameters

predicate P

Returns

GraphTraversal<TStart, TEnd>

HasValue(object?, params object?[]?)

Adds the hasValue step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> HasValue(object? value, params object?[]? otherValues)

Parameters

value object
otherValues object[]

Returns

GraphTraversal<TStart, TEnd>

Id()

Adds the id step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, object> Id()

Returns

GraphTraversal<TStart, object>

Identity()

Adds the identity step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Identity()

Returns

GraphTraversal<TStart, TEnd>

In(params string?[])

Adds the in step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> In(params string?[] edgeLabels)

Parameters

edgeLabels string[]

Returns

GraphTraversal<TStart, Vertex>

InE(params string?[])

Adds the inE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> InE(params string?[] edgeLabels)

Parameters

edgeLabels string[]

Returns

GraphTraversal<TStart, Edge>

InV()

Adds the inV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> InV()

Returns

GraphTraversal<TStart, Vertex>

Index<TNewEnd>()

Adds the index step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Index<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Inject(params TEnd?[]?)

Adds the inject step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Inject(params TEnd?[]? injections)

Parameters

injections TEnd[]

Returns

GraphTraversal<TStart, TEnd>

Intersect(object)

Adds the intersect step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Intersect(object intersectObject)

Parameters

intersectObject object

Returns

GraphTraversal<TStart, TEnd>

Is(P?)

Adds the is step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Is(P? predicate)

Parameters

predicate P

Returns

GraphTraversal<TStart, TEnd>

Is(object?)

Adds the is step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Is(object? value)

Parameters

value object

Returns

GraphTraversal<TStart, TEnd>

Key()

Adds the key step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string> Key()

Returns

GraphTraversal<TStart, string>

LTrim()

Adds the lTrim step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> LTrim()

Returns

GraphTraversal<TStart, string>

LTrim<TNewEnd>(Scope)

Adds the lTrim step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> LTrim<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Label()

Adds the label step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string> Label()

Returns

GraphTraversal<TStart, string>

Length()

Adds the length step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, int?> Length()

Returns

GraphTraversal<TStart, int?>

Length<TNewEnd>(Scope)

Adds the length step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> Length<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Limit<TNewEnd>(Scope, long)

Adds the limit step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Limit<TNewEnd>(Scope scope, long limit)

Parameters

scope Scope
limit long

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Limit<TNewEnd>(long)

Adds the limit step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Limit<TNewEnd>(long limit)

Parameters

limit long

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Local<TNewEnd>(ITraversal)

Adds the local step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Local<TNewEnd>(ITraversal localTraversal)

Parameters

localTraversal ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Loops()

Adds the loops step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, int> Loops()

Returns

GraphTraversal<TStart, int>

Loops(string?)

Adds the loops step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, int> Loops(string? loopName)

Parameters

loopName string

Returns

GraphTraversal<TStart, int>

Map<TNewEnd>(IFunction?)

Adds the map step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Map<TNewEnd>(IFunction? function)

Parameters

function IFunction

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Map<TNewEnd>(ITraversal)

Adds the map step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Map<TNewEnd>(ITraversal mapTraversal)

Parameters

mapTraversal ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Match<TNewEnd>(params ITraversal[])

Adds the match step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<string, TNewEnd>> Match<TNewEnd>(params ITraversal[] matchTraversals)

Parameters

matchTraversals ITraversal[]

Returns

GraphTraversal<TStart, IDictionary<string, TNewEnd>>

Type Parameters

TNewEnd

Math(string)

Adds the math step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, double> Math(string expression)

Parameters

expression string

Returns

GraphTraversal<TStart, double>

Max<TNewEnd>()

Adds the max step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Max<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Max<TNewEnd>(Scope)

Adds the max step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Max<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Mean<TNewEnd>()

Adds the mean step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Mean<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Mean<TNewEnd>(Scope)

Adds the mean step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Mean<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Merge(object)

Adds the merge step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Merge(object mergeObject)

Parameters

mergeObject object

Returns

GraphTraversal<TStart, TEnd>

MergeE()

Adds the mergeE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> MergeE()

Returns

GraphTraversal<TStart, Edge>

MergeE(ITraversal?)

Adds the mergeE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> MergeE(ITraversal? t)

Parameters

t ITraversal

Returns

GraphTraversal<TStart, Edge>

MergeE(IDictionary<object, object>?)

Adds the mergeE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> MergeE(IDictionary<object, object>? m)

Parameters

m IDictionary<object, object>

Returns

GraphTraversal<TStart, Edge>

MergeV()

Adds the mergeV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> MergeV()

Returns

GraphTraversal<TStart, Vertex>

MergeV(ITraversal?)

Adds the mergeV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> MergeV(ITraversal? t)

Parameters

t ITraversal

Returns

GraphTraversal<TStart, Vertex>

MergeV(IDictionary<object, object>?)

Adds the mergeV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> MergeV(IDictionary<object, object>? m)

Parameters

m IDictionary<object, object>

Returns

GraphTraversal<TStart, Vertex>

Min<TNewEnd>()

Adds the min step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Min<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Min<TNewEnd>(Scope)

Adds the min step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Min<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

None()

Adds the none step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> None()

Returns

GraphTraversal<TStart, TEnd>

Not(ITraversal)

Adds the not step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Not(ITraversal notTraversal)

Parameters

notTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

Option(ITraversal?)

Adds the option step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Option(ITraversal? traversalOption)

Parameters

traversalOption ITraversal

Returns

GraphTraversal<TStart, TEnd>

Option(object, ITraversal?)

Adds the option step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Option(object pickToken, ITraversal? traversalOption)

Parameters

pickToken object
traversalOption ITraversal

Returns

GraphTraversal<TStart, TEnd>

Option(object, IDictionary<object, object>?)

Adds the option step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Option(object pickToken, IDictionary<object, object>? traversalOption)

Parameters

pickToken object
traversalOption IDictionary<object, object>

Returns

GraphTraversal<TStart, TEnd>

Option(object, IDictionary<object, object>, Cardinality)

Adds the option step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Option(object pickToken, IDictionary<object, object> traversalOption, Cardinality cardinality)

Parameters

pickToken object
traversalOption IDictionary<object, object>
cardinality Cardinality

Returns

GraphTraversal<TStart, TEnd>

Optional<TNewEnd>(ITraversal)

Adds the optional step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Optional<TNewEnd>(ITraversal optionalTraversal)

Parameters

optionalTraversal ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Or(params ITraversal[])

Adds the or step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Or(params ITraversal[] orTraversals)

Parameters

orTraversals ITraversal[]

Returns

GraphTraversal<TStart, TEnd>

Order()

Adds the order step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Order()

Returns

GraphTraversal<TStart, TEnd>

Order(Scope)

Adds the order step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Order(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TEnd>

OtherV()

Adds the otherV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> OtherV()

Returns

GraphTraversal<TStart, Vertex>

Out(params string?[])

Adds the out step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> Out(params string?[] edgeLabels)

Parameters

edgeLabels string[]

Returns

GraphTraversal<TStart, Vertex>

OutE(params string?[])

Adds the outE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> OutE(params string?[] edgeLabels)

Parameters

edgeLabels string[]

Returns

GraphTraversal<TStart, Edge>

OutV()

Adds the outV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> OutV()

Returns

GraphTraversal<TStart, Vertex>

PageRank()

Adds the pageRank step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> PageRank()

Returns

GraphTraversal<TStart, TEnd>

PageRank(double)

Adds the pageRank step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> PageRank(double alpha)

Parameters

alpha double

Returns

GraphTraversal<TStart, TEnd>

Path()

Adds the path step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Path> Path()

Returns

GraphTraversal<TStart, Path>

PeerPressure()

Adds the peerPressure step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> PeerPressure()

Returns

GraphTraversal<TStart, TEnd>

Product(object)

Adds the product step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Product(object productObject)

Parameters

productObject object

Returns

GraphTraversal<TStart, TEnd>

Profile(string)

Adds the profile step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Profile(string sideEffectKey)

Parameters

sideEffectKey string

Returns

GraphTraversal<TStart, TEnd>

Profile<TNewEnd>()

Adds the profile step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Profile<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Program(object)

Adds the program step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Program(object vertexProgram)

Parameters

vertexProgram object

Returns

GraphTraversal<TStart, TEnd>

Project<TNewEnd>(string?, params string?[])

Adds the project step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<string, TNewEnd>> Project<TNewEnd>(string? projectKey, params string?[] otherProjectKeys)

Parameters

projectKey string
otherProjectKeys string[]

Returns

GraphTraversal<TStart, IDictionary<string, TNewEnd>>

Type Parameters

TNewEnd

Properties<TNewEnd>(params string?[])

Adds the properties step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Properties<TNewEnd>(params string?[] propertyKeys)

Parameters

propertyKeys string[]

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Property(Cardinality, object?, object?, params object?[])

Adds the property step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Property(Cardinality cardinality, object? key, object? value, params object?[] keyValues)

Parameters

cardinality Cardinality
key object
value object
keyValues object[]

Returns

GraphTraversal<TStart, TEnd>

Property(object?, object?, params object?[])

Adds the property step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Property(object? key, object? value, params object?[] keyValues)

Parameters

key object
value object
keyValues object[]

Returns

GraphTraversal<TStart, TEnd>

PropertyMap<TNewEnd>(params string?[])

Adds the propertyMap step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<string, TNewEnd>> PropertyMap<TNewEnd>(params string?[] propertyKeys)

Parameters

propertyKeys string[]

Returns

GraphTraversal<TStart, IDictionary<string, TNewEnd>>

Type Parameters

TNewEnd

RTrim()

Adds the rTrim step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> RTrim()

Returns

GraphTraversal<TStart, string>

RTrim<TNewEnd>(Scope)

Adds the rTrim step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> RTrim<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Range<TNewEnd>(Scope, long, long)

Adds the range step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Range<TNewEnd>(Scope scope, long low, long high)

Parameters

scope Scope
low long
high long

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Range<TNewEnd>(long, long)

Adds the range step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Range<TNewEnd>(long low, long high)

Parameters

low long
high long

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Read()

Adds the read step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Read()

Returns

GraphTraversal<TStart, TEnd>

Repeat(ITraversal)

Adds the repeat step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Repeat(ITraversal repeatTraversal)

Parameters

repeatTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

Repeat(string, ITraversal)

Adds the repeat step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Repeat(string loopName, ITraversal repeatTraversal)

Parameters

loopName string
repeatTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

Replace(string?, string?)

Adds the replace step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> Replace(string? oldChar, string? newChar)

Parameters

oldChar string
newChar string

Returns

GraphTraversal<TStart, string>

Replace<TNewEnd>(Scope, string?, string?)

Adds the replace step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> Replace<TNewEnd>(Scope scope, string? oldChar, string? newChar)

Parameters

scope Scope
oldChar string
newChar string

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Reverse()

Adds the reverse step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Reverse()

Returns

GraphTraversal<TStart, TEnd>

Sack(IBiFunction)

Adds the sack step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Sack(IBiFunction sackOperator)

Parameters

sackOperator IBiFunction

Returns

GraphTraversal<TStart, TEnd>

Sack<TNewEnd>()

Adds the sack step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Sack<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Sample(Scope, int)

Adds the sample step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Sample(Scope scope, int amountToSample)

Parameters

scope Scope
amountToSample int

Returns

GraphTraversal<TStart, TEnd>

Sample(int)

Adds the sample step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Sample(int amountToSample)

Parameters

amountToSample int

Returns

GraphTraversal<TStart, TEnd>

Select<TNewEnd>(Column)

Adds the select step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, ICollection<TNewEnd>> Select<TNewEnd>(Column column)

Parameters

column Column

Returns

GraphTraversal<TStart, ICollection<TNewEnd>>

Type Parameters

TNewEnd

Select<TNewEnd>(ITraversal)

Adds the select step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Select<TNewEnd>(ITraversal keyTraversal)

Parameters

keyTraversal ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Select<TNewEnd>(Pop, ITraversal)

Adds the select step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Select<TNewEnd>(Pop pop, ITraversal keyTraversal)

Parameters

pop Pop
keyTraversal ITraversal

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Select<TNewEnd>(Pop, string?)

Adds the select step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Select<TNewEnd>(Pop pop, string? selectKey)

Parameters

pop Pop
selectKey string

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Select<TNewEnd>(Pop, string?, string?, params string?[])

Adds the select step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<string, TNewEnd>> Select<TNewEnd>(Pop pop, string? selectKey1, string? selectKey2, params string?[] otherSelectKeys)

Parameters

pop Pop
selectKey1 string
selectKey2 string
otherSelectKeys string[]

Returns

GraphTraversal<TStart, IDictionary<string, TNewEnd>>

Type Parameters

TNewEnd

Select<TNewEnd>(string?)

Adds the select step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Select<TNewEnd>(string? selectKey)

Parameters

selectKey string

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Select<TNewEnd>(string?, string?, params string?[])

Adds the select step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<string, TNewEnd>> Select<TNewEnd>(string? selectKey1, string? selectKey2, params string?[] otherSelectKeys)

Parameters

selectKey1 string
selectKey2 string
otherSelectKeys string[]

Returns

GraphTraversal<TStart, IDictionary<string, TNewEnd>>

Type Parameters

TNewEnd

ShortestPath()

Adds the shortestPath step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Path> ShortestPath()

Returns

GraphTraversal<TStart, Path>

SideEffect(IConsumer?)

Adds the sideEffect step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> SideEffect(IConsumer? consumer)

Parameters

consumer IConsumer

Returns

GraphTraversal<TStart, TEnd>

SideEffect(ITraversal)

Adds the sideEffect step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> SideEffect(ITraversal sideEffectTraversal)

Parameters

sideEffectTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

SimplePath()

Adds the simplePath step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> SimplePath()

Returns

GraphTraversal<TStart, TEnd>

Skip<TNewEnd>(Scope, long)

Adds the skip step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Skip<TNewEnd>(Scope scope, long skip)

Parameters

scope Scope
skip long

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Skip<TNewEnd>(long)

Adds the skip step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Skip<TNewEnd>(long skip)

Parameters

skip long

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Split(string?)

Adds the split step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, List<string>?> Split(string? splitChar)

Parameters

splitChar string

Returns

GraphTraversal<TStart, List<string>>

Split<TNewEnd>(Scope, string?)

Adds the split step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, List<TNewEnd>?> Split<TNewEnd>(Scope scope, string? splitChar)

Parameters

scope Scope
splitChar string

Returns

GraphTraversal<TStart, List<TNewEnd>>

Type Parameters

TNewEnd

Store(string)

Adds the store step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Store(string sideEffectKey)

Parameters

sideEffectKey string

Returns

GraphTraversal<TStart, TEnd>

Subgraph(string)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> Subgraph(string sideEffectKey)

Parameters

sideEffectKey string

Returns

GraphTraversal<TStart, Edge>

Substring(int)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> Substring(int startIndex)

Parameters

startIndex int

Returns

GraphTraversal<TStart, string>

Substring(int, int)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> Substring(int startIndex, int endIndex)

Parameters

startIndex int
endIndex int

Returns

GraphTraversal<TStart, string>

Substring<TNewEnd>(Scope, int)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> Substring<TNewEnd>(Scope scope, int startIndex)

Parameters

scope Scope
startIndex int

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Substring<TNewEnd>(Scope, int, int)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> Substring<TNewEnd>(Scope scope, int startIndex, int endIndex)

Parameters

scope Scope
startIndex int
endIndex int

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Sum<TNewEnd>()

Adds the sum step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Sum<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Sum<TNewEnd>(Scope)

Adds the sum step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Sum<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Tail<TNewEnd>()

Adds the tail step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Tail<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Tail<TNewEnd>(Scope)

Adds the tail step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Tail<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Tail<TNewEnd>(Scope, long)

Adds the tail step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Tail<TNewEnd>(Scope scope, long limit)

Parameters

scope Scope
limit long

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Tail<TNewEnd>(long)

Adds the tail step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Tail<TNewEnd>(long limit)

Parameters

limit long

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

TimeLimit(long)

Adds the timeLimit step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> TimeLimit(long timeLimit)

Parameters

timeLimit long

Returns

GraphTraversal<TStart, TEnd>

Times(int)

Adds the times step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Times(int maxLoops)

Parameters

maxLoops int

Returns

GraphTraversal<TStart, TEnd>

To(Direction?, params string?[])

Adds the to step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> To(Direction? direction, params string?[] edgeLabels)

Parameters

direction Direction
edgeLabels string[]

Returns

GraphTraversal<TStart, Vertex>

To(ITraversal)

Adds the to step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> To(ITraversal toVertex)

Parameters

toVertex ITraversal

Returns

GraphTraversal<TStart, TEnd>

To(Vertex?)

Adds the to step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> To(Vertex? toVertex)

Parameters

toVertex Vertex

Returns

GraphTraversal<TStart, TEnd>

To(string?)

Adds the to step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> To(string? toStepLabel)

Parameters

toStepLabel string

Returns

GraphTraversal<TStart, TEnd>

ToE(Direction?, params string?[])

Adds the toE step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Edge> ToE(Direction? direction, params string?[] edgeLabels)

Parameters

direction Direction
edgeLabels string[]

Returns

GraphTraversal<TStart, Edge>

ToLower()

Adds the toLower step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> ToLower()

Returns

GraphTraversal<TStart, string>

ToLower<TNewEnd>(Scope)

Adds the toLower step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> ToLower<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

ToUpper()

Adds the toUpper step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> ToUpper()

Returns

GraphTraversal<TStart, string>

ToUpper<TNewEnd>(Scope)

Adds the toUpper step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> ToUpper<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

ToV(Direction?)

Adds the toV step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> ToV(Direction? direction)

Parameters

direction Direction

Returns

GraphTraversal<TStart, Vertex>

Tree(string)

Adds the tree step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Tree(string sideEffectKey)

Parameters

sideEffectKey string

Returns

GraphTraversal<TStart, TEnd>

Tree<TNewEnd>()

Adds the tree step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Tree<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Trim()

Adds the trim step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, string?> Trim()

Returns

GraphTraversal<TStart, string>

Trim<TNewEnd>(Scope)

Adds the trim step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd?> Trim<TNewEnd>(Scope scope)

Parameters

scope Scope

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Unfold<TNewEnd>()

Adds the unfold step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Unfold<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Union<TNewEnd>(params ITraversal[])

Adds the union step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Union<TNewEnd>(params ITraversal[] unionTraversals)

Parameters

unionTraversals ITraversal[]

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Until(IPredicate)

Adds the until step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Until(IPredicate untilPredicate)

Parameters

untilPredicate IPredicate

Returns

GraphTraversal<TStart, TEnd>

Until(ITraversal)

Adds the until step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Until(ITraversal untilTraversal)

Parameters

untilTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

V(params object?[]?)

Adds the V step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, Vertex> V(params object?[]? vertexIdsOrElements)

Parameters

vertexIdsOrElements object[]

Returns

GraphTraversal<TStart, Vertex>

ValueMap<TKey, TValue>(bool, params string?[])

Adds the valueMap step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<TKey, TValue>> ValueMap<TKey, TValue>(bool includeTokens, params string?[] propertyKeys)

Parameters

includeTokens bool
propertyKeys string[]

Returns

GraphTraversal<TStart, IDictionary<TKey, TValue>>

Type Parameters

TKey
TValue

ValueMap<TKey, TValue>(params string?[])

Adds the valueMap step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, IDictionary<TKey, TValue>> ValueMap<TKey, TValue>(params string?[] propertyKeys)

Parameters

propertyKeys string[]

Returns

GraphTraversal<TStart, IDictionary<TKey, TValue>>

Type Parameters

TKey
TValue

Value<TNewEnd>()

Adds the value step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Value<TNewEnd>()

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Values<TNewEnd>(params string?[])

Adds the values step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TNewEnd> Values<TNewEnd>(params string?[] propertyKeys)

Parameters

propertyKeys string[]

Returns

GraphTraversal<TStart, TNewEnd>

Type Parameters

TNewEnd

Where(ITraversal)

Adds the where step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Where(ITraversal whereTraversal)

Parameters

whereTraversal ITraversal

Returns

GraphTraversal<TStart, TEnd>

Where(P)

Adds the where step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Where(P predicate)

Parameters

predicate P

Returns

GraphTraversal<TStart, TEnd>

Where(string, P)

Adds the where step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Where(string startKey, P predicate)

Parameters

startKey string
predicate P

Returns

GraphTraversal<TStart, TEnd>

With(string)

Adds the with step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> With(string key)

Parameters

key string

Returns

GraphTraversal<TStart, TEnd>

With(string, object?)

Adds the with step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> With(string key, object? value)

Parameters

key string
value object

Returns

GraphTraversal<TStart, TEnd>

Write()

Adds the write step to this GraphTraversal<TStart, TEnd>.

public GraphTraversal<TStart, TEnd> Write()

Returns

GraphTraversal<TStart, TEnd>