Error Handling¶
All python-arango exceptions inherit arango.exceptions.ArangoError
,
which splits into subclasses arango.exceptions.ArangoServerError
and
arango.exceptions.ArangoClientError
.
Server Errors¶
arango.exceptions.ArangoServerError
exceptions lightly wrap non-2xx
HTTP responses coming from ArangoDB. Each exception object contains the error
message, error code and HTTP request response details.
Example:
from arango import ArangoClient, ArangoServerError, DocumentInsertError
# Initialize the ArangoDB client.
client = ArangoClient()
# Connect to "test" database as root user.
db = client.db('test', username='root', password='passwd')
# Get the API wrapper for "students" collection.
students = db.collection('students')
try:
students.insert({'_key': 'John'})
students.insert({'_key': 'John'}) # duplicate key error
except DocumentInsertError as exc:
assert isinstance(exc, ArangoServerError)
assert exc.source == 'server'
exc.message # Exception message usually from ArangoDB
exc.error_message # Raw error message from ArangoDB
exc.error_code # Error code from ArangoDB
exc.url # URL (API endpoint)
exc.http_method # HTTP method (e.g. "POST")
exc.http_headers # Response headers
exc.http_code # Status code (e.g. 200)
# You can inspect the ArangoDB response directly.
response = exc.response
response.method # HTTP method (e.g. "POST")
response.headers # Response headers
response.url # Full request URL
response.is_success # Set to True if HTTP code is 2XX
response.body # JSON-deserialized response body
response.raw_body # Raw string response body
response.status_text # Status text (e.g "OK")
response.status_code # Status code (e.g. 200)
response.error_code # Error code from ArangoDB
# You can also inspect the request sent to ArangoDB.
request = exc.request
request.method # HTTP method (e.g. "post")
request.endpoint # API endpoint starting with "/_api"
request.headers # Request headers
request.params # URL parameters
request.data # Request payload
Client Errors¶
arango.exceptions.ArangoClientError
exceptions originate from
python-arango client itself. They do not contain error codes nor HTTP request
response details.
Example:
from arango import ArangoClient, ArangoClientError, DocumentParseError
# Initialize the ArangoDB client.
client = ArangoClient()
# Connect to "test" database as root user.
db = client.db('test', username='root', password='passwd')
# Get the API wrapper for "students" collection.
students = db.collection('students')
try:
students.get({'_id': 'invalid_id'}) # malformed document
except DocumentParseError as exc:
assert isinstance(exc, ArangoClientError)
assert exc.source == 'client'
# Only the error message is set.
error_message = exc.message
assert exc.error_code is None
assert exc.error_message is None
assert exc.url is None
assert exc.http_method is None
assert exc.http_code is None
assert exc.http_headers is None
assert exc.response is None
assert exc.request is None
Exceptions¶
Below are all exceptions from python-arango.
-
exception
arango.exceptions.
ArangoClientError
(msg: str)[source]¶ Base class for errors originating from python-arango client.
Parameters: msg (str) – Error message.
Variables: - source (str) – Source of the error (always set to “client”).
- message (str) – Error message.
-
exception
arango.exceptions.
ArangoServerError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Base class for errors originating from ArangoDB server.
Parameters: - resp (arango.response.Response) – HTTP response.
- msg (str) – Error message override.
Variables: - source (str) – Source of the error (always set to “server”).
- message (str) – Exception message.
- url (str) – API URL.
- response (arango.response.Response) – HTTP response object.
- request (arango.request.Request) – HTTP request object.
- http_method (str) – HTTP method in lowercase (e.g. “post”).
- http_code (int) – HTTP status code.
- http_headers (dict) – Response headers.
- error_code (int) – Error code from ArangoDB server.
- error_message (str) – Raw error message from ArangoDB server.
-
exception
arango.exceptions.
AQLQueryListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve running AQL queries.
-
exception
arango.exceptions.
AQLQueryExplainError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to parse and explain query.
-
exception
arango.exceptions.
AQLQueryValidateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to parse and validate query.
-
exception
arango.exceptions.
AQLQueryExecuteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to execute query.
-
exception
arango.exceptions.
AQLQueryKillError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to kill the query.
-
exception
arango.exceptions.
AQLQueryClearError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to clear slow AQL queries.
-
exception
arango.exceptions.
AQLQueryTrackingGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve AQL tracking properties.
-
exception
arango.exceptions.
AQLQueryTrackingSetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to configure AQL tracking properties.
-
exception
arango.exceptions.
AQLCachePropertiesError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve query cache properties.
-
exception
arango.exceptions.
AQLCacheConfigureError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to configure query cache properties.
-
exception
arango.exceptions.
AQLCacheEntriesError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve AQL cache entries.
-
exception
arango.exceptions.
AQLCacheClearError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to clear the query cache.
-
exception
arango.exceptions.
AQLFunctionListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve AQL user functions.
-
exception
arango.exceptions.
AQLFunctionCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create AQL user function.
-
exception
arango.exceptions.
AQLFunctionDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete AQL user function.
-
exception
arango.exceptions.
AQLQueryRulesGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve AQL query rules.
-
exception
arango.exceptions.
AsyncExecuteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to execute async API request.
-
exception
arango.exceptions.
AsyncJobListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve async jobs.
-
exception
arango.exceptions.
AsyncJobCancelError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to cancel async job.
-
exception
arango.exceptions.
AsyncJobStatusError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve async job status.
-
exception
arango.exceptions.
AsyncJobResultError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve async job result.
-
exception
arango.exceptions.
AsyncJobClearError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to clear async job results.
-
exception
arango.exceptions.
BackupCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create a backup.
-
exception
arango.exceptions.
BackupDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete a backup.
-
exception
arango.exceptions.
BackupDownloadError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to download a backup from remote repository.
-
exception
arango.exceptions.
BackupGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve backup details.
-
exception
arango.exceptions.
BackupRestoreError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to restore from backup.
-
exception
arango.exceptions.
BackupUploadError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to upload a backup to remote repository.
-
exception
arango.exceptions.
BatchJobResultError
(msg: str)[source]¶ Failed to retrieve batch job result.
-
exception
arango.exceptions.
BatchExecuteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to execute batch API request.
-
exception
arango.exceptions.
OverloadControlExecutorError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to execute overload controlled API request.
-
exception
arango.exceptions.
CollectionListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collections.
-
exception
arango.exceptions.
CollectionInformationError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection information.
-
exception
arango.exceptions.
CollectionPropertiesError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection properties.
-
exception
arango.exceptions.
CollectionConfigureError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to configure collection properties.
-
exception
arango.exceptions.
CollectionShardsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection shards.
-
exception
arango.exceptions.
CollectionStatisticsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection statistics.
-
exception
arango.exceptions.
CollectionRevisionError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection revision.
-
exception
arango.exceptions.
CollectionChecksumError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection checksum.
-
exception
arango.exceptions.
CollectionCompactError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to compact collection.
-
exception
arango.exceptions.
CollectionCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create collection.
-
exception
arango.exceptions.
CollectionDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete collection.
-
exception
arango.exceptions.
CollectionRenameError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to rename collection.
-
exception
arango.exceptions.
CollectionTruncateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to truncate collection.
-
exception
arango.exceptions.
CollectionLoadError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to load collection.
-
exception
arango.exceptions.
CollectionUnloadError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to unload collection.
-
exception
arango.exceptions.
CollectionRecalculateCountError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to recalculate document count.
-
exception
arango.exceptions.
CollectionResponsibleShardError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve responsible shard.
-
exception
arango.exceptions.
CursorStateError
(msg: str)[source]¶ The cursor object was in a bad state.
-
exception
arango.exceptions.
CursorEmptyError
(msg: str)[source]¶ The current batch in cursor was empty.
-
exception
arango.exceptions.
CursorNextError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve the next result batch from server.
-
exception
arango.exceptions.
CursorCloseError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete the cursor result from server.
-
exception
arango.exceptions.
DatabaseListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve databases.
-
exception
arango.exceptions.
DatabasePropertiesError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve database properties.
-
exception
arango.exceptions.
DatabaseCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create database.
-
exception
arango.exceptions.
DatabaseDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete database.
-
exception
arango.exceptions.
DocumentCountError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve document count.
-
exception
arango.exceptions.
DocumentInError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to check whether document exists.
-
exception
arango.exceptions.
DocumentGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve document.
-
exception
arango.exceptions.
DocumentKeysError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve document keys.
-
exception
arango.exceptions.
DocumentIDsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve document IDs.
-
exception
arango.exceptions.
DocumentInsertError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to insert document.
-
exception
arango.exceptions.
DocumentReplaceError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to replace document.
-
exception
arango.exceptions.
DocumentUpdateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to update document.
-
exception
arango.exceptions.
DocumentDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete document.
-
exception
arango.exceptions.
DocumentRevisionError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ The expected and actual document revisions mismatched.
-
exception
arango.exceptions.
FoxxServiceListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve Foxx services.
-
exception
arango.exceptions.
FoxxServiceGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve Foxx service metadata.
-
exception
arango.exceptions.
FoxxServiceCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create Foxx service.
-
exception
arango.exceptions.
FoxxServiceUpdateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to update Foxx service.
-
exception
arango.exceptions.
FoxxServiceReplaceError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to replace Foxx service.
-
exception
arango.exceptions.
FoxxServiceDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete Foxx services.
-
exception
arango.exceptions.
FoxxConfigGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve Foxx service configuration.
-
exception
arango.exceptions.
FoxxConfigUpdateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to update Foxx service configuration.
-
exception
arango.exceptions.
FoxxConfigReplaceError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to replace Foxx service configuration.
-
exception
arango.exceptions.
FoxxDependencyGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve Foxx service dependencies.
-
exception
arango.exceptions.
FoxxDependencyUpdateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to update Foxx service dependencies.
-
exception
arango.exceptions.
FoxxDependencyReplaceError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to replace Foxx service dependencies.
-
exception
arango.exceptions.
FoxxScriptListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve Foxx service scripts.
-
exception
arango.exceptions.
FoxxScriptRunError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to run Foxx service script.
-
exception
arango.exceptions.
FoxxTestRunError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to run Foxx service tests.
-
exception
arango.exceptions.
FoxxDevModeEnableError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to enable development mode for Foxx service.
-
exception
arango.exceptions.
FoxxDevModeDisableError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to disable development mode for Foxx service.
-
exception
arango.exceptions.
FoxxReadmeGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve Foxx service readme.
-
exception
arango.exceptions.
FoxxSwaggerGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve Foxx service swagger.
-
exception
arango.exceptions.
FoxxDownloadError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to download Foxx service bundle.
-
exception
arango.exceptions.
FoxxCommitError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to commit local Foxx service state.
-
exception
arango.exceptions.
GraphListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve graphs.
-
exception
arango.exceptions.
GraphCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create the graph.
-
exception
arango.exceptions.
GraphDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete the graph.
-
exception
arango.exceptions.
GraphPropertiesError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve graph properties.
-
exception
arango.exceptions.
GraphTraverseError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to execute graph traversal.
-
exception
arango.exceptions.
VertexCollectionListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve vertex collections.
-
exception
arango.exceptions.
VertexCollectionCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create vertex collection.
-
exception
arango.exceptions.
VertexCollectionDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete vertex collection.
-
exception
arango.exceptions.
EdgeDefinitionListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve edge definitions.
-
exception
arango.exceptions.
EdgeDefinitionCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create edge definition.
-
exception
arango.exceptions.
EdgeDefinitionReplaceError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to replace edge definition.
-
exception
arango.exceptions.
EdgeDefinitionDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete edge definition.
-
exception
arango.exceptions.
EdgeListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve edges coming in and out of a vertex.
-
exception
arango.exceptions.
IndexListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection indexes.
-
exception
arango.exceptions.
IndexCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create collection index.
-
exception
arango.exceptions.
IndexGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection index.
-
exception
arango.exceptions.
IndexDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete collection index.
-
exception
arango.exceptions.
IndexLoadError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to load indexes into memory.
-
exception
arango.exceptions.
PregelJobCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create Pregel job.
-
exception
arango.exceptions.
PregelJobGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve Pregel job details.
-
exception
arango.exceptions.
PregelJobDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete Pregel job.
-
exception
arango.exceptions.
ServerConnectionError
(msg: str)[source]¶ Failed to connect to ArangoDB server.
-
exception
arango.exceptions.
ServerEngineError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve database engine.
-
exception
arango.exceptions.
ServerVersionError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server version.
-
exception
arango.exceptions.
ServerDetailsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server details.
-
exception
arango.exceptions.
ServerLicenseGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server license.
-
exception
arango.exceptions.
ServerLicenseSetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to set server license.
-
exception
arango.exceptions.
ServerStatusError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server status.
-
exception
arango.exceptions.
ServerTimeError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server system time.
-
exception
arango.exceptions.
ServerEchoError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve details on last request.
-
exception
arango.exceptions.
ServerShutdownError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to initiate shutdown sequence.
-
exception
arango.exceptions.
ServerShutdownProgressError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve soft shutdown progress.
-
exception
arango.exceptions.
ServerRunTestsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to execute server tests.
-
exception
arango.exceptions.
ServerRequiredDBVersionError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server target version.
-
exception
arango.exceptions.
ServerReadLogError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve global log.
-
exception
arango.exceptions.
ServerLogLevelError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server log levels.
-
exception
arango.exceptions.
ServerLogLevelSetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to set server log levels.
-
exception
arango.exceptions.
ServerReloadRoutingError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to reload routing details.
-
exception
arango.exceptions.
ServerStatisticsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server statistics.
-
exception
arango.exceptions.
ServerMetricsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server metrics.
-
exception
arango.exceptions.
ServerRoleError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server role in a cluster.
-
exception
arango.exceptions.
ServerTLSError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve TLS data.
-
exception
arango.exceptions.
ServerTLSReloadError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to reload TLS.
-
exception
arango.exceptions.
ServerEncryptionError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to reload user-defined encryption keys.
-
exception
arango.exceptions.
TaskListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server tasks.
-
exception
arango.exceptions.
TaskGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server task details.
-
exception
arango.exceptions.
TaskCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create server task.
-
exception
arango.exceptions.
TaskDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete server task.
-
exception
arango.exceptions.
TransactionExecuteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to execute raw transaction.
-
exception
arango.exceptions.
TransactionInitError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to initialize transaction.
-
exception
arango.exceptions.
TransactionStatusError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve transaction status.
-
exception
arango.exceptions.
TransactionCommitError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to commit transaction.
-
exception
arango.exceptions.
TransactionAbortError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to abort transaction.
-
exception
arango.exceptions.
TransactionListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve transactions.
-
exception
arango.exceptions.
UserListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve users.
-
exception
arango.exceptions.
UserGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve user details.
-
exception
arango.exceptions.
UserCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create user.
-
exception
arango.exceptions.
UserUpdateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to update user.
-
exception
arango.exceptions.
UserReplaceError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to replace user.
-
exception
arango.exceptions.
UserDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete user.
-
exception
arango.exceptions.
ViewListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve views.
-
exception
arango.exceptions.
ViewGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve view details.
-
exception
arango.exceptions.
ViewCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create view.
-
exception
arango.exceptions.
ViewUpdateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to update view.
-
exception
arango.exceptions.
ViewReplaceError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to replace view.
-
exception
arango.exceptions.
ViewDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete view.
-
exception
arango.exceptions.
ViewRenameError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to rename view.
-
exception
arango.exceptions.
AnalyzerListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve analyzers.
-
exception
arango.exceptions.
AnalyzerGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve analyzer details.
-
exception
arango.exceptions.
AnalyzerCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create analyzer.
-
exception
arango.exceptions.
AnalyzerDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete analyzer.
-
exception
arango.exceptions.
PermissionListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to list user permissions.
-
exception
arango.exceptions.
PermissionGetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve user permission.
-
exception
arango.exceptions.
PermissionUpdateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to update user permission.
-
exception
arango.exceptions.
PermissionResetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to reset user permission.
-
exception
arango.exceptions.
WALPropertiesError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve WAL properties.
-
exception
arango.exceptions.
WALConfigureError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to configure WAL properties.
-
exception
arango.exceptions.
WALTransactionListError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve running WAL transactions.
-
exception
arango.exceptions.
WALFlushError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to flush WAL.
-
exception
arango.exceptions.
WALTickRangesError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to return WAL tick ranges.
-
exception
arango.exceptions.
WALLastTickError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to return WAL tick ranges.
-
exception
arango.exceptions.
WALTailError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to return WAL tick ranges.
-
exception
arango.exceptions.
ReplicationInventoryError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve inventory of collection and indexes.
-
exception
arango.exceptions.
ReplicationDumpBatchCreateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to create dump batch.
-
exception
arango.exceptions.
ReplicationDumpBatchDeleteError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to delete a dump batch.
-
exception
arango.exceptions.
ReplicationDumpBatchExtendError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to extend a dump batch.
-
exception
arango.exceptions.
ReplicationDumpError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve collection content.
-
exception
arango.exceptions.
ReplicationSyncError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to synchronize data from remote.
-
exception
arango.exceptions.
ReplicationClusterInventoryError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve overview of collection and indexes in a cluster.
-
exception
arango.exceptions.
ReplicationLoggerStateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve logger state.
-
exception
arango.exceptions.
ReplicationLoggerFirstTickError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve logger first tick.
-
exception
arango.exceptions.
ReplicationApplierConfigError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve replication applier configuration.
-
exception
arango.exceptions.
ReplicationApplierConfigSetError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to update replication applier configuration.
-
exception
arango.exceptions.
ReplicationApplierStartError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to start replication applier.
-
exception
arango.exceptions.
ReplicationApplierStopError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to stop replication applier.
-
exception
arango.exceptions.
ReplicationApplierStateError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve replication applier state.
-
exception
arango.exceptions.
ReplicationMakeSlaveError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to change role to slave.
-
exception
arango.exceptions.
ReplicationServerIDError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server ID.
-
exception
arango.exceptions.
ClusterHealthError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve DBServer health.
-
exception
arango.exceptions.
ClusterServerIDError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server ID.
-
exception
arango.exceptions.
ClusterServerRoleError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server role.
-
exception
arango.exceptions.
ClusterServerStatisticsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve DBServer statistics.
-
exception
arango.exceptions.
ClusterServerVersionError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server node version.
-
exception
arango.exceptions.
ClusterServerEngineError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve server node engine.
-
exception
arango.exceptions.
ClusterMaintenanceModeError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to enable/disable cluster supervision maintenance mode.
-
exception
arango.exceptions.
ClusterEndpointsError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve cluster endpoints.
-
exception
arango.exceptions.
ClusterServerCountError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to retrieve cluster server count.
-
exception
arango.exceptions.
ClusterRebalanceError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to execute cluster re-balancing operation (load/set).
-
exception
arango.exceptions.
JWTAuthError
(resp: arango.response.Response, request: arango.request.Request, msg: Optional[str, None] = None)[source]¶ Failed to get a new JWT token from ArangoDB.
Error Codes¶
The errno module contains a constant mapping to ArangoDB’s error codes.