Configura la localidad de los datos con extremos regionales

En esta página, se describe cómo configurar las bibliotecas cliente de Cloud Firestore para usar un extremo regional o multirregional.

Cuando usas las bibliotecas cliente de Cloud Firestore, puedes usar cualquiera de los siguientes extremos:

  • Extremo global: De forma predeterminada, las bibliotecas cliente de Cloud Firestore envían solicitudes a la API a un extremo de servicio global llamado firestore.googleapis.com. El extremo de servicio global enruta la solicitud a tu base de datos. Durante el enrutamiento, es posible que una solicitud pase por un servidor en una ubicación diferente a la de tu base de datos.

  • Extremo regional: Un extremo regional aplica restricciones que garantizan que los datos se transmitan, almacenen y procesen en una región Google Cloud especificada. Para asegurarte de que el extremo de servicio procese las solicitudes de Cloud Firestore de tu app en la misma región que tu base de datos, especifica un extremo regional en la biblioteca cliente.

  • Extremo multirregional: Un extremo multirregional aplica restricciones para garantizar que los datos se almacenen y procesen en una multirregión especificada. Para asegurarte de que el extremo de servicio procese las solicitudes Cloud Firestore de tu app en la misma ubicación multirregional que tu base de datos, especifica un extremo multirregional en la biblioteca cliente.

Configura un extremo regional o multirregional

El método para configurar un extremo regional o multirregional es el mismo: debes proporcionar la cadena del extremo cuando inicializas la biblioteca cliente. En los siguientes ejemplos, se muestra cómo configurar la cadena de extremo con un extremo regional (firestore.us-central1.rep.googleapis.com). Para usar un extremo multirregional, proporciona una cadena de extremo multirregional que corresponda a la ubicación de tu base de datos (por ejemplo, firestore.us.rep.googleapis.com para nam5).

Java


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 firestore.us-central1.rep.googleapis.com:443
            .setHost(endpoint)
            .build();
    Firestore dbWithEndpoint = firestoreOptions.getService();

    return dbWithEndpoint;
  }

}
RegionalEndpointSnippets.java

Python

ENDPOINT = "firestore.africa-south1.rep.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)
snippets.py

Semántica de los extremos regionales y multirregionales

Extremos regionales (REP):

Cloud Firestore admite extremos regionales para las ubicaciones regionales que se indican aquí ubicaciones de Cloud Firestore.

Usa el siguiente formato para definir extremos regionales:

Java

  firestore.REGION_NAME.rep.googleapis.com:443

Asegúrate de que el número de puerto esté definido junto con el extremo.

Python

  firestore.REGION_NAME.rep.googleapis.com

Go

  firestore.REGION_NAME.rep.googleapis.com:443

Asegúrate de que el número de puerto esté definido junto con el extremo.

Reemplaza REGION_NAME por el nombre de un host regional.

Estos son algunos ejemplos de nombres de host:

  • firestore.us-central1.rep.googleapis.com
  • firestore.europe-west1.rep.googleapis.com

Extremos multirregionales (MREP)

Para los extremos multirregionales, usa us para las ubicaciones nam5 y nam7, y eu para la ubicación eur3 (consulta Ubicaciones multirregionales).

Java

  firestore.us.rep.googleapis.com:443
  firestore.eu.rep.googleapis.com:443

Asegúrate de que el número de puerto esté definido junto con el extremo.

Python

  firestore.us.rep.googleapis.com
  firestore.eu.rep.googleapis.com

Go

  firestore.us.rep.googleapis.com:443
  firestore.eu.rep.googleapis.com:443

Asegúrate de que el número de puerto esté definido junto con el extremo.

Limitaciones

Extremos de ubicación (obsoleto)

Los extremos de ubicación dejaron de estar disponibles. En su lugar, usa extremos regionales o multirregionales.

Anteriormente, Cloud Firestore admitía extremos locales con el siguiente formato:

Java

  REGION_NAME-firestore.googleapis.com:443

Asegúrate de que el número de puerto esté definido junto con el extremo.

Python

  REGION_NAME-firestore.googleapis.com

Go

  REGION_NAME-firestore.googleapis.com:443

Asegúrate de que el número de puerto esté definido junto con el extremo.

Reemplaza REGION_NAME por el nombre de un host regional o multirregional.

Estos son algunos ejemplos de nombres de host:

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

Para obtener una lista completa de los nombres de host regionales y multirregionales, consulta Ubicaciones de Cloud Firestore.

Restringe el uso del extremo de API global

Para ayudar a aplicar de manera forzosa el uso de extremos regionales y multirregionales, usa la restricción de políticas de la organización constraints/gcp.restrictEndpointUsage para bloquear las solicitudes al extremo de API global. Para obtener más información, consulta Cómo restringir el uso de extremos.