結構描述 SQL

Schema SQL 索引標籤會顯示圖表針對所選資料庫的 DDL：也就是建立其資料表及其鍵、索引和外鍵的 SQL。
在工具列中切換到 Schema SQL 索引標籤，或在快速搜尋的 Tab 下選擇 Schema SQL。從 Export 子選單選擇 Schema SQL 也會開啟此索引標籤，並準備好儲存，請參閱儲存或複製 SQL。

SQL 位於左側，其右側是標題為 Schema SQL 的選項面板，其中包含決定 SQL 樣貌的各個選項，請參閱選項面板。在由右至左的顯示語言中，SQL 同樣留在左側，並由左至右閱讀。
除非此索引標籤首次開啟時編輯器的寬度小於 640 px，否則面板會自動開啟。面板標題列中的 Hide options 會將其摺疊，程式碼右上角的 Show options 則會將其重新開啟。此後，只要編輯器保持開啟，即使切換索引標籤，面板也會維持離開時的開啟或摺疊狀態。它的摺疊與開啟和「程式碼產生器」索引標籤的面板各自獨立，且永遠不會儲存在檔案中。

在 SQL 上按滑鼠右鍵即可開啟其右鍵選單：

• Database 和 Bracket，各為一個子選單，會勾選目前的值。
• Statements 和 Header，各為一個子選單，會勾選目前生效的選項。資料庫不支援的選項會帶有淡化顯示的註記，例如 not in Oracle，且不會有任何作用。
• Options panel，面板顯示時為勾選狀態，可摺疊或開啟面板。
• Save file

此索引標籤開啟期間，快速搜尋會提供 Database 和 Bracket；只列出該資料庫所支援選項的 Schema SQL: Statements 和 Schema SQL: Header；以及可摺疊或開啟面板的 Schema SQL: Options panel。

SQL 會在此索引標籤開啟時寫出，之後每當面板中的某個選項、資料庫名稱或某段指令碼變更時，都會再次寫出。此索引標籤開啟期間對資料表所做的編輯（例如協作者或程式碼代理程式所做的編輯），要等到離開此索引標籤再回來，或上述其中一項變更時才會顯示。

「資料表屬性」有自己的 Schema SQL 索引標籤，會顯示單一資料表的 DDL。它一律寫出單純的 CREATE 陳述式，不含標頭或指令碼，沒有選項面板，其右鍵選單也只提供 Database 和 Bracket。

選項面板

面板包含三組選項，每組各有一個標題：

1. Saved in the document：Database 和 Bracket，請參閱資料庫與引號。
2. This window only：Statements、Header，以及圖表中有資料表群組時出現的 Tables，請參閱陳述式、標頭和資料表。
3. Saved in the document · written as is for every database：Before tables 和 After tables 指令碼，請參閱前置與後置指令碼。

面板底部是 Save file 和 Copy，請參閱儲存或複製 SQL。

This window only 下的選項屬於做出這些選擇的編輯器視窗。它們不會儲存在文件中、不會與協作者共用，也不會記錄到復原歷程記錄中；編輯器關閉或重新載入時會重設，切換索引標籤則會保留。
Statements 的初始值為 If not exists，Header 的初始值為 CREATE + USE。嵌入編輯器的網頁透過 getSchemaSQL() 讀取的 SQL，以及程式碼代理程式讀取的 SQL，則改以 Create 為初始值，且不含標頭。

所選資料庫不支援的選項會以淡化方式留在面板中，並帶有 Not in <database> 工具提示，例如 Not in Oracle，按下它不會有任何作用。
此時 SQL 會改用該資料庫支援的最接近形式，且該形式的按鈕會顯示為按下狀態：If not exists 退回 Create，CREATE + USE 退回 USE（若資料庫也不支援 USE，則退回 None），USE 則退回 None。所做的選擇會保留，因此切換到支援該選項的資料庫時，該選擇就會恢復。

資料庫與引號

Database 是圖表的資料庫，與畫布右鍵選單和程式碼產生器中的 Database 是同一個設定，請參閱資料庫。它列出 Databricks、MSSQL、MariaDB、MySQL、Oracle、PostgreSQL、Snowflake 和 SQLite，初始值為 MySQL，並會像任何編輯一樣儲存在檔案中。

