Semantic search

This page or action requires Javascript to work, please enable Javascript in your browser or use a browser where this is supported so that functionality can be served and is provided as requested. For further assistance, please have a look at the noscript help page.

Search Clear all entries

name	kind	reference	text
map	general	general-steps	transforms the current step element to a new element (which may be empty). see also https://stackoverflow.com/questions/51015636/in-gremlin-how-does-map-really-work
repeat	branch	repeat-step	is used for looping over a traversal given some break predicate
choose	branch	choose-step	routes the current traverser to a particular traversal branch option. With choose(), it is possible to implement if/then/else-semantics as well as more complicated selections.
tryNext	terminal	terminal-steps	will return an Optional and thus, is a composite of hasNext()/next()
bothV	flatMap		maps the current edges to both the ingoing and outgoing Vertices.
inE	flatMap		maps the current elements to the the ingoing edges.
out	flatMap		maps the current elements to the vertices at the end of the outgoing edges.
outV	flatMap		The outV step maps the current edges to the outgoing Vertices.
by	modulator	by-step	is not an actual step, but instead is a "step-modulator" similar to as() and option(). If a step is able to accept traversals, functions, comparators, etc. then by() is the means by which they are added. The general pattern is step().by()…by(). Some steps can only accept one by() while others can take an arbitrary amount.
sum	reducing barrier	sum-step	operates on a stream of numbers and sums the numbers together to yield a result
in	flatMap		maps the current elements to the vertices at the end of the ingoing edges.
or	filter	or-step	ensures that at least one of the provided traversals yield a result.
emit	modulator	emit-step	is not an actual step, but is instead a step modulator for repeat() (find more documentation on the emit() there).
inV	flatMap		maps the current edges to the the ingoing Vertices.
promise	terminal	terminal-steps	can only be used with remote traversals to Gremlin Server or RGPs. It starts a promise to execute a function on the current Traversal that will be completed in the future.
where	filter	where-step	filters the current object based on either the object itself (Scope.local) or the path history of the object (Scope.global) (filter). This step is typically used in conjunction with either #match Step or select()-step, but can be used in isolation.
tail	filter	tail-step
path	map	path-step
addV	sideEffect	addvertex-step	is used to add vertices to the graph
branch	general	general-steps	Splits the traverser
label	map	label-step	maps the traversal to the labels of the current elements.
property	sideEffect	addproperty-step	is used to add properties to the elements of the graph
toList	terminal	terminal-steps	will return all results in a list
as	modulator	as-step	is not a real step, but a "step modulator" similar to by() and option(). With as(), it is possible to provide a label to the step that can later be accessed by steps and data structures that make use of such labels — e.g., select(), match(), and path
is	filter	is-step	filters elements that fullfill the given predicate. Variant: Filters elements that are equal to the given Object.
both	flatMap		maps the current elements to the vertices at the boths ends of the edges.
count	reducing barrier	count-step	counts the total number of represented traversers in the streams (i.e. the bulk count).
union	branch	repeat-step
cap	barrier	cap-step	Iterates the traversal up to the itself and emits the side-effect referenced by the key. If multiple keys are supplied then the side-effects are emitted as a Map.
addE	sideEffect	addedge-step	is used to add edges to the graph
filter	general	general-steps	Continues processing based on the given filter condition.
max	reducing barrier	max-step	operates on a stream of comparable objects and determines which is the last object according to its natural order in the stream.
coalesce	flatMap	coalesce-step	The coalesce()-step evaluates the provided traversals in order and returns the first traversal that emits at least one element.
toSet	terminal	terminal-steps	will return all results in a set and thus, duplicates removed
option	modulator	option-step	An option to a branch() or choose()
and	filter	and-step	ensures that all provided traversals yield a result
outE	flatMap		maps the current elements to the the outgoing edges.
bothE	flatMap		maps the current elements to both the in and outgoing edges.
iterate	terminal	terminal-steps	Iterates the traversal presumably for the generation of side-effects. See https://stackoverflow.com/questions/47403296/iterate-step-is-used-in-the-end-of-the-command-when-creating-nodes-and-edges-t
fold	reducing barrier	fold-step	There are situations when the traversal stream needs a "barrier" to aggregate all the objects and emit a computation that is a function of the aggregate. The fold()-step (map) is one particular instance of this. Please see unfold()-step for the inverse functionality.
explain	terminal	terminal-steps	will return a TraversalExplanation. A traversal explanation details how the traversal (prior to explain()) will be compiled given the registered traversal strategies. A TraversalExplanation has a toString() representation with 3-columns. The first column is the traversal strategy being applied. The second column is the traversal strategy category: [D]ecoration, [O]ptimization, [P]rovider optimization, [F]inalization, and [V]erification. Finally, the third column is the state of the traversal post strategy application. The final traversal is the resultant execution plan.
order	map	order-step	orders the traversal elements
select	map	select-step
limit	filter	limit-step
fill	terminal	terminal-steps	fill(collection) will put all results in the provided collection and return the collection when complete.
mean	reducing barrier	mean-step	operates on a stream of numbers and determines the average of those numbers.
sideEffect	general	general-steps	performs some operation on the traverser and passes it to the next step.
toBulkSet	terminal	terminal-steps	will return all results in a weighted set and thus, duplicates preserved via weighting
coin	filter	coin-step	randomly filters out traversers with the given probability
min	reducing barrier	min-step	operates on a stream of comparable objects and determines which is the first object according to its natural order in the stream.

Semantic search

Query log

Navigation menu

Search