Status Codes

Table of Contents
Classifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Status codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Neo4j v3.5
License: Creative Commons 4.0

The Neo4j status codes for Neo4j v3.5.

Each status code follows the same format:

Neo.[Classification].[Category].[Title]

The fact that a status code is returned by the server does always mean there is a fatal error. Status codes
can also indicate transient problems that may go away if you retry the request.

What the effect of the status code is can be determined by the classification.

1
Classifications
Classification Description Effect on transaction

ClientError The Client sent a bad request - changing the request might yield a Rollback
successful outcome.

ClientNotification There are notifications about the request sent by the client. None

TransientError The database cannot service the request right now, retrying later might Rollback
yield a successful outcome.

DatabaseError The database failed to service the request. Rollback

2
Status codes
This is a complete list of all status codes Neo4j may return, and what they mean.

Status Code Description

Neo.ClientError.Cluster.NotALeader The request cannot be processed by this server. Write

requests can only be processed by the leader.

Neo.ClientError.General.ForbiddenOnReadOnlyDatabase This is a read only database, writing or modifying the

database is not allowed.

Neo.ClientError.General.InvalidArguments The request contained fields that were empty or are not
allowed.

Neo.ClientError.LegacyIndex.LegacyIndexNotFound The request (directly or indirectly) referred to an explicit index

that does not exist.

Neo.ClientError.Procedure.ProcedureCallFailed Failed to invoke a procedure. See the detailed error

description for exact cause.

Neo.ClientError.Procedure.ProcedureNotFound A request referred to a procedure that is not registered with

this database instance. If you are deploying custom
procedures in a cluster setup, ensure all instances in the
cluster have the procedure jar file deployed.

Neo.ClientError.Procedure.ProcedureRegistrationFailed The database failed to register a procedure, refer to the

associated error message for details.

Neo.ClientError.Procedure.ProcedureTimedOut The procedure has not completed within the specified

timeout. You may want to retry with a longer timeout.

Neo.ClientError.Procedure.TypeError A procedure is using or receiving a value of an invalid type.

Neo.ClientError.Request.Invalid The client provided an invalid request.

Neo.ClientError.Request.InvalidFormat The client provided a request that was missing required

fields, or had values that are not allowed.

Neo.ClientError.Request.InvalidUsage The client made a request but did not consume outgoing
buffers in a timely fashion.

Neo.ClientError.Request.TransactionRequired The request cannot be performed outside of a transaction,

and there is no transaction present to use. Wrap your request
in a transaction and retry.

Neo.ClientError.Schema.ConstraintAlreadyExists Unable to perform operation because it would clash with a

pre-existing constraint.

Neo.ClientError.Schema.ConstraintNotFound The request (directly or indirectly) referred to a constraint

that does not exist.

Neo.ClientError.Schema.ConstraintValidationFailed A constraint imposed by the database was violated.

Neo.ClientError.Schema.ConstraintVerificationFailed Unable to create constraint because data that exists in the

database violates it.

Neo.ClientError.Schema.ForbiddenOnConstraintIndex A requested operation can not be performed on the specified

index because the index is part of a constraint. If you want to
drop the index, for instance, you must drop the constraint.

3
Status Code Description

Neo.ClientError.Schema.IndexAlreadyExists Unable to perform operation because it would clash with a

pre-existing index.

Neo.ClientError.Schema.IndexNotApplicable The request did not contain the properties required by the
index.

Neo.ClientError.Schema.IndexNotFound The request (directly or indirectly) referred to an index that

does not exist.

Neo.ClientError.Schema.RepeatedLabelInSchema Unable to create index or constraint because schema had a

repeated label.

Neo.ClientError.Schema.RepeatedPropertyInCompositeSche Unable to create index or constraint because schema had a

ma repeated property.

Neo.ClientError.Schema.RepeatedRelationshipTypeInSchem Unable to create index or constraint because schema had a

a repeated relationship type.

Neo.ClientError.Schema.TokenNameError A token name, such as a label, relationship type or property

