Spécifier des métapropriétés dans OPENXML

S’applique à :SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

Les attributs de métapropriétés dans un document XML décrivent les propriétés d'un élément XML (élément, attribut ou tout autre nœud DOM). Ces attributs n’existent pas physiquement dans le texte du document XML. Toutefois, OPENXML fournit ces métapropriétés pour tous les éléments XML. Ces métapropriétés vous permettent d'extraire des informations (par exemple des informations de positionnement local et d'espace de noms) sur les nœuds XML. Ces informations vous procurent davantage de détails que ceux apparents dans la représentation textuelle.

Vous pouvez mapper ces métapropriétés aux colonnes de l’ensemble de lignes dans une instruction OPENXML à l’aide du paramètre ColPattern . Les colonnes contiennent les valeurs des métapropriétés auxquelles elles sont mappées. Pour plus d’informations sur la syntaxe d’OPENXML, consultez OPENXML (Transact-SQL).

Pour accéder aux attributs de métapropriétés, un espace de noms spécifique à SQL Server est fourni. Cet espace de noms urn:schemas-microsoft-com:xml-metaprop permet à l’utilisateur d’accéder aux attributs de métapropriété. Si le résultat d’une requête OPENXML est retourné dans un format de table edge, la table de bord contient une colonne pour chaque attribut de métapropriété, à l’exception de la xmltext métapropriété.

Certains attributs de métapropriétés sont utilisés à des fins de traitement. Par exemple, l’attribut xmltext metaproperty est utilisé pour la gestion des dépassements de capacité. Cette gestion concerne les données du document non consommées ou non traitées. L'une des colonnes de l'ensemble de lignes qui est généré par OPENXML peut être identifiée comme colonne de dépassement. Pour ce faire, mappez-le à la métapropriété à l’aide xmltext du paramètre ColPattern . La colonne reçoit ensuite les données de dépassement. Le paramètre flags détermine si la colonne contient tout ou uniquement les données non consommées.

Le tableau suivant répertorie les attributs de métapropriétés détenus par chaque élément XML analysé. Ces attributs métaproperty sont accessibles à l’aide de l’espace de noms urn:schemas-microsoft-com:xml-metaprop. Toute valeur définie directement par l'utilisateur dans le document XML à l'aide de ces métapropriétés est ignorée.

Note

Aucune navigation XPath ne vous permet de faire référence à ces métapropriétés.

Attribut de métapropriété	Description
@mp:id	Fournit l'identificateur du nœud DOM. Cet identificateur est généré par le système et couvre l'ensemble du document. Tant que le document n’est pas réparé, cet ID fait référence au même nœud XML. Un ID XML indique 0 que l’élément est un élément racine. Son ID XML parent vaut NULL.
@mp:localname	Stocke la partie locale du nom du nœud. Utilisé avec un préfixe et un URI d'espace de noms, il permet de nommer les nœuds d'éléments ou d'attributs.
@mp:namespaceuri	Fournit l'URI de l'espace de noms de l'élément actuel. Si la valeur de cet attribut est NULL, aucun espace de noms n'est présent.
@mp:prefix	Stocke le préfixe d'espace de noms de l'élément actuel. Si aucun préfixe n'est présent (NULL) et qu'un URI est fourni, l'espace de noms spécifié est l'espace de noms par défaut. Si aucun URI n'est fourni, aucun espace de noms n'est attaché.
@mp:prev	Stocke le frère précédent relatif à un nœud. Fournit des informations sur l'ordre des éléments dans le document. @mp:prev contient l’ID XML du frère précédent possédant le même élément parent. Si un élément figure au début de la liste des frères, @mp:prev a pour valeur NULL.
@mp:xmltext	Utilisé à des fins de traitement. Représente la sérialisation textuelle de l'élément, ainsi que de ses attributs et sous-éléments, utilisée dans la gestion de dépassement d'OPENXML.

Ce tableau présente les propriétés parentes supplémentaires qui vous permettent d'extraire des informations sur la hiérarchie.

Attribut de métapropriété parent	Description
@mp:parentid	Correspond à ../\@mp:id
@mp:parentlocalname	Correspond à ../\@mp:localname
@mp:parentnamespacerui	Correspond à ../\@mp:namespaceuri
@mp:parentprefix	Correspond à ../\@mp:prefix

Examples

Les exemples suivants illustrent l'utilisation d'OPENXML pour créer différentes vues d'ensembles de lignes.

A. Mapper les colonnes d’ensemble de lignes OPENXML aux métapropriétés

Cet exemple utilise OPENXML pour créer une vue d'ensemble de lignes de l'exemple de document XML. Plus spécifiquement, il montre comment différents attributs de métapropriétés peuvent être mappés à des colonnes d’ensembles de lignes dans une instruction OPENXML à l’aide du paramètre ColPattern .

L'instruction OPENXML contient les éléments suivants :

• La id colonne est mappée à l’attribut @mp:id metaproperty et indique que la colonne contient l’ID XML unique généré par le système de l’élément.

• La parent colonne est mappée @mp:parentid et indique que la colonne contient l’ID XML du parent de l’élément.

• La parentLocalName colonne est mappée et @mp:parentlocalname indique que la colonne contient le nom local du parent.

L'instruction SELECT retourne ensuite l'ensemble de lignes fourni par OPENXML :

DECLARE @idoc int;
DECLARE @doc nvarchar(1000);
-- Sample XML document
SET @doc = N'<root>
  <Customer cid= "C1" name="Janine" city="Issaquah">
      <Order oid="O1" date="1/20/1996" amount="3.5" />
      <Order oid="O2" date="4/30/1997" amount="13.4">Customer was very satisfied</Order>
   </Customer>
   <Customer cid="C2" name="Ursula" city="Oelde" >
      <Order oid="O3" date="7/14/1999" amount="100" note="Wrap it blue white red">
          <Urgency>Important</Urgency>
      </Order>
      <Order oid="O4" date="1/20/1996" amount="10000"/>
   </Customer>
</root>';
-- Create an internal representation of the XML document.
EXEC sp_xml_preparedocument @idoc OUTPUT, @doc;

-- Execute a SELECT statement using OPENXML rowset provider.
SELECT *
FROM OPENXML (@idoc, '/root/Customer/Order', 9)
      WITH (id int '@mp:id',
            oid char(5),
            date datetime,
            amount real,
            parentIDNo int '@mp:parentid',
            parentLocalName varchar(40) '@mp:parentlocalname');
EXEC sp_xml_removedocument @idoc;

Voici le résultat obtenu :

id   oid         date                amount    parentIDNo  parentLocalName
--- ------- ---------------------- ---------- ------------ ---------------
6    O1    1996-01-20 00:00:00.000     3.5         2        Customer
10   O2    1997-04-30 00:00:00.000     13.4        2        Customer
19   O3    1999-07-14 00:00:00.000     100.0       15       Customer
25   O4    1996-01-20 00:00:00.000     10000.0     15       Customer

B. Récupérer l’intégralité du document XML

Dans cet exemple, OPENXML est utilisé pour créer une vue d'ensemble de lignes contenant une seule colonne à partir de l'exemple de document XML. Cette colonne, est Col1mappée au xmltext métapropriété et devient une colonne de dépassement de capacité. En conséquence, elle reçoit les données non consommées. Dans ce cas, il s’agit de l’ensemble du document.

L'instruction SELECT retourne ensuite l'intégralité de l'ensemble de lignes.

DECLARE @idoc int;
DECLARE @doc nvarchar(1000);
SET @doc = N'<?xml version="1.0"?>
<root>
  <Customer cid= "C1" name="Janine" city="Issaquah">
      <Order oid="O1" date="1/20/1996" amount="3.5" />
      <Order oid="O2" date="4/30/1997" amount="13.4">Customer was very
             satisfied</Order>
   </Customer>
   <Customer cid="C2" name="Ursula" city="Oelde" >
      <Order oid="O3" date="7/14/1999" amount="100" note="Wrap it blue
             white red">
     <MyTag>Testing to see if all the subelements are returned</MyTag>
          <Urgency>Important</Urgency>
      </Order>
      <Order oid="O4" date="1/20/1996" amount="10000"/>
   </Customer>
</root>';
-- Create an internal representation of the XML document.
EXEC sp_xml_preparedocument @idoc OUTPUT, @doc;

-- Execute a SELECT statement using OPENXML rowset provider.
SELECT *
FROM OPENXML (@idoc, '/')
   WITH (Col1 ntext '@mp:xmltext')

Pour extraire l'intégralité du document sans déclaration XML, vous pouvez spécifier la requête comme suit :

SELECT *
FROM OPENXML (@idoc, '/root')
   WITH (Col1 ntext '@mp:xmltext')
EXEC sp_xml_removedocument @idoc;

La requête retourne l'élément racine ayant la racine du nom et les données contenues dans l'élément racine.

C. Spécification de la métapropriété xmltext pour récupérer les données non consommées d'une colonne

Cet exemple utilise OPENXML pour créer une vue d'ensemble de lignes de l'exemple de document XML. L’exemple montre comment récupérer des données XML nonumées en mappant l’attribut xmltext métaproperty à une colonne d’ensemble de lignes dans OPENXML.

La comment colonne est identifiée comme colonne de dépassement de capacité en la mappant à la @mp:xmltext métapropriété. Le paramètre d’indicateurs est défini sur 9 (XML_ATTRIBUTE et XML_NOCOPY). Cela indique attribute-centric le mappage et indique que seules les données non agrégées doivent être copiées dans la colonne de dépassement de capacité.

L'instruction SELECT retourne ensuite l'ensemble de lignes fourni par OPENXML.

Dans cet exemple, la @mp:parentlocalname métapropriété est définie pour une colonne, ParentLocalNamedans l’ensemble de lignes généré par OPENXML. Par conséquent, cette colonne contient le nom local de l'élément parent.

Deux colonnes supplémentaires sont spécifiées dans l’ensemble de lignes et parentcomment. La parent colonne est mappée @mp:parentid et indique que la colonne contient l’ID XML de l’élément parent de l’élément. La colonne comment est mappée à la métapropriété @mp:xmltext ).

