Você pode pesquisar e gerenciar seus Cloud Firestore recursos usando o Knowledge Catalog, que é uma plataforma para armazenar, gerenciar e acessar seus metadados. É possível usar o Knowledge Catalog para analisar seus Cloud Firestore metadados e ajudar em tarefas como:
- Análise, incluindo dependências e adequação a um caso de uso
- Gestão da mudança
- Evolução do esquema
O Knowledge Catalog é ativado por padrão em bancos de dados novos e atuais Cloud Firestore e recupera automaticamente os seguintes metadados:
| Recurso | Tipo | Campos |
|---|---|---|
| Banco de dados | Plano de controle |
|
| Database schema | Plano de dados |
|
Antes de começar
Para usar insights do Knowledge Catalog com Cloud Firestore, primeiro é necessário ter um banco de dados Cloud Firestore. Para mais informações, consulte Criar e gerenciar bancos de dados.
Papéis necessários para acessar os resultados da pesquisa
Para pesquisar e visualizar metadados Cloud Firestore no
Knowledge Catalog, os principais precisam ter permissões para visualizar recursos
Cloud Firestore, incluindo a permissão
dataplex.projects.search.
Para conceder essas permissões a principais, como usuários, grupos ou contas de serviço, atribua a eles o
Leitor do Cloud Datastore (roles/datastore.viewer)
papel do IAM no projeto que contém os Cloud Firestore
recursos.
| Operação do Knowledge Catalog | Cloud Firestore recurso | Papéis ou permissões necessárias |
|---|---|---|
| Pesquisar recursos Cloud Firestore | Banco de dados | datastore.databases.getMetadata |
| Database schema | datastore.schemas.get |
Para mais informações sobre como conceder papéis, consulte Gerenciar acesso. Para mais informações sobre os papéis do IAM de Cloud Firestore, consulte papéis e permissões de Cloud Firestore.
Papéis necessários para pesquisar entradas
Para pesquisar entradas, você precisa de pelo menos um dos seguintes papéis do IAM no projeto usado para pesquisa:
- Administrador de catálogo do Dataplex (
roles/dataplex.catalogAdmin) - Editor de catálogo do Dataplex (
roles/dataplex.catalogEditor) - Leitor do Dataplex Catalog (
roles/dataplex.catalogViewer)
As permissões nos resultados da pesquisa são verificadas independentemente do projeto selecionado. Para mais informações, consulte Pesquisar recursos de dados com o Knowledge Catalog.
Tipos de descoberta de metadados
A descoberta de metadados do Knowledge Catalog é um processo automatizado que verifica fontes de dados conectadas, como Cloud Firestore, para identificar recursos de dados (como coleções e bancos de dados) e extrair os metadados técnicos deles, como esquemas, descrições e locais, para o catálogo do Knowledge Catalog. Esse processo é executado periodicamente para manter o catálogo sincronizado com os sistemas de origem.
Pesquisa por palavra-chave e linguagem natural
O Knowledge Catalog oferece suporte a pesquisas por palavra-chave e linguagem natural.
- A pesquisa por palavra-chave permite encontrar recursos usando palavras-chave, filtros e uma sintaxe definidos. Por exemplo, é possível inserir
system=Firestore AND type=Databasepara visualizar todos os bancos de dados Cloud Firestore. - A pesquisa com linguagem natural (visualização) usa a IA para entender consultas semânticas. Ela permite encontrar recursos usando linguagem cotidiana, eliminando a necessidade de sintaxe complexa. Por exemplo, é possível inserir consultas como
List all Firestore databases related to sales.
Para mais informações, consulte Sintaxe de pesquisa do Knowledge Catalog.
Exemplo: descobrir um esquema de grupo de coleções Cloud Firestore
Para entender o processo de descoberta de metadados, considere um Cloud Firestore
banco de dados chamado user-firestore-database. Nesse banco de dados, você tem um esquema de grupo de coleções chamado user-schema.
Depois que a descoberta for concluída, você poderá pesquisar esses recursos (user-firestore-database
e user-schema) na página do Knowledge Catalog do
console do Google Cloud ou usando a API Knowledge Catalog.
Em seguida, é possível visualizar detalhes sobre os recursos e enriquecê-los com outros metadados comerciais ou operacionais.
Enriquecer metadados usando aspectos
Os tipos de aspecto são recursos reutilizáveis que podem ser usados como modelos. Os tipos de aspecto ajudam a evitar a duplicação de trabalho e aspectos incompletos. É possível usar o Knowledge Catalog para criar os tipos de aspecto que você precisa.
Depois de criar tipos personalizados de aspecto, é possível anexar aspectos aos seus Cloud Firestore recursos. Ao anexar aspectos aos seus recursos, você pode fazer o seguinte:
- Adicionar metadados comerciais aos recursos
- Pesquise recursos por metadados da empresa e outros metadados personalizados
Para saber mais sobre como criar tipos de aspecto e anexar aspectos ao Cloud Firestore, consulte Gerenciar aspectos e enriquecer metadados.
Pesquisar recursos Cloud Firestore
Use a página de pesquisa do Knowledge Catalog no console do Google Cloud para pesquisar recursos Cloud Firestore.
Acesse a página Pesquisa do Knowledge Catalog.
No painel Filtros , clique em Sistemas e selecione Firestore.
Opcional. Em Aliases de tipo, é possível filtrar os resultados da pesquisa para uma consulta de recurso do Cloud Firestore selecionando um ou mais dos aliases de tipo a seguir:
- Banco de dados
- Database schema
- Outro
Usar consultas para realizar pesquisas por palavra-chave
É possível usar o campo de pesquisa no Knowledge Catalog para realizar consultas de pesquisa por palavra-chave. Por exemplo, é possível inserir
system=Firestore AND type=Database para visualizar todos os Cloud Firestore bancos de dados.
Para mais informações, consulte Sintaxe de pesquisa do Knowledge Catalog.
Para visualizar todos os Cloud Firestore recursos, insira system=Firestore. É possível inserir palavras-chave específicas. Por exemplo, para exibir todas os bancos de dados:Cloud Firestore
system=Firestore AND type=Database
Também é possível usar parênteses e os operadores lógicos AND e OR para expressões complexas. Para saber mais sobre as expressões que você pode usar em
o campo de pesquisa, consulte Sintaxe de pesquisa do Knowledge Catalog.
É possível inserir diretamente consultas de pesquisa para recursos específicos do Cloud Firestore no campo de pesquisa. O formato da string de consulta é o seguinte:
type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"
Substitua:
QUERY_STRING: use a lista a seguir para identificar uma string de consulta com base no tipo de Cloud Firestore recurso que você quer consultar:firestore-databasefirestore-schema
Um exemplo de consulta pode ser semelhante ao seguinte:
type="projects/1234567890/locations/global/entryTypes/firestore-schema"
Pesquisar por tipo de aspecto
O Knowledge Catalog inclui alguns tipos de aspectos integrados que você pode usar para realizar pesquisas.
Para pesquisar por tipo de aspecto, siga estas etapas:
- No painel Aspectos, clique no menu Adicionar mais tipos de aspecto.
- Insira
Firestoree selecione um ou mais dos seguintes tipos de aspecto para limitar os resultados da pesquisa a esse tipo.- Banco de dadosCloud Firestore
- Cloud Firestore Esquema
- Clique em OK.
- Na tabela de resultados, clique no nome de um recurso para visualizar os metadados dele.
- Opcional: aprimore ou visualize seus recursos. Você pode fazer o seguinte:
- Para adicionar uma descrição em rich text do recurso, em Visão geral, clique em Adicionar .
- Para anexar um aspecto ao recurso, em Aspectos, clique em Adicionar .
- Para visualizar os bancos de dados dos membros de uma instância, clique na guia Lista de entradas e depois em Mostrar todas as entradas filhas na pesquisa.
- Em Detalhes da entrada, confira todos os detalhes do recurso. Clique no nome da entrada para detalhar até entradas adicionais.
Pesquisa com linguagem natural em Cloud Firestore
A pesquisa com linguagem natural (visualização) usa a IA para entender consultas semânticas. Ela permite encontrar recursos usando linguagem cotidiana, eliminando a necessidade de sintaxe complexa. Por exemplo, é possível inserir consultas como List all Firestore collections related to sales.
Para mais informações, consulte Sintaxe de pesquisa do Knowledge Catalog.
Pesquisa de sintaxe em Cloud Firestore
A pesquisa por palavra-chave permite encontrar recursos usando palavras-chave, filtros e uma sintaxe definidos. Por exemplo, é possível inserir system=Firestore AND type=Database
para visualizar todos os bancos de dados Cloud Firestore.
Para mais informações, consulte Sintaxe de pesquisa do Knowledge Catalog.
Exemplo de fluxo de trabalho: detalhamento do banco de dados para o esquema
Para detalhar um banco de dados em um esquema, siga estas etapas:
Acesse a página Pesquisa do Knowledge Catalog.
No painel Filtros, selecione Sistemas e, em seguida, Firestore. Se preferir, digite
system=Firestoreno campo de pesquisa.Selecione um banco de dados.
Na página Detalhes do Firestore , clique na guia Lista de entradas e depois em Mostrar todas as entradas filhas na pesquisa.
Na página Detalhes do banco de dados do Firestore , clique na guia Lista de entradas e depois em Mostrar todas as entradas filhas na pesquisa. O Knowledge Catalog mostra os grupos de coleções no banco de dados.
Selecione um nome de grupo de coleções e, na página Detalhes do grupo de coleções , clique em Esquema para visualizar o esquema.
Opcional: para adicionar um tipo de aspecto a um banco de dados, clique no botão Adicionar aspecto.
Preços
Não há custos para armazenar Cloud Firestore metadados técnicos no Knowledge Catalog. Os preços padrão do Knowledge Catalog se aplicam a chamadas de API e ao enriquecimento de outros metadados comerciais. Para mais informações, consulte a página de preços do Knowledge Catalog.
Limitações
- Os resultados da consulta são truncados depois que 10.000 grupos de coleções são ingeridos.
- Durante a ingestão em lote, pode levar até 48 horas para que as atualizações do banco de dados sejam refletidas no Knowledge Catalog.
- Durante a ingestão ao vivo, pode levar até 5 minutos para que as atualizações do banco de dados sejam refletidas no Knowledge Catalog.
- Os grupos de coleções não são atualizados durante a ingestão ao vivo.
- Os esquemas de grupo de coleções são atualizados durante a ingestão ao vivo. No entanto, essa atualização abrange apenas os 100 primeiros campos primitivos de nível superior em ordem alfabética. As informações restantes do esquema são atualizadas de 24 a 48 horas após a ingestão ao vivo.
- O processo de extração pode levar vários minutos.
A seguir
- Sobre o gerenciamento do catálogo de dados no Knowledge Catalog
- Papéis do Identity and Access Management do Knowledge Catalog