Skip to content

Commit 40aed37

Browse files
committed
Document gds.delete()
1 parent cc4feca commit 40aed37

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

doc/modules/ROOT/pages/gds-session.adoc

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,21 @@ sessions.list()
140140

141141
=== Deleting a GDS Session
142142

143-
Use the `delete()` method to delete a GDS Session.
144-
This will terminate the session and stop any running costs from accumulating further.
143+
Deleting a GDS Session will terminate the session and stop any running costs from accumulating further.
145144
Deleting a session will not affect the configured Neo4j data source.
146145
However, any data not written back to the Neo4j instance will be lost.
147146

148-
.Deleting a GDS Session:
147+
If you have an open connection to the session:
148+
149+
.Deleting a GDS Session via an open client connection:
150+
[source, python, role=no-test]
151+
----
152+
gds.delete()
153+
----
154+
155+
Use the `delete()` method to delete a GDS Session.
156+
157+
.Deleting a GDS Session via the GdsSessions object:
149158
[source, python, role=no-test]
150159
----
151160
sessions.delete(session_name="my-new-session")

0 commit comments

Comments
 (0)