Bracket 設定包住資料表、欄位、條件約束和索引名稱的引號：SingleQuote、DoubleQuote、Backtick，或表示完全不加引號的 None，後者為預設值。它和程式碼產生器使用的是同一個設定，請參閱引號。
只以雙引號括住名稱的 Snowflake，在 None 以外的任何選項下都會使用雙引號；Databricks 則一律以反引號括住名稱。
只有在「設定」索引標籤中的 Bracket Type 鎖定為關閉時，Bracket 才會儲存在檔案中，而新圖表的所有鎖定都是開啟的。鎖定開啟期間，變更會重寫畫面上的 SQL，但檔案會保留鎖定的值，圖表重新開啟時也會使用該值，請參閱鎖定。

當資料庫為 Oracle 且 SQL 中含有超過 30 位元組的名稱（Oracle 12.1 及更早的版本會拒絕這類名稱）時，這兩個清單下方會出現一則註記，列出每個這類名稱：Oracle 12.2+ for names over 30 bytes: <names>。它會檢查資料表、欄位、結構描述、鍵、索引、序列和觸發程序的名稱。SQL 本身不會變更。

陳述式

Statements 決定資料表的建立方式：

• Create 會寫出單純的 CREATE 陳述式。
• If not exists 會略過已存在的資料表和索引。MySQL、MariaDB、PostgreSQL、SQLite 和 Databricks 支援此選項；MSSQL、Oracle 和 Snowflake 則改為寫出 Create。
  • MySQL 會將每個資料表寫成 CREATE TABLE IF NOT EXISTS，並將其唯一條件約束、索引和外鍵寫在其中，再將整批陳述式放在 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0; 與 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS; 之間。
  • MariaDB 會在每個陳述式加上 IF NOT EXISTS：CREATE TABLE、每個 UNIQUE 和 FOREIGN KEY 條件約束，以及每個 CREATE INDEX。
  • PostgreSQL 會寫出 CREATE TABLE IF NOT EXISTS 和 CREATE INDEX IF NOT EXISTS，並在重新加入每個外鍵之前，以 DROP CONSTRAINT IF EXISTS 將其刪除。
  • SQLite 會寫出 CREATE TABLE IF NOT EXISTS 和 CREATE INDEX IF NOT EXISTS。
  • Databricks 會寫出 CREATE TABLE IF NOT EXISTS，並在重新加入每個外鍵之前，以 DROP CONSTRAINT IF EXISTS 將其刪除。
• Drop & re-create 會先刪除它寫出的每個資料表，再重新建立，Snowflake 除外。所有資料庫都支援此選項：
  • MySQL 和 MariaDB 會為每個資料表寫出一個 DROP TABLE IF EXISTS，並放在同樣那兩行關閉並重新開啟外鍵檢查的陳述式之間。
  • PostgreSQL 會寫出一個列出所有資料表的 DROP TABLE IF EXISTS，若清單以外的資料表參照其中某個資料表，此陳述式就會失敗。在 CREATE + USE 標頭下，名稱中未指定結構描述的資料表會從該結構描述中刪除，例如 shop.member。
  • MSSQL 會寫出一個交易，如按鈕的工具提示 SQL Server 2016+ 所示，此交易需要 SQL Server 2016 或更新版本。它會先刪除所寫出資料表持有的外鍵，再以一個 DROP TABLE IF EXISTS 刪除這些資料表，並在發生錯誤時回復。清單以外的資料表所持有的外鍵仍會阻止刪除。
  • SQLite 會寫出 PRAGMA foreign_keys=OFF;（此設定在該連線中會保持關閉），接著為每個資料表寫出一個 DROP TABLE IF EXISTS。
  • Oracle 會為每個資料表寫出 DROP TABLE … CASCADE CONSTRAINTS，並為每個自動遞增序列寫出 DROP SEQUENCE，每個陳述式都放在以一行 / 結尾的 PL/SQL 區塊中，並略過資料表或序列不存在時引發的錯誤。
  • Databricks 會為每個資料表寫出一個 DROP TABLE IF EXISTS。
  • Snowflake 不會刪除任何內容，而是改為寫出 CREATE OR REPLACE TABLE。

