DataGrip 2024.1 ヘルプ

ライブテンプレート

ライブテンプレートを使用して、ステートメントやデータベースオブジェクトの定義などの一般的な構成をコードに挿入します。

次のビデオは、ライブテンプレートの使用方法を示しています。

コードスニペットを展開するには、対応するテンプレートの省略形を入力して Tab を押します。Tab を押し続けると、テンプレート内の 1 つの変数から次の変数に移動します。Shift+Tab を押して、前の変数に移動します。

ライブテンプレートの種類

次のタイプのライブテンプレートが区別されます。

  • シンプルなテンプレートには固定プレーンテキストのみが含まれています。シンプルなテンプレートを展開すると、テキストが自動的にソースコードに挿入され、省略形が置き換えられます。

    略語

    次に展開

    tab

    CREATE TABLE new_table ( col INT NOT NULL );

    col

    col int not null
  • パラメーター化されたテンプレートには、ユーザー入力を可能にする変数が含まれています。パラメーター化されたテンプレートを展開すると、変数は、ユーザーが手動で指定するための入力フィールドに置き換えられるか、DataGrip によって自動的に計算されます。

    略語

    次に展開

    ins

    INSERT INTO ... (...) VALUES (...);

    sel

    SELECT * FROM ...;

    selc

    SELECT count(*) FROM ... alias WHERE alias. ...;

    selw

    SELECT * FROM ... alias WHERE alias. ...;

    upd

    UPDATE ... SET ... = ... WHERE ...;
  • サラウンドテンプレートは、選択したコードのブロックをユーザーが指定したテキストで囲みます。

後置コード補完はライブテンプレートに似ています。現在の式を選択せずに変換します。例: 式の後に .cfrom と入力して、対応する後置補完を呼び出し、SELECT ステートメントを SELECT <all_column_names_from_table> FROM <table> に展開できます。

ライブテンプレートの構成

ライブテンプレートを構成するには、設定 Ctrl+Alt+Sエディター | ライブテンプレートページを開きます。ライブテンプレートページでは、使用可能なすべてのライブテンプレートを表示し、編集して新しいテンプレートを作成できます。

テンプレートは、使用可能なコンテキストに応じて(通常、対応する言語ごとに)グループ化されています。テンプレートを別のグループに移動するには、テンプレートを右クリックして移動を選択してから、必要なグループ名を選択します。

ライブテンプレートの SQL ダイアレクトを設定する

ライブテンプレートに特定のダイアレクトを選択できます。例: upd テンプレートを Amazon Redshift でのみ動作させたい場合。

  1. 設定 Ctrl+Alt+S で、エディター | ライブテンプレートに移動します。

  2. SQL ツリーを展開します。

  3. 変更するテンプレートを右クリックし、コンテキストの変更を選択します。

  4. 選択したテンプレートのコンテキストタイプを変更ウィンドウで、SQL ツリーノードを展開し、コンテキストを選択します。

    Set an SQL dialect for a live template

各ライブテンプレートは、英数字、ドット、ハイフンを含む省略形で定義されます。略語はグループ内で一意である必要がありますが、同じ略語が異なるグループで使用され、対応するグループのコンテキストに従って異なる構成に拡張される場合があります。変更されたデフォルトのテンプレートの略語は、リストに青色のフォントで表示されます。

ライブテンプレート設定

ライブテンプレートを構成するには、設定Ctrl+Alt+S)を開き、エディター | ライブテンプレートページに移動します。このページでは、使用可能なすべてのライブテンプレートを言語またはフレームワーク別にグループ化して表示できます。テンプレートを構成するには、目的のグループ(Ruby など)を展開して、テンプレートを選択します。

メイン設定

メイン設定

項目

説明

展開に使用するキー

すべてのテンプレートのデフォルトの呼び出しキーを指定します。特定のテンプレートの個々の拡張キーは、編集領域で定義されます。

標準の拡張キー(TabEnterSpace)が望ましくない場合は、このリストからカスタムオプションを選択します。

カスタムを選択すると、変更リンクがドロップダウンの横に表示され、キーマップページに移動します。

ライブテンプレート

現在使用可能なすべてのテンプレートの省略形とその説明を表示します。略語はノードにグループ化され、各グループ内でアルファベット順にソートされています。テンプレートまたはグループ全体をアクティブにするには、テンプレートまたはグループの近くにあるチェックボックスを選択します。

The Add icon

追加 Alt+Insert

新しいテンプレート項目を現在のテンプレートのグループに追加します。の編集領域で、テンプレートの略語、説明、テキスト、変数、拡張キー、コンテキストを定義できます。

The Remove icon

除去 Delete

選択したライブテンプレートをリストから削除します。

The Duplicate icon

複製

選択したテンプレートに基づいて新しいテンプレートを作成するには、このボタンをクリックします。新しいテンプレート項目が現在のノードに追加され、テンプレートテキスト領域のフィールドに選択したテンプレートの定義が表示されます。

The Restore deleted defaults icon

削除済みのデフォルトテンプレートを復元

このボタンをクリックして、削除されたライブテンプレートを復元します。このボタンは、変更が適用されたときにのみ有効になります。

ライブテンプレートのコンテキストメニュー

ライブテンプレートのコンテキストメニュー

項目

説明

移動

選択したテンプレートを指定したグループに移動します。

コンテキストの変更

現在のテンプレートが有効になっているコンテキストを変更します。このコマンドを選択すると、サポートされている言語コンテキストのリストが表示されます。DataGrip がテンプレートに対してコンテキスト依存であるとみなすようにするには、コンテキスト名の横にあるチェックボックスを選択します。

