jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reorganize error groups

Browse Source
This commit is contained in:
Laurence Isla
2022-05-02 23:14:24 -05:00
committed by GitHub
parent 5f3284eed0
commit 9c23ac2f39
3 changed files with 51 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api.rst
+2
View File
@@ -1799,6 +1799,8 @@ Deletions also support :code:`Prefer: return=representation` plus :ref:`v_filter
Beware of accidentally deleting all rows in a table. To learn to prevent that see :ref:`block_fulltable`.
.. _limited_update_delete:
Limited Updates/Deletions
=========================
docs/errors.rst
+47 -64
View File
@@ -177,6 +177,42 @@ Related to the HTTP request elements.
| | specified in the ``select`` part of the query string. |
| PGRST108 | See :ref:`embed_filters`. |
+---------------+-------------------------------------------------------------+
| .. _pgrst109: | Restricting a Deletion or an Update using limits must |
| | include the ordering of a unique column. |
| PGRST109 | See :ref:`limited_update_delete`. |
+---------------+-------------------------------------------------------------+
| .. _pgrst110: | When restricting a Deletion or an Update using limits |
| | modifies more rows than the maximum specified in the limit. |
| PGRST110 | See :ref:`limited_update_delete`. |
+---------------+-------------------------------------------------------------+
| .. _pgrst111: | Related to :ref:`guc_resp_hdrs`. |
| | |
| PGRST111 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst112: | The status code must be a positive integer. |
| | See :ref:`guc_resp_status`. |
| PGRST112 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst113: | Related to :ref:`binary_output`. See :ref:`providing_img` |
| | for an example on requesting images. |
| PGRST113 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst114: | For an :ref:`UPSERT using PUT <upsert_put>`, when |
| | :ref:`limits and offsets <limits>` are used. |
| PGRST114 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst115: | For an :ref:`UPSERT using PUT <upsert_put>`, when the |
| | primary key in the query string and the body are different. |
| PGRST115 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst116: | More than 1 or no items where returned when requesting |
| | a singular response. See :ref:`singular_plural`. |
| PGRST116 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst117: | The HTTP verb used in the request in not supported. |
| | |
| PGRST117 | |
+---------------+-------------------------------------------------------------+
.. _pgrst2**:
@@ -209,8 +245,8 @@ Related to a :ref:`stale schema cache <stale_schema>`. Most of the time, these e
.. _pgrst3**:
Group 3 - JWT errors
--------------------
Group 3 - JWT
-------------
Related to the authentication process using JWT. You can follow the :ref:`tut1` for an example on how to implement authentication and the :doc:`Authentication page <auth>` for more information on this process.
@@ -230,72 +266,19 @@ Related to the authentication process using JWT. You can follow the :ref:`tut1`
| PGRST302 | is disabled by not setting it in :ref:`db-anon-role`. |
+---------------+-------------------------------------------------------------+
.. _pgrst4**:
.. The Internal Errors Group X** is always at the end
Group 4 - Hasql
---------------
.. _pgrst_X**:
Related to `the library <https://hackage.haskell.org/package/hasql>`_ that PostgREST uses to connect to the database. If you encounter any of these errors, you may have stumbled on a PostgREST bug, please `open an issue <https://github.com/PostgREST/postgrest/issues>`_ and we'll be glad to fix it.
Group X - Internal
------------------
Internal errors mostly related to `the library <https://hackage.haskell.org/package/hasql>`_ that PostgREST uses to connect to the database. If you encounter any of these errors, you may have stumbled on a PostgREST bug, please `open an issue <https://github.com/PostgREST/postgrest/issues>`_ and we'll be glad to fix it.
+---------------+-------------------------------------------------------------+
| Code | Description |
+===============+=============================================================+
| .. _pgrst400: | Internal error: Unexpected Result. |
| | |
| PGRST400 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst401: | Internal error: Attempted to parse more columns than |
| | there are in the result. |
| PGRST401 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst402: | Internal error: Attempted to parse a NULL as some value. |
| | |
| PGRST402 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst403: | Internal error: Wrong value parser used. |
| | |
| PGRST403 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst404: | Internal error: Unexpected amount of rows. |
| | |
| PGRST404 | |
+---------------+-------------------------------------------------------------+
.. _pgrst5**:
Group 5 - General
-----------------
These are uncategorized errors.
+---------------+-------------------------------------------------------------+
| Code | Description |
+===============+=============================================================+
| .. _pgrst500: | Related to :ref:`guc_resp_hdrs`. |
| | |
| PGRST500 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst501: | The status code must be a positive integer. |
| | See :ref:`guc_resp_status`. |
| PGRST501 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst502: | Related to :ref:`binary_output`. See :ref:`providing_img` |
| | for an example on requesting images. |
| PGRST502 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst503: | For an :ref:`UPSERT using PUT <upsert_put>`, when |
| | :ref:`limits and offsets <limits>` are used. |
| PGRST503 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst504: | For an :ref:`UPSERT using PUT <upsert_put>`, when the |
| | primary key in the query string and the body are different. |
| PGRST504 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst505: | More than 1 or no items where returned when requesting |
| | a singular response. See :ref:`singular_plural`. |
| PGRST505 | |
+---------------+-------------------------------------------------------------+
| .. _pgrst506: | The HTTP verb used in the request in not supported. |
| | |
| PGRST506 | |
| .. _pgrstX00: | Internal errors related to the library that connects to the |
| | database. |
| PGRSTX00 | |
+---------------+-------------------------------------------------------------+
postgrest.dict
+2 -2
View File
@@ -50,7 +50,6 @@ GUC
gucs
Gumbs
Haskell
Hasql
Heroku
HMAC
Homebrew
@@ -108,6 +107,8 @@ PgBouncer
pgcrypto
pgjwt
pgrst
pgrstX
PGRSTX
pgSQL
phfts
phraseto
@@ -174,7 +175,6 @@ Tyll
TypeScript
UI
ui
uncategorized
unicode
unix
updatable