Usar o Firestore Studio na edição Standard

Usar o Firestore Studio na edição Standard

É possível gerenciar a edição Standard do Firestore por meio das seguintes ações no Google Cloud console:

• Ver, consultar, adicionar, editar e excluir dados.
• Gerenciar índices.
• Gerenciar regras de segurança.

Ver dados

É possível ver todos os dados da edição Standard do Firestore no Google Cloud console. No visualizador de dados da edição Standard do Firestore, clique em um documento ou em uma coleção para abrir os dados aninhados nesse item.

1. Noconsole, acesse a página Bancos de dados. Google Cloud

   Acessar "Bancos de dados"

2. Selecione o banco de dados necessário na lista de bancos de dados.

3. No menu de navegação, clique em Firestore Studio.

Abrir um caminho específico

Para abrir um documento ou uma coleção em um caminho específico, use o Editar caminho botão :

Documentos principais inexistentes

Um documento pode existir mesmo se um ou mais dos seus principais estiverem ausentes. Por exemplo, o documento no caminho /mycoll/mydoc/mysubcoll/mysubdoc pode existir mesmo se o documento principal /mycoll/mydoc não existir. O visualizador de dados da edição Standard do Firestore mostra documentos principais inexistentes da seguinte maneira:

• Na lista de documentos de uma coleção, os IDs de documentos principais inexistentes estão em itálico.
• Em um painel de informações de um documento principal inexistente, o visualizador de dados indica que ele está ausente.

Aviso: os documentos principais inexistentes aparecem no console, mas eles não aparecem em consultas e snapshots. Você precisa criar o documento para incluí-lo nos resultados da consulta.

Filtrar dados

É possível filtrar documentos em uma coleção com base no valor do campo e nas ==, !-, >, >=, <, <=, in, not-in, array-contains, array-contains-any condições. Por exemplo, é possível mostrar apenas documentos em que o valor do campo firstname é igual a Sam. Para aplicar um filtro de coleção:

1. Clique no botão de filtro ao lado do ID de uma coleção:

   

2. No menu Adicionar filtros , selecione um campo de documento, uma condição de filtro e uma ordem de classificação.

   

3. Clique em Aplicar.

Para remover um filtro de coleção, abra o mesmo menu e clique em Limpar filtro.

Consultar dados

É possível consultar documentos na guia Criador de consultas da página do Firestore Studio.

1. Noconsole, acesse a página Bancos de dados. Google Cloud

   Acessar "Bancos de dados"

2. Selecione o banco de dados necessário na lista de bancos de dados.

3. No menu de navegação, clique em Firestore Studio.

4. Clique na guia Criador de consultas.

5. Selecione um escopo de consulta.

   Selecione Coleção para consultar uma única coleção. No campo de texto, insira um caminho para uma coleção.

   Selecione Grupo de coleções para consultar todas as que têm o mesmo ID. No campo Grupo de coleções, insira o ID de um grupo de coleções.

   A tabela mostra automaticamente os documentos da coleção ou grupo especificado.

6. Clique em Adicionar à consulta para filtrar o conjunto retornado de documentos. Por padrão, o criador de consultas adiciona uma cláusula WHERE, que é possível modificar usando os menus suspensos e os campos de texto ou mudar para uma das outras cláusulas disponíveis. Para continuar criando consultas mais complexas, clique em Adicionar à consulta.

   Para remover uma cláusula de consulta, clique no botão de remoção. Para remover todas as cláusulas de consulta, clique em Limpar.

   Observação: as consultas precisam atender aos requisitos e limitações da edição Standard do Firestore para consultas. Caso contrário, ela falha, e a página retorna um erro que descreve o motivo.

7. Clique em Executar para recuperar os resultados do seu banco de dados.

   

Dica: as consultas executadas são armazenadas no histórico do navegador. Durante a sessão, é possível avançar e voltar no navegador para acessar consultas recentes. Você pode adicionar consultas aos favoritos para acessar com frequência ou compartilhar com outras pessoas.

Requisitos e limitações da consulta

Ao usar o criador de consultas, considere os seguintes requisitos e limitações para consultas.

• Todas as consultas precisam ser compatíveis com um ou mais índices. Se o banco de dados não encontrar um índice compatível com a consulta, ele retornará um erro com um link para criar o índice necessário.

  

• As cláusulas ORDER BY precisam ser correspondentes aos campos nas cláusulas WHERE e vir na mesma ordem. Por padrão, os resultados são ordenados por ID de documento. Se você filtrar por qualquer outro campo com algo diferente de uma igualdade (==), adicione uma cláusula ORDER BY para esse campo.

  

• Cláusulas de consulta de intervalo (<, <=, >, >=) e de valores diferentes (!=, not-in) precisam filtrar no mesmo campo.

Para mais detalhes, confira Limitações de consulta.