key, used is not valid. Tokens cannot be empty strings and
cannot be null.

Neo.ClientError.Security.AuthenticationRateLimit The client has provided incorrect authentication details too

many times in a row.

Neo.ClientError.Security.AuthorizationExpired The stored authorization info has expired. Please reconnect.

Neo.ClientError.Security.CredentialsExpired The credentials have expired and need to be updated.

Neo.ClientError.Security.EncryptionRequired A TLS encrypted connection is required.

Neo.ClientError.Security.Forbidden An attempt was made to perform an unauthorized action.

Neo.ClientError.Security.Unauthorized The client is unauthorized due to authentication failure.

Neo.ClientError.Statement.ArgumentError The statement is attempting to perform operations using

invalid arguments.

Neo.ClientError.Statement.ArithmeticError Invalid use of arithmetic, such as dividing by zero.

Neo.ClientError.Statement.ConstraintVerificationFailed A constraint imposed by the statement is violated by the data

in the database.

Neo.ClientError.Statement.EntityNotFound The statement refers to a non-existent entity.

Neo.ClientError.Statement.ExternalResourceFailed Access to an external resource failed.

Neo.ClientError.Statement.LabelNotFound The statement is referring to a label that does not exist.

Neo.ClientError.Statement.ParameterMissing The statement refers to a parameter that was not provided in

the request.

Neo.ClientError.Statement.PropertyNotFound The statement refers to a non-existent property.

Neo.ClientError.Statement.SemanticError The statement is syntactically valid, but expresses something

that the database cannot do.

Neo.ClientError.Statement.SyntaxError The statement contains invalid or unsupported syntax.

Neo.ClientError.Statement.TypeError The statement is attempting to perform operations on values

with types that are not supported by the operation.

4
Status Code Description

Neo.ClientError.Transaction.ForbiddenDueToTransactionT The transaction is of the wrong type to service the request.

ype For instance, a transaction that has had schema
modifications performed in it cannot be used to subsequently
perform data operations, and vice versa.

Neo.ClientError.Transaction.InvalidBookmark Supplied bookmark cannot be interpreted. You should only

supply a bookmark that was previously generated by Neo4j.
Maybe you have generated your own bookmark, or modified
a bookmark since it was generated by Neo4j.

Neo.ClientError.Transaction.TransactionAccessedConcurr There were concurrent requests accessing the same

ently transaction, which is not allowed.

Neo.ClientError.Transaction.TransactionHookFailed Transaction hook failure.

Neo.ClientError.Transaction.TransactionMarkedAsFailed Transaction was marked as both successful and failed.

Failure takes precedence and so this transaction was rolled
back although it may have looked like it was going to be
committed.

Neo.ClientError.Transaction.TransactionNotFound The request referred to a transaction that does not exist.

Neo.ClientError.Transaction.TransactionTimedOut The transaction has not completed within the specified

timeout (dbms.transaction.timeout). You may want to retry
with a longer timeout.

Neo.ClientError.Transaction.TransactionValidationFaile Transaction changes did not pass validation checks.

d

Neo.ClientNotification.Procedure.ProcedureWarning The query used a procedure that generated a warning.

Neo.ClientNotification.Statement.CartesianProductWarni This query builds a cartesian product between disconnected

ng patterns.

Neo.ClientNotification.Statement.CreateUniqueUnavailab CREATE UNIQUE is not available in the current CYPHER

leWarning version, the query has been run by an older CYPHER version.

Neo.ClientNotification.Statement.DynamicPropertyWarnin Queries using dynamic properties will use neither index

g seeks nor index scans for those properties.

Neo.ClientNotification.Statement.EagerOperatorWarning The execution plan for this query contains the Eager
operator, which forces all dependent data to be materialized
in main memory before proceeding.

Neo.ClientNotification.Statement.ExhaustiveShortestPat Exhaustive shortest path has been planned for your query
hWarning that means that shortest path graph algorithm might not be
used to find the shortest path. Hence an exhaustive
enumeration of all paths might be used in order to find the
requested shortest path.

