ツイートはてブ LINE Pocket

クエリコンソール

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

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

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

概要

クエリまたはデータベースコンソールは、データソースにアタッチされる SQL ファイルです。ターミナルと同じように、クエリコンソールで SQL ステートメントを記述して実行できます。コンソールはプロジェクトコンテキストには含まれません。

データソースを作成すると、データソースのデフォルトのクエリコンソールが自動的に作成されます。必要に応じて、追加のクエリコンソールを作成できます。

各コンソールは新しい接続セッションを作成します。新しい接続を作成したくない場合は、シングルセッションモードを有効にします。

作成されたすべてのクエリコンソールは、内部の Database Consoles ディレクトリにあります。このフォルダーを開くには、プロジェクトツールウィンドウ Alt+1 を開き、スクラッチとコンソール | データベースコンソールに移動します。マシン上では、クエリコンソールファイルは IDE 構成ディレクトリの consoles サブディレクトリに保存されます。

クエリコンソールでのクエリ結果の操作の詳細については、「照会結果」を参照してください。

データベース接続セッション

コンソールごとに、データベース接続セッションが自動的に作成されます。新しい接続セッションを作成し、コンソールツールバーで既存の接続セッションにコンソールを接続できます。

次の例では、PostgreSQL コンソールがデータソースの guest.public スキーマに関連付けられ、console 接続セッションを介して接続されています。console セッションを actor に変更するか、新しいセッションを作成してコンソールを接続できます。

コードエディター

コードエディターは、解決モードとコーディング支援機能を使用して SQL ステートメントを作成し、関連するデータソースに対して実行する場所です。

コードエディターコントロールでコードエディターのツールバーコントロールを見つけます。エディターの基本でエディターの詳細を参照してください。

SQL ステートメントの実行

ステートメントを実行すると、サービスツールウィンドウが開きます。サービスツールウィンドウには、利用可能な接続セッション、出力および結果タブが表示されます。サービスツールウィンドウの詳細については、「サービスツールウィンドウ」を参照してください。

実行されたステートメントがデータ ( SELECT など) を取得する場合、結果は修飾されたテーブル名のタイトルを持つ結果タブに表示されます。結果タブのカスタムタイトルの作成の詳細については、「結果のあるタブにカスタムタイトルを使用する」を参照してください。
実行されたステートメントがデータを取得しない場合、結果が「出力」タブに表示されます。
1. クエリコンソールタブのツールバー。
2. コードエディター。
3. サービスツールウィンドウ。
4. 出力および結果タブ。結果タブがアクティブです。
5. 結果タブのツールバー。
1. クエリコンソールタブのツールバー。
2. コードエディター。
3. サービスツールウィンドウ。
4. 出力および結果タブ。出力タブがアクティブです。
5. 出力タブの右ツールバー。

コンソールファイルの操作

クエリコンソールを作成する

コンソールを作成するには、データベースツールウィンドウ ( 表示 | ツールウィンドウ | データベース ) で次のいずれかのアクションを使用します。

データソースをクリックし、ファイル | 新規 | クエリコンソールを選択します。
データソースを右クリックし、新規 | クエリコンソールを選択します。
データソースをクリックし、Alt+Insert を押し、クエリコンソールを選択します。
データソースをクリックし、Ctrl+Shift+F10 を押し、新規クエリコンソールを選択します。
データソースをクリックし、Ctrl+Shift+Q を押します。

コンソールを開く

コンソールが開いている場合、ここで SQL を記述し、実行して結果を取得できます。

プロジェクトツールウィンドウ ( 表示 | ツールウィンドウ | プロジェクト ) で、Scratches and Consoles | Database Consoles | <data_source_name> に移動し、コンソールファイルをダブルクリックします。
データベースツールウィンドウ ( 表示 | ツールウィンドウ | データベース ) で、クエリコンソールに移動ボタン () をクリックし、開くコンソールを選択するか、新しいコンソールを作成します。
データソースをクリックし、F4 を押して、必要なコンソールを選択します。

クエリコンソールの名前を変更する

クエリコンソールファイルの名前を変更するには、次のいずれかを実行します。

コンソールタブを右クリックし、ファイル名の変更を選択します。
プロジェクトツールウィンドウ ( 表示 | ツールウィンドウ | プロジェクト ) を開き、Scratches and Consoles | Database Consoles に移動します。コンソールを含むデータソースグループを展開し、コンソールファイルを右クリックして、名前変更 (Shift+F6) を選択します。

