Consulta estadísticas de Knowledge Catalog

Consulta estadísticas de Knowledge Catalog

Puedes buscar y administrar tus recursos de Firestore con Knowledge Catalog, que es una plataforma para almacenar, administrar y acceder a tus metadatos. Puedes usar Knowledge Catalog para analizar tus metadatos de Firestore y ayudarte con tareas como las siguientes:

• Análisis, incluidas las dependencias y la idoneidad para un caso de uso
• Administración de cambios
• Evolución del esquema

Knowledge Catalog está habilitado de forma predeterminada en las bases de datos de Firestore nuevas y existentes, y recupera automáticamente los siguientes metadatos:

Recurso	Tipo	Campos
Base de datos	Plano de control	Edición Modos Ubicación (incluidas las multirregiones) ID del proyecto Nombre de la base de datos Hora de creación
Esquema de la base de datos	Plano de datos	Nombre Colección Campo: Tipos de datos Esquema

Antes de comenzar

Para usar las estadísticas de Knowledge Catalog con Firestore, primero debes tener una base de datos de Firestore. Para obtener más información, consulta Crea y administra bases de datos.

Roles requeridos para acceder a los resultados de la búsqueda

Para buscar y ver metadatos de Firestore en Knowledge Catalog, las entidades principales deben tener permisos para ver los recursos de Firestore, incluido el permiso dataplex.projects.search.

Para otorgar a las entidades principales, como usuarios, grupos o cuentas de servicio, estos permisos, asígnales el rol de IAM Visualizador de Cloud Datastore (roles/datastore.viewer) en el proyecto que contiene los recursos de Firestore.

Operación de Knowledge Catalog	Recurso de Firestore	Roles o permisos obligatorios
Buscar recursos de Firestore	Base de datos	datastore.databases.getMetadata
	Esquema de la base de datos	datastore.schemas.get

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso. Para obtener más información sobre los roles de IAM de Firestore, consulta Roles y permisos de Firestore.

Roles requeridos para buscar entradas

Para buscar entradas, necesitas al menos uno de los siguientes roles de IAM en el proyecto que se usa para la búsqueda:

• Administrador de Catálogo de Dataplex (roles/dataplex.catalogAdmin)
• Editor del catálogo de Dataplex (roles/dataplex.catalogEditor)
• Visualizador del catálogo de Dataplex (roles/dataplex.catalogViewer)

Los permisos en los resultados de la búsqueda se verifican de forma independiente del proyecto seleccionado. Para obtener más información, consulta Busca recursos de datos con Knowledge Catalog.

Tipos de descubrimiento de metadatos

El descubrimiento de metadatos de Knowledge Catalog es un proceso automatizado que analiza las fuentes de datos conectadas, como Firestore, para identificar recursos de datos (como colecciones y bases de datos) y extraer sus metadatos técnicos, como esquemas, descripciones y ubicaciones, en el catálogo de Knowledge Catalog. Este proceso se ejecuta de forma periódica para mantener el catálogo sincronizado con los sistemas de origen.

Importante: Los IDs de la base de datos y del grupo de colecciones deben seguir la siguiente convención de nombres para que aparezcan en Knowledge Catalog: Deben contener solo letras, números o caracteres en ""'-._~%%!$&'()*+,;=@/' y no pueden estar en formato UUID ni estar vacíos. Los IDs no pueden comenzar con una barra (/) ni contener dos barras seguidas (//).

Búsqueda de palabras clave y en lenguaje natural

Knowledge Catalog admite búsquedas de palabras clave y en lenguaje natural.

• La búsqueda de palabras clave te permite encontrar recursos con palabras clave, filtros y una sintaxis definidos. Por ejemplo, puedes ingresar system=Firestore AND type=Database para ver todas las bases de datos de Firestore.
• La búsqueda en lenguaje natural (vista previa) usa IA para comprender las consultas semánticas. Te permite encontrar recursos con lenguaje cotidiano, lo que elimina la necesidad de una sintaxis compleja. Por ejemplo, puedes ingresar consultas como List all Firestore databases related to sales.