Gerenciar dados

Na edição Standard do Firestore, armazene dados em documentos que podem ser organizados em coleções. Antes de começar a adicionar dados, saiba mais sobre o modelo de dados da edição Standard do Firestore.

É possível adicionar, editar e excluir documentos e coleções no Console do Firebase. Para gerenciar seus dados no Console do GCP, acesse a página Firestore Studio:

1. Noconsole, acesse a página Bancos de dados. Google Cloud

   Acessar "Bancos de dados"

2. Selecione o banco de dados necessário na lista de bancos de dados.

3. No menu de navegação, clique em Firestore Studio.

Atenção: as operações de leitura, gravação e exclusão realizadas no console são contabilizadas como uso da edição Standard do Firestore.

Adicionar dados

1. Clique em Iniciar coleção.
2. Insira um ID de coleção. Insira um ID de documento. A edição Standard do Firestore irá gerar o ID do documento, mas você pode substituí-lo por um ID de documento específico. Adicione campos para os dados no documento.
3. Clique em Salvar. Sua nova coleção e documento aparecem na visualização de dados.
4. Para adicionar mais documentos à coleção, clique em Adicionar documento.

Edite dados

1. Clique em uma coleção para exibir os documentos dela. Depois, clique em um documento para ver os campos e subcoleções dele.
2. Clique em um campo para editar o valor dele. Para adicionar campos ou subcoleções ao documento selecionado, clique em Adicionar campo ou Iniciar coleção.

Excluir dados

É possível excluir documentos ou coleções do visualizador de dados.

Observação: Em alguns casos, excluir um grande número de documentos pode fazer o visualizador de dados carregar lentamente ou retornar um erro de tempo limite. Isso se aplica a operações de exclusão realizadas no visualizador de dados e em outros lugares.

Para excluir uma coleção, faça o seguinte:

1. Selecione a coleção que você quer excluir.
2. Clique no ícone de menu na parte superior da coluna de documentos e depois clique em Excluir coleção.

Para excluir um documento:

1. Selecione o documento que você quer excluir.
2. Clique no ícone de menu na parte superior da coluna de detalhes do documento. Selecione Excluir documento ou Excluir campos do documento.

Ao excluir um documento, você também exclui todos os dados e as subcoleções dele.

Excluir os campos de um documento não exclui as subcoleções. Embora esteja vazio, o documento ainda existe e pode aparecer nos resultados da consulta.

Para excluir um campo específico de um documento, faça o seguinte:

1. Selecione o documento para ver os campos dele.
2. Clique no ícone de exclusão ao lado do campo que você quer remover.

Como gerenciar regras de segurança do Firestore

É possível gerenciar e implantar regras de segurança do Firestore diretamente no Google Cloud console. O editor de regras está disponível para o Firestore no modo nativo nas edições Standard e Enterprise.

Usar o Google Cloud console

Observação: o Google Cloud console não oferece suporte à implantação de regras de segurança do Firestore no banco de dados (default). Para gerenciar regras do (default) banco de dados, use o Console do Firebase ou a CLI do Firebase.

Permissões necessárias

Para gerenciar e implantar regras de segurança no Google Cloud console, você precisa das seguintes permissões do IAM:

• firebaserules.releases.create
• firebaserules.releases.delete
• firebaserules.releases.update
• firebaserules.rulesets.create
• firebaserules.rulesets.delete
• firebaserules.rulesets.list
• firebaserules.rulesets.test (necessário para usar o simulador de regras)

Para implantar regras no Google Cloud console:

1. Noconsole, acesse a página Bancos de dados. Google Cloud

   Acessar "Bancos de dados"

2. Clique no ID do banco de dados que você quer gerenciar.

3. No menu de navegação, clique em Segurança.

4. Clique na guia Regras do Firestore.

5. No editor de regras, confira as regras. Para editar, clique em Novo conjunto de regras ou Clonar conjunto de regras e modifique as regras.

6. Clique em Publicar para implantar as mudanças.

Também é possível conferir conjuntos de regras anteriores na linha do tempo e clonar ou restaurar.

Como ativar o Firebase

Para editar as regras de segurança do Firestore do banco de dados (default) usando o Console do Firebase ou a CLI do Firebase, ative o Firebase para seu Google Cloud projeto. Se o Firebase não estiver ativado, ative-o em a página Segurança no Google Cloud console:

O recurso de regras de segurança do Firestore é integrado ao Firebase Auth e aos SDKs do Firebase (Web, Android, plataformas Apple). Para mais informações sobre o Firebase e o Firestore, consulte os primeiros passos com o Firebase.

Gerenciar índices

Para criar novos índices para suas consultas e gerenciar os índices já existentes no Console do Firebase, acesse a guia Bancos de dados e armazenamento > Firestore > Índices. Saiba mais sobre como gerenciar índices.