メインコンテンツまでスキップ

クエリスニペット

多くの場合、最初から何かを書くよりも、以前の作業を複製して変更する方が簡単です。 これは、一般的な JOIN ステートメントや複雑な CASE 式に特に当てはまります。 クエリのリストが増えると、必要なステートメントがどのクエリに含まれているかを覚えるのが難しくなる可能性があります。 また、ユーザーが実行時に置き換えることができるプレースホルダー テキストを含む挿入ポイントを含むクエリ スニペットを作成することもできます。

クエリ スニペットは、オートコンプリートを使用して共有およびトリガーできるクエリのセグメントです。 クエリ・スニペットは次の目的で使用してください。

  • よくある JOIN ステートメント
  • WITHCASEなどの複雑な句。
  • 条件付きフォーマット

スニペットの例を次に示します。

--Simple snippet
WHERE fare_amount > 100

--Snippet with an insertion point for a value to be provided at runtime
WHERE fare_amount > ${1:value}

--Snippet with an insertion point for a value to be provided at runtime and containing a default value
WHERE fare_amount > ${1:100}

--Snippet with multiple insertion points
WHERE fare_amount > ${2:min_value} AND fare_amount < ${1:max_value} AND trip_distance < ${0:max_distance}

クエリ スニペットを作成する

次の手順を使用して、これらのスニペットの例を使用してスニペットを作成します。

  1. ワークスペースの上部バーでユーザー名をクリックし、ドロップダウンから [ 設定 ] を選択します。

  2. 「開発者 」タブをクリックします。

  3. [SQL クエリ スニペット ] の横にある [管理] をクリックします。

  4. [クエリ スニペットを作成 ] をクリックします。

  5. 「置換 」フィールドに、スニペットの名前を入力します。この名前は、スニペットを使用するクエリを記述するときに使用します。

  6. 必要に応じて、説明を入力します。

  7. [スニペット ] フィールドに、スニペットを入力します。

  8. 作成 をクリックします。

    クエリ ス��ニペット

クエリでクエリ スニペットを使用する

これらのクエリ スニペットを使用できる単純なクエリの例を次に示します。

--Simple query
SELECT * FROM samples.nyctaxi.trips

このクエリでクエリ スニペットを使用するには、次の手順に従います。

  1. SQL エディタ を開きます。

  2. SQL エディターのクエリ ペインにクエリを入力します。

  3. スニペット名の最初の 3 文字を入力し、オートコンプリート ウィンドウからスニペットを選択します。 Option + Space を押してスニペットを選択することで、ウィンドウを手動で開くこともできます。

    スニペットを選択するクエリ

  4. クエリースニペットの WHERE 句を使用して クエリーを実行します。

    クエリで使用されるスニペットを表示するクエリ

クエリ・スニペットの挿入ポイントの操作

挿入ポイントを指定するには、整数のタブ オーダーを 1 つのドル記号と中括弧で囲みます ${}。 先頭にコロン :を付けるテキストプレースホルダはオプションですが、スニペットに慣れていないユーザーにとっては便利です。 以前に作成した挿入ポイントを含むクエリ スニペットでは、 ${1:value} はプレースホルダを含む挿入ポイントであり、 ${1:100} は実行時にオーバーライドできるプレースホルダのデフォルト値を持つ挿入ポイントです。 Databricks SQL がスニペットをレンダリングすると、ドル記号の $ と中括弧の{}が取り除かれ、value という単語または 100 のデフォルトが強調表示されて置き換えられます。

挿入ポイントが複数ある場合は、テキスト挿入カラットが最初の挿入ポイントにジャンプして、希望の値の入力を求められます。 Tab を押すと、カラットは次の値の挿入点にジャンプします。 Tab をもう一度押すと、カラットは最後の挿入点に達するまで次の挿入点行にジャンプします。

注記

ゼロ ${0} の挿入点は、常にタブ オーダーの最後の点です。

クエリで挿入ポイントのクエリスニペットを使用するには、次の手順を実行してください。

  1. SQL エディタ を開きます。

  2. SQL エディターのクエリ ペインにクエリを入力します。

  3. クエリ スニペットの名前の最初の 3 文字を入力し、挿入ポイントがデフォルト値のないクエリ スニペットを選択します。

    クエリスニペットがクエリに追加され、テキスト挿入カラットが挿入ポイントにジャンプします。

    挿入ポイントを使用したクエリ スニペットでデフォルト値がない

  4. WHERE 句に 200 などの値を入力してください。

  5. 必要に応じて、クエリスニペットの WHERE 句を使用してクエリを実行します。

  6. 前の手順を繰り返しますが、デフォルト値を使用して挿入ポイントを含むクエリスニペットを選択します。

    挿入ポイントを使用したクエリ デフォルト値を含むクエリ スニペット

  7. 前の手順を繰り返しますが、複数の挿入ポイントを持つクエリスニペットを選択します。

    挿入ポイントを使用したクエリ 複数の挿入ポイントを含むスニペットのクエリ

  8. 最初の挿入ポイントに値を入力し、タブを次の挿入ポイントに移動して値を入力し、次にタブを最後の挿入ポイントに入力して値を入力します。