接続を管理する

このドキュメントでは、BigQuery 接続を表示、一覧表示、共有、編集、削除、トラブルシューティングする方法について説明します。

BigQuery 管理者は、サービスと外部データソースへの接続に使用する接続を作成し、管理できます。BigQuery アナリストは、これらの接続を使用して、BigQuery にデータを移動することやコピーすることなく、外部データソースにクエリを送信します。次のタイプの接続を作成できます。

Amazon S3 接続
Apache Spark 接続
Blob Storage 接続
Cloud Storage データに接続し、リモート関数を実装するためのクラウドリソース接続。
Spanner 接続
Cloud SQL 接続
AlloyDB 接続

始める前に

接続が機能していることを確認します。接続はタイプ固有であり、接続された外部データソースによって異なります。
BigQuery Connection API を有効にします。

API を有効にする
プロジェクト内のサービスアカウントのリストを表示できることを確認します。BigQuery がサービスアカウントを作成して使用し、外部データソースに接続します。接続を作成すると、Google Cloud 管理の Identity and Access Management（IAM）サービスアカウントが自動的に作成されます。特定の接続に関連付けられているサービスアカウントを表示するには、接続の詳細を表示します。

必要なロール

接続の管理に必要な権限を取得するには、管理者に次の IAM ロールを付与するよう依頼してください。

接続の詳細を表示する: データセットに対する BigQuery 接続ユーザー（roles/bigquery.connectionUser）
すべての接続を一覧表示する: データセットに対する BigQuery 接続ユーザー（roles/bigquery.connectionUser）
接続を共有する: 接続に対する BigQuery 接続管理者（roles/bigquery.connectionAdmin）
接続を編集する: 接続に対する BigQuery 接続管理者（roles/bigquery.connectionAdmin）
接続を削除する: 接続に対する BigQuery 接続管理者（roles/bigquery.connectionAdmin）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

これらの事前定義ロールには、このドキュメントのタスクを実行するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

接続の詳細を表示する: bigquery.connections.get
すべての接続を一覧表示する: bigquery.connections.list
接続を編集、削除する: bigquery.connections.update
接続を共有する: bigquery.connections.setIamPolicy

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

すべての接続を一覧表示する

次のオプションのいずれかを選択します。

コンソール

[BigQuery] ページに移動します。

[BigQuery] に移動

接続は、プロジェクトで外部接続というグループに一覧表示されます。
[エクスプローラ] ペインで、[プロジェクト名] > [外部接続] の順にクリックして、すべての接続のリストを表示します。

bq

bq ls コマンドを入力し、--connection フラグを指定します。必要に応じて、--project_id フラグと --location フラグを指定して、一覧表示する接続のプロジェクトとロケーションを特定します。

bq ls --connection --project_id=PROJECT_ID --location=REGION

次のように置き換えます。

PROJECT_ID: 実際の Google Cloud プロジェクト ID
REGION: 接続リージョン

API

REST API リファレンスセクションの projects.locations.connections.list メソッドを使用します。

Java

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

BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアントライブラリの認証を設定するをご覧ください。

import com.google.cloud.bigquery.connection.v1.ListConnectionsRequest;
import com.google.cloud.bigquery.connection.v1.LocationName;
import com.google.cloud.bigqueryconnection.v1.ConnectionServiceClient;
import java.io.IOException;

// Sample to get list of connections
public class ListConnections {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    String location = "MY_LOCATION";
    listConnections(projectId, location);
  }

  static void listConnections(String projectId, String location) throws IOException {
    try (ConnectionServiceClient client = ConnectionServiceClient.create()) {
      LocationName parent = LocationName.of(projectId, location);
      int pageSize = 10;
      ListConnectionsRequest request =
          ListConnectionsRequest.newBuilder()
              .setParent(parent.toString())
              .setPageSize(pageSize)
              .build();
      client
          .listConnections(request)
          .iterateAll()
          .forEach(con -> System.out.println("Connection Id :" + con.getName()));
    }
  }
}

接続の詳細を表示する

接続を作成すると、接続の構成に関する情報を取得できます。この構成には、転送を作成したときに指定した値が含まれます。

次のオプションのいずれかを選択します。

コンソール

[BigQuery] ページに移動します。

[BigQuery] に移動

接続は、プロジェクトの外部接続というグループに一覧表示されます。
[エクスプローラ] ペインで、[プロジェクト名] > [外部接続] > [接続] の順にクリックします。

bq

bq show コマンドを入力し、--connection フラグを指定します。必要に応じて、接続 ID をプロジェクト ID と接続のリージョンで修飾します。

bq show --connection PROJECT_ID.REGION.CONNECTION_ID

次のように置き換えます。

PROJECT_ID: 実際の Google Cloud プロジェクト ID
REGION: 接続リージョン
CONNECTION_I: 接続 ID

