Beschreibungen

funktional

Beschreibungen von Tabellen, Ansichten und Spalten bearbeiten und als Kommentar-DDL zurück auf den Server schreiben.

Tabellen, Ansichten und Spalten können eine Beschreibung, der Kommentar, den die Datenbank selbst direkt am Objekt speichert. SQLly liest diese Beschreibungen überall, wo es das Schema zeigt (die Comment-Spalte des Objektbestands, den Schema-Dokumentationsexport, den KI-Kontext), und du kannst sie an zwei Stellen schreiben, ohne die Kommentar-Syntax der Engine von Hand zu tippen.

Wo bearbeiten

  • Struktur bearbeiten - ein Beschreibung Das Feld für die Tabelle befindet sich unter der Spaltenliste, und jede Spaltenzeile hat ihr eigenes Beschreibungsfeld. Beschreibungsänderungen erscheinen in der Änderungsliste als Beschreibung festlegen. Bei den meisten Engines erscheinen sie im Skript nach den strukturellen Änderungen; der Kommentar gehört zur Spalte, daher braucht eine Umbenennung oder ein Typwechsel keine zusätzliche Anweisung. Bei MySQL und MariaDB, wo eine Spaltenänderung die komplette Definition neu ausschreibt, trägt eine umbenannte, neu typisierte, mit neuem Standardwert versehene oder neu angelegte Spalte ihre Beschreibung in derselben Klausel mit, sodass sie ihren Kommentar behält (oder bekommt) und die strukturelle Änderung nicht rückgängig gemacht wird.
  • Objekteigenschaften - die Allgemein Eine Seite einer Tabelle oder Ansicht zeigt deren aktuelle Beschreibung in einem bearbeitbaren Feld, sobald sie gelesen wurde. Eine Änderung markiert die Seite als geändert; Änderungen überprüfen zeigt die exakte Anweisung, bevor irgendetwas ausgeführt wird.

Das Löschen des Textes entfernt die Beschreibung. Beide Oberflächen folgen den üblichen Überprüfungsregeln: „Struktur bearbeiten“ erzeugt ein Skript in einem Editor-Tab, „Objekteigenschaften“ führt nur über das zugehörige Prüfblatt aus.

Wenn sich die aktuellen Beschreibungen nicht lesen lassen (etwa wegen eines Rechteproblems), blenden beide Oberflächen das Beschreibungsfeld aus und zeigen stattdessen den Grund. Eine Änderung wird nie gegen einen geratenen Wert geskriptet, denn auf SQL Server hängt die richtige Prozedur davon ab, ob schon eine Beschreibung existiert.

Was SQLly auf jeder Engine ausführt

EngineTabellen-/SichtbeschreibungSpaltenbeschreibung
SQL Server / Azure SQLdas MS_Description erweiterte Eigenschaft: sp_addextendedproperty wenn keine existiert, sp_updateextendedproperty wenn doch einer existiert (auch einer, der leeren Text enthält), sp_dropextendedproperty zum Löschen. Views werden als Views angesprochen.Dieselben Prozeduren auf Spaltenebene.
PostgreSQLCOMMENT ON TABLE / COMMENT ON VIEW … IS '…'; IS NULL löscht.COMMENT ON COLUMN … IS '…'.
CockroachDBCOMMENT ON TABLE … IS '…'. CockroachDB hat kein COMMENT ON VIEW, sodass das Beschreibungsfeld einer Sicht aus diesem Grund ausgeblendet wird.COMMENT ON COLUMN … IS '…'.
DuckDBCOMMENT ON TABLE / COMMENT ON VIEW; IS NULL löscht.COMMENT ON COLUMN.
Oracle-DatenbankCOMMENT ON TABLE … IS '…' (Oracle spricht Views über das TABLE-Schlüsselwort an); IS '' löscht.COMMENT ON COLUMN.
MySQL / MariaDBALTER TABLE … COMMENT = '…'. Sichten können keine Beschreibung speichern (der Server meldet jeden Kommentar einer Sicht als VIEW), daher wird das Feld der Ansicht aus diesem Grund ausgeblendet.MySQL hat keine Anweisung, die nur einen Kommentar ändert, daher führt SQLly ALTER TABLE … MODIFY COLUMN. Bei einer reinen Beschreibungsänderung zeigt es die Spalte exakt als SHOW CREATE TABLE gibt es aus und ersetzt nur die COMMENT '…' -Klausel, wobei alles andere erhalten bleibt, einschließlich Klauseln nach dem Kommentar wie bei MariaDBs CHECK (json_valid(…)); wenn sich dieser Text nicht lesen lässt, verweigert SQLly die Änderung, statt zu raten. Wenn dieselbe Bearbeitung die Spalte auch umbenennt, ihren Typ oder ihre Standardeinstellung ändert oder sie hinzufügt, geht die COMMENT in diese CHANGE/MODIFY/ADD -Klausel.
ClickHouseALTER TABLE … MODIFY COMMENT '…'. Sichten können nach dem Anlegen nicht kommentiert werden; SQLly sagt dir, die Sicht neu anzulegen mit einer COMMENT Klausel.ALTER TABLE … COMMENT COLUMN … '…'.
SQLite / libSQLKein serverseitiger Kommentar-Speicher. Die Beschreibungsfelder sind ausgeblendet und der Editor zeigt stattdessen den Grund an.

Text wird für die Engine in Anführungszeichen gesetzt: eingebettete Anführungszeichen werden überall verdoppelt, SQL Server-Werte werden als Unicode gesendet N'…' Literale, und MySQL und ClickHouse escapen auch Backslashes.

In MySQL und MariaDB wird eine Spalte, die Struktur bearbeiten umbenennt, neu typisiert oder mit einem neuen Standardwert versieht, aus den Feldern des Editors neu aufgebaut: ihr Typ, ihre Nullbarkeit, ihr Standardwert, Auto-Inkrement, ihre ON UPDATE (für Timestamp- und Datetime-Spalten) und ihre Beschreibung. Eine Zeichensatz- oder Kollationsüberschreibung, ein generierter Ausdruck, INVISIBLEoder eine Spaltenebene CHECK wird nicht erneut angegeben; wenn die aktuelle Definition eine hat, wird dies im Skript in einer -- WARNING Zeile angegeben, sodass du sie vor dem Ausführen zum Typ hinzufügen kannst.

SQLly
Struktur bearbeiten mit dem Beschreibungsfeld für die Tabelle und Beschreibungsfeldern je Spalte sowie den Zeilen zum Setzen der Beschreibung in der Änderungsliste.Struktur bearbeiten mit dem Beschreibungsfeld für die Tabelle und Beschreibungsfeldern je Spalte sowie den Zeilen zum Setzen der Beschreibung in der Änderungsliste.
Struktur bearbeiten mit dem Beschreibungsfeld für die Tabelle und Beschreibungsfeldern je Spalte sowie den Zeilen zum Setzen der Beschreibung in der Änderungsliste.