Xata · Schema

ErrorResponse

Error response with PostgreSQL error fields.

DatabasePostgresServerlessDeveloper ToolsBranchingAI Agent

Properties

Name Type Description
message string Human-readable error message.
code string PostgreSQL error code (SQLSTATE) or application error code.
severity string PostgreSQL error severity (e.g. `ERROR`, `FATAL`).
detail string Optional detail message.
hint string Optional hint for resolving the error.
position string Character position in the query where the error occurred.
internalPosition string Position in an internally-generated query.
internalQuery string Text of the internally-generated query.
where string Context in which the error occurred.
schema string Schema name related to the error.
table string Table name related to the error.
column string Column name related to the error.
dataType string Data type name related to the error.
constraint string Constraint name related to the error.
file string Source file where the error was reported (server-side).
line string Source line where the error was reported (server-side).
routine string Source routine where the error was reported (server-side).
View JSON Schema on GitHub

JSON Schema

xata-errorresponse-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ErrorResponse",
  "description": "Error response with PostgreSQL error fields.",
  "type": "object",
  "properties": {
    "message": {
      "description": "Human-readable error message.",
      "type": "string"
    },
    "code": {
      "description": "PostgreSQL error code (SQLSTATE) or application error code.",
      "type": "string"
    },
    "severity": {
      "description": "PostgreSQL error severity (e.g. `ERROR`, `FATAL`).",
      "type": "string"
    },
    "detail": {
      "description": "Optional detail message.",
      "type": "string"
    },
    "hint": {
      "description": "Optional hint for resolving the error.",
      "type": "string"
    },
    "position": {
      "description": "Character position in the query where the error occurred.",
      "type": "string"
    },
    "internalPosition": {
      "description": "Position in an internally-generated query.",
      "type": "string"
    },
    "internalQuery": {
      "description": "Text of the internally-generated query.",
      "type": "string"
    },
    "where": {
      "description": "Context in which the error occurred.",
      "type": "string"
    },
    "schema": {
      "description": "Schema name related to the error.",
      "type": "string"
    },
    "table": {
      "description": "Table name related to the error.",
      "type": "string"
    },
    "column": {
      "description": "Column name related to the error.",
      "type": "string"
    },
    "dataType": {
      "description": "Data type name related to the error.",
      "type": "string"
    },
    "constraint": {
      "description": "Constraint name related to the error.",
      "type": "string"
    },
    "file": {
      "description": "Source file where the error was reported (server-side).",
      "type": "string"
    },
    "line": {
      "description": "Source line where the error was reported (server-side).",
      "type": "string"
    },
    "routine": {
      "description": "Source routine where the error was reported (server-side).",
      "type": "string"
    }
  },
  "required": [
    "message"
  ]
}