Neo.ClientNotification.Statement.ExperimentalFeature This feature is experimental and should not be used in

production systems.

Neo.ClientNotification.Statement.FeatureDeprecationWar This feature is deprecated and will be removed in future

ning versions.

Neo.ClientNotification.Statement.JoinHintUnfulfillable The database was unable to plan a hinted join.

Warning

5
Status Code Description

Neo.ClientNotification.Statement.JoinHintUnsupportedWa Queries with join hints are not supported by the RULE
rning planner.

Neo.ClientNotification.Statement.NoApplicableIndexWarn Adding a schema index may speed up this query.

ing

Neo.ClientNotification.Statement.PlannerUnavailableWar The RULE planner is not available in the current CYPHER

ning version, the query has been run by an older CYPHER version.

Neo.ClientNotification.Statement.PlannerUnsupportedWar This query is not supported by the COST planner.

ning

Neo.ClientNotification.Statement.RuntimeUnsupportedWar This query is not supported by the chosen runtime.

ning

Neo.ClientNotification.Statement.SuboptimalIndexForWil Index cannot execute wildcard query efficiently.

dcardQuery

Neo.ClientNotification.Statement.UnboundedVariableLeng The provided pattern is unbounded, consider adding an

thPatternWarning upper limit to the number of node hops.

Neo.ClientNotification.Statement.UnknownLabelWarning The provided label is not in the database.

Neo.ClientNotification.Statement.UnknownPropertyKeyWar The provided property key is not in the database.

ning

Neo.ClientNotification.Statement.UnknownRelationshipTy The provided relationship type is not in the database.

peWarning

Neo.DatabaseError.General.IndexCorruptionDetected The request (directly or indirectly) referred to an index that is

in a failed state. The index needs to be dropped and
recreated manually.

Neo.DatabaseError.General.SchemaCorruptionDetected A malformed schema rule was encountered. Please contact

your support representative.

Neo.DatabaseError.General.StorageDamageDetected Expected set of files not found on disk. Please restore from
backup.

Neo.DatabaseError.General.UnknownError An unknown error occurred.

Neo.DatabaseError.Schema.ConstraintCreationFailed Creating a requested constraint failed.

Neo.DatabaseError.Schema.ConstraintDropFailed The database failed to drop a requested constraint.

Neo.DatabaseError.Schema.IndexCreationFailed Failed to create an index.

Neo.DatabaseError.Schema.IndexDropFailed The database failed to drop a requested index.

Neo.DatabaseError.Schema.LabelAccessFailed The request accessed a label that did not exist.

Neo.DatabaseError.Schema.LabelLimitReached The maximum number of labels supported has been reached,

no more labels can be created.

Neo.DatabaseError.Schema.PropertyKeyAccessFailed The request accessed a property that does not exist.

Neo.DatabaseError.Schema.RelationshipTypeAccessFailed The request accessed a relationship type that does not exist.

Neo.DatabaseError.Schema.SchemaRuleAccessFailed The request referred to a schema rule that does not exist.

Neo.DatabaseError.Schema.SchemaRuleDuplicateFound The request referred to a schema rule that is defined multiple

times.

Neo.DatabaseError.Statement.ExecutionFailed The database was unable to execute the statement.

6
Status Code Description

Neo.DatabaseError.Transaction.TransactionCommitFailed The database was unable to commit the transaction.

Neo.DatabaseError.Transaction.TransactionLogError The database was unable to write transaction to log.

Neo.DatabaseError.Transaction.TransactionRollbackFaile The database was unable to roll back the transaction.

d

Neo.DatabaseError.Transaction.TransactionStartFailed The database was unable to start the transaction.

Neo.TransientError.Cluster.NoLeaderAvailable No leader available at the moment. Retrying your request at a

later time may succeed.

Neo.TransientError.Cluster.ReplicationFailure Replication failure.

Neo.TransientError.General.DatabaseUnavailable The database is not currently available to serve your request,

