branch

Split a traversal based on values.

Synopsis

branch(traversal)
Table 1. Legend
Syntax conventions Description
Lowercase and uppercase Literal keyword. Includes ().
Italics Variable value. Replace with a user-defined value.
[] Optional. Square brackets ( [] ) surround optional command arguments. Do not type the square brackets.
{} Group. Braces ( {} ) identify a group to choose from. Do not type the braces.
| Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
... Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.

Description

The branch step is a general step.

Examples

Find all ingredients in a particular fridge (based on the fridgeSensor id), count, and print an message depending on the count returned.
g.V().hasLabel('ingredient').as('ingredient').
  branch(inE('contains').filter(outV().has('stateId',31).has('cityId',200)).count()).
    option(0L, constant('unavailable')).
    option(1L, constant('time to reorder')).
    option(none, constant('available')).as('status').
  select('ingredient','status').
    by('name').
    by()