Actividad de consulta de Cloud Firestore
Introducción
Una actividad de Consulta de Cloud Firestore, utilizando su conexión de Cloud Firestore, consulta documentos dentro de una colección en Cloud Firestore y está destinada a ser utilizada como una fuente para proporcionar datos en una operación.
Crear una actividad de consulta de Cloud Firestore
Una instancia de una actividad de Consulta de Cloud Firestore se crea a partir de una conexión de Cloud Firestore utilizando su tipo de actividad Consulta.
Para crear una instancia de una actividad, arrastre el tipo de actividad al lienzo de diseño o copie el tipo de actividad y péguelo en el lienzo de diseño. Para más detalles, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.
Una actividad de Consulta de Cloud Firestore existente se puede editar desde estas ubicaciones:
- La pestaña Puntos finales y conectores del proyecto en la paleta de componentes de diseño (consulte Paleta de componentes de diseño).
- La pestaña Componentes del panel del proyecto (consulte Menú de acciones de componentes en Pestaña de componentes del panel del proyecto).
- La página de Puntos finales globales (consulte Editar un punto final global en Puntos finales globales).
Configurar una actividad de consulta de Cloud Firestore
Siga estos pasos para configurar una actividad de Consulta de Cloud Firestore:
-
Paso 1: Ingrese un nombre y seleccione una colección
Proporcione un nombre para la actividad y seleccione una colección. -
Paso 2: Revise los esquemas de datos
Se muestran los esquemas de solicitud o respuesta.
Paso 1: Ingrese un nombre y seleccione una colección
En este paso, proporcione un nombre para la actividad y seleccione una colección. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
-
Nombre: Ingrese un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Consulta de Cloud Firestore y no debe contener barras diagonales
/
ni dos puntos:
. -
Seleccionar una colección: Esta sección muestra las colecciones disponibles en el punto final de Cloud Firestore.
-
Colección seleccionada: Después de seleccionar una colección, se lista aquí.
-
Buscar: Ingrese el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de colecciones. La búsqueda no distingue entre mayúsculas y minúsculas. Si las colecciones ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar colecciones desde el punto final al buscar, ingrese criterios de búsqueda y luego actualice, como se describe a continuación.
-
Actualizar: Haga clic en el ícono de actualizar o en la palabra Actualizar para recargar colecciones desde el punto final de Cloud Firestore. Esto puede ser útil si se han agregado colecciones a Google Cloud Firestore. Esta acción actualiza todos los metadatos utilizados para construir la tabla de colecciones mostrada en la configuración.
-
Seleccionar una colección: Dentro de la tabla, haga clic en cualquier parte de una fila para seleccionar una colección. Solo se puede seleccionar una colección. La información disponible para cada colección se obtiene del punto final de Cloud Firestore:
- ID: El ID de la colección.
Consejo
Si la tabla no se llena con las colecciones disponibles, la conexión a Cloud Firestore puede no haber sido exitosa. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.
-
Continuar en caso de error: Seleccione continuar la ejecución de la actividad si se encuentra un error para un conjunto de datos en una solicitud por lotes. Si se encuentran errores, se escriben en el registro de operaciones.
-
Guardar y salir: Si está habilitado, haga clic para guardar la configuración de este paso y cerrar la configuración de la actividad.
-
Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que haga clic en el botón Finalizado en el último paso.
-
Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pide que confirme que desea descartar los cambios.
Paso 2: Revisar los esquemas de datos
Se muestran los esquemas de solicitud o respuesta. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
-
Esquemas de datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformaciones.
El conector de Cloud Firestore utiliza el Google Firebase JavaScript SDK v8. Consulte la documentación para obtener información sobre los nodos y campos del esquema.
El esquema de datos de la solicitud consta de estos nodos y campos:
Nodo/Campo del esquema de solicitud Descripción item
Nodo que representa los elementos que se están consultando. filter
Campo que contiene uno de estos operadores de consulta: LessThan
LessThanOrEqualTo
EqualTo
GreaterThan
GreaterThanOrEqualTo
NotEqualTo
ArrayContains
ArrayContainsAny
In
NotIn
Para obtener más información sobre los operadores de consulta y sus limitaciones, consulte la documentación de Cloud Firestore.
field
El campo del documento que se consultará contra el filter
yvalues
especificados.values
Nodo que contiene los valores de la consulta para el filter
especificado.
Nota
Si está utilizando los operadores de consulta
In
oNotIn
en el campofilter
, se utiliza toda la matriz de consulta en el nodovalues
. Para todos los demás operadores de consulta, solo se utiliza el primer partype
/value
de la matriz.item
Nodo que contiene cada valor de consulta. type
El tipo de dato de la consulta. value
El valor de la consulta para el type
especificado.limit
El número de resultados de la consulta que se devolverán; para devolver todos los resultados, establezca en 0
.returnOnlyFieldValues
Establecer en true
devuelve solo los valores consultados; establecer enfalse
devuelve el documento completo. -
Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para regenerar esquemas desde el punto final de Cloud Firestore. Esta acción también regenera un esquema en otras ubicaciones a lo largo del proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.
-
Regresar: Haz clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.
-
Terminado: Haz clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.
-
Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pide que confirmes que deseas descartar los cambios.
Próximos pasos
Después de configurar una actividad de Consulta de Cloud Firestore, completa la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puedes configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.
Las acciones del menú para una actividad son accesibles desde el panel del proyecto y el lienzo de diseño. Para más detalles, consulta el menú de acciones de actividad en Conceptos básicos de conectores.
Las actividades de Consulta de Cloud Firestore se pueden utilizar como fuente con estos patrones de operación:
- Patrón de transformación
- Patrón de archivo de dos objetivos (como la primera fuente únicamente)
- Patrón de archivo HTTP de dos objetivos (como la primera fuente únicamente)
- Patrón de dos transformaciones (como la primera o segunda fuente)
Para utilizar la actividad con funciones de scripting, escribe los datos en una ubicación temporal y luego utiliza esa ubicación temporal en la función de scripting.
Cuando estés listo, despliega y ejecuta la operación y valida el comportamiento revisando los registros de la operación.