graphile / graphile/graphile.github.io

Add documentation about reporting error codes from within PostgreSQL

オープン
#56 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
SCSS
スター
27
フォーク
126
PR マージ指標
30日以内にマージされた PR はありません

説明

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?

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

このIssueには、提案されたドキュメント本文とPostgreSQLの予約済みエラーコード付録へのリンクがありますが、リポジトリ内のファイルもドキュメントのエントリーポイントも示されていません。まずPostGraphileのエラー報告に関するドキュメントを見つけ、次に記載されているルールと例をPostgreSQLに照らして確認してください。ガイダンスと一般的なコードが適切なドキュメントの場所に公開されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
postgresql
領域
databases, documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。