BigQuery クライアント ライブラリ

このページでは、Google BigQuery API の新しい Cloud クライアント ライブラリの使用方法を示します。以前の Google API クライアント ライブラリを含む、Google Cloud API のクライアント ライブラリの詳細については、クライアント ライブラリの説明をご覧ください。

クライアント ライブラリのインストール

C#

Install-Package Google.Cloud.BigQuery.V2 -Pre

Go

go get -u cloud.google.com/go/bigquery

Java

Maven を使用している場合は、以下を pom.xml ファイルに追加します。

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-bigquery</artifactId>
  <version>1.27.0</version>
</dependency>

Gradle を使用している場合は、依存関係に以下を追加します。

compile 'com.google.cloud:google-cloud-bigquery:1.27.0'

SBT を使用している場合は、依存関係に以下を追加します。

libraryDependencies += "com.google.cloud" % "google-cloud-bigquery" % "1.27.0"

注: Cloud Java クライアント ライブラリは現在 Android をサポートしていません。

Node.js

npm install --save @google-cloud/bigquery

PHP

composer require google/cloud-bigquery

Python

Python 開発環境の設定の詳細については、Python 開発環境設定ガイドをご覧ください。

pip install --upgrade google-cloud-bigquery

Ruby

gem install google-cloud-bigquery

認証の設定

クライアント ライブラリを実行するには、まずサービス アカウントを作成し、環境変数を設定して、認証を設定する必要があります。

GCP Console

1. GCP Console で [サービス アカウント キーの作成] ページに移動します。

   [サービス アカウント キーの作成] ページに移動
2. [サービス アカウント] プルダウン リストから [新しいサービス アカウント] を選択します。
3. [サービス アカウント名] フィールドに名前を入力します。

4. [役割] プルダウン リストで、[プロジェクト] > [オーナー] を選択します。

   注: [役割] フィールドの設定により、リソースにアクセスするサービス アカウントが承認されます。このフィールドの設定は、後で GCP Console を使用して表示したり変更したりできます。本番環境アプリケーションを開発している場合は、[プロジェクト] > [オーナー] よりも詳細な権限を指定します。詳しくはサービス アカウントへの役割の付与をご覧ください。
5. [作成] をクリックします。キーが含まれている JSON ファイルがパソコンにダウンロードされます。

コマンドライン

ローカルマシンで Cloud SDK を使用して、または Cloud Shell 内で以下のコマンドを実行できます。

1. サービス アカウントを作成します。[NAME] は目的のサービス アカウント名に置き換えます。

   gcloud iam service-accounts create [NAME]

2. サービス アカウントに権限を付与します。[PROJECT_ID] は実際のプロジェクト ID に置き換えます。

   gcloud projects add-iam-policy-binding [PROJECT_ID] --member "serviceAccount:[NAME]@[PROJECT_ID].iam.gserviceaccount.com" --role "roles/owner"

   注: [役割] フィールドの設定により、リソースにアクセスするサービス アカウントが承認されます。このフィールドの設定は、後で GCP Console を使用して表示したり変更したりできます。本番環境アプリケーションを開発している場合は、[プロジェクト] > [オーナー] よりも詳細な権限を指定します。詳しくはサービス アカウントへの役割の付与をご覧ください。

3. キーファイルを生成します。[FILE_NAME] はキーファイルの名前に置き換えます。

   gcloud iam service-accounts keys create [FILE_NAME].json --iam-account [NAME]@[PROJECT_ID].iam.gserviceaccount.com

環境変数 GOOGLE_APPLICATION_CREDENTIALS をサービス アカウント キーが含まれる JSON ファイルのファイルパスに設定します。

例: Linux または Mac OS

[PATH] は、サービス アカウント キーが含まれる JSON ファイルのファイルパスに置き換えます。

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

例:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

例: Windows

[PATH] は、サービス アカウント キーが含まれる JSON ファイルのファイルパスに置き換え、[FILE_NAME] はファイル名に置き換えます。

PowerShell を使用する場合:

$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

例:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\[FILE_NAME].json"

コマンド プロンプトを使用する場合:

set GOOGLE_APPLICATION_CREDENTIALS=[PATH]

クライアント ライブラリの使用

次の例は、クライアント ライブラリの使用方法を示しています。

C#

Google BigQuery API クライアント ライブラリの詳細については、C# API リファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

using System;
using Google.Cloud.BigQuery.V2;

namespace GoogleCloudSamples
{
    public class Program
    {
        public static void Main(string[] args)
        {
            // Your Google Cloud Platform project ID
            string projectId = "YOUR-PROJECT-ID";

            // Instantiates a client
            BigQueryClient client = BigQueryClient.Create(projectId);

            // The id for the new dataset
            string datasetId = "my_new_dataset";

            // Creates the dataset
            BigQueryDataset dataset = client.CreateDataset(datasetId);

            Console.WriteLine($"Dataset {dataset.FullyQualifiedId} created.");
        }
    }
}

Go

Google BigQuery API クライアント ライブラリの詳細については、Go API リファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

// Sample bigquery-quickstart creates a Google BigQuery dataset.
package main

import (
	"fmt"
	"log"

	// Imports the Google Cloud BigQuery client package.
	"cloud.google.com/go/bigquery"
	"golang.org/x/net/context"
)

