Criar e gerenciar consultas salvas

Esta página descreve como criar e gerenciar consultas salvas. Ao escrever consultas no Firestore Studio, você pode salvar e gerenciar essas consultas. Para mais informações, consulte Visão geral das consultas salvas .

O recurso de consultas salvas está disponível apenas no console, e não usando APIs.

Funções exigidas

Para ter as permissões necessárias para usar consultas salvas, peça ao administrador para conceder a você os seguintes papéis do Identity and Access Management (IAM) no projeto:

  • Para visualizar consultas salvas: Leitor do Cloud Datastore (roles/datastore.viewer)
  • Para visualizar, criar, modificar e excluir consultas salvas: Usuário do Cloud Datastore (roles/datastore.user)
  • Para administrar, visualizar, criar, modificar e excluir consultas salvas: Proprietário do Cloud Datastore (roles/datastore.owner). Esse papel tem permissões amplas e oferece acesso total ao Firestore com compatibilidade com o MongoDB, apenas para uso por administradores.

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para usar consultas salvas. Para saber mais sobre as permissões necessárias, consulte Permissões necessárias.

Permissões necessárias

Para criar, visualizar, modificar e excluir consultas salvas, você precisa das seguintes permissões do IAM no nível do projeto:

Ação Permissões do IAM necessárias
Criar consultas salvas
  • databasesconsole.studioQueries.create
Ver consultas salvas
  • databasesconsole.studioQueries.search
  • databasesconsole.locations.get
  • databasesconsole.locations.list
Modificar consultas salvas
  • databasesconsole.studioQueries.update
Excluir consultas salvas
  • databasesconsole.studioQueries.delete
Administrar consultas salvas
(apenas para uso por administradores)
  • databasesConsole.studioQueries.list
  • databasesconsole.locations.list

Também é possível conseguir essas permissões usando papéis personalizados ou outros papéis predefinidos.

O papel de Usuário de consultas do Studio (roles/databasesconsole.studioQueryUser) oferece acesso para criar, visualizar e gravar consultas salvas. Esse papel atende às necessidades da maioria dos usuários.

Conceda o papel de Admin de consultas do Studio (roles/databasesconsole.studioQueryAdmin) apenas aos administradores. Para mais informações sobre o IAM do Firestore com compatibilidade com o MongoDB, consulte Identity and Access Management .

Criar uma consulta salva

Para criar uma consulta salva, siga estas etapas:

  1. Acesse a página Todos os bancos de dados no Google Cloud console.
    Todos os bancos de dados
  2. Selecione um banco de dados do Firestore com compatibilidade com o MongoDB em que você quer criar uma consulta salva.
  3. No menu de navegação, clique em Firestore Studio.
  4. No painel Explorer da página do Firestore Studio, navegue até a seção Coleções.
  5. Clique em uma coleção para abrir uma nova guia do editor. Opcional: clique em Ver ações ao lado de uma coleção. Em seguida, clique em Consultar coleção para abrir uma nova guia do editor.
  6. No editor de consultas, insira uma consulta.
  7. Clique em Salvar.
  8. Na caixa de diálogo Salvar consulta, insira um nome para a consulta salva.
  9. Clique em Salvar.

Abrir e executar uma consulta salva

Para abrir uma consulta salva como uma nova consulta, siga estas etapas:

  1. No painel Explorer da página Firestore Studio, navegue até a seção Consultas.
  2. Clique em uma consulta salva para abri-la em uma nova guia do editor. Opcional: clique em Ver ações ao lado de uma consulta salva. Em seguida, clique em Abrir consulta para abri-la em uma nova guia do editor.
  3. Clique em Executar.

Atualizar uma consulta salva

Para atualizar uma consulta salva, siga estas etapas:

  1. No painel Explorer da página Firestore Studio, navegue até a seção Consultas.
  2. Clique em uma consulta salva para abri-la em uma nova guia do editor. Opcional: clique em Ver ações ao lado de uma consulta salva. Em seguida, clique em Abrir consulta para abri-la em uma nova guia do editor.
  3. Modifique a consulta.
  4. Para salvar a consulta modificada, clique em Salvar.

Visualizar e gerenciar uma lista de todas as consultas salvas

Para visualizar uma lista de todas as consultas salvas no projeto, siga estas etapas:

  1. Acesse a página Todos os bancos de dados no Google Cloud console.
    Todos os bancos de dados
  2. Selecione qualquer banco de dados. Como uma consulta salva é filha de um projeto, desde que você tenha o papel necessário, é possível visualizar todas as consultas salvas no projeto de qualquer banco de dados.
  1. Selecione qualquer banco de dados.
  2. No painel Explorer da página Firestore Studio, navegue até a seção Consultas.
  3. Clique em Ver ações ao lado de uma consulta salva. Em seguida, clique em Gerenciar consultas.

    A página Consultas salvas será aberta. Essa página lista todas as consultas salvas neste projeto, incluindo consultas salvas para outros Google Cloud produtos.

É possível pesquisar, filtrar, visualizar e excluir consultas na página Consultas salvas. Não é possível editar uma consulta na página Consultas salvas.

Excluir uma consulta salva

É possível excluir uma consulta salva na página Firestore Studio ou na página Consultas salvas no Google Cloud console.

  1. No painel Explorer da página Firestore Studio, navegue até a seção Consultas.
  2. Clique em Ver ações ao lado da consulta salva que você quer excluir. Em seguida, para excluir a consulta salva, clique em Excluir consulta.
  3. Na caixa de diálogo Excluir consulta, clique em Excluir.

Também é possível excluir uma consulta salva na página Consultas salvas. Para excluir uma consulta salva na página Consultas salvas, siga estas etapas:

  1. Navegue até a página Consultas salvas.
  2. Clique em Ver ações ao lado da consulta salva que você quer excluir.
  3. Clique em Excluir consulta para excluir a consulta salva.
  4. Na caixa de diálogo Excluir consulta, clique em Excluir.

A seguir