Light
Dark
System
v4latest
v4latest
v3
v2
v1

Exceptions

class

EdgeDB.ConfigurationException

Represents a generic configuration error.

method

EdgeDB.ConfigurationException.ConfigurationException()
EdgeDB.ConfigurationException.ConfigurationException(string message): ConfigurationException

Creates a new EdgeDB.ConfigurationException.

Arguments
  • message (string) – The configuration error message.

method

EdgeDB.ConfigurationException.ConfigurationException()
EdgeDB.ConfigurationException.ConfigurationException(string message, Exception inner): ConfigurationException

Creates a new EdgeDB.ConfigurationException.

Arguments
  • message (string) – The configuration error message.

  • inner (Exception) – An inner exception.

class

EdgeDB.ConnectionFailedException

Represents a connection failure that cannot be retried.

Properties
  • Attempts (int) – Gets the number of attempts the client made to reconnect.

method

EdgeDB.ConnectionFailedException.ConnectionFailedException()
EdgeDB.ConnectionFailedException.ConnectionFailedException(int attempts): ConnectionFailedException

Constructs a new EdgeDB.ConnectionFailedException with the number of connection attempts made.

Arguments
  • attempts (int) – The number of attempts made to connect.

class

EdgeDB.ConnectionFailedTemporarilyException

Represents a temporary connection failiure exception.

Properties
  • SocketError (SocketError) – Gets the socket error that caused the connection to fail.

method

EdgeDB.ConnectionFailedTemporarilyException.ConnectionFailedTemporarilyException()
EdgeDB.ConnectionFailedTemporarilyException.ConnectionFailedTemporarilyException(SocketError error): ConnectionFailedTemporarilyException

Constructs a new EdgeDB.ConnectionFailedTemporarilyException with the specified socket error.

Arguments
  • error (SocketError) – The underlying socket error that caused this exception to be thrown.

class

EdgeDB.CustomClientException

Represents a generic error with custom clients.

method

EdgeDB.CustomClientException.CustomClientException()
EdgeDB.CustomClientException.CustomClientException(string message): CustomClientException

Constructs a new EdgeDB.CustomClientException with the specified error message.

Arguments
  • message (string) – The error message describing why this exception was thrown.

class

EdgeDB.EdgeDBErrorException

Represents an exception that was caused by an error from EdgeDB.

Properties
  • Details (string) – Gets the details related to the error.

  • ServerTraceBack (string) – Gets the server traceback log for the error.

  • Hint (string) – Gets the hint for the error.

  • Query (string) – Gets the query that caused this error.

Methods

method

EdgeDB.EdgeDBErrorException.ToString()
EdgeDB.EdgeDBErrorException.ToString(): string

Prettifies the error if it was a result of a bad query string; otherwise formats it.

class

EdgeDB.EdgeDBException

Represents a generic exception that occured with the edgedb library.

method

EdgeDB.EdgeDBException.EdgeDBException()
EdgeDB.EdgeDBException.EdgeDBException(bool shouldRetry, bool shouldReconnect): EdgeDBException

Constructs a new EdgeDB.EdgeDBException.

Arguments
  • shouldRetry (bool) – Whether or not this exception is retryable.

  • shouldReconnect (bool) – Whether or not the client who caught this exception should reconnect.

method

EdgeDB.EdgeDBException.EdgeDBException()
EdgeDB.EdgeDBException.EdgeDBException(string message, bool shouldRetry, bool shouldReconnect): EdgeDBException

Constructs a new EdgeDB.EdgeDBException with the specified error message.

Arguments
  • message (string) – The error message describing why this exception was thrown.

  • shouldRetry (bool) – Whether or not this exception is retryable.

  • shouldReconnect (bool) – Whether or not the client who caught this exception should reconnect.

method

EdgeDB.EdgeDBException.EdgeDBException()
EdgeDB.EdgeDBException.EdgeDBException(string message, Exception innerException, bool shouldRetry, bool shouldReconnect): EdgeDBException

Constructs a new EdgeDB.EdgeDBException with the specified error message and inner exception.