データソースディレクトリのグループコンソール

プロジェクトツールウィンドウ ( 表示 | ツールウィンドウ | プロジェクト ) で、スクラッチとコンソール | データベースコンソールに移動します。
新しいディレクトリを作成するデータソースグループを右クリックし、新規 | ディレクトリを選択します。
ディレクトリの名前を指定してください。
コンソールファイルを選択してディレクトリにドラッグします。
移動ダイアログで、リファクタリングをクリックします。

クエリコンソールを削除する

プロジェクトツールウィンドウ ( 表示 | ツールウィンドウ | プロジェクト ) で、スクラッチとコンソール | データベースコンソールに移動します。
コンソールを含むデータソースグループを展開します。
コンソールファイルを右クリックして削除を選択します。

コンソールファイルを新しい場所にコピーする

プロジェクトツールウィンドウ ( 表示 | ツールウィンドウ | プロジェクト ) で、スクラッチとコンソール | データベースコンソールに移動します。
コンソールを含むデータソースグループを展開します。
コンソールファイルを右クリックしてリファクタリング | ファイルのコピーを選択します。
宛先ディレクトリフィールドで、ファイルの新しい場所を指定します。

ファイルブラウザーでコンソールファイルを開く

ファイルブラウザーでコンソールファイルを開くには、次のいずれかを実行します。

コンソールタブを右クリックし、開く | <file_browser> に移動します。
プロジェクトツールウィンドウ ( 表示 | ツールウィンドウ | プロジェクト ) を開き、スクラッチとコンソール | データベースコンソールに移動します。コンソールを含むデータソースグループを展開し、コンソールファイルを右クリックして、開く | <file_browser> を選択します。

コンソール設定を構成する

スキーマを変更する

クエリコンソールツールバーで、<スキーマ> ボタンをクリックしてデータベースとスキーマのリストを開き、クエリを実行するデータベースとスキーマを選択します。
スキーマの詳細については、スキーマを参照してください。

コンソール設定を変更する

コンソールを開き、クエリ実行設定を開く ... ボタン () をクリックします。

コンソールのダイアレクトを構成する

コードエディターで SQL ダイアレクトを変更する

編集領域を右クリックし、ダイアレクト (<current_dialect>) をを選択します。SQL ダイアレクトの変更ウィンドウでダイアレクトを選択します。

生産性のヒント

クエリコンソールの履歴を表示する

コンソールで、任意の領域を右クリックしてローカル履歴 | 履歴の表示を選択します。

エディターでコードスタイルを適用する

エディター内の任意の領域または選択したコードを右クリックし、コードの整形を選択します。または、Ctrl+Alt+L を押します。

クエリコンソールのファイルパスを表示する

ファイルの詳細を表示するには、コンソールタブの上にカーソルを置きます。

選択ウィンドウからコンソールファイルに移動する

Alt+F1 を押し、プロジェクトビューを選択して Enter を押します。

INSERT ステートメントのデータをテーブルとして編集する

編集する INSERT ステートメントを選択します。
選択を右クリックしてテーブルとして編集をクリックします。
開いたテーブルエディターで、テーブルセルに必要な変更を加えます。Enter を押して確認します。

コンテキストメニュー

コードエディターのコンテキストメニューで、次のアクションを使用して生産性を向上させます。

アクション	ショートカット	説明
テーブルとして編集		`INSERT` ステートメントでは、テーブル形式のデータを操作するためのエディターが開きます。
ダイアレクトの変更 (<CurrentDialect>)		SQL ダイアレクトを変更します。リストからダイアレクトを選択します。
計画の表示		計画の表示 : 現在のステートメントの実行計画 (英語)(または説明計画) を表示します。結果は、専用のプランタブにツリー / テーブルが混在する形式で表示されます。実行計画のダイアグラムを作成するには、「プラン」タブの左側にあるダイアグラムの表示アイコン () をクリックするか、`Ctrl+Alt+Shift+U` を押します。フレームグラフを作成するには、フレームグラフボタン () をクリックします。計画の表示 (生) : 現在のステートメントの実行計画 (英語)(または説明計画) を表示します。結果は表形式で表示されます。技術的には、`EXPLAIN <CURRENT_STATEMENT>` または類似のステートメントが実行されます。
実行	`Ctrl+Enter`	現在のステートメントまたは選択されたステートメントのシーケンスを実行します。
ファイルへの実行		現在のステートメントを実行し、結果をテキストファイルに保存します。出力形式を選択し、ファイルの場所と名前を指定します。
実行 'console [data_source]'	`Ctrl+Shift+F10`	クエリコンソールですべてのステートメントを実行します。

