Skip to content

Commit 748854c

Browse files
committed
Clarify use of query parameters in AGA
1 parent 58038f7 commit 748854c

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,27 @@ image::example-graphs/aura-graph-analytics-serverless.png[]
3232
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

35+
To run the example, you must first set two query parameters called `clientId` and `clientSecret` to your link:https://neo4j.com/docs/aura/api/authentication/[Aura API keys].
36+
37+
[NOTE]
38+
====
39+
It is good practice to use link:https://neo4j.com/docs/cypher-manual/current/syntax/parameters/[query parameters] for sensitive data such as credentials.
40+
This also removes the need to enter the same strings multiple times.
41+
42+
In the Aura console, you can set query parameters within the link:https://neo4j.com/docs/aura/query/operations/#query-parameters[Query tool^].
43+
For other environments, see the link:https://neo4j.com/docs/cypher-manual/current/syntax/parameters[Cypher manual].
44+
====
45+
3546
[IMPORTANT]
47+
====
3648
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).
3749
50+
Aura API keys examples:
51+
52+
* Client ID: `n1lYYI2Zxxxxxxxxxxxxxxxxv1Cddvbp`
53+
* Client secret: `MduaDb4CxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxINtP_7Lt`
54+
====
55+
3856
.Project a graph called 'myGraph' using a remote Cypher projection into a new GDS Session
3957
[source, cypher, role=noplay setup-query]
4058
----
@@ -53,7 +71,7 @@ RETURN g.graphName, g.nodeCount, g.relationshipCount
5371
----
5472
<1> The Cypher `parallel` runtime is recommended but not mandatory.
5573
<2> Add the `gds.aura.api.credentials` function before the actual query.
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.
74+
You need to set the string values for `clientId` and `clientSecret` as query parameters first.
5775
<3> Set the `memory` (mandatory) and `ttl` (optional) parameters.
5876

5977
.Results

0 commit comments

Comments
 (0)