PyCharm 2024.3 ヘルプ

クエリを実行する

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

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

  1. Ctrl+Alt+S を押して設定を開き、プラグインを選択します。

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

ショートカット、ツールバーボタンとアイコン、コンテキストメニュー、実行 / デバッグ構成を使用して、コードを実行できます。クエリコンソールスクラッチファイル、ユーザーファイルからクエリを実行できます

クエリ結果を表示する場所と方法の詳細については、「照会結果」を参照してください。

ステートメントとプロシージャーを実行する

クエリコンソールでステートメントを実行する

コードを入力して実行するターミナルに関しては、クエリコンソールに関連付けることができます。

  1. データベースツールウィンドウ ( 表示 | ツールウィンドウ | データベース ) で、データソースをクリックします。

  2. F4 を押してクエリコンソールを開きます。コンソールの操作の詳細については、「コンソールを操作する」を参照してください。

  3. 実行したいステートメントを入力するか貼り付けます。

  4. ツールバーの実行ボタン(the Execute button)をクリックしてください。あるいは、Ctrl+Enter を押します。

    複数のステートメントがある場合は、すべてのステートメントを実行するか、単一のステートメントを実行するかを選択します。候補リストには、常にすべてのステートメントを実行するための項目が含まれています。

    Run a query

開いているファイルからステートメントを実行する

PyCharm では、ファイルを開いて実行できます。ファイルサイズの制限は 20 MB です。20 MB を超えるファイルを開くと、ファイルの最初の 2.5 MB のみが表示されます。ファイルは SQL ファイルタイプに関連付けられている必要があります。ファイルタイプの関連付けの詳細については、ファイルタイプの関連付けトピックを参照してください。

  1. プロジェクトツールウィンドウ ( 表示 | ツールウィンドウ | プロジェクト ) を開き、SQL ファイルをダブルクリックします。

    PyCharm でのディレクトリとファイルのアタッチの詳細については、「ユーザーファイル」を参照してください。

  2. 実行したいステートメントをクリックします。

    また、実行するコードのフラグメントを選択(ハイライト)できます。サブクエリまたはステートメントのグループにすることができます。PyCharm は選択のみを実行します。

  3. ツールバーの実行ボタン(the Execute button)をクリックしてください。あるいは、Ctrl+Enter を押します。

    クエリ実行設定をカスタマイズするには、カスタマイズリンクをクリックします。または、Ctrl+Alt+S を押して設定を開き、ツール | データベース | クエリ実行に移動します。

  4. (オプション) SQL ファイルがデータソースにアタッチされていない場合は、<データソース> リストでアタッチするデータソースを選択します。

  5. ステートメントウィンドウで、Enter を押して、選択したステートメントを実行します。他のエントリを切り替えて、別のステートメントのセットを実行できます。実行しようとしているステートメントは、クエリエディターでハイライトされます。

    スクリプトファイルを実行する別の例については、「youtube.com の次のビデオ(英語)」を参照してください。

ストアドプロシージャを実行する

ストアドプロシージャは、名前が割り当てられた SQL ステートメントのセットです。PostgreSQL、Microsoft SQL Server、Oracle、MySQL でストアドプロシージャを実行できます。

  1. 実行するストアド関数を右クリックし、関数の実行を選択します。

  2. ルーチンの実行ウィンドウで、必要なすべてのパラメーター値を入力し、OK をクリックします。

    必要に応じて、実行元チェックボックスを選択し、保存された関数を実行するファイルまたはコンソールを選択します。

    Run stored procedures

SELECT ステートメントを実行し、結果をファイルに保存する

  1. (オプション) ファイルがデータソースに接続されていない場合は、ツールバーのデータソースのリストからデータソースを選択します。次に、セッションリストから接続セッションを選択します。

    接続セッションの詳細については、「セッション」を参照してください。

  2. SELECT ステートメントを右クリックします。

  3. ファイルへ実行を選択して、出力フォーマットを選択してください。

  4. データのエクスポートダイアログで、使用するエクストラクターとその他の設定を指定します。

    データのエクスポートダイアログの詳細については、データのエクスポートトピックを参照してください。

Save the result of a SELECT statement into a file

ステートメント実行のキャンセル

  • 実行中のステートメントをキャンセルするには、ツールバーの the Cancel Running Statements icon ステートメント実行のキャンセルをクリックします。

    リクエストがキャンセルされている間、ガターの進行状況インジケーターに赤い四角が表示されます。

