Conectar-se a um banco de dados do Firestore

Use o Firestore para configurar um banco de dados na nuvem NoSQL escalonável para seu serviço do Cloud Run. O Firestore é um banco de dados NoSQL flexível e escalonável para desenvolvimento focado em dispositivos móveis, Web e servidores.

Usando a integração do Cloud Run descrita nesta página, é possível conectar rapidamente seu serviço do Cloud Run a um novo banco de dados do Firestore.

Antes de começar

  • Verifique se o serviço do Cloud Run com que você está integrando já está implantado.
  • Consulte a página de preços do Firestore. A cobrança é feita com base nos recursos individuais usados na integração.

Funções exigidas

Para usar as integrações do Cloud Run, você ou seu administrador precisa conceder papéis do IAM em dois principais diferentes.

Clique para conferir os papéis necessários da sua Conta do Google

Para receber as permissões necessárias para usar as integrações do Cloud Run, peça ao administrador para conceder à sua Conta do Google os seguintes papéis do IAM no projeto:

Clique para conferir os papéis necessários para a conta de serviço

Para implantar o serviço do Cloud Run, use a conta de serviço padrão do Compute Engine criada automaticamente ou especifique uma conta de serviço gerenciado pelo usuário. Essa conta de serviço precisa ter os seguintes papéis:

Conectar um serviço a um novo banco de dados do Firestore

Qualquer mudança na configuração leva à criação de uma nova revisão. As próximas revisões também recebem essa configuração de modo automático, a menos que você faça atualizações explícitas para alterar esse comportamento.

É possível conectar um serviço do Cloud Run a um banco de dados do Firestore usando o console ou a linha de comando.

Console

  1. No console do Google Cloud, acesse a página do Cloud Run.

    Acesse o Cloud Run

  2. Clique no serviço na lista de serviços que você quer usar na integração.

  3. Clique na guia Integrations.

  4. Clique em Adicionar integração.

  5. Clique em Banco de dados do Firestore.

  6. Use o nome padrão ou mude o nome para o valor que você quer usar.

    imagem

  7. Se for necessário ativar uma lista de APIs, clique em Ativar e aguarde a ativação das APIs.

  8. Em Recursos, observe os novos recursos que serão criados como resultado dessa integração.

  9. Clique em Enviar e aguarde a criação da integração e dos recursos. Isso pode levar até 15 minutos.

Linha de comando

  1. Atualizar para a versão mais recente da Google Cloud CLI:

    gcloud components update

  2. Criar a integração:

    gcloud beta run integrations create \
--type=firestore \
--service=SERVICE \

    Substitua:

    • SERVICE pelo nome do serviço do Cloud Run.

    Se quiser, inclua a flag --service-account=SERVICE_ACCOUNT_EMAIL.

    • SERVICE_ACCOUNT_EMAIL pelo endereço de e-mail da conta de serviço gerenciado pelo usuário (PROJECT_NUMBER-compute@developer.gserviceaccount.com) que é usado para implantar o serviço. Omita essa flag se quiser usar a conta de serviço padrão do Compute (SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com).

      Para continuar usando a conta de serviço especificada ao implantar integrações do Cloud Run, execute o seguinte comando:

      gcloud config set runapps/deployment-service-account

  3. Aguarde até 15 minutos. Durante esse tempo, um banco de dados do Firestore totalmente configurado é criado e conectado. Além disso, uma nova revisão do Cloud Run é criada, incluindo variáveis de ambiente que identificam o banco de dados. Quando o processo estiver concluído, a seguinte mensagem será exibida:

    [firestore] integration [firestore-xxx] has been updated successfully.

To connect to the Firestore database, utilize the environment variable
`FIRESTORE_DB_NAME`. This variable is added to the Cloud Run
service for you.

    É possível verificar o status executando gcloud beta run integrations describe.

Conferir integrações de banco de dados do Firestore

Para ver o status atual das integrações de banco de dados do Firestore para seu serviço do Cloud Run:

Console

  1. No console do Google Cloud, acesse a página do Cloud Run.

    Acesse o Cloud Run

  2. Clique no serviço na lista de serviços que você quer usar na integração.

  3. Clique na guia Integrations.

  4. Localize a integração do banco de dados do Firestore em que você tem interesse e clique em Ver detalhes.

Linha de comando

  1. Use o comando a seguir para ver uma lista de integrações disponíveis:

    gcloud beta run integrations list

  2. Usando um nome da lista retornada, exiba os detalhes:

    gcloud beta run integrations describe INTEGRATION_NAME

    Substitua INTEGRATION_NAME pelo nome da sua integração do banco de dados do Firestore.

Excluir integrações de banco de dados do Firestore

A exclusão de uma integração também exclui todos os recursos do Google Cloud associados a ela, mas não exclui o serviço do Cloud Run.

Para excluir uma integração de banco de dados do Firestore no serviço do Cloud Run:

Console

  1. No console do Google Cloud, acesse a página do Cloud Run.

    Acesse o Cloud Run

  2. Clique no serviço do qual você quer excluir uma integração.

  3. Clique na guia Integrations.

  4. Localize a integração do banco de dados do Firebase do seu interesse e clique no ícone de reticências à direita da integração e, em seguida, em Excluir.

Linha de comando

  1. Use o comando a seguir para obter uma lista de integrações disponíveis:

    gcloud beta run integrations list

  2. Usando um nome da lista retornada, exclua a integração:

    gcloud beta run integrations delete INTEGRATION_NAME

    Substitua:

    • INTEGRATION_NAME pelo nome da sua integração do banco de dados do Firestore.

    Se preferir, use as seguintes flags opcionais:

    Opção Descrição
    --service-account O endereço de e-mail da conta de serviço gerenciado pelo usuário para executar a operação de exclusão.

Acessar o banco de dados do Firestore no seu código

Depois de concluir a integração, o Cloud Run adiciona automaticamente a variável de ambiente FIRESTORE_DB_NAME para uso no seu código de serviço do Cloud Run.

Exemplo de código para serviços que usam o Firestore

Consulte a documentação do Firestore para ver exemplos de código do Cloud Run e do Firestore.

Limitações