PostgreSQL のコメント文字

この記事では、PostgreSQL で文字または文字セットにコメントする方法を紹介します。

多くの言語では、プログラマーが特定のコードまたはその特定の部分がどのように機能するかを説明する方法としてコメントを使用しています。

ほとんどの場合、シンボルが続き、パーサーによってコメントとして認識される行全体が続きます。 PostgreSQL では、-- キーワードを使用してコメントし、その後に特定のコメントを続けます。

PostgreSQL の基本的なコメント

Postgres クエリ内の何かにコメントするには、コードに次の構文を使用します。

-- [comment string] (STANDARD SQL SINGLE LINE)
or
/* [comment string
    comment string 2] */ (STANDARD SQL MULTI LINE CODE)

コメントは、クエリの実行に不要と見なされるため、さらに構文解析を行う前に削除されます。

何かについてコメントするには、クエリに移動して、次のようにします。

-- This is a test comment

また、このようなコードを実行する傾向がある場合でも、文字はコメントの一部であり、コード構文に干渉しないため、コードは適切に実行されます。 より大きなコメント文字列を使用して複数行で同じことを行うには、次のように記述します。

/*
I am working on a test string
that is effectively better
with multiple lines
*/

したがって、PostgreSQL での COMMENT がいかに簡単であるかがわかります。 しかし、この方法論は PGADMIN[Version_NO] または PostgreSQL を実行できるその他の GUI に対して完全に機能します。

コマンド ライン ユーティリティまたは bash について言及する場合は、いくつかの点に留意する必要があります。 それらが以下にあるものを見てみましょう。

PSQL のコメント - PostgreSQL コマンドライン ユーティリティ

PSQL を起動して、PGADMIN で行ったようにコメントしてみましょう。

select  * from DOGGY; --postgres

上記のクエリを実行すると、正しい結果が返されます。 しかし、\ コマンドで同じことをしようとするとどうなるでしょうか。 次のクエリを実行します。

\dt --display relations

出力：

Did not find any relation named "--display".
\dt: extra argument "relations" ignored

これは、DT コマンドの場合だけではありません。 SLASH を含む PSQL で他のクエリを実行すると、コメントが無視される可能性があります。

したがって、これを解決するには、PostgreSQL でクエリの横にコメントを書き込む代わりに、COMMENT を取得して SLASH コマンドの前に実行することができます。 このようにして、コメントは無視されませんが、作業コードのクリーン バージョンを実装することもできます。

postgres=# --postgres
postgres=# \dt

上記のコマンドを実行すると、希望する結果が得られます。 また、IGNORE エラーはなくなります。

上記のコマンドは、\DT の前に -- POSTGRES を追加して実行するだけで機能します。

PSQL の SLASH コマンドは、META-COMMANDS としても知られています。 では、PSQL にコメントを入れる他のさまざまな方法を見てみましょう。

\ECHO を使用して、PSQL でコメントする

次のクエリを実行すると、完全に機能する傾向があります。

\dt \echo display table

次の結果が表示されます。

PSQL の \ECHO は、引数を OUTPUT に出力する傾向があります。 したがって、\ECHO の横にコメントを書き込むと、そのコメントがコンソールに出力されます。

したがって、PSQL にコメントを追加する美しい方法です。

PSQL の \ECHO コマンドの代わりに \WARN を使用してコメントを付けます

コンソールにコメントを出力できる別のコマンドは \WARN です。 \ECHO に似ています。 ただし、出力は標準エラー チャネルに出力されます。

これは違いはありません。 \WARN コマンドを使用してクエリを実行すると、完全に機能します。

\dt \warn display_table;

PSQL の標準エラー チャネルはコンソールであるため、\ECHO の横にあるコメントは、前のコマンドの実行直後に出力されます。

\ と -- を使用して、PSQL でコメントする

\dt \\ --display_table_check

上記のクエリはテーブルを返しますが、コンソールにコメントを出力しません。 \\ は SEPARATOR メタコマンドであり、これに出会う 2つの異なる端がいかなるシナリオでも結合されないように指定するために使用されます。

私たちの場合、\dt は -- コメント とは完全に別のコマンドであり、\\ の指定がない場合、PSQL は両方が 1つのコマンドであると想定した可能性があります。

PSQL と PGADMIN でコメントする方法を学習したので、探索できるオプションが他にもいくつかあります。上記の方法が目的に合わない場合に、ここで簡単に説明します。 ニーズとウォンツ。

PostgreSQL の特定のオブジェクトに関する COMMENT

COMMENT キーワードは、PostgreSQL データベース内の特定のオブジェクトにコメントするもう 1つの効率的な方法です。 COMMENT は URL で読むことができます。

今のところ、TABLE の例を使用して、これを使用してコメントします。

COMMENT on table DOGGY is 'The Dogs table is amazing!';

次に、このコメントを表示するには、PSQL に切り替えてコマンドを実行します。 \d+. これにより、DESCRIPTION 列のコメントを表示するテーブルが返されます。

したがって、PSQL でクエリを実行すると、次のような結果が得られます。

出力：

したがって、COMMENT を使用すると、構文エラーを回避するのに役立ち、コメントをシンプルで効果的かつ具体的なものにする効率的な方法にもなります。

今日は、PostgreSQL セッションでコメントする方法を学びました。 もちろん、さまざまなシナリオにはさまざまな方法が必要です。

たとえば、COMMENTを使用すると、他のプログラマーがオブジェクトを作成したコードの動作ではなく、オブジェクトの説明と詳細な説明をチェックする必要がある場合に非常に役立ちます。 したがって、どの方法を選択するかはあなた次第です。

いつものように、チュートリアルを正しく読んで、コードの機能をよりよく理解してください。