パラメータ化されたクエリの実行

このドキュメントでは、BigQuery でパラメータ化されたクエリを実行する方法について説明します。

BigQuery はクエリパラメータをサポートしています。ユーザーの入力からクエリが作成される場合に、SQL インジェクションを防ぐことができます。この機能は、標準 SQL 構文でのみ利用可能です。クエリパラメータは、任意の式の代わりに使用できます。パラメータは、識別子、列名、テーブル名、またはクエリの他の部分の代わりとして使用することはできません。

名前付きパラメータを指定するには、@param_name のように、@ 記号の後に識別子を続けます。たとえば、次のクエリは、特定の Shakespeare コーパスで、指定した値以上の単語数を持つ語句をすべて検索します。

#standardSQL
SELECT
  word,
  word_count
FROM
  `bigquery-public-data.samples.shakespeare`
WHERE
  corpus = @corpus
  AND word_count >= @min_word_count
ORDER BY
  word_count DESC

あるいは、プレースホルダ値 ? を使用して、位置パラメータを指定します。1 つのクエリで位置パラメータまたは名前付きパラメータを使用できますが、両方を使用することはできません。

Console

パラメータ化されたクエリは、GCP Console ではサポートされていません。

ウェブ UI

パラメータ化されたクエリは、BigQuery ウェブ UI ではサポートされていません。

コマンドライン

--parameter を使用して、name:type:value の形式でパラメータの値を指定します。空の名前を使用すると、位置パラメータが生成されます。型を省略すると、STRING が使用されます。

--parameter フラグは、標準 SQL 構文を指定するフラグ --use_legacy_sql=false と併用する必要があります。

（省略可）ロケーションを指定するには、--location フラグを使用します。

bq query \
--use_legacy_sql=false \
--parameter=corpus::romeoandjuliet \
--parameter=min_word_count:INT64:250 \
'SELECT
  word, word_count
FROM
  `bigquery-public-data.samples.shakespeare`
WHERE
  corpus = @corpus
AND
  word_count >= @min_word_count
ORDER BY
  word_count DESC'

API

名前付きパラメータを使用するには、query ジョブ構成で parameterMode を NAMED に設定します。

query ジョブ構成でパラメータのリストを使用して queryParameters を入力します。各パラメータの name には、クエリで使用する @param_name を設定します。

useLegacySql を false に設定して標準 SQL 構文を有効にします。

{
  "query": "SELECT word, word_count FROM `bigquery-public-data.samples.shakespeare` WHERE corpus = @corpus AND word_count >= @min_word_count ORDER BY word_count DESC;",
  "queryParameters": [
    {
      "parameterType": {
        "type": "STRING"
      },
      "parameterValue": {
        "value": "romeoandjuliet"
      },
      "name": "corpus"
    },
    {
      "parameterType": {
        "type": "INT64"
      },
      "parameterValue": {
        "value": "250"
      },
      "name": "min_word_count"
    }
  ],
  "useLegacySql": false,
  "parameterMode": "NAMED"
}

Google API Explorer で試してみましょう。

位置パラメータを使用するには、query ジョブ構成で parameterMode を POSITIONAL に設定します。

Go

このサンプルを試す前に、BigQuery クイックスタート: クライアントライブラリの使用にある Go 向けの手順に従って設定を行ってください。詳細については、BigQuery Go API のリファレンスドキュメントをご覧ください。

名前付きパラメータを使用する場合

パラメータ化されたクエリの実行