描述

功能性的

編輯資料表、檢視和欄位描述,並將其以註解 DDL 寫回伺服器。

資料表、檢視和欄位可以帶有 描述,也就是資料庫自己存在物件旁的註解。SQLly 在顯示結構描述的每個地方都會讀取這些描述(物件清單的 Comment 欄位、結構描述文件匯出、AI 上下文),而你可以從兩個地方撰寫,不必手寫引擎的註解語法。

編輯位置

  • 編輯結構 - 一個 描述 欄位放在欄位清單下方,而每一列欄位都有各自的描述框。描述的編輯會顯示在變更清單中,名稱為 設定描述。在大多數引擎上,描述會在結構變更之後另外寫成語句;註解屬於欄位本身,所以重新命名或改變類型不需要額外的語句。在 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 不會重述;若目前的定義已經有,腳本會用 -- WARNING 行上,方便你在執行前把它加進型別。

SQLly
「編輯結構」現在提供資料表描述欄位與每個欄位的描述框,變更清單中也有「設定描述」資料列。「編輯結構」現在提供資料表描述欄位與每個欄位的描述框,變更清單中也有「設定描述」資料列。
「編輯結構」現在提供資料表描述欄位與每個欄位的描述框,變更清單中也有「設定描述」資料列。