使用区域端点配置数据位置

本页介绍如何配置 Firestore 客户端库以使用区域端点。

使用 Firestore 客户端库时，您可以使用以下任一端点：

  • 全球端点：默认情况下，Firestore 客户端库会向名为 firestore.googleapis.com 的全球服务端点发送 API 请求。全局服务端点将请求路由到您的数据库。在路由期间，请求可能会通过与数据库位置不同的区域服务端点传递。

  • 区域端点：区域端点执行区域限制，以确保在指定区域中存储和处理数据。 如需保证服务端点在您的数据库所在的区域中处理应用的 Firestore 请求，请在客户端库中指定区域端点。

设置区域端点

以下示例展示了如何在初始化 Firestore 客户端时设置区域端点。如果设置区域端点不是数据驻留位置，则可能会导致 PermissionDeniedError 错误。

Java

如需向 Firestore 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。 


import com.google.auth.oauth2.GoogleCredentials;
import com.google.cloud.firestore.Firestore;
import com.google.cloud.firestore.FirestoreOptions;

/**
 * Demonstrate how to set a regional endpoint.
 */
public class RegionalEndpointSnippets {

  /**
   * Create a client with a regional endpoint.
   **/
  public Firestore regionalEndpoint(String projectId, String endpoint) throws Exception {
    FirestoreOptions firestoreOptions =
        FirestoreOptions.newBuilder()
            .setProjectId(projectId)
            .setCredentials(GoogleCredentials.getApplicationDefault())
            // set endpoint like nam5-firestore.googleapis.com:443
            .setHost(endpoint)
            .build();
    Firestore dbWithEndpoint = firestoreOptions.getService();

    return dbWithEndpoint;
  }

}

Python

如需向 Firestore 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。 

ENDPOINT = "nam5-firestore.googleapis.com"
client_options = ClientOptions(api_endpoint=ENDPOINT)
db = firestore.Client(client_options=client_options)

cities_query = db.collection("cities").limit(2).get()
for r in cities_query:
    print(r)

区域性端点语义

Firestore 支持单区域位置和多区域位置的区域端点。

请使用以下格式定义区域端点：

Java

  REGION_NAME-firestore.googleapis.com:443

请确保已定义端口号以及端点。

Python

  REGION_NAME-firestore.googleapis.com

Go

  REGION_NAME-firestore.googleapis.com:443

请确保已定义端口号以及端点。

将 REGION_NAME 替换为单区域或多区域主机名。

以下是一些主机名示例：

  • eur3-firestore.googleapis.com
  • nam5-firestore.googleapis.com
  • europe-west6-firestore.googleapis.com
  • asia-northeast2-firestore.googleapis.com

如需查看多区域和单区域主机名的完整列表，请参阅 Firestore 位置。

后续步骤