クエリコンソールリファレンス

コードエディターを使用して、SQL ステートメントを作成および実行したり、その他の関連タスクを実行したりします。

エディターの基本でエディターの詳細を参照してください。

ツールバーコントロール

アイコン	アクションとショートカット	説明
	実行 `Ctrl+Enter`	選択した 1 つまたは複数の SQL ステートメントを実行します。何も選択されていない場合は、現在の文が実行されます。
	クエリ履歴の参照 `Ctrl+Alt+E`	対応するデータソースに対して実行したすべてのステートメントを表示するダイアログを開きます。クエリ履歴を使用するダイアログも参照してください。
	パラメーターの表示	パラメーターダイアログを開くまたは閉じます。ユーザーパラメーターの詳細については、クエリを実行するトピックを参照してください。
	クエリ実行設定を開く	設定ダイアログのツール \| データベース \| クエリ実行セクションを開いて、クエリ実行設定を表示または編集します。これらの設定の詳細については、「クエリ実行」を参照してください。
	トランザクションモードおよびトランザクションの分離	データベーストランザクションの分離レベル(英語)とトランザクションのコミット方法を選択します。自動 : データベースサーバーにローカルの変更を送信すると、現在のトランザクションが自動的にコミットされます。マニュアル : データベースサーバーに送信された変更は、ツールバーの送信とコミット () またはロールバック () ボタンを使用して明示的にコミットまたはロールバックできるトランザクションに蓄積されます。データベースのトランザクションモードと分離の詳細については、変更をデータベースに送信するを参照してください。
	コミット	( マニュアルトランザクションモードの場合) 現在のトランザクションをコミットします。このボタンは手動トランザクションモードでのみ使用できます。「トランザクションモードと分離」も参照してください。
	ロールバック	( マニュアルトランザクションモードの場合) 変更をロールバックします。このボタンは手動トランザクションモードでのみ使用できます。「トランザクションモードと分離」も参照してください。
	ステートメント実行のキャンセル `Ctrl+F2`	現在のステートメントの実行を終了します。
	ファイル解決モード	解決モードを選択して、コード内のデータベースオブジェクトが解決されるコンテキストを管理します。 Playground: クエリコンソールのデフォルトモード。すべてのデータベースオブジェクトは同じコンテキストに解決されます。スクリプト : ローカル SQL ファイルのデフォルトモード。`USE` SQL ステートメント（PostgreSQL の場合は `SET search_path TO`）は、データベースオブジェクトが解決されるデフォルトのコンテキストをオーバーライドします。解決モードの詳細については、解決モードを参照してください。次のビデオでは、`public` スキーマがクエリコンソールのデフォルトとして選択されています。スキーマには `actor` テーブルが含まれていますが、`information_schema` スキーマには含まれていません。解決モードが Playground の場合、すべてのステートメントは無関係であるとみなされ、データベースオブジェクトは両方の `SELECT` ステートメントでデフォルトのスキーマに解決されます。解決モードがスクリプトに変更されると、2 番目の `SELECT` ステートメントは `SET search_path TO information_schema` ステートメントに関連しているとみなされます。`actor` テーブルはそのステートメントでは解決されなくなりました。
	エディター内の結果表示	クエリコンソールのコードエディター内でクエリ結果の表示を切り替えます。エディター内の結果の詳細については、エディター内の結果表示を参照してください。
<スキーマ>	現在のスキーマを切り替える	デフォルトのスキーマまたはデータベースを選択します。PostgreSQL、Amazon Redshift、および Greenplum では、<スキーマ> リストを使用してスキーマ検索パスを形成します。スキーマの詳細については、スキーマを参照してください。
<セッション>	接続中のセッションを切り替える	データベース接続セッションを選択します。データベース接続セッションの詳細については、接続セッションを管理するを参照してください。