File tree Expand file tree Collapse file tree 2 files changed +16
-2
lines changed Expand file tree Collapse file tree 2 files changed +16
-2
lines changed Original file line number Diff line number Diff line change @@ -143,8 +143,13 @@ This object holds the details required to establish connections with a Neo4j dat
143
143
:class: `neo4j.Driver ` objects hold a connection pool from which :class: `neo4j.Session ` objects can borrow connections.
144
144
Closing a driver will immediately shut down all connections in the pool.
145
145
146
+ .. note ::
147
+ Driver objects only open connections and pool them as needed. To verify that
148
+ the driver is able to communicate with the database without executing any
149
+ query, use :meth: `neo4j.Driver.verify_connectivity `.
150
+
146
151
.. autoclass :: neo4j.Driver()
147
- :members: session, close
152
+ :members: session, close, verify_connectivity
148
153
149
154
150
155
.. _driver-configuration-ref :
Original file line number Diff line number Diff line change @@ -319,15 +319,24 @@ def verify_connectivity(self, **config):
319
319
Use the exception to further understand the cause of the connectivity problem.
320
320
321
321
Note: Even if this method throws an exception, the driver still need to be closed via close() to free up all resources.
322
+
323
+ .. note::
324
+ \\ *\\ *config is experimental may change in the future.
325
+
322
326
"""
323
327
raise NotImplementedError
324
328
325
- @experimental ("Feature support query, based on Bolt Protocol Version and Neo4j Server Version will change in the future." )
329
+ @experimental ("Feature support query, based on Bolt protocol version and Neo4j server version will change in the future." )
326
330
def supports_multi_db (self ):
327
331
""" Check if the server or cluster supports multi-databases.
328
332
329
333
:return: Returns true if the server or cluster the driver connects to supports multi-databases, otherwise false.
330
334
:rtype: bool
335
+
336
+
337
+ .. note::
338
+ Feature support query, based on Bolt Protocol Version and Neo4j
339
+ server version will change in the future.
331
340
"""
332
341
with self .session () as session :
333
342
session ._connect (READ_ACCESS )
You can’t perform that action at this time.
0 commit comments