the Cancel Running Statements icon ステートメント実行のキャンセルボタンを 2 回クリックすると、PyCharm はリモートプロセスを終了するか、もう少し待つことができる警告を表示します。この警告は、同時に実行されている一部のプロセスに対して非アクティブ化を行うと危険になる可能性があるため、安全を確保するために表示されます。

また、IDE はアイドルキャンセルの 10 秒後に警告を表示します。

接続をキャンセルする

リクエストの実行だけでなく、接続の作成も中断できます。これは、コンソールの最初のクエリに特に関係しており、接続も作成されます。

接続を作成するプロセスを停止できます。これを行うには、接続の作成中にツールバーのステートメント実行のキャンセルボタン (the Cancel Running Statements icon) をクリックします。接続が停止され、接続がキャンセルされましたメッセージが表示されます。

解決モード

SQL スクリプトを実行し、データベースオブジェクトの使用をリンクとして扱い、正しいコード補完を提供するために、PyCharm はコード内のデータベースオブジェクトを特定のコンテキストに解決する必要があります。デフォルトでは、IDE は次のいずれかを開始点として使用して、データベースオブジェクトを解決します。<スキーマ> セレクター、またはデフォルトデータベース (上記のいずれも設定されていない場合)。

コードが単一のスクリプトであるか、複数の無関係な SQL ステートメントが含まれているかに応じて、次のいずれかの解決モードを選択して、データベースオブジェクトを適切に解決します。

  • Playground: クエリコンソールのデフォルトモード。すべてのデータベースオブジェクトは同じコンテキストに解決されます。

    コードが、単一のスクリプトとして実行されることを意図していない、接続されていない SQL ステートメントのセットである場合は、このモードを使用します。

  • スクリプト : ローカル SQL ファイルのデフォルトモード。USE SQL ステートメント(PostgreSQL の場合は SET search_path TO)は、データベースオブジェクトが解決されるデフォルトのコンテキストをオーバーライドします。

    コードを単一のスクリプトとして実行する場合は、このモードを使用します。

次のビデオでは、public スキーマがクエリコンソールのデフォルトとして選択されています。スキーマには actor テーブルが含まれていますが、information_schema スキーマには含まれていません。解決モードが Playground の場合、すべてのステートメントは無関係であるとみなされ、データベースオブジェクトは両方の SELECT ステートメントでデフォルトのスキーマに解決されます。

解決モードがスクリプトに変更されると、2 番目の SELECT ステートメントは SET search_path TO information_schema ステートメントに関連しているとみなされます。actor テーブルはそのステートメントでは解決されなくなりました。

ユーザーパラメーター

データベースベンダーによっては、疑問符 ? が SQL ステートメントのパラメーターとして扱われます。設定 Ctrl+Alt+Sツール | データベース | クエリ実行 | ユーザーパラメーターページで、他のどの文字とそのシーケンスをパラメーターとして扱うか、またどの場所で扱うかを指定できます。

SQL パラメーターのパターンは正規表現を使用して指定されます。

パラメーター化されたステートメントを実行する

ステートメントにパラメーターがある場合、PyCharm はステートメントを実行する前にパラメーターの値を指定するように要求します。

  • パラメーター化されたステートメントを実行するには、ツールバーの実行ボタン (the Execute button) をクリックし、2 番目の列に値を入力します。または、パラメーターダイアログを開くには、パラメーターの表示ボタン (the View Parameters button) をクリックします。

    Execute a parametrized statement

サンプル

パラメーターとしての配列

PyCharm では、パラメーターを値に置き換えるのは簡単です。配列を値として使用するには、対応するフィールドに配列を指定します。

次の例では、? パラメーターを 206, 'John', 'Smith' 値に置き換えることができます。

INSERT INTO actor (actor_id, first_name, last_name, last_update) VALUES (?, '01.02.2023 13:34');
Using array of values as a parameter

パラメーターの詳細については、データベースのドキュメントを参照してください。

パラメーターパターン

スクリプトに特定のパラメーター構文を持つパラメーターがある場合は、正規表現を使用してパターンを指定します。

次の例では、設定 Ctrl+Alt+Sツール | データベース | クエリ実行 | ユーザーパラメーターページで %{2}(\w+_\d+) パターンを設定する必要があります。