Drop & re-create 生效期間，面板中會有一則警告列出它所刪除的資料表：Drops <tables> before creating them. Their rows are lost.，在 Snowflake 上則為 Replaces <tables>. Their rows are lost.
最多會完整列出五個資料表。超過五個時，警告會列出前四個，並計算其餘的數量，例如 a, b, c, d, and 3 more tables。

標頭

Header 會在 SQL 開頭寫出建立或選取其執行所在之資料庫（或結構描述）的陳述式。名稱為圖表的資料庫名稱，也就是在工具列的 database name 輸入框中輸入的名稱，並會以 Bracket 字元加上引號。

• MySQL 和 MariaDB：USE 會寫出 USE shop;，CREATE + USE 則會在其前面寫出 CREATE DATABASE IF NOT EXISTS shop;。
• MSSQL：USE 會寫出 USE shop 和 GO，CREATE + USE 則會在其前面寫出 IF DB_ID(N'shop') IS NULL CREATE DATABASE shop 和 GO。
• PostgreSQL 只支援 CREATE + USE，會寫出 CREATE SCHEMA IF NOT EXISTS shop; 和 SET search_path TO shop, public;。
• Oracle 只支援 USE，會寫出 ALTER SESSION SET CURRENT_SCHEMA = shop;。CREATE + USE 會退回此選項，因此在此索引標籤的預設標頭下，Oracle 寫出的就是這一行。
• Snowflake 和 Databricks：USE 會寫出 USE SCHEMA shop;，CREATE + USE 則會在其前面寫出 CREATE SCHEMA IF NOT EXISTS shop;。
• SQLite 兩者都不支援，也不會寫出標頭。

在支援 USE 或 CREATE + USE 的資料庫上，按鈕的工具提示會說明它在該資料庫中寫出的內容，例如 PostgreSQL 上的 CREATE SCHEMA + SET search_path。

只有在資料庫名稱為單純的識別碼時才會寫出標頭：以 ASCII 字母（A–Z、a–z）或 _ 開頭，後面接著 ASCII 字母、數字或 _。
其他任何名稱（包括空白名稱）都不會寫出標頭，此時 PostgreSQL 的 DROP TABLE 也不會指定結構描述。當生效的標頭不是 None 時，Header 下方會有一則註記指出這一點：Database name "<name>" is not a valid identifier.
新圖表的資料庫名稱為空白，因此在為其命名之前，面板會顯示 Database name "" is not a valid identifier.

資料表

只要圖表中至少有一個資料表群組（無論顯示或隱藏），This window only 下方就會出現 Tables，每個選項各有一個核取方塊：

• All，可勾選或取消勾選所有核取方塊。只有部分核取方塊被勾選時，它會顯示為混合狀態。
• 每個資料表群組各一個核取方塊，依圖表的群組順序排列，顯示群組名稱，沒有名稱的群組則顯示 unnamed；群組有顏色時，名稱前會有一個該顏色的圓點。
• No group，代表不屬於任何群組的資料表。

所有核取方塊都勾選時，此索引標籤會寫出整個圖表。
只勾選部分核取方塊時，會寫出已勾選核取方塊的資料表，連同其索引及其持有的外鍵，包括參照未納入之資料表的外鍵。前置與後置指令碼仍會寫出，而 Drop & re-create、其警告以及關於長名稱的 Oracle 註記都只涵蓋這些資料表。
沒有勾選任何核取方塊時，此索引標籤不會寫出任何內容，程式碼上方會顯示提示 No tables chosen. Check some under Tables. 此時 Save file 會儲存一個空檔案，Copy 則會複製空白文字。

與 Statements 和 Header 一樣，此選擇屬於視窗，請參閱選項面板。
之後新增的群組，只有在當時所有核取方塊都已勾選時，才會以勾選狀態開始。移除群組會一併移除其核取方塊，而移除最後一個群組則會重新勾選全部。
此選擇只套用於此索引標籤。「資料表屬性」的 Schema SQL 索引標籤和 getSchemaSQL() 都不受其影響。

前置與後置指令碼

Before tables 和 After tables 用來存放自己的 SQL，例如放在資料表之前的 CREATE EXTENSION 或 SET 陳述式，或放在資料表之後的授權、檢視和初始資料。
它們會儲存在文件中，無論使用哪種資料庫，整個圖表都只有這一組。每段指令碼都會依輸入的原樣寫入 SQL，且永遠不會經過檢查：前置指令碼寫在標頭之後、DROP 陳述式和資料表之前，後置指令碼則寫在最末尾。

