Skip to content

Commit b4738d4

Browse files
committed
Improve AGA docs (#11032)
* Improve AGA docs * increase TTL for quickstart * fix default value * link to Aura API in quickstart * Expand client params note
1 parent 694003d commit b4738d4

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

doc/modules/ROOT/pages/aura-graph-analytics/cypher.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ WITH gds.aura.api.credentials($clientId, $clientSecret) AS credentials
144144
CALL gds.session.getOrCreate(
145145
'test-session',
146146
'4GB',
147-
duration({minutes: 5})
147+
duration({minutes: 30})
148148
)
149149
YIELD id AS sessionId, name AS sessionName
150150
RETURN sessionId, sessionName
@@ -180,7 +180,7 @@ CALL gds.session.getOrCreate(
180180
| Name | Type | Optional | Description
181181
| sessionName | String | no | The name of the GDS Session to create or return.
182182
| memory | String | no | The size of the GDS Session, e.g. `4GB`, `8GB`, etc.
183-
| ttl | Duration | yes | The time to live of the GDS Session when no activity is recorded, e.g. `duration({days: 1})`, `duration({hours: 12})`, etc. The default value is 2 days.
183+
| ttl | Duration | yes | The time to live of the GDS Session when no activity is recorded, e.g. `duration({days: 1})`, `duration({hours: 12})`, etc. The default value is 1 hour.
184184
|===
185185

186186
[[session-create-procedure-results]]

doc/modules/ROOT/pages/aura-graph-analytics/quickstart.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The next step is to project the data into a graph within a remote session.
3333
The following example shows how to run a Cypher projection and xref:aura-graph-analytics/index.adoc#implicit-sessions[create a session] at the same time.
3434

3535
[IMPORTANT]
36-
Make sure that the credentials you use here are the Aura API keys (client ID and client secret), *not* your AuraDB credentials (username and password).
36+
Make sure that the credentials you use here are the link:https://neo4j.com/docs/aura/api/authentication/[Aura API keys] (client ID and client secret), *not* your AuraDB credentials (username and password).
3737

3838
.Project a graph called 'myGraph' using a remote Cypher projection into a new GDS Session
3939
[source, cypher, role=noplay setup-query]
@@ -47,13 +47,13 @@ WITH gds.graph.project('myGraph', source, target, {
4747
targetNodeProperties: target { .age },
4848
relationshipProperties: r { .weight }
4949
}, {
50-
memory: '4GB', ttl: duration({minutes: 5}) // <3>
50+
memory: '4GB', ttl: duration({minutes: 30}) // <3>
5151
}) AS g
5252
RETURN g.graphName, g.nodeCount, g.relationshipCount
5353
----
5454
<1> The Cypher `parallel` runtime is recommended but not mandatory.
5555
<2> Add the `gds.aura.api.credentials` function before the actual query.
56-
You need to set the `clientId` and `clientSecret` link:https://neo4j.com/docs/cypher-manual/current/syntax/parameters/[query parameters] first.
56+
You need to set the string values for `clientId` and `clientSecret` as link:https://neo4j.com/docs/cypher-manual/current/syntax/parameters/[query parameters] first.
5757
<3> Set the `memory` (mandatory) and `ttl` (optional) parameters.
5858

5959
.Results

0 commit comments

Comments
 (0)