Adición de espacios de nombres a consultas mediante WITH XMLNAMESPACES

Artigo
04/26/2023

Se aplica a: SQL Server Azure SQL Database Azure SQL Managed Instance

WITH XMLNAMESPACES (Transact-SQL) proporciona compatibilidad con los URI de espacio de nombres de la siguiente manera:

Hace que las asignaciones de prefijos de espacio de nombres a los URI estén disponibles al generar XML mediante FOR XML .
Hace que las asignaciones de espacios de nombres a los URI estén disponibles para el contexto de espacio de nombres estático de los métodos del tipo de datos xml.

Uso de WITH XMLNAMESPACES en consultas FOR XML

WITH XMLNAMESPACES permite incluir espacios de nombres XML en las consultas FOR XML. Por ejemplo, considere la siguiente consulta FOR XML:

SELECT ProductID, Name, Color
FROM   Production.Product
WHERE  ProductID IN (316, 317)
FOR XML RAW;

El resultado es el siguiente:

<row ProductID="316" Name="Blade" />
<row ProductID="317" Name="LL Crankarm" Color="Black" />

Para agregar espacios de nombres al XML generado por la consulta FOR XML, especifique primero las asignaciones de los prefijos de espacio de nombres a los URI mediante la cláusula WITH NAMESPACES. A continuación, utilice los prefijos de espacio de nombres para especificar los nombres en la consulta, como se muestra en la siguiente consulta modificada. La cláusula WITH XMLNAMESPACES especifica el prefijo del espacio de nombres (ns1) a la asignación de URI (uri). Después, el prefijo ns1 se usa para especificar los nombres de elementos y atributos que la cláusula FOR XML debe generar.

WITH XMLNAMESPACES ('uri' as ns1)
SELECT ProductID as 'ns1:ProductID',
       Name      as 'ns1:Name',
       Color     as 'ns1:Color'
FROM  Production.Product
WHERE ProductID IN (316, 317)
FOR XML RAW ('ns1:Prod'), ELEMENTS;

El resultado XML incluye los prefijos de espacio de nombres:

<ns1:Prod xmlns:ns1="uri">
  <ns1:ProductID>316</ns1:ProductID>
  <ns1:Name>Blade</ns1:Name>
</ns1:Prod>
<ns1:Prod xmlns:ns1="uri">
  <ns1:ProductID>317</ns1:ProductID>
  <ns1:Name>LL Crankarm</ns1:Name>
  <ns1:Color>Black</ns1:Color>
</ns1:Prod>

La siguiente información se aplica a la cláusula WITH XMLNAMESPACES:

Se admite solamente en los modos RAW, AUTO y PATH de las consultas FOR XML. No se admite el modo EXPLICIT.
Afecta a los prefijos de espacio de nombres de las consultas FOR XML y a los métodos del tipo de datos xml , pero no al analizador XML. Por ejemplo, la consulta siguiente devuelve un error porque el documento XML no tiene ninguna declaración de espacio de nombres para el prefijo myNS.

Las directivas FOR XML, XMLSCHEMA y XMLDATA no se pueden usar cuando se usa una cláusula WITH XMLNAMESPACES.

CREATE TABLE T (x xml);
GO
WITH XMLNAMESPACES ('https://abc' as myNS )
INSERT INTO T VALUES('<myNS:root/>');
GO

Uso de la directiva XSINIL

No se puede definir el prefijo xsi en la cláusula WITH XMLNAMESPACES si usa la directiva ELEMENTS XSINIL. En su lugar, se agrega automáticamente cuando se usa ELEMENTS XSINIL. La consulta siguiente usa ELEMENTS XSINIL, que genera XML centrado en elementos donde los valores NULL se asignan a elementos que tienen el atributo xsi:nil establecido en True.

WITH XMLNAMESPACES ('uri' as ns1)
SELECT ProductID as 'ns1:ProductID',
       Name      as 'ns1:Name',
       Color     as 'ns1:Color'
FROM Production.Product
WHERE ProductID = 316
FOR XML RAW, ELEMENTS XSINIL;

El resultado es el siguiente:

<row xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="uri">
  <ns1:ProductID>316</ns1:ProductID>
  <ns1:Name>Blade</ns1:Name>
  <ns1:Color xsi:nil="true" />
</row>

Especificar espacios de nombres predeterminados

En lugar de declarar un prefijo de espacio de nombres, se puede declarar un espacio de nombres predeterminado mediante la palabra clave DEFAULT. En la consulta FOR XML, enlazará el espacio de nombres predeterminado con los nodos XML del XML resultante. En el ejemplo siguiente, WITH XMLNAMESPACES especifica dos prefijos de espacio de nombres definidos con un espacio de nombres predeterminado.

WITH XMLNAMESPACES ('uri1' as ns1,
                    'uri2' as ns2,
                    DEFAULT 'uri2')
SELECT ProductID,
      Name,
      Color
FROM Production.Product
WHERE ProductID IN (316, 317)
FOR XML RAW ('ns1:Product'), ROOT('ns2:root'), ELEMENTS;

La consulta FOR XML genera XML centrado en elementos. La consulta usa los prefijos del espacio de nombres en los nodos de nomenclatura. En la cláusula SELECT, IDdeProducto, Nombre y Color no especifican un nombre con ningún prefijo. Por lo tanto, los elementos correspondientes en el XML resultante pertenecen al espacio de nombres predeterminado.

