within

Given a list of objects, return the ones that listed.

Synopsis

within(object, ...)
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 within() predicate answers the question: Is the incoming object in the array of provided objects?

Examples

Get the two people who have the specified user-defined vertex ids:
g.V().has(id, within("{~label=person, personId=1}", "{~label=person, personId=2}"))