Puedes buscar y administrar tus recursos de Cloud 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 Cloud Firestore y ayudar 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 Cloud Firestore nuevas y existentes, y recupera automáticamente los siguientes metadatos:
| Recurso | Tipo | Campos |
|---|---|---|
| Base de datos | Plano de control |
|
| Esquema de base de datos | Plano de datos |
|
Antes de comenzar
Habilita la API de Knowledge Catalog (dataplex.googleapis.com).
- Antes de habilitar las APIs, necesitas el rol de IAM de administrador de Service Usage
roles/serviceusage.serviceUsageAdmin, que contiene el permisoserviceusage.services.enable. Obtén más información para otorgar roles. - Para habilitar una API, consulta Habilita las APIs.
Para usar las estadísticas de Knowledge Catalog con Cloud Firestore, primero debes tener una base de datos de Cloud Firestore. Para obtener más información, consulta Crea y administra bases de datos.
Roles necesarios para acceder a los resultados de la búsqueda
Para buscar y ver los metadatos de Cloud Firestore en
Knowledge Catalog, las principales deben tener permisos para ver
los recursos de Cloud Firestore, incluido el
permiso dataplex.projects.search.
Para otorgar estos permisos a las principales, como usuarios, grupos o cuentas de servicio, asígnales el rol de IAM de
visualizador de Cloud Datastore (roles/datastore.viewer)
en el proyecto que contiene los recursos de
Cloud Firestore.
| Operación de Knowledge Catalog | Cloud Firestore recurso | Roles o permisos requeridos |
|---|---|---|
| Buscar recursos de Cloud Firestore | Base de datos | datastore.databases.getMetadata |
| Esquema de 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 Cloud Firestore, consulta Roles y permisos de Cloud Firestore.
Roles necesarios para buscar entradas
Para buscar entradas, necesitas tener al menos uno de los siguientes roles de IAM en el proyecto que se usa en 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 independientemente 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 Cloud Firestore, para identificar los 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.
Búsqueda por palabras clave y búsqueda en lenguaje natural
Knowledge Catalog admite búsquedas por palabras clave y en lenguaje natural.
- La búsqueda por palabras clave te permite encontrar recursos con palabras clave específicas, filtros y una
sintaxis definida. Por ejemplo, puedes ingresar
system=Firestore AND type=Databasepara ver todas las bases de datos de Cloud Firestore. - La búsqueda en lenguaje natural (versión preliminar) usa la IA para comprender las consultas semánticas. Te
permite encontrar recursos con un 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 para Knowledge Catalog.
Ejemplo: Descubre un esquema de grupo de colecciones de Cloud Firestore
Para comprender el proceso de descubrimiento de metadatos, considera una base de datos de Cloud 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, podrás buscar estos recursos, user-firestore-database
y user-schema, en la página de Knowledge Catalog de la
consola de Google Cloud o con la API de Knowledge Catalog.
Luego, puedes ver detalles sobre los recursos y enriquecerlos con metadatos
empresariales o de operaciones adicionales.
Enriquece los metadatos con aspectos
Los tipos de aspecto 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 Cloud 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 Cloud Firestore, consulta Administra aspectos y enriquece los metadatos.
Buscar recursos de Cloud Firestore
Usa la página de búsqueda de Knowledge Catalog en la consola de Google Cloud para buscar recursos de Cloud Firestore.
Ve a la página Búsqueda de Knowledge Catalog.
En el panel Filtros, haz clic en Sistemas y, luego, selecciona Firestore.
Opcional. En Alias de tipo, puedes filtrar los resultados de la búsqueda por un tipo específico de recurso de Cloud Firestore seleccionando uno o más de los siguientes alias de tipo:
- Base de datos
- Esquema de 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 por palabras clave. Por ejemplo, puedes ingresar
system=Firestore AND type=Database para ver todas las bases de datos de Cloud Firestore.
Para obtener más información, consulta Sintaxis de búsqueda para Knowledge Catalog.
Para ver todos los recursos de Cloud Firestore, ingresa system=Firestore. Puedes ingresar
palabras clave específicas. Por ejemplo, para ver todas las bases de datos de Cloud 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 para Knowledge Catalog.
Puedes ingresar búsquedas de forma directa para recursos específicos de Cloud 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 Cloud Firestore que deseas consultar:firestore-databasefirestore-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:
- En el panel Aspectos, haz clic en el menú Agregar más tipos de aspectos.
- Ingresa
Firestorey, luego, selecciona uno o más de los siguientes tipos de aspecto para limitar los resultados de la búsqueda a ese tipo.- Cloud Firestore base de datos
- Esquema de Cloud Firestore
- Haz clic en Aceptar.
- En la tabla de resultados, haz clic en el nombre de un recurso para ver sus metadatos.
- Opcional: Mejora o visualiza tus recursos. Puedes realizar cualquiera 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 Cloud Firestore
La búsqueda en lenguaje natural (versión preliminar) usa la IA para comprender las consultas semánticas. Te
permite encontrar recursos con un 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 para Knowledge Catalog.
Búsqueda de sintaxis en Cloud Firestore
La búsqueda por palabras clave te permite encontrar recursos con palabras clave específicas, filtros y una
sintaxis definida. Por ejemplo, puedes ingresar system=Firestore AND type=Database
para ver todas las bases de datos de Cloud Firestore.
Para obtener más información, consulta Sintaxis de búsqueda para Knowledge Catalog.
Flujo de trabajo de ejemplo: Desglosa de la base de datos al esquema
Para desglosar de una base de datos a un esquema, sigue estos pasos:
Ve a la página Búsqueda de Knowledge Catalog.
En el panel Filtros, selecciona Sistemas y, luego, Firestore. También puedes ingresar
system=Firestoreen el campo de búsqueda.Selecciona una base de datos.
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.
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.
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.
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 Cloud 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 hayan transferido 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. La información restante 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