Descriptions

fonctionnel

Modifiez les descriptions des tables, vues et colonnes et réécrivez-les sur le serveur sous forme de DDL de commentaire.

Les tables, vues et colonnes peuvent porter une description, le commentaire que la base de données elle-même stocke à côté de l'objet. SQLly lit ces descriptions partout où il affiche le schéma (la colonne Commentaire de l'inventaire des objets, l'exportation de la documentation du schéma, le contexte IA), et vous pouvez les écrire depuis deux endroits sans taper manuellement la syntaxe de commentaire du moteur.

Où éditer

  • Modifier la structure - un Description champ de la table se trouve sous la liste des colonnes, et chaque ligne de colonne a sa propre zone de description. Les modifications de description apparaissent dans la liste des changements comme Définir la description. Sur la plupart des moteurs, ils sont scriptés après les modifications structurelles ; le commentaire appartient à la colonne, donc un renommage ou un changement de type ne nécessite pas de déclaration supplémentaire. Sur MySQL et MariaDB, où la modification d'une colonne reformule toute sa définition, une colonne qui est renommée, dont le type est modifié, dont la valeur par défaut est modifiée ou qui est ajoutée contient sa description dans cette même clause, de sorte qu'elle conserve (ou obtient) son commentaire et que la modification structurelle n'est pas annulée.
  • Propriétés de l'objet - la Général la page d'une table ou d'une vue affiche sa description à jour dans un champ modifiable une fois qu'elle a été lue. La modifier marque la page comme modifiée ; Vérifier les modifications affiche l'instruction exacte avant que quoi que ce soit ne soit exécuté.

Effacer le texte supprime la description. Les deux surfaces suivent les règles d'examen habituelles : Modifier la structure génère un script dans un onglet de l'éditeur, les propriétés de l'objet s'exécutent uniquement depuis sa feuille d'examen.

Si les descriptions actuelles ne peuvent pas être lues (un problème d'autorisations, par exemple), les deux vues masquent le champ de description et affichent la raison à la place. Une modification n'est jamais scriptée à partir d'une valeur devinée, car sur SQL Server, la bonne procédure dépend de l'existence ou non d'une description.

Ce que SQLly exécute sur chaque moteur

MoteurDescription de table / vueDescription de colonne
SQL Server / Azure SQLLe MS_Description propriété étendue : sp_addextendedproperty lorsqu'aucune n'existe, sp_updateextendedproperty lorsqu'il y en a un (y compris un qui contient un texte vide), sp_dropextendedproperty pour effacer. Les vues sont traitées comme des vues.Les mêmes procédures au niveau des colonnes.
PostgreSQLCOMMENT ON TABLE / COMMENT ON VIEW … IS '…'; IS NULL efface.COMMENT ON COLUMN … IS '…'.
CockroachDBCOMMENT ON TABLE … IS '…'. CockroachDB n'a pas COMMENT ON VIEW, donc le champ de description d'une vue est caché pour cette raison.COMMENT ON COLUMN … IS '…'.
DuckDBCOMMENT ON TABLE / COMMENT ON VIEW; IS NULL efface.COMMENT ON COLUMN.
Base de données OracleCOMMENT ON TABLE … IS '…' (Oracle adresse les vues avec le mot-clé TABLE); IS '' efface.COMMENT ON COLUMN.
MySQL / MariaDBALTER TABLE … COMMENT = '…'. Les vues ne peuvent pas stocker de description (le serveur rapporte le commentaire de chaque vue comme VIEW), donc le champ de la vue est caché pour cette raison.MySQL n'a pas d'instruction qui change uniquement un commentaire, donc SQLly exécute ALTER TABLE … MODIFY COLUMN. Pour un changement de description uniquement, il réécrit la colonne exactement comme SHOW CREATE TABLE l'imprime et remplace juste le COMMENT '…' clause, en gardant tout le reste, y compris les clauses après le commentaire comme celles de MariaDB CHECK (json_valid(…)); si ce texte ne peut pas être lu, SQLly refuse la modification plutôt que de deviner. Lorsque la même modification renomme aussi la colonne, change son type, sa valeur par défaut ou l'ajoute, le COMMENT va dans ça CHANGE/MODIFY/ADD clause à la place.
ClickHouseALTER TABLE … MODIFY COMMENT '…'. Les vues ne peuvent pas être commentées après leur création ; SQLly vous indique de recréer la vue avec un COMMENT clause.ALTER TABLE … COMMENT COLUMN … '…'.
SQLite / libSQLPas de stockage de commentaires côté serveur. Les champs de description sont cachés et l'éditeur affiche la raison à la place.

Le texte est mis entre guillemets pour le moteur : les guillemets internes sont doublés partout, les valeurs SQL Server sont envoyées en Unicode N'…' littéraux, et MySQL et ClickHouse échappent également les barres obliques inverses.

Sur MySQL et MariaDB, une colonne que l'Éditeur de structure renomme, dont il change le type ou la valeur par défaut, est reconstruite à partir des champs de l'éditeur : son type, sa nullabilité, sa valeur par défaut, son auto-incrément, son ON UPDATE (pour les colonnes timestamp et datetime), et sa description. Un jeu de caractères ou une collation remplacée, une expression générée, INVISIBLE, ou une contrainte de colonne CHECK n'est pas réexprimé ; lorsque la définition actuelle en a un, le script l'indique dans une -- WARNING ligne afin que vous puissiez l'ajouter au type avant l'exécution.

SQLly
Modifier la structure avec le champ de description de la table et les zones de description par colonne, et l'action Définir la description dans la liste des modifications.Modifier la structure avec le champ de description de la table et les zones de description par colonne, et l'action Définir la description dans la liste des modifications.
Modifier la structure avec le champ de description de la table et les zones de description par colonne, et l'action Définir la description dans la liste des modifications.