Struct DatabaseError 

pub struct DatabaseError {
    pub code: String,
    pub message: String,
    pub details: Option<String>,
    pub hint: Option<String>,
    pub constraint: Option<String>,
    pub table: Option<String>,
    pub column: Option<String>,
}

Database-specific error type.

Fields

code: String

The five-character SQLSTATE. This decides the HTTP status, so it is the field that matters most.

message: String

PostgreSQL’s primary message.

details: Option<String>

PostgreSQL’s detail field, where it sent one.

hint: Option<String>

PostgreSQL’s hint field, where it sent one.

constraint: Option<String>

The constraint that was violated, for the integrity SQLSTATEs.

table: Option<String>

The table the failure concerns, where PostgreSQL identified one.

column: Option<String>

The column the failure concerns, where PostgreSQL identified one.

Implementations

impl DatabaseError

pub fn raised_response(&self) -> Option<Result<RaisedResponse, RaiseFault>>

The response a RAISE sqlstate 'PGRST' asked for.

A function can take over the whole response by raising that SQLSTATE: the message is the body, and the detail carries the status, an optional status text and any headers. It is how a schema returns a 402 with its own payload without the API layer knowing anything about billing.

None when this is not that error. Err when it is and the schema wrote it wrongly, which is a bug in the schema rather than a response to half-apply.

pub fn status_code(&self) -> StatusCode

The HTTP status a PostgreSQL error code maps to.

PostgREST’s table (mapSQLtoHTTP in Error.hs), which is part of its contract rather than an implementation detail: a client distinguishes a missing function from a bad argument by the status.

The default is 400, not 500: the great majority of SQLSTATEs a request can provoke are provoked by the request. Reporting them as server errors tells the client to retry something that will never succeed.

pub fn code(&self) -> &'static str

Get error code for API response.

Trait Implementations

impl Debug for DatabaseError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for DatabaseError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for DatabaseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DatabaseError> for Error

fn from(source: DatabaseError) -> Self

Converts to this type from the input type.