Ir para o conteúdo

Atividade de Consulta do Cloud Firestore

Introdução

Uma atividade de Consulta do Cloud Firestore, utilizando sua conexão do Cloud Firestore, consulta documentos dentro de uma coleção no Cloud Firestore e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Consulta do Cloud Firestore

Uma instância de uma atividade de Consulta do Cloud Firestore é criada a partir de uma conexão do Cloud Firestore usando seu tipo de atividade Consulta.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade de Consulta do Cloud Firestore existente pode ser editada a partir destes locais:

Configurar uma atividade de Consulta do Cloud Firestore

Siga estas etapas para configurar uma atividade de Consulta do Cloud Firestore:

Passo 1: Insira um nome e selecione uma coleção

Neste passo, forneça um nome para a atividade e selecione uma coleção. Cada elemento da interface do usuário deste passo é descrito abaixo.

Configuração da atividade de consulta do Cloud Firestore passo 1

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Consulta do Cloud Firestore e não deve conter barras / ou dois pontos :.

  • Selecionar uma Coleção: Esta seção exibe as coleções disponíveis no endpoint do Cloud Firestore.

  • Coleção Selecionada: Após uma coleção ser selecionada, ela é listada aqui.

  • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de coleções. A pesquisa não diferencia maiúsculas de minúsculas. Se as coleções já estiverem exibidas na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar coleções do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar coleções do endpoint do Cloud Firestore. Isso pode ser útil se coleções foram adicionadas ao Google Cloud Firestore. Esta ação atualiza todos os metadados usados para construir a tabela de coleções exibida na configuração.

  • Selecionando uma Coleção: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar uma coleção. Apenas uma coleção pode ser selecionada. As informações disponíveis para cada coleção são obtidas do endpoint do Cloud Firestore:

    • ID: O ID da coleção.

    Dica

    Se a tabela não for preenchida com coleções disponíveis, a conexão do Cloud Firestore pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

  • Continuar em Caso de Erro: Selecione para continuar a execução da atividade se um erro for encontrado para um conjunto de dados em uma solicitação em lote. Se algum erro for encontrado, ele será registrado no log de operações.

  • Salvar e Sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de consulta do Cloud Firestore

  • Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

    O conector do Cloud Firestore usa o Google Firebase JavaScript SDK v8. Consulte a documentação para obter informações sobre os nós e campos do esquema.

    O esquema de dados da solicitação consiste nos seguintes nós e campos:

    Nó/Campo do Esquema de Solicitação Descrição
    item Nó representando os itens que estão sendo consultados.
    filter Campo contendo um destes operadores de consulta:
  • LessThan
  • LessThanOrEqualTo
  • EqualTo
  • GreaterThan
  • GreaterThanOrEqualTo
  • NotEqualTo
  • ArrayContains
  • ArrayContainsAny
  • In
  • NotIn

    • Para mais informações sobre operadores de consulta e suas limitações, consulte a documentação do Cloud Firestore.
    field O campo do documento a ser consultado em relação ao filter e values especificados.
    values Nó contendo os valores da consulta para o filter especificado.

    Nota

    Se você estiver usando os operadores de consulta In ou NotIn no campo filter, todo o array de consulta no nó values é utilizado. Para todos os outros operadores de consulta, apenas o primeiro par type / value do array é utilizado.
    item Nó contendo cada valor de consulta.
    type O tipo de dado da consulta.
    value O valor da consulta para o type especificado.
    limit O número de resultados da consulta a serem retornados; para retornar todos os resultados, defina como 0.
    returnOnlyFieldValues Definir como true retorna apenas os valores consultados; definir como false retorna o documento inteiro.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint do Cloud Firestore. Esta ação também regenera um esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade de Consulta do Cloud Firestore, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para mais detalhes, consulte o menu de ações da atividade em Conceitos básicos do conector.

As atividades de Consulta do Cloud Firestore podem ser usadas como fonte com esses padrões de operação:

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.