Para obtener más información, consulta Sintaxis de búsqueda de Knowledge Catalog.

Ejemplo: Descubre un esquema de grupo de colecciones de Firestore

Para comprender el proceso de descubrimiento de metadatos, considera una base de datos de Firestore llamada user-firestore-database. En esta base de datos, tienes un esquema de grupo de colecciones llamado user-schema.

Una vez que se complete el descubrimiento, puedes buscar estos recursos (user-firestore-database y user-schema) en la página de Knowledge Catalog de la Google Cloud consola o con la API de Knowledge Catalog. Luego, puedes ver los detalles de los recursos y enriquecerlos con metadatos empresariales o operativos adicionales.

Enriquece los metadatos con aspectos

Los tipos de aspectos son recursos reutilizables que puedes usar como plantillas para aspectos. Los tipos de aspecto te ayudan a evitar la duplicación de trabajo y los aspectos incompletos. Puedes usar Knowledge Catalog para crear los tipos de aspectos que necesitas.

Después de crear tipos de aspectos personalizados, puedes adjuntar aspectos a tus recursos de Firestore. Adjuntar aspectos a tus recursos te permite hacer lo siguiente:

• Agregar metadatos empresariales a los recursos
• Buscar recursos por metadatos empresariales y otros metadatos personalizados

Para obtener más información sobre cómo crear tipos de aspectos y adjuntar aspectos a Firestore, consulta Administra aspectos y enriquece los metadatos.

Busca recursos de Firestore

Usa la página de búsqueda de Knowledge Catalog en la Google Cloud consola para buscar recursos de Firestore.

1. Ve a la página Búsqueda de Knowledge Catalog.

   Ir a Búsqueda

2. En el panel Filtros, haz clic en Sistemas y, luego, selecciona Firestore.

3. Es opcional. En Alias de tipo, puedes filtrar los resultados de la búsqueda a un tipo específico de recurso de Firestore. Para ello, selecciona uno o más de los siguientes alias de tipo:

   • Base de datos
   • Esquema de la base de datos
   • Otro

Usa consultas para realizar búsquedas de palabras clave

Puedes usar el campo de búsqueda en Knowledge Catalog para realizar búsquedas de palabras clave. Por ejemplo, puedes ingresar system=Firestore AND type=Database para ver todas las bases de datos de Firestore.

Para obtener más información, consulta Sintaxis de búsqueda de Knowledge Catalog.

Para ver todos los recursos de Firestore, ingresa system=Firestore. Puedes ingresar palabras clave específicas. Por ejemplo, para ver todas las bases de datos de Firestore, haz lo siguiente:

system=Firestore AND type=Database

También puedes usar paréntesis y los operadores lógicos AND y OR para expresiones complejas. Para obtener más información sobre las expresiones que puedes usar en el campo de búsqueda, consulta Sintaxis de búsqueda de Knowledge Catalog.

Puedes ingresar búsquedas de forma directa para recursos específicos de Firestore en el campo de búsqueda. El formato de la cadena de consulta es el siguiente:

type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"

Reemplaza lo siguiente:

• QUERY_STRING: Usa la siguiente lista para identificar una cadena de consulta según el tipo de recurso de Firestore que deseas consultar:

  • firestore-database
  • firestore-schema

Una consulta de ejemplo podría tener el siguiente aspecto:

type="projects/1234567890/locations/global/entryTypes/firestore-schema"

Busca por tipo de aspecto

Knowledge Catalog incluye algunos tipos de aspectos integrados que puedes usar para realizar búsquedas.

Para buscar por tipo de aspecto, sigue estos pasos:

1. En el panel Aspectos, haz clic en el menú Agregar más tipos de aspectos.
2. Ingresa Firestore y, luego, selecciona uno o más de los siguientes tipos de aspecto para limitar los resultados de la búsqueda a ese tipo.
   • Base de datos de Firestore
   • Esquema de Firestore