func main() {
	ctx := context.Background()

	// Sets your Google Cloud Platform project ID.
	projectID := "YOUR_PROJECT_ID"

	// Creates a client.
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}

	// Sets the name for the new dataset.
	datasetName := "my_new_dataset"

	// Creates the new BigQuery dataset.
	if err := client.Dataset(datasetName).Create(ctx, &bigquery.DatasetMetadata{}); err != nil {
		log.Fatalf("Failed to create dataset: %v", err)
	}

	fmt.Printf("Dataset created\n")
}

Java

Google BigQuery API クライアント ライブラリの詳細については、Java API リファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

// Imports the Google Cloud client library
import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Dataset;
import com.google.cloud.bigquery.DatasetInfo;

public class QuickstartSample {
  public static void main(String... args) throws Exception {
    // Instantiate a client. If you don't specify credentials when constructing a client, the
    // client library will look for credentials in the environment, such as the
    // GOOGLE_APPLICATION_CREDENTIALS environment variable.
    BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();

    // The name for the new dataset
    String datasetName = "my_new_dataset";

    // Prepares a new dataset
    Dataset dataset = null;
    DatasetInfo datasetInfo = DatasetInfo.newBuilder(datasetName).build();

    // Creates the dataset
    dataset = bigquery.create(datasetInfo);

    System.out.printf("Dataset %s created.%n", dataset.getDatasetId().getDataset());
  }
}

Node.js

Google BigQuery API クライアント ライブラリの詳細については、Node.js API リファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

// Imports the Google Cloud client library
const BigQuery = require('@google-cloud/bigquery');

// Your Google Cloud Platform project ID
const projectId = 'YOUR_PROJECT_ID';

// Creates a client
const bigquery = new BigQuery({
  projectId: projectId,
});

// The name for the new dataset
const datasetName = 'my_new_dataset';

// Creates the new dataset
bigquery
  .createDataset(datasetName)
  .then(results => {
    const dataset = results[0];

    console.log(`Dataset ${dataset.id} created.`);
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

PHP

Google BigQuery API クライアント ライブラリの詳細については、PHP API リファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

# Includes the autoloader for libraries installed with composer
require __DIR__ . '/vendor/autoload.php';

# Imports the Google Cloud client library
use Google\Cloud\BigQuery\BigQueryClient;

# Your Google Cloud Platform project ID
$projectId = 'YOUR_PROJECT_ID';

# Instantiates a client
$bigquery = new BigQueryClient([
    'projectId' => $projectId
]);

# The name for the new dataset
$datasetName = 'my_new_dataset';

# Creates the new dataset
$dataset = $bigquery->createDataset($datasetName);

echo 'Dataset ' . $dataset->id() . ' created.';

Python

Google BigQuery API クライアント ライブラリの詳細については、Python API リファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

# Imports the Google Cloud client library
from google.cloud import bigquery

# Instantiates a client
bigquery_client = bigquery.Client()

# The name for the new dataset
dataset_id = 'my_new_dataset'

# Prepares a reference to the new dataset
dataset_ref = bigquery_client.dataset(dataset_id)
dataset = bigquery.Dataset(dataset_ref)

# Creates the new dataset
dataset = bigquery_client.create_dataset(dataset)

print('Dataset {} created.'.format(dataset.dataset_id))

Ruby

Google BigQuery API クライアント ライブラリの詳細については、Ruby API リファレンス ドキュメントをご覧ください。

GitHub で表示 フィードバック

# Imports the Google Cloud client library
require "google/cloud/bigquery"

# Your Google Cloud Platform project ID
project_id = "YOUR_PROJECT_ID"

# Instantiates a client
bigquery = Google::Cloud::Bigquery.new project: project_id

# The name for the new dataset
dataset_name = "my_new_dataset"

# Creates the new dataset
dataset = bigquery.create_dataset dataset_name

puts "Dataset #{dataset.dataset_id} created."

参考情報

C#

• API リファレンス ドキュメント
• ソースコード
• GitHub 公開バグトラッカー
• Stack Overflow

Go

• API リファレンス ドキュメント
• ソースコード
• GitHub 公開バグトラッカー
• Stack Overflow

Java

• API リファレンス ドキュメント
• ソースコード
• GitHub 公開バグトラッカー
• Stack Overflow

Node.js

• API リファレンス ドキュメント
• ソースコード
• GitHub 公開バグトラッカー
• スタック オーバーフロー

PHP

• API リファレンス ドキュメント
• ソースコード
• GitHub 公開バグトラッカー
• Stack Overflow

Python

• API リファレンス ドキュメント
• ソースコード
• GitHub 公開バグトラッカー
• スタック オーバーフロー

Ruby

• API リファレンス ドキュメント
• ソースコード
• GitHub 公開バグトラッカー
• スタック オーバーフロー

サードパーティの BigQuery クライアント ライブラリ

上記の表の Google がサポートするライブラリに加えて、サードパーティが提供する一連のライブラリも使用できます。

言語	ライブラリ
Python	pandas-gbq
R	bigrquery
Scala	spark-bigquery

次のステップ

• クライアント ライブラリを使用して簡単なアプリケーションを作成する方法を学習する。