refer to the database logs for more details. Retrying your
request at a later time may succeed.

Neo.TransientError.General.OutOfMemoryError There is not enough memory to perform the current task.

Please try increasing dbms.memory.heap.max_size in the
neo4j configuration (normally in conf/neo4j.conf or, if you
are using Neo4j Desktop, found through the user interface) or
if you are running an embedded installation increase the
heap by using -Xmx command line flag, and then restart the
database.

Neo.TransientError.General.StackOverFlowError There is not enough stack size to perform the current task.
This is generally considered to be a database error, so please
contact Neo4j support. You could try increasing the stack
size: for example to set the stack size to 2M, add
dbms.jvm.additional=-Xss2M to in the neo4j configuration
(normally in conf/neo4j.conf or, if you are using Neo4j
Desktop, found through the user interface) or if you are
running an embedded installation just add -Xss2M as
command line flag.

Neo.TransientError.Network.CommunicationError An unknown network failure occurred, a retry may resolve

the issue.

Neo.TransientError.Request.NoThreadsAvailable There are no available threads to serve this request at the

moment. You can retry at a later time or consider increasing
max thread pool size for bolt connector(s).

Neo.TransientError.Schema.SchemaModifiedConcurrently The database schema was modified while this transaction

was running, the transaction should be retried.

Neo.TransientError.Security.AuthProviderFailed An auth provider request failed.

Neo.TransientError.Security.AuthProviderTimeout An auth provider request timed out.

Neo.TransientError.Security.ModifiedConcurrently The user was modified concurrently to this request.

Neo.TransientError.Transaction.ConstraintsChanged Database constraints changed since the start of this

transaction.

Neo.TransientError.Transaction.DeadlockDetected This transaction, and at least one more transaction, has

acquired locks in a way that it will wait indefinitely, and the
database has aborted it. Retrying this transaction will most
likely be successful.

7
Status Code Description

Neo.TransientError.Transaction.InstanceStateChanged Transactions rely on assumptions around the state of the

Neo4j instance they execute on. For instance, transactions in
a cluster may expect that they are executing on an instance
that can perform writes. However, instances may change
state while the transaction is running. This causes
assumptions the instance has made about how to execute
the transaction to be violated - meaning the transaction must
be rolled back. If you see this error, you should retry your
operation in a new transaction.

Neo.TransientError.Transaction.Interrupted Interrupted while waiting.

Neo.TransientError.Transaction.LockAcquisitionTimeout Unable to acquire lock within configured timeout

(dbms.lock.acquisition.timeout).

Neo.TransientError.Transaction.LockClientStopped The transaction has been terminated, so no more locks can

be acquired. This can occur because the transaction ran
longer than the configured transaction timeout, or because a
human operator manually terminated the transaction, or
because the database is shutting down.

Neo.TransientError.Transaction.LockSessionExpired The lock session under which this transaction was started is
no longer valid.

Neo.TransientError.Transaction.Outdated Transaction has seen state which has been invalidated by

applied updates while transaction was active. Transaction
may succeed if retried.

Neo.TransientError.Transaction.Terminated Explicitly terminated by the user.

8
License
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)

You are free to

Share
copy and redistribute the material in any medium or format

Adapt
remix, transform, and build upon the material

The licensor cannot revoke these freedoms as long as you follow the license terms.

Under the following terms

Attribution
You must give appropriate credit, provide a link to the license, and indicate if changes were made. You
may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or
your use.

NonCommercial
You may not use the material for commercial purposes.

ShareAlike
If you remix, transform, or build upon the material, you must distribute your contributions under the
same license as the original.

No additional restrictions
You may not apply legal terms or technological measures that legally restrict others from doing
anything the license permits.

Notices
You do not have to comply with the license for elements of the material in the public domain or where your
use is permitted by an applicable exception or limitation.

No warranties are given. The license may not give you all of the permissions necessary for your intended
use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the
material.

See https://creativecommons.org/licenses/by-nc-sa/4.0/ for further details. The full license text is available
at https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.