DECLARE @idoc int;
DECLARE @doc nvarchar(1000);
-- sample XML document
SET @doc = N'<root>
  <Customer cid= "C1" name="Janine" city="Issaquah">
      <Order oid="O1" date="1/20/1996" amount="3.5" />
      <Order oid="O2" date="4/30/1997" amount="13.4">Customer was very satisfied</Order>
   </Customer>
   <Customer cid="C2" name="Ursula" city="Oelde" >
      <Order oid="O3" date="7/14/1999" amount="100" note="Wrap it blue white red">
          <Urgency>Important</Urgency>
      </Order>
      <Order oid="O4" date="1/20/1996" amount="10000"/>
   </Customer>
</root>
';
-- Create an internal representation of the XML document.
EXEC sp_xml_preparedocument @idoc OUTPUT, @doc;

-- Execute a SELECT statement using OPENXML rowset provider.
SELECT *
FROM OPENXML (@idoc, '/root/Customer/Order', 9)
      WITH (oid char(5),
            date datetime,
            comment ntext '@mp:xmltext');
EXEC sp_xml_removedocument @idoc;

Voici l'ensemble de résultats. Étant donné que les colonnes oid et les colonnes de date sont déjà consommées, elles n’apparaissent pas dans la colonne de dépassement de capacité.

oid   date                        comment
----- --------------------------- ----------------------------------------
O1    1996-01-20 00:00:00.000     <Order amount="3.5"/>
O2    1997-04-30 00:00:00.000     <Order amount="13.4">Customer was very
                                   satisfied</Order>
O3    1999-07-14 00:00:00.000     <Order amount="100" note="Wrap it blue
                                   white red"><Urgency>
                                   Important</Urgency></Order>
O4    1996-01-20 00:00:00.000     <Order amount="10000"/>

Voir aussi

• OPENXML (Transact-SQL)
• OPENXML (SQL Server)