Actividad de consulta de MongoDB

Introducción

Una actividad de Consulta de MongoDB, utilizando su conexión de MongoDB, recupera datos de una colección de MongoDB y está destinada a ser utilizada como fuente para proporcionar datos en una operación.

Crear una actividad de consulta de MongoDB

Una instancia de una actividad de Consulta de MongoDB se crea a partir de una conexión de MongoDB 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 MongoDB existente se puede editar desde estas ubicaciones:

• El lienzo de diseño (consulte Menú de acciones de componentes en Lienzo 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).

Configurar una actividad de consulta de MongoDB

Siga estos pasos para configurar una actividad de Consulta de MongoDB:

• Paso 1: Ingrese un nombre y seleccione una colección
  Proporcione un nombre para la actividad y seleccione una colección.

• Paso 2: Especifique la configuración
  Especifique el Filtro, Límite, Tipo de proyección y Proyección.

• Paso 3: Revise los esquemas de datos
  Se mostrarán los esquemas de solicitud o respuesta.

Paso 1: Ingrese un nombre y seleccione una colección

En este paso, proporciona un nombre para la actividad y selecciona una colección. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Consulta de MongoDB y no debe contener barras inclinadas / ni dos puntos :.

• Seleccionar un Objeto: Esta sección muestra las colecciones disponibles en el punto final de MongoDB.

  • Objeto de MongoDB Seleccionado: Después de seleccionar una colección, se lista aquí.

  • Buscar: Ingresa 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, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

  • Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para recargar colecciones desde el punto final de MongoDB. Esto puede ser útil si se han agregado colecciones a MongoDB. Esta acción actualiza todos los metadatos utilizados para construir la tabla de colecciones mostradas en la configuración.

  • Seleccionar una Colección: Dentro de la tabla, haz 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 MongoDB:

    • Nombre: El nombre de la colección.

    • Descripción: La descripción de la colección.

  Consejo

  Si la tabla no se llena con colecciones disponibles, la conexión de MongoDB puede no haber sido exitosa. Asegúrate de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

• Guardar y Salir: Si está habilitado, haz clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

• 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.

Paso 2: Especificar configuraciones

En este paso, especifica el Filtro, Límite, Tipo de Proyección y Proyección. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Filtro: Ingresa un filtro (en formato de JSON extendido de MongoDB) para usar al recuperar documentos de la colección especificada.

• Límite: Ingresa el número máximo de documentos a recuperar de la colección.

• Tipo de Proyección: Selecciona un tipo de proyección, ya sea Incluir o Excluir:

  • Incluir: Devuelve ciertos campos (especificados dentro del campo Proyección) en la respuesta.

  • Excluir: Excluye ciertos campos (especificados en el campo Proyección) de la respuesta.

• Proyección: Ingresa una proyección para incluir o excluir campos devueltos en la respuesta de la Consulta. Los múltiples valores deben estar separados por una coma.

• Ordenar: Define el orden de clasificación de la respuesta de esta actividad. Haz clic en el ícono de agregar para añadir una Propiedad y un Tipo de Ordenación a la tabla a continuación:

  • Propiedad: Ingresa el nombre del campo que se está ordenando.
  • Tipo de Ordenamiento: Especifica si los documentos que contienen el campo están ordenados en orden ascendente (1) o descendente (-1).

  Para guardar la fila, haz clic en el ícono de enviar en la columna más a la derecha.

  Para editar o eliminar una sola fila, pasa el cursor sobre la columna más a la derecha y utiliza el ícono de editar o el ícono de eliminar .

  Para eliminar todas las filas, haz clic en Limpiar Todo.

  Importante

  Los campos en la tabla Ordenar muestran el ícono de variable solo en modo de edición. Para que los valores de variable de estos campos se llenen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

  Los campos en la tabla Ordenar no admiten el uso de variables para pasar JSON sin procesar. Si tu caso de uso no admite definir JSON sin procesar en los campos directamente, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Terminado en el último paso.

• 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 pedirá que confirmes que deseas descartar los cambios.

Paso 3: 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 mapeo de transformaciones.

  Nota

  Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.

  El conector de MongoDB utiliza el MongoDB Java Driver v4.1. Consulta la documentación del controlador y la referencia de MongoDB para obtener información sobre los nodos y campos del esquema.

  La actividad Query utiliza XML tanto en sus esquemas de solicitud como de respuesta.

  Los esquemas de datos de solicitud y respuesta constan de estos nodos y campos:

  • Solicitud:

    Campo/Nodo del Esquema de Solicitud	Descripción
    queryRequest	Solicitud para consultar la base de datos
    filter	Un filtro en formato JSON extendido de MongoDB utilizado para coincidir con los documentos en la colección seleccionada
    projection	La cadena de proyección
    limit	Número máximo de documentos a recuperar de la colección
    projectionType	El tipo de proyección, ya sea include o exclude
    sort	El orden de clasificación de la respuesta de esta actividad
    key	Ingresa el campo que se va a clasificar
    value	Especifica si los documentos que contienen el campo se ordenan en orden ascendente (1) o descendente (-1)
    aggregrate	Nodo que contiene las especificaciones de una operación de agregación
    unwind	Ingresa el campo para desenrollar
    match	Nodo que contiene el par clave-valor de las condiciones para la etapa de coincidencia del pipeline
    key	Ingresa el campo que se está consultando
    value	Ingresa el valor deseado del campo que se está consultando
    sortAggregrate	Nodo que contiene el orden de clasificación de los resultados agregados
    key	Ingresa el campo que se va a clasificar
    value	Especifica si los documentos que contienen el campo se devuelven en orden ascendente (1) o descendente (-1)
    project	Nodo que contiene condiciones para la etapa del pipeline de proyección
    exclude	Ingresa el campo que se va a excluir en la respuesta
    include	Ingresa el campo que se va a incluir en la respuesta
    group	Nodo que contiene condiciones para la etapa del pipeline de agrupación
    key	Ingresa la clave del grupo
    value	Ingresa el valor del grupo
    accumulator	Ingresa el acumulador
    nameNewField	Ingresa el nombre del campo que se está agregando
    out	Ingresa la colección para la etapa del pipeline de salida

  • Respuesta:

    Campo/Nodo del Esquema de Respuesta	Descripción
    queryResponse	Respuesta de la consulta a la base de datos
    records	Número de documentos (registros) devueltos
    documents	Nodo que representa los documents
    document	Contenido del documento

• Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para regenerar esquemas desde el punto final de MongoDB. 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.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar 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 pedirá que confirmes que deseas descartar los cambios.

Próximos pasos

Después de configurar una actividad de Consulta de MongoDB, completa la configuración de la operación añadiendo 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 MongoDB se pueden utilizar como fuente con estos patrones de operación:

• Patrón de transformación
• Patrón de archivo de dos destinos (como la primera fuente únicamente)
• Patrón de archivo HTTP de dos destinos (como la primera fuente únicamente)
• Patrón de dos transformaciones (como la primera o segunda fuente)

Para utilizar la actividad con funciones de scripting, escriba los datos en una ubicación temporal y luego use esa ubicación temporal en la función de scripting.

Cuando esté listo, despliegue y ejecute la operación y valide el comportamiento revisando los registros de operación.