Kommentarzeichen in PostgreSQL

1. Grundlegendes Kommentieren in PostgreSQL
2. Kommentar in PSQL - Das PostgreSQL-Befehlszeilenprogramm
3. COMMENT zu bestimmten Objekten in PostgreSQL

In diesem Artikel wird vorgestellt, wie wir ein Zeichen oder eine Gruppe von Zeichen in PostgreSQL kommentieren können.

Viele Sprachen verwenden Kommentare, um dem Programmierer zu erklären, wie ein bestimmter Code oder ein bestimmter Teil davon funktioniert.

Es folgt meist ein Symbol und dann eine ganze Zeile, die vom Parser als Kommentar wahrgenommen wird. In PostgreSQL kommentieren wir mit dem Schlüsselwort --, gefolgt von einem bestimmten Kommentar.

Grundlegendes Kommentieren in PostgreSQL

Um etwas in einer Postgres-Abfrage zu kommentieren, verwenden Sie die folgende Syntax für Ihren Code.

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

Kommentare werden entfernt, bevor eine weitere Syntaxanalyse erfolgt, da sie für die Abfrageausführung als unnötig erachtet werden.

Um also etwas zu kommentieren, gehen Sie zu Ihrer Abfrage und gehen Sie wie folgt vor.

-- This is a test comment

Und wenn Sie dazu neigen, den Code mit so etwas auszuführen, wird Ihr Code trotzdem ordnungsgemäß ausgeführt, da die Zeichen Teil des Kommentars sind und sich nicht in Ihre Codesyntax einmischen. Um dasselbe mehrzeilig mit einer größeren Kommentarzeichenfolge zu tun, schreiben Sie etwas wie folgt.

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

Sie können also sehen, wie einfach es ist, in PostgreSQL zu KOMMENTIEREN. Aber diese Methode funktioniert perfekt für PGADMIN[Version_NO] oder jede andere GUI, die PostgreSQL ausführen kann.

Wir müssen einige Punkte beachten, wenn wir uns auf das Befehlszeilendienstprogramm oder Bash beziehen. Mal sehen, was sie unten sind.

Kommentar in PSQL - Das PostgreSQL-Befehlszeilenprogramm

Lassen Sie uns PSQL starten und versuchen, zu kommentieren, wie wir es in PGADMIN getan haben.

select  * from DOGGY; --postgres

Die Ausführung der obigen Abfrage gibt uns die richtigen Ergebnisse zurück. Aber was ist, wenn wir versuchen, dasselbe mit einem \-Befehl zu tun? Ausführen der folgenden Abfrage.

\dt --display relations

Ausgang:

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

Und das nicht nur beim DT-Befehl. Das Ausführen einer anderen Abfrage in PSQL, die einen SLASH enthält, ignoriert möglicherweise Kommentare.

Um dies zu lösen, können wir fortfahren und anstatt Kommentare neben eine Abfrage in PostgreSQL zu schreiben, können wir den COMMENT nehmen und ihn vor den SLASH-Befehlen ausführen. Auf diese Weise wird der Kommentar nicht ignoriert, aber wir können auch eine saubere Version unseres Arbeitscodes implementieren.

postgres=# --postgres
postgres=# \dt

Wenn Sie den obigen Befehl ausführen, erhalten Sie jetzt das gewünschte Ergebnis. Außerdem gibt es keine IGNORE-Fehler mehr.

Der obige Befehl funktioniert einfach, indem das -- POSTGRES vor dem \DT angehängt und dann ausgeführt wird.

SLASH-Befehle in PSQL sind auch als META-COMMANDS bekannt. Sehen wir uns nun verschiedene andere Möglichkeiten zum Einfügen von Kommentaren in PSQL an.

Verwenden Sie das \ECHO zum Kommentieren in PSQL

Das Ausführen der folgenden Abfrage funktioniert in der Regel einwandfrei.

\dt \echo display table

Und zeigt das folgende Ergebnis:

Das \ECHO in PSQL neigt dazu, Argumente in OUTPUT zu drucken. Wenn Sie also den Kommentar neben \ECHO schreiben, wird dieser Kommentar in der Konsole gedruckt.

Daher eine schöne Möglichkeit, Kommentare in PSQL hinzuzufügen.

Verwenden Sie \WARN als Alternative zum \ECHO-Befehl in PSQL zum Kommentieren

Ein weiterer Befehl, der Kommentare in der Konsole drucken kann, ist \WARN. Es ist ähnlich wie \ECHO; Die Ausgabe wird jedoch auf dem Standardfehlerkanal ausgegeben.

Dies macht keinen Unterschied. Es funktioniert perfekt, wenn Sie die Abfrage mit dem Befehl \WARN ausführen.

\dt \warn display_table;

Da der Standardfehlerkanal von PSQL die Konsole ist, wird jeder Kommentar neben \ECHO direkt nach der Ausführung des vorhergehenden Befehls ausgegeben.

Verwenden Sie \ und dann --, um in PSQL zu kommentieren

\dt \\ --display_table_check

Die obige Abfrage gibt uns die Tabelle zurück, gibt aber keinen Kommentar auf der Konsole aus. \\ ist der SEPARATOR-Metabefehl und wird verwendet, um anzugeben, dass die beiden unterschiedlichen Enden, die darauf treffen, in keinem Szenario verbunden werden sollen.

In unserem Fall ist \dt ein ganz anderer Befehl als der --Kommentar, und es könnte sein, dass PSQL ohne die Angabe von \\ davon ausgegangen wäre, dass beides ein Befehl wäre.

Nachdem wir nun gelernt haben, wie man in PSQL und PGADMIN kommentiert, gibt es noch ein paar andere Optionen, die Sie erkunden können, die wir hier kurz behandeln werden, damit Sie sie befolgen und implementieren können, wenn das oben Gesagte nicht Ihren Vorstellungen entspricht Bedürfnisse und Wünsche.

COMMENT zu bestimmten Objekten in PostgreSQL

Das Schlüsselwort COMMENT ist eine weitere effiziente Methode, um bestimmte Objekte in einer PostgreSQL-Datenbank zu kommentieren. COMMENT können Sie hier nachlesen: URL.

Wir nehmen vorerst das Beispiel TABLE und kommentieren es damit.

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

Und dann, um diesen Kommentar anzuzeigen, wechseln Sie zu PSQL und führen Sie den Befehl aus; \d+. Dadurch wird eine Tabelle zurückgegeben, um unsere Kommentare in der Spalte BESCHREIBUNG anzuzeigen.

Wenn wir also die Abfrage in PSQL ausführen, erhalten wir Folgendes.

Ausgang:

Daher hilft uns die Verwendung von COMMENT, Syntaxfehler zu vermeiden, und ist auch eine effiziente Möglichkeit, Kommentare einfach, effektiv und spezifisch zu halten.

Heute haben wir also gelernt, wie wir in einer PostgreSQL-Sitzung kommentieren können. Natürlich sind für unterschiedliche Szenarien unterschiedliche Methoden erforderlich.

Die Verwendung von COMMENT zum Beispiel wäre eine große Hilfe, wenn andere Programmierer eher Beschreibungen und detaillierte Erklärungen von Objekten überprüfen müssten als das Funktionieren des Codes, der sie erstellt hat. Daher ist es Ihnen überlassen, für welche Methode Sie sich entscheiden.

Achten Sie wie immer darauf, unsere Tutorials richtig zu lesen, um die Funktionsweise unseres Codes besser zu verstehen.