DDL 出力と共有
このガイドでは、建表 DDL、DCL 権限文、ORM モデルコード、Routine スケルトンの確認と出力、および読み取り専用リンクによる安全なチーム共有の手順を解説します。
概要
テーブル設計が完了した後、データベースのレビュー依頼、デプロイ申請、アプリケーションへの ORM コード組み込み、チームメンバーへの共有などをスムーズに行うことができます。
主な操作手順
1. 多様な成果物の確認と切り替え
右側の出力パネルで、目的に応じて表示を切り替えます。
- 建表 DDL: 主キー、カラム制約、コメント、インデックス、パーティション構文を含む完全な
CREATE TABLE文を確認します。Schema Nameを指定している場合はschema.table形式で出力されます。 - 権限 DCL: 指定したユーザーやロールに対する
GRANT権限付与文を確認します。 - ORM モデルコード: Prisma、TypeORM、SQLAlchemy、GORM、JPA の5大フレームワークをワンクリックで切り替え、型定義とアノテーションを取得します。
- ビュー/Routine: 定義した
CREATE VIEW文やストアドプロシージャ、関数、トリガーの骨格コードを確認します。
2. コードのコピーとフォーマット切り替え
- パネル内の**「DDL コピー」、「DCL コピー」、「ORM コピー」、「ビュー/Routine コピー」**をクリックしてクリップボードに取得します。
- ツールバーで**「コンパクト / 整列」**表示を切り替えることができ、コピーされる SQL も選択したフォーマットが維持されます。
3. パネルの折りたたみによる作業領域の拡大
カラム数が多く横スクロールが必要な場合は、出力パネル上部の折りたたみボタンを押してパネルを収納し、編集テーブルを全幅で利用できます。
4. 読み取り専用共有リンクの生成
- 上部操作バーの**「共有リンク」**ボタンをクリックします。
- 有効期限付きの読み取り専用 URL が自動生成され、クリップボードにコピーされます。
- 共有内容には、テーブル名、Schema Name、カラム定義、インデックス、その他設定が完全に保持されます。
5. 受信側の共同作業とコピー作成
- 共有リンクを開いたメンバーは保護された読み取り専用ビューで閲覧するため、元の設計が書き換わることはありません。
- この設計をベースに変更を加えたい場合は、上部バナーの**「コピーとして保存して編集」**をクリックすると、自身のワークスペースに独立した編集可能コピーが作成されます。
データベースバージョンと特殊構文
データベース方言の注意事項
- Oracle 同義語: 建表 DDL に
PUBLIC SYNONYMは自動付与されなくなりました。必要な場合は適切な権限を持つ管理者が個別に作成してください。 - MySQL のデフォルト値式: TEXT、BLOB、JSON 型で定数デフォルト値を設定する場合、式形式(例:
DEFAULT ('{}'))で出力されます(MySQL 8.0.13 以降が必要)。 - エスケープ動作: MySQL 系の文字列はバックスラッシュエスケープ有効モードで出力されます。セッションで
NO_BACKSLASH_ESCAPESが有効な場合は事前に確認してください。
完了のチェックリスト
- [ ] コピーした SQL や ORM コードが対象のクライアント環境で正常に実行・コンパイルできる。
- [ ] スキーマ名を指定した場合、すべての出力で修飾テーブル名が維持されている。
- [ ] シークレットウィンドウ等で共有リンクを開いた際、読み取り専用で正常に表示される。
- [ ] 「コピーとして保存」からスムーズに編集可能状態に移行できる。