<ns2:root xmlns="uri2" xmlns:ns2="uri2" xmlns:ns1="uri1">
  <ns1:Product>
    <ProductID>316</ProductID>
    <Name>Blade</Name>
  </ns1:Product>
  <ns1:Product>
    <ProductID>317</ProductID>
    <Name>LL Crankarm</Name>
    <Color>Black</Color>
  </ns1:Product>
</ns2:root>

La consulta siguiente es similar a la anterior, con la diferencia de que se especifica el modo AUTO de FOR XML.

WITH XMLNAMESPACES ('uri1' as ns1,  'uri2' as ns2,DEFAULT 'uri2')
SELECT ProductID,
      Name,
      Color
FROM Production.Product as "ns1:Product"
WHERE ProductID IN (316, 317)
FOR XML AUTO, ROOT('ns2:root'), ELEMENTS;

Uso de espacios de nombres predefinidos

Si se utilizan espacios de nombres predefinidos, excepto los espacios de nombres xml y xsi cuando se utiliza ELEMENTS XSINIL, es necesario especificar explícitamente el enlace con el espacio de nombres por medio de WITH XMLNAMESPACES. En la consulta siguiente se define explícitamente el enlace entre el prefijo de espacio de nombres y el URI para el espacio de nombres predefinido (urn:schemas-microsoft-com:xml-sql).

WITH XMLNAMESPACES ('urn:schemas-microsoft-com:xml-sql' as sql)
SELECT 'SELECT * FROM Customers FOR XML AUTO, ROOT("a")' AS "sql:query"
FOR XML PATH('sql:root');

Éste es el resultado. Los usuarios de SQLXML están familiarizados con esta plantilla XML. Para obtener más información, vea Conceptos de programación en SQLXML 4.0.

<sql:root xmlns:sql="urn:schemas-microsoft-com:xml-sql">
  <sql:query>SELECT * FROM Customers FOR XML AUTO, ROOT("a")</sql:query>
</sql:root>

Solo se puede utilizar el prefijo de espacio de nombres xml sin definirlo explícitamente en WITH XMLNAMESPACES, como se muestra en la siguiente consulta en modo PATH. Por otra parte, si se declara el prefijo, debe estar enlazado con el espacio de nombres http://www.w3.org/XML/1998/namespace. Los nombres especificados en la cláusula SELECT hacen referencia al prefijo de espacio de nombres xml que no se define explícitamente mediante WITH XMLNAMESPACES.

SELECT 'en'    as "English/@xml:lang",
       'food'  as "English",
       'ger'   as "German/@xml:lang",
       'Essen' as "German"
FOR XML PATH ('Translation');
GO

Los atributos @xml:lang usan el espacio de nombres xml predefinido. Dado que la versión XML 1.0 no requiere la declaración explícita del enlace de espacio de nombres xml, el resultado no incluirá una declaración explícita del enlace de espacio de nombres.

El resultado es el siguiente:

<Translation>
  <English xml:lang="en">food</English>
  <German xml:lang="ger">Essen</German>
</Translation>

Uso de WITH XMLNAMESPACES con los métodos de tipo de datos xml

Los métodos de tipo de datos xml especificados en una consulta SELECT, o en UPDATE cuando se trata del método modify(), tienen que repetir la declaración de espacio de nombres en su prólogo. Esto puede resultar lento. Por ejemplo, la consulta siguiente recupera los identificadores de modelo de producto cuyas descripciones de catálogo no incluyen la especificación. Es decir, el elemento <Specifications> existe.

SELECT ProductModelID, CatalogDescription.query('
declare namespace pd="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ProductModelDescription";
    <Product
        ProductModelID= "{ sql:column("ProductModelID") }"
        />
') AS Result
FROM Production.ProductModel
WHERE CatalogDescription.exist('
    declare namespace  pd="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ProductModelDescription";
     /pd:ProductDescription[(pd:Specifications)]'
    ) = 1;

En la consulta anterior, los métodos query() y exist() declaran el mismo espacio de nombres en su prólogo. Por ejemplo:

declare namespace pd="https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ProductModelDescription";

Alternativamente, se puede declarar primero WITH XMLNAMESPACES y utilizar los prefijos de espacio de nombres en la consulta. En este caso, los métodos query() y exist() no tienen que incluir declaraciones de espacio de nombres en su prólogo.

WITH XMLNAMESPACES ('https://schemas.microsoft.com/sqlserver/2004/07/adventure-works/ProductModelDescription' as pd)
SELECT ProductModelID, CatalogDescription.query('
    <Product
        ProductModelID= "{ sql:column("ProductModelID") }"
        />
') AS Result
FROM Production.ProductModel
WHERE CatalogDescription.exist('
     /pd:ProductDescription[(pd:Specifications)]'
    ) = 1;
GO

Una declaración explícita en el prólogo de XQuery invalida el prefijo del espacio de nombres y el espacio de nombres de elemento predeterminado que se definen en la cláusula WITH.

Consulte también

Métodos del tipo de datos xml
Referencia del lenguaje XQuery (SQL Server)
WITH XMLNAMESPACES (Transact-SQL)
FOR XML (SQL Server)

Compartir por

Adición de espacios de nombres a consultas mediante WITH XMLNAMESPACES

Uso de WITH XMLNAMESPACES en consultas FOR XML

Uso de la directiva XSINIL

Especificar espacios de nombres predeterminados

Uso de espacios de nombres predefinidos

Uso de WITH XMLNAMESPACES con los métodos de tipo de datos xml

Consulte también

Comentarios

Recursos adicionais