3. Haz clic en Aceptar.
4. En la tabla de resultados, haz clic en el nombre de un recurso para ver sus metadatos.
5. Opcional: Mejora o visualiza tus recursos. Puedes realizar una de las siguientes acciones:
   • Para agregar una descripción de texto enriquecido del recurso, en Descripción general, haz clic en Agregar .
   • Para adjuntar un aspecto al recurso, en Aspectos, haz clic en Agregar .
   • Para ver las bases de datos de miembros de una instancia, haz clic en la pestaña Lista de entradas y, luego, en Mostrar todas las entradas secundarias en la búsqueda.
   • En Información de las entradas, visualiza todos los detalles del recurso. Haz clic en el nombre de la entrada para desglosar las entradas adicionales.

Búsqueda en lenguaje natural en Firestore

La búsqueda en lenguaje natural (vista previa) usa IA para comprender las consultas semánticas. Te permite encontrar recursos con lenguaje cotidiano, lo que elimina la necesidad de una sintaxis compleja. Por ejemplo, puedes ingresar consultas como List all Firestore collections related to sales.

Para obtener más información, consulta Sintaxis de búsqueda de Knowledge Catalog.

Búsqueda de sintaxis en Firestore

La búsqueda de palabras clave te permite encontrar recursos con palabras clave, filtros y una sintaxis definidos. Por ejemplo, puedes ingresar system=Firestore AND type=Database para ver todas las bases de datos de Firestore.

Para obtener más información, consulta Sintaxis de búsqueda de Knowledge Catalog.

Ejemplo de flujo de trabajo: Desglosar de base de datos a esquema

Para desglosar de una base de datos a un esquema, sigue estos pasos:

1. Ve a la página Búsqueda de Knowledge Catalog.

   Ir a Búsqueda

2. En el panel Filtros, selecciona Sistemas y, luego, Firestore. También puedes ingresar system=Firestore en el campo de búsqueda.

3. Selecciona una base de datos.

4. En la página Detalles de Firestore , haz clic en la pestaña Lista de entradas y, luego, en Mostrar todas las entradas secundarias en la búsqueda.

   Nota: Si no hay una pestaña Lista de entradas, regresa a la página Buscar y elige una base de datos diferente.

5. En la página Detalles de la base de datos de Firestore , haz clic en la pestaña Lista de entradas y, luego, en Mostrar todas las entradas secundarias en la búsqueda. Knowledge Catalog muestra los grupos de colecciones en la base de datos.

6. Selecciona un nombre de grupo de colecciones y, luego, en la página Detalles del grupo de colecciones , haz clic en Esquema para ver el esquema.

7. Opcional: Para agregar un tipo de aspecto a una base de datos, haz clic en el botón Agregar aspecto.

Precios

No se aplican cargos por almacenar metadatos técnicos de Firestore en Knowledge Catalog. Los precios estándar de Knowledge Catalog se aplican a las llamadas a la API y al enriquecimiento adicional de metadatos empresariales. Para obtener más información, consulta la página de precios de Knowledge Catalog.

Limitaciones

• Los resultados de la consulta se truncan después de que se transfieren 10,000 grupos de colecciones.
• Durante la transferencia por lotes, las actualizaciones de tu base de datos pueden tardar hasta 48 horas en reflejarse en Knowledge Catalog.
• Durante la transferencia en vivo, las actualizaciones de tu base de datos pueden tardar hasta 5 minutos en reflejarse en Knowledge Catalog.
• Los grupos de colecciones no se actualizan durante la transferencia en vivo.
• Los esquemas de grupos de colecciones se actualizan durante la transferencia en vivo. Sin embargo, esta actualización solo abarca los primeros 100 campos primitivos de nivel superior en orden alfabético. El resto de la información del esquema se actualiza entre 24 y 48 horas después de la transferencia en vivo.
• El proceso de extracción puede tardar varios minutos.

¿Qué sigue?

• Acerca de la administración del catálogo de datos en Knowledge Catalog
• Roles de Identity and Access Management de Knowledge Catalog