DataGrip 2020.3 ヘルプ

ライブテンプレート

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

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

Live Templates

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

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

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

    略語 次に展開
    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 テンプレートを Db2 ではなく MySQL でのみ使用する場合

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

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

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

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

    Set an SQL dialect for a live template

各ライブテンプレートは、英数字、ドット、ハイフンを含む略語によって定義されます。省略形はグループ内で一意でなければならないが、同じ省略形を異なるグループで使用し、対応するグループのコンテキストに従って異なる構造に拡張することができます。変更されたデフォルトテンプレートの略語は、青いフォントでリストに表示されます。

ライブテンプレート設定

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

メイン設定

メイン設定

項目 説明
展開に使用するキー

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

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

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

ライブテンプレート

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

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 はコードスタイルページで定義されている現在のスタイル設定に従って展開されたテキストを自動的に再フォーマットします。

関連ページ:

ライブテンプレート変数

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

コード補完

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

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

次の手順例は、現在の日付とユーザー名でコメントのテンプレートを作成する方法を示しています。設定 / 環境設定ダイアログで、に移動します。新しいライブテンプレートを作成するテンプレートグループ(たとえば、other)を選択します。テンプレートグループを選択しない場合、ライブテンプレートがユーザーグループに追加されます。をクリックし、ライブテンプレートを選択します。略語フィールドで、テンプレートの展開に使用される文字を指定します。例:、(オプション)説明フィールドに、将来の参照用にテンプレートを記...

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

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

コードスタイル

スキーム:この領域では、コードスタイルスキームを選択し、必要に応じて変更します。コードスタイルスキームの設定は、DataGrip がコードを生成、リファクタリング、または再フォーマットするたびに自動的に適用されます。コードスタイルは、プロジェクトレベルと IDE レベル(グローバル)で定義されます。プロジェクトレベルでは、設定はプロジェクトスキームにグループ化されます。これは事前定義されており、太字でマークされています。プロジェクトスタイルスキームは現在のプロジェクトにのみ適用されます。IDE...

LightEdit モード

DataGrip でプロジェクト全体を作成またはロードせずに 1 つのファイルのみを編集する必要がある場合は、LightEdit モードを使用できます。LightEdit モードはテキストのようなエディターとして機能し、コード補完やコードナビゲーションなどの通常の IDE エディター機能をサポートしていないことに注意してください。ただし、特定のコード行に移動したり、コードの一部を折りたたんだり展開したり、ファイルエンコーディングを確認したり、変更したりすることはできます。LightEdit モード...