DDL データソース

データベースツールと SQL プラグインを有効にする

この機能は、PhpStorm にデフォルトでバンドルされ有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。

Ctrl+Alt+S を押して設定を開き、プラグインを選択します。
インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。

DDL データソースは、データ定義言語ステートメント (DDL ステートメント) を含む SQL ファイルに基づくデータベース構造の仮想ビューです。エディターでは、このようなファイルに定義されているすべてのテーブル、列、その他のオブジェクトを参照できます。ダイアグラム表もサポートされています。

DDL データソースを使用すると、データベースのバージョン管理を維持できます。SQL ファイルを VCS システムに保存し、データベース構造が更新されるたびに再生成します。

作成された DDL データソースは、データベースツールウィンドウ ( 表示 | ツールウィンドウ | データベース ) で使用できるようになります。プロジェクトツールウィンドウ ( 表示 | ツールウィンドウ | プロジェクト ) でステートメントを使用して SQL ファイルを作成および管理できます。

DDL data source in Database tool window and SQL files with statements in Project tool window

PhpStorm では、既存のデータソースをダンプし、既存の SQL ファイルを使用して DDL データソースを作成できます。

既存のデータソースを DDL データソースにダンプすると、この DDL データソースの SQL ファイルを含むフォルダーがデータベースツールウィンドウに自動的に接続されます。
選択したデータソースの DDL データソースがすでにある場合は、DDL ファイルを既存の DDL データソースにダンプするか、新しいデータソースを作成するかを選択できます。
既存の SQL ファイルを使用して DDL データソースを作成するには、SQL ファイルが含まれるディレクトリをプロジェクトに追加し、プロジェクトツールウィンドウからデータベースツールウィンドウにドラッグします。

ファイルスコープを使用して、DDL データソースのソースとして使用されるファイルとフォルダーをフィルター処理します。DLL ファイルを既存の DDL データソースにダンプすると、除外されたファイルは無視されます。

DDL データソースを作成する

既存のデータソースを DDL データソースにダンプする

データベースツールウィンドウで、DDL データソースにダンプするデータソースを右クリックし、インポート / エクスポート | DDL データソースにダンプを選択します。
DDL データソースのコード設定を構成するには、DDL 生成設定の構成を参照してください。
データソースおよびドライバーダイアログで、DDL データソースを選択し、ディレクトリまたは DDL ファイルの追加をクリックします。
ファイルブラウザーで、データソースの DDL ファイルを保存するディレクトリに移動し、オープンをクリックします。
OK をクリックします。

既存のファイルから DDL データソースを作成する

次のいずれかの方法でデータソースのプロパティを開きます。
- データベースツールウィンドウのツールバーで、データソースをクリックします。
- Shift+Enter を押します。
データソースおよびドライバーダイアログの左側のペインのデータソースタブで、追加アイコン () をクリックし、DDL データソースを選択します。
ソースペインで、追加ボタン（）をクリックします。
ファイルブラウザーで、SQL ファイルまたは DDL ステートメントを含むファイルに移動し、オープンをクリックします。
ダイアレクトリンクをクリックして、追加の SQL ファイルに使用するダイアレクトを選択します。
設定を適用して OK をクリックします。

DDL データソースの操作

スコープを使用してファイルとフォルダーをフィルター処理する

次のいずれかの方法でデータソースのプロパティを開きます。
- データベースツールウィンドウのツールバーで、データソースをクリックします。
- Shift+Enter を押します。
ソースペインで、追加ボタン（）をクリックします。
スコープを使用してファイルとフォルダーを追加およびフィルター処理するには、次のいずれかのオプションを選択します。
- 既存のスコープを使用するには、メニューからスコープを選択します。
- 現在の DDL データソース専用のファイルのグループを作成するには、匿名スコープを選択します。このスコープは特に保存されません。
- 既存のスコープを編集するか、新しいスコープを作成するには、スコープの編集をクリックします。スコープの詳細については、「スコープとファイルの色」を参照してください。
設定を適用して OK をクリックします。

自動同期が選択されている場合、対応するファイルへの変更により、DDL データソースが自動的にリフレッシュされます。この動作を無効にするには、チェックボックスをオフにします。

