FOR XML (SQL Server)

Aplica-se a:SQL ServerBanco de Dados SQL do AzureInstância Gerenciada de SQL do Azure

Uma consulta SELECT retorna resultados como um conjunto de linhas. Opcionalmente, é possível recuperar resultados formais de uma consulta SQL como XML com a especificação da cláusula FOR XML na consulta. A cláusula FOR XML pode ser usada em consultas de nível superior e em subconsultas. A cláusula FOR XML de nível superior pode ser usada apenas na instrução SELECT. Em subconsultas, FOR XML pode ser usado nas instruções INSERT, UPDATE e DELETE. FOR XML também pode ser usado em instruções de atribuição.

Em uma cláusula FOR XML, você especifica um destes modos:

• RAW
• AUTO
• EXPLICIT
• PATH

O modo RAW gera um único elemento <row> por linha no conjunto de linhas retornado pela instrução SELECT. É possível gerar hierarquia de XML escrevendo consultas FOR XML aninhadas.

O modo AUTO gera aninhamento no XML resultante usando heurística com base na maneira como a instrução SELECT é especificada. Você tem controle mínimo sobre a forma do XML gerado. As consultas FOR XML aninhadas podem ser escritas para gerar hierarquia de XML além da forma do XML gerada pela heurística do modo AUTO.

O modo EXPLICIT permite mais controle sobre a forma do XML. É possível misturar atributos e elementos à vontade para decidir a forma do XML. Um formato específico é necessário para o conjunto de linhas resultante que é gerado por causa da execução da consulta. Em seguida, esse formato do conjunto de linhas é mapeado na forma do XML. A força do modo EXPLICIT é misturar atributos e elementos à vontade, criar wrappers e propriedades aninhadas complexas, criar valores separados por espaços (por exemplo, o atributo OrderID pode ter uma lista de valores de ID de ordem) e conteúdo misto.

No entanto, a escrita de consultas no modo EXPLICIT pode ser trabalhosa. É possível usar algumas das novas funcionalidades de FOR XML, como escrita da diretiva TYPE e de consultas no modo FOR XML RAW/AUTO/PATH, em vez de usar o modo EXPLICIT para gerar as hierarquias. As consultas FOR XML aninhadas podem produzir qualquer XML que possa ser gerado usando o modo EXPLICIT. Para obter mais informações, consulte Usar consultas FOR XML aninhadas e Diretiva TYPE em consultas FOR XML.

O modo PATH em conjunto com a funcionalidade de consulta FOR XML aninhada fornece a flexibilidade do modo EXPLICIT de uma maneira mais simples.

Esses modos estão em efeito apenas para a execução da consulta para a qual eles estão definidos. Eles não afetam os resultados de nenhuma consulta subsequente.

FOR XML não é válido para nenhuma seleção usada com uma cláusula FOR BROWSE.

Exemplo

A instrução SELECT a seguir recupera informações das tabelas Sales.Customer e Sales.SalesOrderHeader o banco de dados AdventureWorks2022 . Essa consulta especifica o modo AUTO na cláusula FOR XML :

USE AdventureWorks2022;
GO
SELECT Cust.CustomerID,
       OrderHeader.CustomerID,
       OrderHeader.SalesOrderID,
       OrderHeader.Status
FROM Sales.Customer Cust 
INNER JOIN Sales.SalesOrderHeader OrderHeader
ON Cust.CustomerID = OrderHeader.CustomerID
FOR XML AUTO;

Cláusula FOR XML e nomes de servidores

Quando uma instrução SELECT com uma cláusula FOR XML especifica um nome de quatro partes na consulta, o nome do servidor não é retornado no documento XML resultante quando a consulta é executada no computador local. No entanto o nome do servidor é retornado como o nome de quatro partes quando a consulta é executada em um servidor de rede.

Por exemplo, considere esta consulta:

SELECT TOP 1 LastName
  FROM ServerName.AdventureWorks2022.Person.Person
  FOR XML AUTO;

 

Servidor local: quando ServerName é um servidor local, a consulta retorna o seguinte texto:

<AdventureWorks2022.Person.Person LastName="Achong" />  

 

Servidor de rede: quando ServerName é um servidor de rede, a consulta retorna o seguinte texto:

<ServerName.AdventureWorks2022.Person.Person LastName="Achong" />

 

Evitar ambiguidade: essa possível ambiguidade pode ser evitada com a especificação desse alias:

SELECT TOP 1 LastName
  FROM ServerName.AdventureWorks2022.Person.Person x
  FOR XML AUTO;

Agora, a consulta não ambígua retorna o seguinte texto:

<x LastName="Achong"/>

Confira também

Sintaxe básica da cláusula FOR XML
Usar o modo RAW com FOR XML
Usar o modo AUTO com FOR XML
Usar o modo EXPLICIT com FOR XML
Usar o modo PATH com FOR XML
OPENXML (SQL Server)
Adicionar namespaces a consultas com WITH XMLNAMESPACES