where

Filters based on a predicate, a sideEffect or a traversal.

Synopsis

where()
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 where() step is a filter step that filters the returned objects based on a predicate, a sideEffect, or a traversal.

Examples

First find all the reviewers that rated Beef Bourguignon 5-stars. Then find what other recipes those reviewers rated 5-stars, and count how many reviewers did by recipe, without including Beef Bourguignon in the count. It illustrates the use of the where() step with where(neq('a')) to exclude Beef Bourguignon.
g.V().has('recipe', 'name', 'Beef Bourguignon').as('a').
  inE('reviewed').has('stars', 5).outV().outE('reviewed').has('stars', 5).
  inV().where(neq('a')).groupCount().by('name')