データソース内の参照オブジェクト

通常のデータソースのテーブルを参照するインデックスを DDL データソースに作成できます。コードでは、このテーブルが正しく参照され、インデックスのあるテーブルがデータベースツリーに表示されます。

次のいずれかの方法でデータソースのプロパティを開きます。
- データベースツールウィンドウのツールバーで、データソースをクリックします。
- Shift+Enter を押します。
拡張する DDL データソースを選択します。
追加アイコン（）をクリックし、データソースの拡張を選択して、参照するデータソースを選択します。

DDL データソースの SQL ファイルのダイアレクトを設定する

次のいずれかの方法でデータソースのプロパティを開きます。
- データベースツールウィンドウのツールバーで、データソースをクリックします。
- Shift+Enter を押します。
変更する DDL データソースをクリックします。
ソースタブで、SQL ダイアレクトの構成アイコン（）をクリックします。

DDL データソースでのオブジェクトの作成

データベースツールウィンドウで、DDL データソースノードの項目を右クリックし、新規に移動します。オブジェクトリストから、作成するオブジェクトを選択します。

DDL 生成設定の構成

DDL データソース用に生成されるファイルのコード設定を構成できます。

次のいずれかの方法でデータソースのプロパティを開きます。
- データベースツールウィンドウのツールバーで、データソースをクリックします。
- Shift+Enter を押します。
データソースタブで、DDL データソースを選択します。
新規ファイルレイアウトタブをクリックします。

新しいファイルレイアウトタブの設定

オプション	説明
レイアウト	DDL ファイルを保存および生成する方法を定義します。スキーマごとのオブジェクトごとのファイル : オブジェクトごとに個別のファイルを生成し、スキーマ名の付いたフォルダーに配置します。スキーマおよびデータベースごとのオブジェクトごとのファイル : オブジェクトごとに個別のファイルを生成し、スキーマ名の付いたフォルダーに配置します。スキーマ名のフォルダーをデータベース名のフォルダーに配置します。オブジェクトごとのファイル : オブジェクトごとに個別のファイルを生成し、1 つのディレクトリに配置します。オーダーのあるオブジェクトごとのファイル : 各オブジェクトごとに個別のファイルを生成し、ファイル名に数字の接頭辞を追加します。スキーマおよびタイプ別のオブジェクトごとのファイル : オブジェクトごとに個別のファイルを生成し、タイプ名の付いたフォルダーに配置します。型名のフォルダーをスキーマ名のフォルダーに配置します。
ルートパス	DDL ファイルのロケーションディレクトリを定義します。
コードスタイル	生成された DDL ファイルにコードスタイルを適用します。
オブジェクトをスキーマ名で修飾	テーブル名にスキーマ名を追加します。異なるスキームで同じ名前のテーブルが 2 つ以上ある場合は、テーブルを修飾できます。このオプションには次のパラメーターがあります。自動 : 異なるスキームに同じテーブル名が 3 つ以上ある場合は、自動的にテーブル名を修飾します。なし : テーブル名を修飾しないでください。常時 : 常にテーブル名を修飾します。
制約の配置	`FOREIGN KEY`、`UNIQUE`、`CHECK` を配置する場所とその他の制約を定義します。列内 : 制約が 1 つの列に基づいている場合は、列定義に追加します。制約が 2 つ以上の列に基づいている場合は、すべての列の後にテーブル定義に制約を配置します。テーブル内 : テーブル定義内のすべての列の後。テーブルの後 : テーブル定義の後に、`ALTER TABLE ADD CONSTRAINT` を使用します。
データベース提供コードを再生成する	データベースによってソースコードの一部として提供されているプロパティの定義を再生成します。
生成コードを整形	生成されたコードを現在のコードスタイルプロファイルで再フォーマットします。このオプションは、生成されたコードにのみ影響し、サーバーから直接受信したコードには影響しません。
デフォルトのスキーマ / データベース	DDL データソース内のオブジェクトのデフォルトのスキーマまたはデータベースを設定します。DDL データソースには、名前のないデータベースとスキーマがあります。次の表では、デフォルトのスキーマ名を設定できます。