Diretiva TYPE em consultas FOR XML

Artigo
09/04/2023

Aplica-se a:SQL Server Banco de Dados SQL do Azure Instância Gerenciada de SQL do Azure

O suporte do SQL Server para o tipo de dados xml (Transact-SQL) possibilita a solicitação opcional de que o resultado de uma consulta FOR XML seja retornado como xml ao especificar a diretiva TYPE. Isso permite processar o resultado de uma consulta FOR XML no servidor. Por exemplo, é possível especificar um XQuery nela, atribuir o resultado a uma variável de tipo xml ou gravar Consultas FOR XML aninhadas.

Observação

O SQL Server retorna dados de instância do tipo de dados xml para o cliente como resultado de diferentes constructos de servidor, como consultas FOR XML que usam a diretiva TYPE, ou nos casos em que o tipo de dados xml é usado para retornar valores de dados de instância XML de colunas da tabela SQL e de parâmetros de saída. No código do aplicativo cliente, o provedor ADO.NET solicita que essas informações de tipo de dados xml sejam enviadas em uma codificação binária do servidor. Porém, se você estiver usando FOR XML sem a diretiva TYPE, os dados XML retornarão como um tipo de cadeia de caracteres. De qualquer forma, o provedor cliente sempre poderá controlar qualquer formulário de XML. Observe que FOR XML de nível superior sem a diretiva TYPE não pode ser usado com cursores.

Exemplos

Os exemplos a seguir ilustram o uso da diretiva TYPE com consultas FOR XML.

Recuperando resultados de consultas FOR XML como tipo xml

A consulta a seguir recupera informações de contato de clientes da tabela Contacts . Como a diretiva TYPE é especificada em FOR XML, o resultado é retornado como o tipo xml .

USE AdventureWorks2022;
Go
SELECT BusinessEntityID, FirstName, LastName
FROM Person.Person
ORDER BY BusinessEntityID
FOR XML AUTO, TYPE;

Este é o resultado parcial:

<Person.Person BusinessEntityID="1" FirstName="Ken" LastName="Sánchez"/>
<Person.Person BusinessEntityID="2" FirstName="Terri" LastName="Duffy"/>
...

Atribuindo resultados de consultas FOR XML a uma variável de tipo xml

No exemplo a seguir, um resultado de FOR XML é atribuído a uma variável de tipo xml , @x. A consulta recupera informações de contato, como BusinessEntityID, FirstName, LastNamee números de telefone adicionais, na coluna AdditionalContactInfo de xmlTYPE. Como a cláusula FOR XML especifica a diretiva TYPE , o XML é retornado como o tipo xml e é atribuído a uma variável.

USE AdventureWorks2022;
GO
DECLARE @x xml;
SET @x = (
   SELECT BusinessEntityID,
          FirstName,
          LastName,
          AdditionalContactInfo.query('
declare namespace aci="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactInfo";
declare namespace act="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactTypes";
              //act:telephoneNumber/act:number') as MorePhoneNumbers
   FROM Person.Person
   FOR XML AUTO, TYPE);
SELECT @x;
GO

Consultando resultados de uma consulta FOR XML

As consultas FOR XML retornam XML. Portanto, é possível aplicar métodos do tipo xml, como query() e value(), ao resultado XML retornado por consultas FOR XML.

Na consulta a seguir, o método query() do tipo de dados xml é usado para consultar o resultado da consulta FOR XML . Para obter mais informações, consulte Método query() (tipo de dados xml).

USE AdventureWorks2022;
GO
SELECT (SELECT BusinessEntityID, FirstName, LastName, AdditionalContactInfo.query('
DECLARE namespace aci="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactInfo";
DECLARE namespace act="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactTypes";
//act:telephoneNumber/act:number
') AS PhoneNumbers
FROM Person.Person
FOR XML AUTO, TYPE).query('/Person.Person[1]');

A consulta interna SELECT ... FOR XML retorna um resultado de tipo xml para o qual SELECT externo aplica o método query() ao tipo xml . Observe a diretiva TYPE especificada.

Este é o resultado:

<Person.Person BusinessEntityID="1" FirstName="Ken" LastName="Sánchez">
  <PhoneNumbers>
    <act:number xmlns:act="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactTypes">111-111-1111</act:number>
    <act:number xmlns:act="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactTypes">112-111-1111</act:number>
  </PhoneNumbers>
</Person.Person>

Na consulta a seguir, o método value() do tipo de dados xml é usado para recuperar um valor do resultado XML retornado pela consulta SELECT...FOR XML . Para obter mais informações, consulte Método value() (tipo de dados xml).

USE AdventureWorks2022;
GO
DECLARE @FirstPhoneFromAdditionalContactInfo varchar(40);
SELECT @FirstPhoneFromAdditionalContactInfo =
( SELECT BusinessEntityID, FirstName, LastName, AdditionalContactInfo.query('
declare namespace aci="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactInfo";
declare namespace act="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactTypes";
   //act:telephoneNumber/act:number
   ') AS PhoneNumbers
   FROM Person.Person Contact
   FOR XML AUTO, TYPE).value('
declare namespace act="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ContactTypes";
  /Contact[@BusinessEntityID="1"][1]/PhoneNumbers[1]/act:number[1]', 'varchar(40)'
);
SELECT @FirstPhoneFromAdditionalContactInfo;

A expressão de caminho XQuery no método value() recupera o primeiro número de telefone de contato de um cliente cujo BusinessEntityID é 1.

Observação

Se a diretiva TYPE não for especificada, o resultado da consulta FOR XML será retornado como o tipo nvarchar(max).

Usando resultados de consulta FOR XML em INSERT, UPDATE e DELETE (DML do Transact-SQL)

O exemplo a seguir demonstra como consultas FOR XML podem ser usadas em instruções DML (linguagem de manipulação de dados). No exemplo, o FOR XML retorna uma instância do tipo xml . A instrução INSERT insere esse XML em uma tabela.

CREATE TABLE T1(intCol int, XmlCol xml);
GO
INSERT INTO T1
VALUES(1, '<Root><ProductDescription ProductModelID="1" /></Root>');
GO

CREATE TABLE T2(XmlCol xml)
GO
INSERT INTO T2(XmlCol)
SELECT (SELECT XmlCol.query('/Root')
        FROM T1
        FOR XML AUTO,TYPE);
GO

Confira também

FOR XML (SQL Server)