Ir para o conteúdo

Atividade de consulta do Cloud Firestore

Introdução

Uma atividade Consulta do Cloud Firestore, usando sua conexão do Cloud Firestore, consulta documentos dentro de uma coleção no Cloud Firestore e se destina a ser usado como uma fonte para fornecer dados em uma operação.

Criar uma atividade de consulta do Cloud Firestore

Uma instância de uma atividade 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 quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criar uma instância de atividade em Reutilização de componentes.

Uma atividade Consulta existente do Cloud Firestore pode ser editada nestes locais:

Configurar uma atividade de consulta do Cloud Firestore

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

Etapa 1: insira um nome e selecione uma coleção

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

Etapa 1 da configuração da atividade de consulta do Cloud Firestore

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

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

  • Coleção selecionada: Depois que uma coleção é selecionada, ela é listada aqui.

  • Pesquisar: Insira qualquer valor de 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 serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar coleções do endpoint ao pesquisar, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualização Ícone de atualização ou a palavra Refresh para recarregar coleções do endpoint do Cloud Firestore. Isso pode ser útil se coleções tiverem sido adicionadas ao Google Cloud Firestore. Esta ação atualiza todos os metadados usados para criar 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 ser bem-sucedido. 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 de lote. Se algum erro for encontrado, ele será gravado no log de operação.

  • 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 nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Revise os esquemas de dados

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

Etapa 2 da 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 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 nestes nós e campos:

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

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

    Nota

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

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

  • Voltar: Clique para armazenar temporariamente a configuração desta 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 nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Próximos passos

Após configurar uma atividade Query do Cloud Firestore, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode configurar as definições da operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu para uma atividade são acessíveis a partir do painel do projeto e da quadro de design. Para obter detalhes, consulte menu de ações de atividade em Noções básicas do conector.

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

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

Quando estiver pronto, implantar e executar a operação e validar o comportamento verificando os logs de operação.