Caracteres de comentarios en PostgreSQL

1. Comentarios básicos en PostgreSQL
2. Comentar en PSQL - La utilidad de línea de comandos de PostgreSQL
3. COMENTARIO sobre objetos específicos en PostgreSQL

Este artículo presentará cómo podemos comentar un carácter o un conjunto de caracteres en PostgreSQL.

Muchos lenguajes usan comentarios como una forma para que el programador explique cómo funciona un determinado código o una parte específica de él.

En su mayoría es seguido por un símbolo y luego una línea completa percibida como un comentario por el analizador. En PostgreSQL, comentamos usando la palabra clave --, seguida de un comentario específico.

Comentarios básicos en PostgreSQL

Para comentar cualquier cosa en una consulta de Postgres, use la siguiente sintaxis para su código.

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

Los comentarios se eliminan antes de que se realice un análisis de sintaxis adicional, ya que se consideran innecesarios para la ejecución de consultas.

Entonces, para comentar algo, vaya a su consulta y haga algo de la siguiente manera.

-- This is a test comment

Y si tiende a ejecutar el código con algo como esto, su código aún se ejecutará correctamente ya que los caracteres son parte del comentario y no se entrometerán con la sintaxis de su código. Para hacer lo mismo en varias líneas con una cadena de comentarios más grande, escriba algo de la siguiente manera.

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

Por lo tanto, puede ver lo fácil que es COMENTAR en PostgreSQL. Pero esta metodología funciona perfectamente para PGADMIN[Version_NO] o cualquier otra GUI que pueda ejecutar PostgreSQL.

Debemos tener en cuenta algunos puntos si nos referimos a la utilidad de línea de comandos o bash. Veamos cuáles son a continuación.

Comentar en PSQL - La utilidad de línea de comandos de PostgreSQL

Iniciemos PSQL e intentemos comentar como lo hicimos en PGADMIN.

select  * from DOGGY; --postgres

Ejecutar la consulta anterior nos devuelve los resultados correctos. Pero, ¿y si tratamos de hacer lo mismo con un comando \? Ejecutando la siguiente consulta.

\dt --display relations

Producción :

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

Y no es sólo el caso del comando DT. Ejecutar cualquier otra consulta en PSQL que contenga una SLASH posiblemente ignorará los comentarios.

Por lo tanto, para resolver esto, podemos continuar y en lugar de escribir comentarios junto a una consulta en PostgreSQL, podemos tomar el COMENTARIO y ejecutarlo antes de los comandos SLASH. De esta manera, el comentario no será ignorado, pero también podremos implementar una versión limpia de nuestro código de trabajo.

postgres=# --postgres
postgres=# \dt

Ejecutar el comando anterior ahora nos dará el resultado que deseamos. Además, no habrá más errores IGNORAR.

El comando anterior funciona simplemente añadiendo -- POSTGRES antes de \DT y luego ejecutándolo.

Los comandos SLASH en PSQL también se conocen como META-COMMANDS. Veamos ahora otras formas de poner comentarios en PSQL.

Usa el \ECHO para comentar en PSQL

Ejecutar la siguiente consulta tiende a funcionar perfectamente.

\dt \echo display table

Y muestra el siguiente resultado:

El \ECHO en PSQL tiende a imprimir argumentos a la SALIDA. Entonces, cuando escriba el comentario junto a \ECHO, imprimirá ese comentario en la consola.

Por lo tanto, una hermosa manera de agregar comentarios en PSQL.

Utilice \WARN como alternativa al comando \ECHO en PSQL para comentar

Otro comando que puede imprimir comentarios en la consola es \WARN. Es similar a \ECHO; sin embargo, la salida se imprime en el canal de error estándar.

Esto no hace la diferencia. Funcionará perfectamente si ejecuta la consulta con el comando \WARN.

\dt \warn display_table;

Debido a que el canal de error estándar de PSQL es la consola, cualquier comentario junto a \ECHO se imprimirá justo después de la ejecución del comando anterior.

Use \ y luego -- para comentar en PSQL

\dt \\ --display_table_check

La consulta anterior nos devuelve la tabla pero no imprime ningún comentario en la consola. \\ es el meta-comando SEPARATOR y se usa para especificar que los dos extremos diferentes que lo encuentran no deben unirse en ningún escenario.

En nuestro caso, \dt es un comando completamente separado del -- comentario, y podría ser que PSQL, sin la especificación de \\, podría haber asumido que ambos eran un solo comando.

Ahora que hemos aprendido cómo comentar en PSQL y PGADMIN, todavía hay algunas otras opciones que puede explorar, que cubriremos brevemente aquí para que las siga e implemente si las anteriores no están de acuerdo con sus necesidades. necesidades y deseos.

COMENTARIO sobre objetos específicos en PostgreSQL

La palabra clave COMMENT es otro método eficiente para comentar objetos específicos en una base de datos PostgreSQL. Puedes leer sobre COMENTARIO aquí: URL.

Por ahora, usaremos el ejemplo de TABLE y lo comentaremos usando this.

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

Y luego, para ver este comentario, cambie a PSQL y ejecute el comando; \d+. Esto devolverá una tabla para ver nuestros comentarios en la columna DESCRIPCIÓN.

Entonces, si ejecutamos la consulta en PSQL, obtendremos algo como lo siguiente.

Producción:

Por lo tanto, usar COMENTARIO nos ayuda a evitar errores de sintaxis y también es una forma eficiente de mantener los comentarios simples, efectivos y específicos.

Así que hoy aprendimos cómo podemos comentar en una sesión de PostgreSQL. Por supuesto, se requieren diferentes métodos para diferentes escenarios.

Usar COMENTARIO, por ejemplo, sería de mucha ayuda si otros programadores tuvieran que revisar las descripciones y explicaciones detalladas de los objetos en lugar del “funcionamiento del código que los creó”. Por lo tanto, depende de usted qué método elija.

Como siempre, asegúrese de leer nuestros tutoriales correctamente para comprender mejor el funcionamiento de nuestro código.