Saltar al contenido

Como documentar un query en SQL? Ventajas y desventajas

Cuando estamos trabajando con SQL, es sumamente importante documentar nuestras consultas. Esto nos permitirá tener una referencia clara de lo que estamos haciendo, y podremos revisarlo fácilmente en el futuro. Además, si alguien más tiene que realizar una modificación en nuestra consulta, será mucho más fácil si la documentación está actualizada. En este artículo te explicaremos cómo documentar un query en SQL de manera efectiva.

Para muchos de nosotros solo escuchar la palabra documentar nos puede llenar de tedio, y sin embargo es una de las partes mas importantes de nuestro trabajo. La documentación nos ayuda a darnos cuenta si estamos haciendo las cosas bien, y nos da una referencia para volver atrás si algo va mal. También es importante considerar que sea Oracle , Mysql, Sqlserver o cualquier otro SGBD, la documentación es necesaria.

Índice

    Formas de documentar en SQL

    En general, existen dos maneras principales de documentar un query en SQL: utilizando comentarios y etiquetas. Los comentarios se utilizan para agregar información adicional mientras que las etiquetas se utilizan para agrupar y categorizar nuestras consultas. En este artículo nos enfocaremos en los comentarios, ya que son la forma más utilizada de documentación.

    Para los fines de este ejemplo utilizaremos la creación de un procedimiento almacenado, pero los conceptos son aplicables a cualquier query en SQL.

    La sintaxis para agregar un comentario en oracle , mysql, Sqlserver o cualquier otro SGBD, es la siguiente:

    — Mi comentario aquí

    En este ejemplo vemos que el comentario empieza como guiones indicando que es solo una linea de comentario. mientras que si queremos agregar mas de una linea utilizariamos los caracteres /* */ .

    /*

    Este es un query en SQL que estoy documentando.

    Esto es un segundo párrafo del comentario.

    */

    Como podemos ver, la principal diferencia entre uno y otro es la cantidad de lineas que deseamos agregar.

    Cual es la desventaja de documentar?

    – consume tiempo que podríamos dedicar a otras actividades.

    – puede hacer nuestro query más largo y difícil de leer.

    – si no se documenta bien, puede ser inútil.

    A pesar de estas desventajas, documentar un query en SQL es sumamente importante y debería ser una parte integral de nuestro flujo de trabajo.

    Ventajas de documentar una consulta en SQL

    como decía mi profesor quien no documenta su query «es porque no lo sabe hacer bien» y sin embargo documentar un query nos puede llevar mucho tiempo.

    En mi experiencia personal, documentar un query en SQL me ha ayudado a:

    – Entender mejor lo que estoy haciendo.

    – Detectar errores de sintaxis más fácilmente.

    – Compartir mi query con otros y recibir feedback.

    De igual forma te recomiendo en esta entrada guía para dar formato a mi código SQL, el cual sera de mucha ayuda, ademas si necesitas ver este link para documetar cada pocedimiento, función y vista que tienes en la base de datos

    En resumen, documentar una consulta en SQL es sumamente importante para nuestro flujo de trabajo. Aunque pueda ser incomodo iniciar en esta practica es sumamente importante incluirla dentro de nuestras actividades de trabajo.

    Prueba tu conocimiento del tema

    Results

    -
    Next

    #1. cual es la desventaja de documentar?

    Next

    #2. . La documentación nos ayuda a darnos cuenta si estamos haciendo las cosas bien, y nos da una referencia para volver atrás si algo va mal.

    #3. En general, existen dos maneras principales de documentar un query en SQL:

    Finish

    Hasta la próxima!

    Bye :D!!