Skip to content

Commit 0c501fa

Browse files
committed
Add note about communication with Neo4j DB on GDS construction
1 parent fe66a03 commit 0c501fa

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

doc/modules/ROOT/pages/getting-started.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ assert gds.version()
3838
"2.1.9"
3939
----
4040

41+
Please note that the `GraphDataScience` object needs to communicate with a Neo4j database upon construction, and uses the default "neo4j" database by default.
42+
If there is no such database, you will need to <<specifying-targeted-database, provide a valid database using the `database` keyword>>.
43+
4144

4245
=== AuraDS
4346

@@ -75,6 +78,7 @@ using_enterprise = gds.is_licensed()
7578
----
7679

7780

81+
[[specifying-targeted-database]]
7882
=== Specifying targeted database
7983

8084
If we don't want to use the default database of our DBMS we can provide the `GraphDataScience` constructor with the keyword parameter `database`:
@@ -102,10 +106,10 @@ If Apache Arrow is available on the https://neo4j.com/docs/graph-data-science/cu
102106
[source,python,role=no-test]
103107
----
104108
gds = GraphDataScience(
105-
NEO4J_URI,
106-
auth=(NEO4J_USER, NEO4J_PASSWORD),
107-
arrow=True,
108-
arrow_disable_server_verification=False,
109+
NEO4J_URI,
110+
auth=(NEO4J_USER, NEO4J_PASSWORD),
111+
arrow=True,
112+
arrow_disable_server_verification=False,
109113
arrow_tls_root_certs=CERT
110114
)
111115
----

0 commit comments

Comments
 (0)