Skip to content

Fix nested value nature of result element #5

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

Merged
merged 2 commits into from
Feb 19, 2025
Merged

Fix nested value nature of result element #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4ffcb4
Fix nested value nature of result element
gjmwoods Feb 17, 2025
db0487b
A sprinkle of newlines to make things clearer
gjmwoods Feb 18, 2025
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
20 changes: 11 additions & 9 deletions modules/ROOT/pages/bookmarks.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@ All responses include a `bookmarks` field containing a list of encoded bookmarks
"n"
],
"values": [
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:0",
"labels": [
"Person"
],
"properties": {
"name": "Alice",
"age": 42
[
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:0",
"labels": [
"Person"
],
"properties": {
"name": "Alice",
"age": 42
}
}
}
]
]
},
"bookmarks": [
Expand Down
4 changes: 3 additions & 1 deletion modules/ROOT/pages/impersonation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ Content-Type: application/json
"n.name"
],
"values": [
"Alice"
[
"Alice"
]
]
},
"bookmarks": [
Expand Down
8 changes: 5 additions & 3 deletions modules/ROOT/pages/profile-query.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ Content-Type: application/json
"n.name"
],
"values": [
"Alice"
[
"Alice"
]
]
},
"profiledQueryPlan": {
Expand Down Expand Up @@ -75,8 +77,8 @@ Content-Type: application/json
"Rows": 1
},
"identifiers": [
"n",
"`n.name`"
"n",
"`n.name`"
],
"children": [
{
Expand Down
4 changes: 3 additions & 1 deletion modules/ROOT/pages/query-counters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,12 @@ Content-Type: application/json
{
"data": {
"fields": [
"n.name"
"n.name"
],
"values": [
[
"Peter"
]
]
},
"counters": {
Expand Down
22 changes: 12 additions & 10 deletions modules/ROOT/pages/query.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,18 @@ Content-Type: application/json
"alice"
],
"values": [ // <3>
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:0", // <4>
"labels": [
"Person"
],
"properties": {
"name": "Alice",
"age": 42
[
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:0", // <4>
"labels": [
"Person"
],
"properties": {
"name": "Alice",
"age": 42
}
}
}
]
]
},
"bookmarks": [ // <5>
Expand All @@ -77,7 +79,7 @@ Content-Type: application/json
<1> Because the server does not know whether the request will be successful or not when it sends the HTTP status code, all API requests return a `202` status code, regardless of whether the statements were successfully executed.
The only exception is authentication errors, which result in a `401` status code.
<2> Query result keys.
<3> Query result values, in the same order as `fields`. +
<3> Query result values for each result returned by the query. Each individual result values are in the same order as `fields`. +
For more information on what format the values may take, see xref:result-formats.adoc[].
<4> Entity ID within the database.
Use `elementId` with care, as no guarantees are given about the mapping between ID values and elements outside the scope of a single transaction.
Expand Down
62 changes: 33 additions & 29 deletions modules/ROOT/pages/result-formats.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ To request this format, set `Accept: application/json` in the request headers (o
----
{
"data": {
"fields": [ field1, field2, ... ], // <1>
"values": [ entity1, entity2, ... ] // <2>
"fields": [ field1, field2, ... ], // <1>
"values": [ [ entity1, entity2, ... ] ] // <2>
}
}
----

<1> Query fields, i.e. keys for the returned objects
<2> Query result (the inner structure of each element depends on the object type)
<2> Query results. The outer array represents a single result (or row) where the inner array contains the individual values for that result (the inner structure of each element depends on the object type).

.Return a node and a property
====
Expand Down Expand Up @@ -66,16 +66,18 @@ Content-Type: application/json
"name"
],
"values": [
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:2",
"labels": [
"Person"
],
"properties": {
"name": "Phil"
}
},
"Phil"
[
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:2",
"labels": [
"Person"
],
"properties": {
"name": "Phil"
}
},
"Phil"
]
]
},
"bookmarks": [
Expand Down Expand Up @@ -331,25 +333,27 @@ Content-Type: application/json
"name"
],
"values": [
{
"$type": "Node",
"_value": {
"_element_id": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:2",
"_labels": [
"Person"
],
"_properties": {
"name": {
"$type": "String",
"_value": "Phil"
[
{
"$type": "Node",
"_value": {
"_element_id": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:2",
"_labels": [
"Person"
],
"_properties": {
"name": {
"$type": "String",
"_value": "Phil"
}
}
}
},
{
"$type": "String",
"_value": "Phil"
}
},
{
"$type": "String",
"_value": "Phil"
}
]
]
},
"bookmarks": [
Expand Down
38 changes: 20 additions & 18 deletions modules/ROOT/pages/routing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,25 +40,27 @@ Content-Type: application/json
"n"
],
"values": [
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:0",
"labels": [
"Person"
],
"properties": {
"name": "Alice",
"age": 42
[
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:0",
"labels": [
"Person"
],
"properties": {
"name": "Alice",
"age": 42
}
},
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:1",
"labels": [
"Person"
],
"properties": {
"name": "Lucy"
}
}
},
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:1",
"labels": [
"Person"
],
"properties": {
"name": "Lucy"
}
}
]
]
},
"bookmarks": [
Expand Down
42 changes: 23 additions & 19 deletions modules/ROOT/pages/transactions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,18 @@ neo4j-cluster-affinity: MTAuOC41Ljc6MTc0NzQ= // <2>
"alice"
],
"values": [ // <4>
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:0", // <5>
"labels": [
"Person"
],
"properties": {
"name": "Alice",
"age": 42
[
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b025e:0", // <5>
"labels": [
"Person"
],
"properties": {
"name": "Alice",
"age": 42
}
}
}
]
]
},
"bookmarks": [ // <6>
Expand All @@ -100,7 +102,7 @@ The only exception is authentication errors, which result in a `401` status code
<.> The header `neo4j-cluster-affinity` identifies the cluster member handling the transaction.
It must be included as a header to all subsequent requests, including commit/rollback requests.
<.> Query result keys.
<.> Query result values, in the same order as `fields`. +
<.> Query result values for each result returned by the query. Each individual result values are in the same order as `fields`. +
For more information on what format the values may take, see xref:result-formats.adoc[].
<.> Entity ID within the database.
Use `elementId` with care, as no guarantees are given about the mapping between ID values and elements outside the scope of a single transaction.
Expand Down Expand Up @@ -165,16 +167,18 @@ Content-Type: application/json
"bob"
],
"values": [
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b034e:0",
"labels": [
"Person"
],
"properties": {
"name": "Bob",
"age": 43
[
{
"elementId": "4:ff04df25-ff2b-4b55-98f8-6888297b034e:0",
"labels": [
"Person"
],
"properties": {
"name": "Bob",
"age": 43
}
}
}
]
]
},
"bookmarks": [
Expand Down