利用可能なコンテキストタイプは有効なプラグインによって異なります。

コピー

システムクリップボードにシリアル化されたテンプレート XML を作成します。

貼り付け

コピーしたテンプレートの XML 表現を選択したテンプレートのグループに貼り付けます。

テンプレート編集エリア

テンプレート編集エリア

次の場合には、フォーカスがこの領域に移動します。

  • 追加 The Add icon またはコピー The Copy icon ボタンをクリックしたとき。

  • リストからライブテンプレートを選択したとき。

  • エディターでコードの一部を選択してコード | ライブテンプレートとして保存を選択したとき。

この領域のコントロールを使用して、新しいライブテンプレートを作成し、既存のテンプレートの設定を編集します。

フィールドラベルにマークされているホットキーを使用して、テンプレートテキスト領域を移動できます。

項目

説明

略語

このフィールドでは、テンプレートの略語を指定します。例: エディターでテンプレートを識別する一連の文字。

説明

このフィールドには、テンプレートのオプションの説明またはその使用例を提供します。

テンプレートテキスト

このフィールドに、プレーンテキストと変数 $<variable name>$ の形式を含むテンプレート本文を入力します。必要に応じて、変数の編集をクリックし、必要に応じて変数構成します。テンプレートテキスト内のドル記号 $ をエスケープするには、単に $$ を複製します。

該当する

この読み取り専用フィールドには、エディターがテンプレートを認識する必要がある言語とコード部分が表示されます。このようなコンテキストで Ctrl+J を押すと、DataGrip はこのコンテキストで有効なテンプレートのリストを表示します。

変更

現在のテンプレートが有効になっているコンテキストのセットを変更するには、このリンクをクリックします。リンクをクリックすると、サポートされている言語コンテキストのリストが表示されます。DataGrip がテンプレートに対してコンテキスト依存であるとみなすようにするには、コンテキスト名の横にあるチェックボックスを選択します。

変数の編集

テンプレート変数の編集ダイアログを開くと、テンプレート展開時に DataGrip がテンプレート変数を処理する方法を定義できます。詳細については、「ライブテンプレート変数」を参照してください。

オプション

この領域では、テンプレートが展開されたときのエディターの動作を定義します。

  • 展開 - このリストから、テンプレートを呼び出すキーを選択します。

  • スタイルに応じて整形 : このチェックボックスを選択すると、DataGrip はコードスタイルページで定義されている現在のスタイル設定に従って展開されたテキストを自動的に再フォーマットします。

関連ページ:

新しい UI

新しいユーザーインターフェース (UI) は、DataGrip の外観を新しく再設計したものです。これは、視覚的な複雑さを軽減し、重要な機能に簡単にアクセスできるようにし、必要に応じて複雑な機能を段階的に公開することを目的として作成されており、その結果、見た目も操作性もすっきりします。主な変更点には、簡素化されたメインツールバー、新しいツールウィンドウレイアウト、新しいテーマ、更新されたアイコンがあります。新しい UI を有効にするを押して設定を開き、を選択します。新しい UI の有効化チェッ...

ライブテンプレート変数

ライブテンプレートの略語を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値または関数を使用して計算された値です。テンプレート内で変数を宣言するには、次の形式を使用します: 式では、ドル文字を開閉せずに変数名を使用します(例:)。式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定義されている他の変数...

コード補完

このセクションでは、コーディングプロセスのスピードアップを可能にするコンテキスト対応コード補完のさまざまなテクニックについて説明します。基本補完:基本コード補完は、可視性スコープ内でステートメント、データベースオブジェクト名、パラメーター、キーワードを完成させるのに役立ちます。コード補完を呼び出すと、DataGrip はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します (提案にはライブテンプレートも含まれます)。基本補完を呼び出す名前の入力を開始します。を押すか、メイ...

ライブテンプレートを作成する

次の手順例は、現在の日付とユーザー名でコメントのテンプレートを作成する方法を示しています。を押して設定を開き、を選択します。新しいライブテンプレートを作成するテンプレートグループ(たとえば、other)を選択します。テンプレートグループを選択しない場合、ライブテンプレートがユーザーグループに追加されます。をクリックし、ライブテンプレートを選択します。テンプレートが使用可能になるコンテキストを指定します。デフォルトでは、コンテキストは指定されておらず、DataGrip はダイアログの下部にメッセー...

キーマップ

このページを使用して、選択したキーマップのショートカットとアクションを検索し、カスタムキーマップを作成、編集、削除し、カスタムキーマップのアクションに関連付けられたショートカットを変更します。定義済みキーマップは編集できません。事前定義されたキーマップ(太字でリストされている)のショートカットの関連付けを変更すると、DataGrip はそのキーマップのコピーを作成し、変更できます(親キーマップにインデントが付いた通常のフォントでリストされます)。キーマップスキームアクション:をクリックして、選...

ライブテンプレートを共有する

DataGrip はカスタムライブテンプレートグループの定義と事前定義済みテンプレートグループに追加されたテンプレートを自動的に生成された XML 設定ファイルに保存します。カスタムグループの場合、ファイルには、グループに含まれるすべてのテンプレートの定義が含まれます。変更済みの定義済みグループの場合、ファイルには追加(または変更)されたライブテンプレートの定義のみが含まれます。ライブテンプレートグループ設定ファイルは、IDE 構成ディレクトリの templates ディレクトリに格納されています。...