換行會寫成 LF，指令碼前面的空白行和後面的空白字元會被移除。
在 MSSQL 上，若指令碼的最後一行不是 GO（或帶有計數的 GO），會在其後加上一行 GO，如兩個輸入框下方的那行文字所述。在 Oracle 上，請自行以一行 / 結束 PL/SQL 區塊。

這兩個輸入框會對 SQL 套用語法醒目提示，並隨文字增加而變高。
編輯會在離開輸入框時（按一下其他位置或切換索引標籤）套用，旁邊的 SQL 和文件也要到那時才會變更。僅按一下進入的輸入框不會變更任何內容。
指令碼的編輯和其他任何編輯一樣會變更圖表：它會儲存在檔案中，協作者也會看到，且每次套用的編輯都算作復原歷程記錄中的一個步驟，可在 ERD 索引標籤中復原。
在輸入框中輸入時，編輯器本身的快速鍵會交由輸入框處理，因此 Ctrl + Z (Windows/Linux) 或 ⌘ + Z (Mac) 會復原在其中輸入的內容，而複製、剪下和貼上會作用於文字而非圖表。
快速搜尋和物件總管的搜尋仍可透過各自的快速鍵開啟，也就是 Ctrl + K 和 Ctrl + F (Windows/Linux) 或 ⌘ + K 和 ⌘ + F (Mac)。由於 Ctrl + F 或 ⌘ + F 會切換到 ERD 索引標籤，因此它會和任何索引標籤切換一樣套用所做的編輯。
沒有鍵盤焦點的輸入框會跟隨協作者或程式碼代理程式對其指令碼所做的變更。目前所在的輸入框若在未輸入任何內容的情況下離開，會在離開時顯示該變更。若有輸入，離開時會套用您的文字並取代對方的內容。

儲存或複製 SQL

面板底部或右鍵選單中的 Save file 會將此索引標籤顯示的 SQL 原樣儲存為 <database name>-<timestamp>.sql，包括其目前的資料庫、引號、陳述式、標頭、資料表和指令碼。其命名與儲存方式和其他所有匯出相同，請參閱匯出。

畫布右鍵選單或快速搜尋中的 Export ▸ Schema SQL 本身不會儲存任何內容。
它會切換到此索引標籤，即使選項面板已摺疊也會將其開啟，並將鍵盤焦點放在 Save file 上，因此按 Enter 即可儲存檔案。

面板底部的 Copy，或將指標停留在程式碼上時其右上角出現的複製按鈕，都會複製 SQL。
帶有勾號的 Copied! 快顯通知會顯示兩秒以示確認。若瀏覽器或主應用程式拒絕存取剪貼簿，則會改為顯示帶有警告符號的 Couldn't copy to the clipboard 快顯通知。再次複製會取代原本的快顯通知，而不會再新增一則。
SQL 也可以選取，因此可以只取用其中一部分。

DDL 寫出的內容

無論編輯器在何處寫出結構描述 SQL，以下規則都適用：此索引標籤及其檔案，以及嵌入編輯器的網頁或程式碼代理程式讀取的 SQL。
「資料表屬性」的 Schema SQL 索引標籤也會對其顯示的那一個資料表遵循這些規則。它不會寫出外鍵（但 SQLite 位於其 CREATE TABLE 之內的外鍵除外），也不會寫出 Oracle 的序列或觸發程序。

各部分依下列順序排列，彼此間隔一個空白行：標頭、前置指令碼、DROP 陳述式、資料表和後置指令碼。資料表依名稱順序寫出。
沒有資料表也沒有指令碼的圖表不會寫出任何內容，即使選擇了標頭也一樣。

Auto Increment

標示為 Auto Increment 的欄位會依各資料庫的寫法寫出：MySQL 和 MariaDB 為 AUTO_INCREMENT，MSSQL 為 IDENTITY(1,1)，Snowflake 為 AUTOINCREMENT，PostgreSQL 和 Databricks 則為 GENERATED ALWAYS AS IDENTITY。
Oracle 則會得到序列 SEQ_<table>，以及從該序列填入欄位值的觸發程序 SEQ_TRG_<table>。觸發程序以一行 / 結尾，因此 SQL*Plus 和 SQLcl 會執行它。

