Skip to content

Commit e42bc6a

Browse files
authored
Tidy up exception documentation (#760)
1 parent 8fd0572 commit e42bc6a

File tree

2 files changed

+131
-58
lines changed

2 files changed

+131
-58
lines changed

docs/source/api.rst

Lines changed: 60 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1233,22 +1233,39 @@ Errors
12331233
Neo4j Errors
12341234
============
12351235

1236-
Neo4j Execution Errors
1236+
Server-side errors
12371237

12381238

12391239
* :class:`neo4j.exceptions.Neo4jError`
12401240

12411241
* :class:`neo4j.exceptions.ClientError`
12421242

1243+
* :class:`neo4j.exceptions.CypherSyntaxError`
1244+
1245+
* :class:`neo4j.exceptions.CypherTypeError`
1246+
1247+
* :class:`neo4j.exceptions.ConstraintError`
1248+
1249+
* :class:`neo4j.exceptions.AuthError`
1250+
1251+
* :class:`neo4j.exceptions.TokenExpired`
1252+
1253+
* :class:`neo4j.exceptions.Forbidden`
1254+
12431255
* :class:`neo4j.exceptions.DatabaseError`
12441256

12451257
* :class:`neo4j.exceptions.TransientError`
12461258

1259+
* :class:`neo4j.exceptions.DatabaseUnavailable`
1260+
1261+
* :class:`neo4j.exceptions.NotALeader`
1262+
1263+
* :class:`neo4j.exceptions.ForbiddenOnReadOnlyDatabase`
1264+
12471265

12481266
.. autoclass:: neo4j.exceptions.Neo4jError
12491267
:members: message, code, is_retriable, is_retryable
12501268

1251-
12521269
.. autoclass:: neo4j.exceptions.ClientError
12531270
:show-inheritance:
12541271

@@ -1264,13 +1281,10 @@ Neo4j Execution Errors
12641281
.. autoclass:: neo4j.exceptions.AuthError
12651282
:show-inheritance:
12661283

1267-
.. autoclass:: neo4j.exceptions.Forbidden
1284+
.. autoclass:: neo4j.exceptions.TokenExpired
12681285
:show-inheritance:
12691286

1270-
.. autoclass:: neo4j.exceptions.ForbiddenOnReadOnlyDatabase
1271-
:show-inheritance:
1272-
1273-
.. autoclass:: neo4j.exceptions.NotALeader
1287+
.. autoclass:: neo4j.exceptions.Forbidden
12741288
:show-inheritance:
12751289

12761290
.. autoclass:: neo4j.exceptions.DatabaseError
@@ -1282,25 +1296,50 @@ Neo4j Execution Errors
12821296
.. autoclass:: neo4j.exceptions.DatabaseUnavailable
12831297
:show-inheritance:
12841298

1299+
.. autoclass:: neo4j.exceptions.NotALeader
1300+
:show-inheritance:
1301+
1302+
.. autoclass:: neo4j.exceptions.ForbiddenOnReadOnlyDatabase
1303+
:show-inheritance:
1304+
1305+
12851306

12861307

12871308
Driver Errors
12881309
=============
12891310

1290-
Connectivity Errors
1311+
Client-side errors
12911312

12921313

12931314
* :class:`neo4j.exceptions.DriverError`
12941315

12951316
* :class:`neo4j.exceptions.TransactionError`
12961317

1318+
* :class:`neo4j.exceptions.TransactionNestingError`
1319+
1320+
* :class:`neo4j.exceptions.ResultError`
1321+
1322+
* :class:`neo4j.exceptions.ResultConsumedError`
1323+
1324+
* :class:`neo4j.exceptions.ResultNotSingleError`
1325+
12971326
* :class:`neo4j.exceptions.SessionExpired`
12981327

12991328
* :class:`neo4j.exceptions.ServiceUnavailable`
13001329

1330+
* :class:`neo4j.exceptions.RoutingServiceUnavailable`
1331+
1332+
* :class:`neo4j.exceptions.WriteServiceUnavailable`
1333+
1334+
* :class:`neo4j.exceptions.ReadServiceUnavailable`
1335+
1336+
* :class:`neo4j.exceptions.IncompleteCommit`
1337+
13011338
* :class:`neo4j.exceptions.ConfigurationError`
13021339

1303-
* :class:`neo4j.exceptions.ResultConsumedError`
1340+
* :class:`neo4j.exceptions.AuthConfigurationError`
1341+
1342+
* :class:`neo4j.exceptions.CertificateConfigurationError`
13041343

13051344

13061345
.. autoclass:: neo4j.exceptions.DriverError
@@ -1312,15 +1351,21 @@ Connectivity Errors
13121351
.. autoclass:: neo4j.exceptions.TransactionNestingError
13131352
:show-inheritance:
13141353

1354+
.. autoclass:: neo4j.exceptions.ResultError
1355+
:show-inheritance:
1356+
1357+
.. autoclass:: neo4j.exceptions.ResultConsumedError
1358+
:show-inheritance:
1359+
1360+
.. autoclass:: neo4j.exceptions.ResultNotSingleError
1361+
:show-inheritance:
1362+
13151363
.. autoclass:: neo4j.exceptions.SessionExpired
13161364
:show-inheritance:
13171365

13181366
.. autoclass:: neo4j.exceptions.ServiceUnavailable
13191367
:show-inheritance:
13201368

1321-
Raised when a database server or service is not available.
1322-
This may be due to incorrect configuration or could indicate a runtime failure of a database service that the driver is unable to route around.
1323-
13241369
.. autoclass:: neo4j.exceptions.RoutingServiceUnavailable
13251370
:show-inheritance:
13261371

@@ -1330,6 +1375,9 @@ Connectivity Errors
13301375
.. autoclass:: neo4j.exceptions.ReadServiceUnavailable
13311376
:show-inheritance:
13321377

1378+
.. autoclass:: neo4j.exceptions.IncompleteCommit
1379+
:show-inheritance:
1380+
13331381
.. autoclass:: neo4j.exceptions.ConfigurationError
13341382
:show-inheritance:
13351383

@@ -1339,12 +1387,6 @@ Connectivity Errors
13391387
.. autoclass:: neo4j.exceptions.CertificateConfigurationError
13401388
:show-inheritance:
13411389

1342-
.. autoclass:: neo4j.exceptions.ResultConsumedError
1343-
:show-inheritance:
1344-
1345-
.. autoclass:: neo4j.exceptions.ResultNotSingleError
1346-
:show-inheritance:
1347-
13481390

13491391

13501392
Internal Driver Errors

0 commit comments

Comments
 (0)