Package com.surrealdb

Class QueryException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.surrealdb.SurrealException

com.surrealdb.ServerException

com.surrealdb.QueryException

All Implemented Interfaces:

Serializable

public class QueryException
extends ServerException

Query execution failure (not executed, timed out, cancelled).

Details use the {kind, details?} format with variants defined in QueryDetailKind.

See Also:

• ErrorKind.QUERY
• Serialized Form

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getTimeout()	Returns the timeout duration when the query timed out, as a map containing "secs" and "nanos" keys.
boolean	isCancelled()	Returns true when the query was cancelled.
boolean	isNotExecuted()	Returns true when the query was not executed (e.g.
boolean	isTimedOut()	Returns true when the query timed out.

Methods inherited from class com.surrealdb.ServerException

findCause, findCause, getDetails, getKind, getKindEnum, getServerCause, hasKind, hasKind

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

isNotExecuted

public boolean isNotExecuted()

Returns true when the query was not executed (e.g. a previous statement in a multi-statement query failed).

Returns:

whether the detail kind is NotExecuted

isTimedOut

public boolean isTimedOut()

Returns true when the query timed out.

Returns:

whether the detail kind is TimedOut

isCancelled

public boolean isCancelled()

Returns true when the query was cancelled.

Returns:

whether the detail kind is Cancelled

getTimeout

public Map<String,Object> getTimeout()

Returns the timeout duration when the query timed out, as a map containing "secs" and "nanos" keys.

Returns:

the timeout map, or null