若資料庫不接受在該欄位的類型上使用自動遞增，該子句會被省略，並在資料表之後以一行註解指出該欄位：

• PostgreSQL 只在 smallint、integer 或 bigint 上接受它，可使用它們的任何名稱：INT、INTEGER、BIGINT、SMALLINT、INT2、INT4 或 INT8。其他類型的欄位既不會加上該子句，也不會加上預設值，註解內容例如 -- PostgreSQL takes IDENTITY only on smallint, integer or bigint, so member.id is written without it.
• Databricks 只在 BIGINT 或 LONG 上接受它。
• SQLite 只在資料表唯一的主鍵欄位為整數類型（例如 INT、BIGINT 或 INT8，無論是否指定寬度）時接受 AUTOINCREMENT。該欄位會寫成 INTEGER，鍵則寫成 PRIMARY KEY (id AUTOINCREMENT)。其他任何類型的單一鍵寫出時都不會帶有它。

參照動作

各資料庫會寫出哪些 ON DELETE 與 ON UPDATE 動作，列於 ON DELETE 與 ON UPDATE 中。
當 Snowflake 省略某個動作時，該外鍵的 ALTER TABLE 上方會有一行註解指出該動作，例如 -- Snowflake creates no foreign key with a referential action other than NO ACTION, so ON DELETE CASCADE is left out.

以結構描述限定的資料表名稱

當 Bracket 為 None 時，含有點的資料表名稱（例如 sales.users）會被視為結構描述和資料表，並在方括號或雙引號之外的最後一個點處分割。

• MySQL、MariaDB、MSSQL、Oracle 和 PostgreSQL 只以資料表部分建立其寫出的自動名稱：五者都有 FK_users_TO_orders 和 IDX_users，PostgreSQL 以外都有 UQ_users_email，而 MSSQL 和 Oracle 這兩個會為主鍵命名的資料庫還有 PK_users。在這兩者上，[sales].[users] 和 "sales"."users" 也會得到 PK_users，[Order] 則會得到 PK_Order。
• SQLite 不會為條件約束命名，因此它建立的唯一自動名稱是索引名稱：CREATE INDEX sales.IDX_users ON users。
• Oracle 會在資料表所屬的結構描述中建立資料表的索引，以及自動遞增欄位的序列和觸發程序：sales.IDX_users、sales.SEQ_users 和 sales.SEQ_TRG_users。
• 在 Oracle 和 SQLite 中，自行為索引名稱指定的結構描述會予以保留。
• 與先前名稱重複（不區分大小寫）的自動外鍵名稱或索引名稱會加上編號。當 orders 同時參照 sales.users 和 hr.Users 時，第二個鍵為 FK_Users_TO_orders1。

在其他任何 Bracket 下，整個資料表名稱都是單一識別碼，例如 "PK_sales.users"。Snowflake 和 Databricks 一律保留完整名稱。
「索引」索引標籤中的 Keys 列也會顯示相同的名稱。

預設值

欄位的預設值會依輸入的原樣寫出，但若資料庫只在括號內才會讀取該運算式，則會為其加上括號。已經在括號內的預設值會維持原樣。

• MySQL 會為常值或目前時間以外的任何內容加上括號，例如 (uuid())。它也會為 BLOB、TEXT、JSON、空間類型或 LONG… 欄位上 NULL 以外的任何預設值加上括號，並為 TIMESTAMP 或 DATETIME 以外任何欄位上的目前時間加上括號。
• MariaDB 會為常值、目前時間、函式呼叫或名稱以外的任何內容加上括號。
• SQLite 會為常值或名稱以外的任何內容加上括號，例如 (datetime('now'))。
• PostgreSQL 只會為在括號外含有 AT TIME ZONE、AND、OR、IS、IN、LIKE、COLLATE 或 = ANY 等字詞的運算式加上括號，例如 (now() AT TIME ZONE 'utc')。
• MSSQL、Oracle、Snowflake 和 Databricks 會依輸入的原樣寫出所有預設值。

唯讀編輯器

在 readonly 編輯器中，此索引標籤會照常運作：Database 和 Bracket 仍會變更顯示的 SQL，Statements、Header 和 Tables 仍可使用，Save file 和 Copy 也仍可儲存和複製 SQL。
只有兩個指令碼輸入框是唯讀的。