API

REST API リファレンスセクションの projects.locations.connections.get メソッドを使用します。

Java

import com.google.cloud.bigquery.connection.v1.Connection;
import com.google.cloud.bigquery.connection.v1.ConnectionName;
import com.google.cloud.bigquery.connection.v1.GetConnectionRequest;
import com.google.cloud.bigqueryconnection.v1.ConnectionServiceClient;
import java.io.IOException;

// Sample to get connection
public class GetConnection {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    String location = "MY_LOCATION";
    String connectionId = "MY_CONNECTION_ID";
    getConnection(projectId, location, connectionId);
  }

  static void getConnection(String projectId, String location, String connectionId)
      throws IOException {
    try (ConnectionServiceClient client = ConnectionServiceClient.create()) {
      ConnectionName name = ConnectionName.of(projectId, location, connectionId);
      GetConnectionRequest request =
          GetConnectionRequest.newBuilder().setName(name.toString()).build();
      Connection response = client.getConnection(request);
      System.out.println("Connection info retrieved successfully :" + response.getName());
    }
  }
}

次のロールを付与することで、ユーザーがデータをクエリして接続を管理できます。

roles/bigquery.connectionUser: ユーザーが接続を使用して外部データソースに接続し、クエリを実行できるようにします。
roles/bigquery.connectionAdmin: ユーザーが接続を管理できるようにします。

BigQuery での IAM のロールと権限について詳しくは、事前定義ロールと権限をご覧ください。

次のオプションのいずれかを選択します。

コンソール

[BigQuery] ページに移動します。

[BigQuery] に移動

接続は、プロジェクトで外部接続というグループに一覧表示されます。
[エクスプローラ] ペインで、[プロジェクト名] > [外部接続] > [接続] の順にクリックします。
[詳細] ペインで、[共有] をクリックして接続を共有します。次に、以下の操作を行います。
1. [接続の権限] ダイアログで、プリンシパルを追加または編集して、他のプリンシパルと接続を共有します。
2. [保存] をクリックします。

bq

bq コマンドラインツールを使用して接続を共有することはできません。接続を共有するには、Google Cloud コンソールまたは BigQuery Connections API メソッドを使用します。

API

BigQuery Connections REST API の projects.locations.connections.setIAM メソッドを使用して、policy リソースのインスタンスを指定します。

Java

import com.google.api.resourcenames.ResourceName;
import com.google.cloud.bigquery.connection.v1.ConnectionName;
import com.google.cloud.bigqueryconnection.v1.ConnectionServiceClient;
import com.google.iam.v1.Binding;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import java.io.IOException;

// Sample to share connections
public class ShareConnection {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    String location = "MY_LOCATION";
    String connectionId = "MY_CONNECTION_ID";
    shareConnection(projectId, location, connectionId);
  }

  static void shareConnection(String projectId, String location, String connectionId)
      throws IOException {
    try (ConnectionServiceClient client = ConnectionServiceClient.create()) {
      ResourceName resource = ConnectionName.of(projectId, location, connectionId);
      Binding binding =
          Binding.newBuilder()
              .addMembers("group:example-analyst-group@google.com")
              .setRole("roles/bigquery.connectionUser")
              .build();
      Policy policy = Policy.newBuilder().addBindings(binding).build();
      SetIamPolicyRequest request =
          SetIamPolicyRequest.newBuilder()
              .setResource(resource.toString())
              .setPolicy(policy)
              .build();
      client.setIamPolicy(request);
      System.out.println("Connection shared successfully");
    }
  }
}

接続を編集する

接続では、接続を作成したユーザーの認証情報が使用されます。接続に関連付けられているユーザーを変更する必要がある場合は、ユーザーの認証情報を更新できます。これは、接続を作成したユーザーが組織のメンバーではなくなった場合に便利です。

接続の次の要素は編集できません。

接続タイプ
接続 ID
ロケーション

次のオプションのいずれかを選択します。

コンソール

[BigQuery] ページに移動します。

[BigQuery] に移動

接続は、プロジェクトで外部接続というグループに一覧表示されます。
[エクスプローラ] ペインで、[プロジェクト名] > [外部接続] > [接続] の順にクリックします。
[詳細] ペインで、 [詳細を編集] をクリックすれば、詳細を編集できます。次に、以下の操作を行います。
1. [接続の編集] ダイアログで、ユーザー認証情報などの接続の詳細を編集します。
2. [接続の更新] をクリックします。

bq

bq update コマンドを入力して、接続フラグ --connection を指定します。完全修飾された connection_id が必要です。

  bq update --connection --connection_type='CLOUD_SQL'
      --properties='{"instanceId" : "INSTANCE",
      "database" : "DATABASE", "type" : "MYSQL" }'
      --connection_credential='{"username":"USERNAME", "password":"PASSWORD"}'
      PROJECT.REGION.CONNECTION_ID