SELECT title, description, release_year FROM actor JOIN film_actor fa ON actor.actor_id = fa.actor_id JOIN film f ON f.film_id = fa.film_id WHERE last_name = '%%winnerpl_2';
Example of a parameter pattern in IDE Settings dialog

テーブル構造のプレビュー

IDE コードエディターでは、クイックドキュメント機能を使用して、SQL ステートメント内のテーブルの構造をプレビューできます。

  • SQL ステートメント内のテーブル構造をプレビューするには、テーブルを選択して Ctrl+Q を押します。

表示されるクイックドキュメントポップアップには、テーブルに関するその他の情報とともに CREATE DDL スクリプトが含まれます。

この機能の詳細については、クイックドキュメントを参照してください。

Preview table structure in editor tab

実行されたステートメントの履歴を表示する

クエリ履歴を使用するダイアログ

PyCharm は、クエリコンソールで実行したすべてのステートメントの履歴を保存します。

  • クエリ履歴ダイアログを開くには、ツールバーのクエリ履歴の参照ボタン (the Browse query history button) をクリックするか、Ctrl+Alt+E を押します。

    クエリ履歴ダイアログでは、次の操作を実行できます。

    • 情報をフィルターするには、検索クエリを入力してください。

    • クエリ履歴ダイアログからコンソールにクエリを貼り付けるには、クエリ履歴ダイアログの左ペインにあるクエリをダブルクリックします。

    • 履歴からレコードを削除するには、レコードを選択して Delete を押します。

    View history of executed queries

結果の表示

通常、クエリを実行すると、結果は表形式で表示されます。PyCharm は、結果をデータエディターに表示します。各ステートメントごとに、結果を含むデータエディターがサービスツールウィンドウの別のタブに表示されます。

クエリ結果の表示の詳細については、照会結果を参照してください。

The results of the SELECT statements in the tabs of Services tool window

関連ページ:

クエリコンソール

データベースツールと SQL プラグインを有効にするこの機能は、PyCharm にデフォルトでバンドルされ有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して設定を開き、を選択します。インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。概要:クエリまたはデータベースコンソールは、データソースにアタッ...

スクラッチファイル

一時的なメモを作成したり、プロジェクトのコンテキスト外でコードを作成したりする必要がある場合があります。別のアプリケーションに切り替える代わりに、スクラッチファイルとスクラッチバッファを使用できます。スクラッチファイルは、構文のハイライト、コード補完、対応するファイルタイプのその他すべての機能をサポートする、完全に機能し、実行可能で、デバッグ可能なファイルです。例: あるプロジェクトに取り組んでいるときに、後で別のプロジェクトで使用できるメソッドのアイデアを思いつくことがあります。メソッドのドラ...

照会結果

通常、クエリを実行すると、結果が表形式で返されます。PyCharm は結果をデータエディターに表示します。ステートメントごとに、結果を含むデータエディターがサービスツールウィンドウの別のタブに表示されます。例: クエリコンソールで 3 つのステートメントを実行すると、ツールウィンドウに 3 つのタブが表示されます。データエディターとビューアー、またはデータエディターは、データを操作するためのユーザーインターフェースを提供します。データエディターでは、データの並べ替え、フィルター、追加、編集、削除...

ファイルタイプの関連付け

PyCharm は、さまざまな言語やテクノロジを表すファイルの言語固有の機能(構文のハイライトやコード分析など)について、ファイルタイプのリストを保持します。各ファイルタイプは、言語サービスを 1 つ以上のファイル名パターンにリンクします。ファイルタイプのデフォルトリストには、関連するすべてのファイル名パターンが含まれていますが、カスタム言語ファイルに新しいファイルタイプを追加したり、既存のファイルタイプに関連付けられたファイル名パターンを変更したりできます。エディターでファイルを開くと、PyC...

ユーザーファイル

データベースツールと SQL プラグインを有効にするこの機能は、PyCharm にデフォルトでバンドルされ有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して設定を開き、を選択します。インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。ユーザーファイルは、マシンまたはアクセスできるその他の場所に保存さ...

セッション

データベースツールと SQL プラグインを有効にするこの機能は、PyCharm にデフォルトでバンドルされ有効になっているデータベースツールと SQL プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して設定を開き、を選択します。インストール済みタブを開き、データベースツールおよび SQL プラグインを見つけて、プラグイン名の横にあるチェックボックスを選択します。PyCharm では、データベースへの接続は特別なラッパー、つまり...