View Source Xandra.Error exception (Xandra v0.18.0)

An exception struct that represents an error returned by Cassandra.

For more information on when this error is returned or raised, see the documentation for the Xandra module.

The :reason field represents the reason (as an atom) of the error. For example, if the query you're trying to execute contains a syntax error, :reason will be :invalid_syntax. The :message field is a string that contains the exact error message that Cassandra returned.

Since this struct is an exception, it is possible to raise it with Kernel.raise/1. If the intent is to format errors as strings (for example, for logging purposes), it is possible to use Exception.message/1 to get a formatted version of the error.

Summary

Types

t()

The type for a Cassandra error exception.

Functions

%Xandra.Error{}

The exception struct for a Cassandra error.

Types

Link to this type

t()

View Source 
@type t() :: %Xandra.Error{
  __exception__: true,
  message: String.t(),
  reason: atom(),
  warnings: [String.t()]
}

The type for a Cassandra error exception.

Functions

Link to this function

%Xandra.Error{}

View Source (struct)

The exception struct for a Cassandra error.