次のように置き換えます。

INSTANCE: Cloud SQL インスタンス
DATABASE: データベース名
USERNAME: Cloud SQL データベースのユーザー名
PASSWORD: Cloud SQL データベースのパスワード
PROJECT: Google Cloud プロジェクト ID
REGION: 接続リージョン
CONNECTION_ID: 接続 ID

たとえば、次のコマンドを使用すると、ID が federation-test で接続 ID が test-mysql のプロジェクト内の接続が更新されます。

bq update --connection --connection_type='CLOUD_SQL'
    --properties='{"instanceId" : "federation-test:us-central1:new-mysql",
    "database" : "imdb2", "type" : "MYSQL" }'
    --connection_credential='{"username":"my_username",
    "password":"my_password"}' federation-test.us.test-mysql

API

REST API リファレンスセクションの projects.locations.connections.patch メソッドを参照し、connection のインスタンスを指定します。

Java

import com.google.cloud.bigquery.connection.v1.Connection;
import com.google.cloud.bigquery.connection.v1.ConnectionName;
import com.google.cloud.bigquery.connection.v1.UpdateConnectionRequest;
import com.google.cloud.bigqueryconnection.v1.ConnectionServiceClient;
import com.google.protobuf.FieldMask;
import com.google.protobuf.util.FieldMaskUtil;
import java.io.IOException;

// Sample to update connection
public class UpdateConnection {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    String location = "MY_LOCATION";
    String connectionId = "MY_CONNECTION_ID";
    String description = "MY_DESCRIPTION";
    Connection connection = Connection.newBuilder().setDescription(description).build();
    updateConnection(projectId, location, connectionId, connection);
  }

  static void updateConnection(
      String projectId, String location, String connectionId, Connection connection)
      throws IOException {
    try (ConnectionServiceClient client = ConnectionServiceClient.create()) {
      ConnectionName name = ConnectionName.of(projectId, location, connectionId);
      FieldMask updateMask = FieldMaskUtil.fromString("description");
      UpdateConnectionRequest request =
          UpdateConnectionRequest.newBuilder()
              .setName(name.toString())
              .setConnection(connection)
              .setUpdateMask(updateMask)
              .build();
      Connection response = client.updateConnection(request);
      System.out.println("Connection updated successfully :" + response.getDescription());
    }
  }
}

接続を削除する

次のオプションのいずれかを選択します。

コンソール

[BigQuery] ページに移動します。

[BigQuery] に移動

接続は、プロジェクトで外部接続というグループに一覧表示されます。
[エクスプローラ] ペインで、[プロジェクト名] > [外部接続] > [接続] の順にクリックします。
[詳細] ペインで、 [削除] をクリックして接続を削除します。
[接続を削除しますか？] ダイアログボックスに「delete」と入力して削除を確定します。
[削除] をクリックします。

bq

bq rm コマンドを入力して、接続フラグ --connection を指定します。完全修飾された connection_id が必要です。

bq rm --connection PROJECT_ID.REGION.CONNECTION_ID

次のように置き換えます。

PROJECT_ID: 実際の Google Cloud プロジェクト ID
REGION: 接続リージョン
CONNECTION_ID: 接続 ID

API

REST API リファレンスセクションの projects.locations.connections.delete メソッドをご覧ください。

Java

import com.google.cloud.bigquery.connection.v1.ConnectionName;
import com.google.cloud.bigquery.connection.v1.DeleteConnectionRequest;
import com.google.cloud.bigqueryconnection.v1.ConnectionServiceClient;
import java.io.IOException;

// Sample to delete a connection
public class DeleteConnection {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    String location = "MY_LOCATION";
    String connectionName = "MY_CONNECTION_NAME";
    deleteConnection(projectId, location, connectionName);
  }

  static void deleteConnection(String projectId, String location, String connectionName)
      throws IOException {
    try (ConnectionServiceClient client = ConnectionServiceClient.create()) {
      ConnectionName name = ConnectionName.of(projectId, location, connectionName);
      DeleteConnectionRequest request =
          DeleteConnectionRequest.newBuilder().setName(name.toString()).build();
      client.deleteConnection(request);
      System.out.println("Connection deleted successfully");
    }
  }
}

次のステップ

リモート関数を利用する方法を学習する。
Apache Spark のストアドプロシージャを使用する方法を確認する。

接続を管理する

始める前に

必要なロール

必要な権限

すべての接続を一覧表示する

コンソール

bq

API

Java

接続の詳細を表示する

コンソール

bq

API

Java

ユーザーとの接続を共有する

コンソール

bq

API

Java

接続を編集する

コンソール

bq

API

Java

接続を削除する

コンソール

bq

API

Java

次のステップ