Documentación automágica de cadenas

planificado

Rastrea un valor inexpicable a través del DDL y deja una nota útil para la siguiente persona, quizá tú en el futuro.

¿Encontraste un código misterioso en un conjunto de resultados? Cuando SQLly puede seguir el valor a través de Introspección DDL, deja una nota en línea que explica de dónde salió el valor, así que la consulta responde un poco más a su propia trivia.

SELECT status /* ← enum: orders.status_id → status_codes.code */

De dónde proviene la explicación

Del esquema, por orden de confianza, y la nota indica cuál se utilizó:

  1. Una clave foránea. El valor es un id de otra tabla: síguelo e indica la tabla referenciada y su columna legible.
  2. Una restricción CHECK. Una columna restringida a un puñado de literales es una enumeración en todo menos en el nombre, y la restricción detalla el conjunto permitido.
  3. Una tabla de búsqueda. Una tabla pequeña de filas de código y descripción unidas por nombre en lugar de por una clave declarada, muy común y que vale la pena reconocer.
  4. Una propiedad extendida o comentario de columna - donde tu equipo ya anotó la respuesta y nada te la ha mostrado.
Una nota es un comentario, nunca una reescritura. La explicación se inserta como comentario SQL, así que no afecta a nada más, sobrevive a cualquier commit en un repositorio y se borra con una sola tecla. Tu consulta significa exactamente lo que significaba antes.

Documentación como subproducto

La parte buena es el rumbo: ibas a consultar esto de todos modos, y la nota significa que la siguiente persona, muy posiblemente tu yo del futuro, no tiene por qué hacerlo. Es el mismo instinto que Documentar esquema, aplicado un valor desconcertante cada vez en lugar de una base de datos entera de golpe.

Planeado. Ya existe el modelo de relaciones y restricciones que necesita y ya impulsa sugerencia de unión y la resolución de valores de visualización; esto es una interfaz nueva sobre él, no un conocimiento nuevo.