All Products
Search
Document Center

:Overview

Last Updated:Feb 21, 2024

Types

  • Element: An element step reads vertices or edges from a graph.

  • Map: A map step maps input objects to other objects.

  • Filter: A filter step filters input objects.

  • sideEffect: A sideEffect step allows input objects to proceed unchanged, but generates some computational sideEffects in the process.

  • Branch: A branch step splits input objects and sends each to an arbitrary location in the traversal.

  • Modulator: A modulator step provides parameters for other steps.

  • Function: Functions are provided to steps. For example, comparison functions can be provided to filter steps.

  • Policy: Users can customize policies for traversal steps.

Description

Note: Steps that are marked with asterisks (*) are extended steps of iGraph. Other steps are open source Apache Gremlin steps.

Type

Step

Description

Element

E

Reads edges from a graph.

inV

Returns the vertices that are associated with an edge.

out

Returns the vertices that are associated with a vertex

outE

Returns the edges that are associated with a vertex

V

Reads vertices from a graph.

Map

barrier

Serves as a barrier.

bulk

Returns the bulk value of an element.

cap

Returns the value of a sideEffect.

constant

Returns a custom constant value.

count

Counts the number of input objects.

fold

Aggregates input objects into a list<object>.

group

Groups input objects based on a specific rule.

groupCount

Groups input objects based on a specific rule and returns the number of objects in each group.

identity

Returns input objects.

label

Returns the graph labels of elements.

loops

Returns the number of times that the current loop has been gone through.

math

Performs scientific calculation.

max

Returns the maximum value of input objects.

mean

Returns the average value of input objects.

min

Returns the minimum value of input objects.

order

Sorts input objects.

path

Returns the path of a traversal.

project

Maps input objects to a map<string,object>.

properties

Returns the properties of an element.

propertyMap

Returns a map of the properties of an element.

sack

Returns the sack value of an element.

select

Returns the objects with labels defined by an as() step.

sum

Sums input objects.

unfold

Unfolds a list<object> to objects.

values

Returns the values of properties of an element.

Filter

and

Returns the input objects for which all child traversals have results.

cyclicPath

Returns a cyclic path.

dedup

Deduplicates input objects.

distinct [*]

Hashes input objects based on a specific method and extracts a specific number of objects from each hash bucket.

filter

Filters elements.

has

Filters elements and returns the elements that meet the specified condition.

hasKey

Filters elements based on field names and returns the names and values of the fields that meet the specified condition.

hasLabel

Filters elements based on labels and returns the elements that meet the specified condition.

hasValue

Filters elements based on field values and returns the names and values of the fields that meet the specified condition.

is

Filters elements based on a number or string.

limit

Returns a specific number of the first elements.

not

Returns the input objects for which a child traversal returns no results.

or

Returns the input objects for which at least one child traversal has results.

range

Returns the objects in a specific range.

sample

Samples objects.

simplePath

Returns a simple path.

tail

Returns a specific number of the last elements.

where

Filters elements.

sideEffect

aggregate

Aggregates input objects into a list<object> with a barrier.

alias [*]

Defines virtual fields for input elements.

fields [*]

Retains the specified fields and removes other fields from elements.

store

Aggregates input objects into a list<object> without a barrier.

Branch

branch

Performs branching queries.

choose

Performs branching queries.

coalesce

Evaluates the input traversals in sequence and returns the first traversal that finds at least one element.

local

Runs a child traversal for each input object.

optional

Returns the result of a child traversal if the child traversal has a result.

repeat

Loops over a traversal.

unoin

Merges the results of child traversals.

Modulator

as

Adds labels to input objects.

by

Provides parameters such as traversals, functions, and comparators for other steps.

emit

Returns the intermediate results of a loop.

indexQuery [*]

Performs an inverted query.

option

Specifies an option for branching queries.

times

Specifies the number of times that a loop is gone through.

until

Specifies the condition to break a loop.

withSack

Defines initial value supplier, split operator, and merge operator for the sack of each element.

Function

P

Compares values.

T

Extracts the information about elements.

UDF [*]

Uses a user-defined function (UDF).

Policy

withStrategies

Applies a custom policy to a traversal.

PathRecordStrategy

Specifies the type of information to be returned for a path.

PushDownStrategy

Pushes a sideEffect step to the storage layer for execution.