graphile / graphile/graphile.github.io

Add documentation about reporting error codes from within PostgreSQL

Offen
#56 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
SCSS
Sterne
27
Forks
126
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Here's what I use on some projects (most error codes have been omitted because they won't make sense for your app):

---

Error codes
===========

Errors from PostGraphile may come through with one of these error codes.

Error code rules
----------------

Some error codes are [reserved by
PostgreSQL](https://www.postgresql.org/docs/9.6/static/errcodes-appendix.html),
so error codes we use must match these criterea:

- 5 alphanumeric (capitals) letters
- First character must be a letter
- First character cannot be F, H, P or X.
- Third character cannot be 0 or P.
- Fourth character must be a letter.
- Must not end `000`

Rewritten, the above rules state:

- Char 1: A-Z except F, H, P, X
- Char 2: A-Z0-9
- Char 3: A-Z0-9 except 0, P
- Char 4: A-Z
- Char 5: A-Z0-9

Common
------

- SELF0: you can't do that to yourself (e.g. remove admin from yourself)
- ERROR: invalid arguments
- UNSUB: error unsubscribing - perhaps your token was wrong?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

The issue provides proposed documentation text and links to PostgreSQL's reserved error-code appendix, but names no repository file or documentation entry point. Start by locating the PostGraphile error-reporting documentation, then check the stated rules and examples against PostgreSQL; it is done when the guidance and common codes are published in the appropriate documentation location.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
postgresql
Bereich
databases, documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.