説明

実装済み

テーブル、ビュー、列の説明を編集し、コメント DDL としてサーバーに書き戻します。

テーブル、ビュー、列には 説明、データベース自体がオブジェクトに付けて保存しているコメント。SQLly は、スキーマを表示するあらゆる場所(オブジェクト一覧の「コメント」列、スキーマドキュメントのエクスポート、AI コンテキスト)でそれらの説明を読み取り、エンジンのコメント構文を手書きしなくても 2 か所から書き込めます。

編集する場所

  • 構造を編集 - 1 つの 説明 テーブルのフィールドは列リストの下にあり、各列の行には独自の説明ボックスがあります。説明の編集は変更リストに次のように表示されます 説明を設定。ほとんどのエンジンでは、構造変更の後にスクリプト化されます。コメントは列に属しているため、名前変更や型変更に追加のステートメントは不要です。列を変更するとその定義全体を書き直す MySQL と MariaDB では、名前変更、型変更、既定値の再設定、追加を行う列は、同じ句の中に説明も含めるため、コメントが保持(または付与)され、構造の変更が取り消されることもありません。
  • オブジェクトプロパティ - 次の 全般 テーブルやビューのページでは、読み込んだ後、編集可能なフィールドにその説明が表示されます。変更するとページが変更ありとしてマークされます; 変更を確認する 実際に実行する前に、正確なステートメントを表示します。

テキストを消去すると、説明が削除されます。どちらの画面も通常のレビュールールに従います。「構造を編集」はスクリプトをエディタータブに出力し、「オブジェクトのプロパティ」はレビューシートからのみ実行されます。

現在の説明が読み取れない場合(権限の問題など)、どちらの画面でも説明フィールドを隠して、代わりに理由を表示します。SQL Server では、説明が既に存在するかどうかで使うべきプロシージャが変わるため、推測した値に対して編集をスクリプト化することはありません。

各エンジンで SQLly が実行する内容

エンジンテーブル/ビューの説明列の説明
SQL Server / Azure SQLその MS_Description 拡張プロパティ: sp_addextendedproperty 存在しない場合、 sp_updateextendedproperty 存在する場合 (空のテキストを持つものも含む)、 sp_dropextendedproperty クリアします。ビューはビューとして扱われます。列レベルでも同じ手順です。
PostgreSQLCOMMENT ON TABLE / COMMENT ON VIEW … IS '…'; IS NULL クリアされます。COMMENT ON COLUMN … IS '…'.
CockroachDBCOMMENT ON TABLE … IS '…'。CockroachDB には次がありません COMMENT ON VIEW、そのため、ビューの説明フィールドはその理由とともに非表示になります。COMMENT ON COLUMN … IS '…'.
DuckDBCOMMENT ON TABLE / COMMENT ON VIEW; IS NULL クリアされます。COMMENT ON COLUMN.
OracleデータベースCOMMENT ON TABLE … IS '…' (Oracle では TABLE キーワードでビューを指定します)。 IS '' クリアされます。COMMENT ON COLUMN.
MySQL / MariaDBALTER TABLE … COMMENT = '…'。ビューには説明を保存できません(サーバーはすべてのビューのコメントを次として報告します VIEW)。そのため、ビューのフィールドはその理由付きで非表示になります。MySQLにはコメントだけを変更するステートメントがないため、SQLlyは次を実行します ALTER TABLE … MODIFY COLUMN。説明のみの変更では、列を次のとおりにそのまま再度記述します SHOW CREATE TABLE それを出力し、次の部分だけを置き換えます COMMENT '…' 句の場合も、それ以外はすべてそのまま保ちます。コメントの後ろにある句(MariaDBの CHECK (json_valid(…)); そのテキストを読み取れない場合、SQLly は推測せず変更を拒否します。同じ編集で列の名前変更、型変更、既定値の再設定、追加も行う場合は、 COMMENT その中に入ります CHANGE/MODIFY/ADD 代わりに句を使ってください。
ClickHouseALTER TABLE … MODIFY COMMENT '…'。ビューは作成後にコメントを付けられません。SQLly は、次を指定してビューを再作成するよう案内します COMMENT 句。ALTER TABLE … COMMENT COLUMN … '…'.
SQLite / libSQLサーバー側のコメントストアはありません。説明フィールドは非表示になり、エディターには代わりに理由が表示されます。

テキストはエンジンに合わせて引用符で囲まれます。埋め込まれた引用符はどこでも二重化され、SQL Server の値は Unicode として送信されます N'…' リテラルでは、MySQL と ClickHouse はバックスラッシュもエスケープします。

MySQL と MariaDB では、構造の編集で名前変更、型変更、既定値の変更を行った列は、エディターのフィールドから再構築されます。その型、NULL 許容、既定値、自動増分、 ON UPDATE (timestamp 列と datetime 列向け)、およびその説明。文字セットや照合順序の上書き、生成式、 INVISIBLE、または列レベルの CHECK は再指定されません。現在の定義に 1 つある場合、スクリプトはその旨を次の中で示します -- WARNING 行で、実行前にそれを型に追加できます。

SQLly
構造の編集で、テーブルの説明フィールドと列ごとの説明ボックスを編集でき、変更リストには「説明を設定」行が表示されます。構造の編集で、テーブルの説明フィールドと列ごとの説明ボックスを編集でき、変更リストには「説明を設定」行が表示されます。
構造の編集で、テーブルの説明フィールドと列ごとの説明ボックスを編集でき、変更リストには「説明を設定」行が表示されます。