Documentation des chaînes automagiques
prévuSuivez une valeur inexpliquée dans le DDL et laissez une note utile à la personne qui passera après vous, peut-être votre futur vous.
Vous avez trouvé un code mystérieux dans un ensemble de résultats ? Lorsque SQLly peut suivre la valeur à travers L'introspection DDL, il laisse une note en ligne expliquant d'où vient la valeur, pour que la requête réponde elle-même à un petit détail amusant de plus.
SELECT status /* ← enum: orders.status_id → status_codes.code */
D'où provient l'explication
Du schéma, par ordre de fiabilité - et la note indique laquelle a été utilisée :
- Une clé étrangère. La valeur est un identifiant dans une autre table : suivez-le et nommez la table référencée ainsi que sa colonne lisible.
- Une contrainte de vérification. Une colonne limitée à une poignée de littéraux est une énumération de fait, et la contrainte énonce l'ensemble des valeurs permises.
- Une table de recherche. Une petite table de lignes code et description reliées par le nom plutôt que par une clé déclarée, très courante, et qu'il vaut la peine de savoir reconnaître.
- Une propriété étendue ou un commentaire de colonne - où votre équipe a déjà écrit la réponse et rien ne vous l'a montré.
Documentation comme sous-produit
Ce qui est agréable, c'est la direction prise : vous alliez de toute façon chercher cette information, et la note signifie que la prochaine personne, très probablement vous dans le futur, n'a pas besoin de le faire. C'est le même réflexe que Documenter le schéma, appliqué à une valeur déroutante à la fois plutôt qu'à une base de données entière d'un coup.
Prévu. Le modèle de relation et de contrainte dont il a besoin existe déjà et alimente déjà suggestion de jointure et la résolution des valeurs d'affichage; c'est une nouvelle surface par-dessus, pas une nouvelle connaissance.