option

An option for branch() or choose().

Synopsis

option(value, value_returned)
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 option() step modulator is used in conjunction with branch() or choose(), and specifies the returned values based on values found at that point in a traversal.

Examples

Find all people and list whether they are female, male, or unknown:
g.V().hasLabel('person').
  project('name','gender').
    by('name').
    by(choose(values('gender')).
                 option('F', constant('female')).
                 option('M', constant('male')).
option(none, constant('unknown')))