Skip to content

Add expected output and explanatory callouts to values()-step docs #3570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
spmallette wants to merge 1 commit into from
+19 −3
Closed

Add expected output and explanatory callouts to values()-step docs #3570

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions docs/src/reference/the-traversal.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5768,14 +5768,30 @@ link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gre
=== Values Step

The `values()`-step (*map*) extracts the values of properties from an `Element` in the traversal stream.
When called with one or more property keys it returns the values of just those properties, and when
called with no arguments it returns the values of every property on the element. A vertex property may
itself be multi-valued and may carry meta-properties, and those two cases produce results that are easy
to confuse. The examples below use the "TinkerPop Crew" toy graph, whose vertex `1` (marko) has a
multi-valued `location` property, to illustrate the difference.

[gremlin-groovy,theCrew]
----
g.V(1).values()
g.V(1).values('location')
g.V(1).properties('location').values()
g.V(1).values() <1>
g.V(1).values('location') <2>
g.V(1).properties('location').values() <3>
----

<1> With no arguments, `values()` emits every property value on the vertex across all of its property
keys. Vertex `1` therefore yields its single `name` value together with each of its `location` values.
<2> Supplying a property key restricts the output to the values of that property. Because vertex `1` has
a multi-valued `location`, four city-name `String` values are returned.
<3> `properties('location')` first selects the `location` properties themselves, so the following
`values()` extracts their meta-property values, the `startTime` and `endTime` years. These are `Integer`
values and are distinct from the city-name `String` values produced by `values('location')` in the
previous line.

The order in which property values are returned is not guaranteed.

*Additional References*

link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#values(java.lang.String...)++[`values(String...)`]
Expand Down
Loading