Arguments
  • message (string) – The error message describing why this exception was thrown.

  • innerException (Exception) – The inner exception.

  • shouldRetry (bool) – Whether or not this exception is retryable.

  • shouldReconnect (bool) – Whether or not the client who caught this exception should reconnect.

class

EdgeDB.InvalidConnectionException

Represents an error with the provided connection details.

method

EdgeDB.InvalidConnectionException.InvalidConnectionException()
EdgeDB.InvalidConnectionException.InvalidConnectionException(string message): InvalidConnectionException

Constructs a new EdgeDB.InvalidConnectionException with the specified error message.

Arguments
  • message (string) – The error message describing why this exception was thrown.

class

EdgeDB.InvalidSignatureException

Represents an exception that occurs when the server signature is incorrect.

method

EdgeDB.InvalidSignatureException.InvalidSignatureException()
EdgeDB.InvalidSignatureException.InvalidSignatureException(): InvalidSignatureException

class

EdgeDB.MissingCodecException

Represents an exception that occurs when the client doesn’t have a codec for incoming or outgoing data.

method

EdgeDB.MissingCodecException.MissingCodecException()
EdgeDB.MissingCodecException.MissingCodecException(string message): MissingCodecException

Constructs a new EdgeDB.MissingCodecException with the specified error message.

Arguments
  • message (string) – The error message describing why this exception was thrown.

class

EdgeDB.MissingRequiredException

Represents an exception that occurs when required data isn’t returned.

method

EdgeDB.MissingRequiredException.MissingRequiredException()
EdgeDB.MissingRequiredException.MissingRequiredException(): MissingRequiredException

class

EdgeDB.NoTypeConverterException

method

EdgeDB.NoTypeConverterException.NoTypeConverterException()
EdgeDB.NoTypeConverterException.NoTypeConverterException(Type target, Type source): NoTypeConverterException

Constructs a new EdgeDB.NoTypeConverterException with the target and source types.

Arguments
  • target (Type) – The target type that EdgeDB.DocGenerator.docMemberSummaryParamref was going to be converted to.

  • source (Type) – The source type.

method

EdgeDB.NoTypeConverterException.NoTypeConverterException()
EdgeDB.NoTypeConverterException.NoTypeConverterException(Type target, Type source, Exception inner): NoTypeConverterException

Constructs a new EdgeDB.NoTypeConverterException with the target and source type, and inner exception.

Arguments
  • target (Type) – The target type that EdgeDB.DocGenerator.docMemberSummaryParamref was going to be converted to.

  • source (Type) – The source type.

  • inner (Exception) – The inner exception.

method

EdgeDB.NoTypeConverterException.NoTypeConverterException()
EdgeDB.NoTypeConverterException.NoTypeConverterException(string message, Exception inner): NoTypeConverterException

Constructs a new EdgeDB.NoTypeConverterException with the specified error message.

Arguments
  • message (string) – The error message describing why this exception was thrown.

  • inner (Exception) – An optional inner exception.

class

EdgeDB.ResultCardinalityMismatchException

Represents an exception that occurs when a queries cardinality isn’t what the client was expecting.

method

EdgeDB.ResultCardinalityMismatchException.ResultCardinalityMismatchException()
EdgeDB.ResultCardinalityMismatchException.ResultCardinalityMismatchException(Cardinality expected, Cardinality actual): ResultCardinalityMismatchException

Constructs a new EdgeDB.ResultCardinalityMismatchException.

Arguments
  • expected (Cardinality) – The expected cardinality.

  • actual (Cardinality) – The actual cardinality

class

EdgeDB.TransactionException

Represents an exception that occurs within transactions.

method

EdgeDB.TransactionException.TransactionException()
EdgeDB.TransactionException.TransactionException(string message, Exception innerException): TransactionException

Constructs a new EdgeDB.TransactionException with a specified error message.

Arguments
  • message (string) – The error message describing why this exception was thrown.

  • innerException (Exception) – An optional inner exception.

class

EdgeDB.UnexpectedMessageException

Represents an exception that occurs when the client receives an unexpected message.

Light
Dark
System

We use ChatGPT with additional context from our documentation to answer your questions. Not all answers will be accurate. Please join our Discord if you need more help.