graphile / graphile/graphile.github.io

Add documentation about reporting error codes from within PostgreSQL

Ouverte
#56 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
SCSS
Étoiles
27
Forks
126
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

L’issue fournit un texte de documentation proposé et des liens vers l’annexe des codes d’erreur réservés de PostgreSQL, mais ne nomme aucun fichier du dépôt ni aucun point d’entrée de la documentation. Commencez par localiser la documentation de PostGraphile sur le signalement des erreurs, puis vérifiez les règles et les exemples indiqués par rapport à PostgreSQL ; le travail est terminé lorsque les recommandations et les codes courants sont publiés à l’emplacement de documentation approprié.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
postgresql
Domaine
databases, documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.