Schema 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 で再び開きます。その後は、エディタを開いている間、タブを切り替えても、開いたまま、または折りたたんだままの状態が保たれます。Code Generator タブのパネルとは別に折りたたんだり開いたりでき、ファイルに保存されることはありません。
SQL を右クリックすると、次の項目を持つコンテキストメニューが開きます。
DatabaseとBracket。どちらもサブメニューで、現在の値にチェックが付きます。StatementsとHeader。どちらもサブメニューで、適用されている選択肢にチェックが付きます。データベースにない選択肢にはnot in Oracleのような淡い色の注記が付き、選んでも何も起きません。Options panel。パネルが表示されている間はチェックが付き、パネルを折りたたむか開きます。Save file…
このタブを開いている間、クイック検索には Database と Bracket、データベースにある選択肢だけを一覧表示する Schema SQL: Statements と Schema SQL: Header、パネルを折りたたむか開く Schema SQL: Options panel、そして Export: Schema SQL が表示されます。
SQL はタブを開いたときに書き出され、その後はパネルの選択肢、データベース名、スクリプトのいずれかが変わるたびに書き出し直されます。共同編集者やコーディングエージェントによる編集など、タブを開いている間にテーブルに加えられた編集は、タブを離れて戻ってきたとき、またはそれらのいずれかが変わったときに表示されます。
テーブルのプロパティにも独自の Schema SQL タブがあり、1 つのテーブルの DDL を表示します。このタブは常にヘッダーもスクリプトもない通常の CREATE 文を書き出し、オプションパネルはなく、コンテキストメニューには Database と Bracket しかありません。
オプションパネル
パネルには、それぞれ見出しの付いた 3 つのグループがあります。
Saved in the document:DatabaseとBracket。データベースと Bracket を参照してください。This window only:Statements、Header、そしてダイアグラムにテーブルグループがある間はTables。ステートメント、ヘッダー、テーブルを参照してください。Saved in the document · written as is for every database:Before tablesとAfter tablesのスクリプト。前後のスクリプトを参照してください。
パネルの下部には Save file と Copy があります。SQL の保存とコピーを参照してください。
This window only の下の選択は、それを選んだエディタのウィンドウに属します。ドキュメントに保存されることも、共同編集者と共有されることも、Undo のために記録されることもなく、エディタを閉じるか再読み込みするとリセットされます。タブを切り替えても保持されます。
Statements は If not exists、Header は CREATE + USE から始まります。一方、エディタを組み込むページが getSchemaSQL() で読み取る SQL と、コーディングエージェントが読み取る SQL は、Create でヘッダーなしの状態から始まります。
選択しているデータベースにない選択肢は、Not in Oracle のような Not in <database> というツールチップが付いた淡い色の状態でパネルに残り、押しても何も起きません。
このとき SQL はそのデータベースにある最も近い形式を使い、その形式のボタンが押された状態で表示されます。If not exists は Create に、CREATE + USE は USE（データベースに USE もない場合は None）に、USE は None に置き換わります。選んだ内容は保持されるため、それがあるデータベースに切り替えると元に戻ります。
データベースと Bracket
Database はダイアグラムのデータベースで、キャンバスのコンテキストメニューの Database や Code Generator のものと同じ設定です。データベースを参照してください。Databricks、MSSQL、MariaDB、MySQL、Oracle、PostgreSQL、Snowflake、SQLite が並び、既定値は MySQL で、ほかの編集と同じようにファイルに保存されます。
Bracket は、テーブル名、カラム名、制約名、インデックス名を囲む引用符を設定します。SingleQuote、DoubleQuote、Backtick、または引用符をまったく付けない None から選び、既定値は None です。Code Generator のものと同じ設定です。Bracket を参照してください。
名前を二重引用符でしか囲まない Snowflake は、None 以外のどれを選んでも二重引用符を使い、Databricks は常に名前をバッククォートで囲みます。
Bracket がファイルに保存されるのは、設定タブの Bracket Type のロックがオフの間だけで、新しいダイアグラムではすべてのロックがオンです。ロックがオンの間に変更すると、画面上の SQL は書き換わりますが、ファイルはロックされた値を保持し、ダイアグラムはその値で開き直されます。ロックを参照してください。
データベースが Oracle で、Oracle 12.1 以前が受け付けない 30 バイトを超える名前が SQL に含まれている間は、2 つのリストの下に注記が表示され、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 は、
CREATE TABLE、各UNIQUE制約とFOREIGN KEY制約、各CREATE INDEXのそれぞれの文にIF NOT EXISTSを付けます。 - 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で削除します。
- MySQL は、各テーブルをユニーク制約、インデックス、外部キーを内側に含めた
Drop & re-createは、Snowflake を除き、書き出すすべてのテーブルを作成し直す前に削除します。すべてのデータベースにあり、次のように書き出します。- MySQL と MariaDB は、外部キーのチェックをオフにしてから元に戻す同じ 2 行の間に、テーブルごとに
DROP TABLE IF EXISTSを書き出します。 - PostgreSQL は、すべてのテーブルを挙げた 1 つの
DROP TABLE IF EXISTSを書き出します。リストにないテーブルがそのいずれかを参照している場合、この文は失敗します。CREATE + USEのヘッダーでは、名前にスキーマを含まないテーブルは、shop.memberのようにそのスキーマから削除されます。 - MSSQL は 1 つのトランザクションを書き出します。ボタンのツールチップ
SQL Server 2016+が示すとおり、SQL Server 2016 以降が必要です。書き出すテーブルが持つ外部キーを削除してから、1 つのDROP TABLE IF EXISTSでテーブルを削除し、エラーが起きるとロールバックします。リストにないテーブルが持つ外部キーは、引き続き削除を妨げます。 - SQLite は、その接続ではオフのままになる
PRAGMA foreign_keys=OFF;を書き出し、続いてテーブルごとにDROP TABLE IF EXISTSを書き出します。 - Oracle は、テーブルごとに
DROP TABLE … CASCADE CONSTRAINTSを、Auto Increment のシーケンスごとにDROP SEQUENCEを書き出します。それぞれ/の行で終わる PL/SQL ブロックに入っており、テーブルやシーケンスが存在しない場合に発生するエラーを無視します。 - Databricks は、テーブルごとに
DROP TABLE IF EXISTSを書き出します。 - Snowflake は何も削除せず、代わりに
CREATE OR REPLACE TABLEを書き出します。
- MySQL と MariaDB は、外部キーのチェックをオフにしてから元に戻す同じ 2 行の間に、テーブルごとに
Drop & re-create が適用されている間は、パネルの警告が削除するテーブルを挙げます。Drops <tables> before creating them. Their rows are lost.、Snowflake では Replaces <tables>. Their rows are lost. と表示されます。
5 つまではすべてのテーブルの名前を挙げます。5 つを超えると、最初の 4 つを挙げて残りの数を示し、a, b, c, d, and 3 more tables のようになります。
ヘッダー
Header は、SQL を実行するデータベースまたはスキーマを作成または選択する文で 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. と表示されます。
テーブル
ダイアグラムにテーブルグループが 1 つ以上ある間は、表示しているか非表示かにかかわらず、This window only の下に Tables が表示され、次の選択肢ごとにチェックボックスが並びます。
All。すべてのボックスにチェックを付けるか、外します。一部だけにチェックが付いている間は、中間の状態で表示されます。- テーブルグループごとに 1 つのボックス。ダイアグラムでのグループの順に並び、グループの名前（名前のないグループは
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 には、テーブルの前に置く CREATE EXTENSION や SET の文、テーブルの後に置く権限の付与、ビュー、初期データなど、独自の SQL を書きます。
これらはドキュメントに保存され、データベースにかかわらず、ダイアグラム全体で 1 組です。どちらも検証されることなく、入力したとおりに SQL に書き出されます。前のスクリプトはヘッダーの後、DROP 文とテーブルの前に、後のスクリプトは最後に書き出されます。
改行は LF で書き出され、スクリプトの前の空行と後ろの空白は取り除かれます。
MSSQL では、2 つのフィールドの下の行に記載されているとおり、最後の行が GO（または回数付きの GO）ではないスクリプトの後に GO の行が追加されます。Oracle では、PL/SQL ブロックの終わりの / の行を自分で書きます。
フィールドは SQL を構文ハイライトし、テキストに合わせて広がります。
編集は、ほかの場所をクリックするかタブを切り替えてフィールドを離れたときに適用され、そのとき初めて横の SQL とドキュメントが変わります。クリックして入っただけのフィールドは何も変えません。
スクリプトの編集は、ほかの編集と同じようにダイアグラムを変更します。ファイルに保存され、共同編集者にも表示され、適用された各編集は Undo の履歴の 1 ステップになり、ERD タブから Undo できます。
フィールドに入力している間は、エディタ自身のショートカットはフィールドに任されるため、Ctrl + Z (Windows/Linux) または ⌘ + Z (Mac) はそこでの入力を取り消し、コピー、切り取り、貼り付けはダイアグラムではなくテキストに対して動作します。クイック検索と検索と置換は、引き続きそれぞれのショートカットで開きます。
キーボードフォーカスのないフィールドは、共同編集者やコーディングエージェントがそのスクリプトに加えた変更に追従します。フォーカスのあるフィールドでは、何も入力せずに離れたときにその変更が表示されます。入力していた場合は、離れたときに自分のテキストが適用され、相手の変更を置き換えます。
SQL の保存とコピー
パネルの下部にある Save file、またはコンテキストメニューの Save file… は、現在のデータベース、括弧の種類、ステートメント、ヘッダー、テーブル、スクリプトを反映した、タブに表示されているとおりの SQL を <データベース名>-<時刻>.sql として保存します。ほかの書き出しと同じ方法で名前が付けられ、保存されます。書き出しを参照してください。
キャンバスのコンテキストメニューまたはクイック検索の Export ▸ Schema SQL は、それだけでは何も保存しません。どのタブにも表示されるクイック検索のコマンド Export: Schema SQL も同様です。
どちらもこのタブに切り替え、オプションパネルを折りたたんでいた場合でも開き、Save file にキーボードフォーカスを置くため、Enter を押すとファイルが保存されます。
パネルの下部にある Copy、またはコードにマウスを重ねている間にその右上に表示されるコピーボタンで、SQL をコピーします。
チェックマークの付いた Copied! のトーストが 2 秒間表示され、コピーされたことを伝えます。ブラウザやホストがクリップボードを拒否した場合は、代わりに警告マークの付いた Couldn't copy to the clipboard のトーストでそのことを伝えます。もう一度コピーすると、トーストが増えるのではなく置き換わります。
SQL は選択もできるため、一部だけを取り出すこともできます。
DDL が書き出す内容
これらの規則は、エディタが Schema SQL を書き出すすべての場所に当てはまります。このタブとそのファイル、そしてエディタを組み込むページやコーディングエージェントが読み取る SQL です。
テーブルのプロパティの Schema SQL タブも、表示する 1 つのテーブルについてこれらに従います。ただし、外部キーは書き出さず（CREATE TABLE の中に置かれる SQLite の外部キーを除く）、Oracle のシーケンスとトリガーも書き出しません。
各部分は、空行 1 つを挟んで、ヘッダー、前のスクリプト、DROP 文、テーブル、後のスクリプトの順に並びます。テーブルは名前順に書き出されます。
テーブルもスクリプトもないダイアグラムは、ヘッダーを選んでいても何も書き出しません。
Auto Increment
Auto Increment を付けたカラムは、各データベースの書き方で書き出されます。MySQL と MariaDB では AUTO_INCREMENT、MSSQL では IDENTITY(1,1)、Snowflake では AUTOINCREMENT、PostgreSQL と Databricks では GENERATED ALWAYS AS IDENTITY です。
Oracle では、シーケンス SEQ_<テーブル名> と、そのシーケンスからカラムに値を入れるトリガー SEQ_TRG_<テーブル名> が作成されます。トリガーは / の行で終わるため、SQL*Plus と SQLcl で実行できます。
データベースがそのカラムの型で Auto Increment を受け付けない場合は句が省かれ、テーブルの後のコメント行がそのカラムを示します。
- 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 が
AUTOINCREMENTを受け付けるのは、INT、BIGINT、INT8のような整数型の、テーブルで唯一の主キーカラムだけで、幅の指定の有無は問いません。そのカラムはINTEGERとして、キーはPRIMARY KEY (id AUTOINCREMENT)として書き出されます。それ以外の型の唯一のキーは、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 は、書き出す自動の名前をテーブルの部分だけから作ります。5 つすべてで
FK_users_TO_ordersとIDX_users、PostgreSQL 以外でUQ_users_email、そしてこの中で主キーに名前を付ける 2 つである MSSQL と Oracle でPK_usersとなります。この 2 つでは、[sales].[users]と"sales"."users"もPK_usersになり、[Order]はPK_Orderになります。 - SQLite は制約に名前を付けないため、作る自動の名前はインデックスの名前だけです。
CREATE INDEX sales.IDX_users ON usersのようになります。 - Oracle は、テーブルのインデックスと、Auto Increment のカラムのシーケンスとトリガーを、テーブルのスキーマに作成します。
sales.IDX_users、sales.SEQ_users、sales.SEQ_TRG_usersのようになります。 - Oracle と SQLite では、自分でスキーマを付けたインデックス名はそのスキーマを保ちます。
- 大文字・小文字を区別せずに比べて前の名前と重複する、外部キーやインデックスの自動の名前には番号が付きます。
sales.usersとhr.Usersの両方がordersから参照されている場合、2 つ目のキーはFK_Users_TO_orders1になります。
それ以外の Bracket では、"PK_sales.users" のように、テーブル名全体が 1 つの識別子になります。Snowflake と Databricks は常に名前全体を保ちます。
Indexes タブの Keys の行にも、同じ名前が表示されます。
既定値
カラムの既定値は入力したとおりに書き出されますが、データベースがその式を括弧の中でしか読み取らない場合は括弧で囲みます。すでに括弧で囲まれている既定値はそのまま残ります。
- MySQL は、リテラルと現在時刻以外のすべてを
(uuid())のように囲みます。また、BLOB、TEXT、JSON、空間データ型、LONG…のカラムではNULL以外のすべての既定値を、TIMESTAMPとDATETIME以外のカラムでは現在時刻を囲みます。 - MariaDB は、リテラル、現在時刻、関数呼び出し、名前以外のすべてを囲みます。
- SQLite は、リテラルと名前以外のすべてを
(datetime('now'))のように囲みます。 - PostgreSQL が囲むのは、
(now() AT TIME ZONE 'utc')のように、AT TIME ZONE、AND、OR、IS、IN、LIKE、COLLATE、= ANYのような語を括弧の外に含む式だけです。 - MSSQL、Oracle、Snowflake、Databricks は、すべての既定値を入力したとおりに書き出します。
読み取り専用のエディタ
readonly のエディタでも、タブは通常どおり動作します。Database と Bracket は表示される SQL を変え、Statements、Header、Tables も機能し、Save file と Copy で SQL を保存、コピーできます。
読み取り専用になるのは、2 つのスクリプトのフィールドだけです。