Consultar dados usando FetchXML no Dataverse

FetchXML é uma linguagem de consulta baseada em XML proprietária usada para recuperar dados do Dataverse. Consulte a referência FetchXml para os elementos usados para recuperar dados.

Observação

Você também pode usar FetchXML para definir exibições para aplicativos controlados por modelos e alguns recursos de relatório. Este artigo não inclui elementos e atributos para esses casos de uso. Saiba mais sobre como personalizar exibições de aplicativo orientadas por modelo com código.

Redigir uma consulta FetchXML

Todas as consultas são baseadas em uma única tabela. O elemento raiz é fetch. Use o elemento de entidade para selecionar a tabela da qual a consulta recupera dados. O exemplo a seguir representa uma consulta FetchXML simples:

<fetch top='5'>
  <entity name='account'>
      <attribute name='name' />
  </entity>
</fetch>

Essa consulta retorna a coluna Name das cinco primeiras linhas da tabela Account, usando o LogicalName da tabela para definir o atributo entityname.

Limitar o número de linhas

Para limitar o número de linhas retornadas, use o atributo do elemento fetchtop. Sem o atributo top, o Dataverse retorna até 5.000 linhas de tabelas padrão e 500 linhas de tabelas elásticas.

Como alternativa, especifique um número de registros a serem retornados usando paginação. Não use o top atributo quando você solicita páginas de dados. Saiba como solicitar resultados paginados

Você não pode usar top quando solicita uma contagem de linhas usando o returntotalrecordcount atributo. Saiba como contar linhas

Retornar resultados distintos

Use o atributo fetchdistinct para obrigar a consulta a eliminar quaisquer valores duplicados nos resultados.

Se você usar o distinct atributo, deverá adicionar pelo menos um elemento de ordem para ter uma paginação consistente.

Quando você usa o distinct atributo, os resultados retornados não incluem valores de chave primária para cada registro porque representam uma agregação de todos os valores distintos.

Recuperar dados com FetchXML

Para obter resultados da consulta, envie sua solicitação para o Dataverse. Saiba como recuperar dados do Dataverse usando FetchXml.

Refinar sua consulta

Depois de selecionar a tabela com a qual iniciar a consulta, refina a consulta para obter os dados necessários. Os artigos a seguir explicam como concluir sua consulta.

Artigo	Tarefa
Selecionar colunas	Especifique quais colunas de dados devem ser retornadas.
Unir tabelas	Especifique quais tabelas relacionadas retornam nos resultados.
Ordenar linhas	Especifique a ordem de classificação das linhas a serem retornadas.
Filtrar linhas	Especifique quais linhas de dados devem ser retornadas.
Resultados da página	Especifique quantas linhas de dados devem ser retornadas com cada solicitação.
Agregar dados	Como agrupar e agregar os dados retornados.
Contar número de linhas	Como obter uma contagem do número de linhas retornadas.
Otimizações de desempenho	Como otimizar o desempenho.

Ferramentas da comunidade

Há ferramentas gratuitas para redigir e testar solicitações FetchXML:

• XrmToolboxFetchXmlBuilder
• Power Platform ToolboxFetchXML Studio

Observação

A Microsoft não dá suporte a ferramentas criadas pela comunidade. Se você tiver dúvidas ou problemas com as ferramentas da comunidade, entre em contato com o editor da ferramenta.

Usar FetchXML como um parâmetro de mensagem

Você também pode usar FetchXML como um parâmetro para operações do Dataverse, como as seguintes mensagens:

Nome da mensagem	Classe de solicitação do SDK para .NET	Operação da API Web
BackgroundSendEmail	BackgroundSendEmailRequest	Ação BackgroundSendEmail
BulkDetectDuplicates	BulkDetectDuplicatesRequest	Ação BulkDetectDuplicates
FullTextSearchKnowledgeArticle	FullTextSearchKnowledgeArticleRequest	Ação FullTextSearchKnowledgeArticle
FetchXmlToQueryExpression	FetchXmlToQueryExpressionRequest	Função FetchXmlToQueryExpression
SendBulkMail	SendBulkMailRequest	Ação SendBulkMail
Rollup	RollupRequest	Função de resumo

Próximas Etapas 

Saiba como selecionar colunas.

Selecionar colunas

Saiba como recuperar dados usando FetchXML.

Recuperar dados com FetchXml.