Compartir a través de

Objetos DiffGram

Un DiffGram es un formato XML que identifica las versiones actual y original de los elementos de datos. El DataSet utiliza el formato DiffGram para cargar y hacer persistente su contenido, así como para serializar su contenido con el fin de transportarlo a través de una conexión de red. Cuando un DataSet se escribe como un DiffGram, rellena el DiffGram con toda la información necesaria para recrear con precisión el contenido, aunque no el esquema, del DataSet, incluidos los valores de columna de las versiones de fila Original y Current, la información de error de fila y el orden de fila.

Cuando se envía y recupera un DataSet desde un servicio Web XML, se utiliza implícitamente el formato DiffGram. Además, al cargar el contenido de un objeto DataSet desde XML mediante el método ReadXml, o al escribir el contenido en el XML mediante el método WriteXml, puede especificar que el contenido se lea o escriba como DiffGram. Para obtener más información, vea Carga de un conjunto de datos desde XML y Escritura de contenido de dataSet como datos XML.

Si bien .NET Framework utiliza principalmente el formato DiffGram como formato de serialización para el contenido de un DataSet, también es posible usar DiffGrams para modificar datos en tablas de una base de datos de Microsoft SQL Server.

Un diffgram se genera escribiendo el contenido de todas las tablas en un <diffgram> elemento.

Para generar un Diffgram

  1. Genere una lista de tablas raíz (es decir, tablas sin elemento primario).

  2. Para cada tabla y sus descendientes en la lista, escriba la versión actual de todas las filas en la primera sección del Diffgram.

  3. Para cada tabla de DataSet, escriba la versión original de todas las filas, si hay alguna, en la sección <before> del Diffgram.

  4. Para las filas que tienen errores, escriba el contenido del error en la <errors> sección del diffgram.

El Diffgram se procesa en orden, del principio del archivo XML al final.

Para procesar un Diffgram

  1. Procese la primera sección del Diffgram, que contiene la versión actual de las filas.

  2. Procese la segunda o la <before> sección que contiene la versión de fila original de las filas modificadas y eliminadas.

    Nota

    Si una fila está marcada como eliminada, la operación de eliminación puede suprimir también sus descendientes, dependiendo de la propiedad Cascade del actual DataSet.

  3. Procese la <errors> sección. Establezca la información de error de la fila y la columna especificadas para cada elemento de esta sección.

Nota

Si establece XmlWriteMode en Diffgram, el contenido del DataSet de destino y del DataSet original podría ser distinto.

Formato de un DiffGram

El formato de DiffGram está dividido en tres secciones: los datos actuales, los datos originales (o "antes de") y una sección de errores, como se muestra en el siguiente ejemplo.

<?xml version="1.0"?>
<diffgr:diffgram
         xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"
         xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1"
         xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <DataInstance>
   </DataInstance>

  <diffgr:before>
  </diffgr:before>

  <diffgr:errors>
  </diffgr:errors>
</diffgr:diffgram>

El formato DiffGram consta de los bloques de datos siguientes:

< DataInstance> El nombre de este elemento, DataInstance, se usa con fines de explicación en esta documentación. Un elemento DataInstance representa un DataSet o una fila de una DataTable. En lugar de DataInstance, el elemento contendría el nombre del DataSet o DataTable. Este bloque del formato DiffGram contiene los datos actuales, se hayan modificado o no. Un elemento, o fila, que se haya modificado se identifica con la anotación diffgr:hasChanges.

<diffgr:before> Este bloque del formato DiffGram contiene la versión original de una fila. Los elementos de este bloque se hacen coincidir con los del bloque DataInstance mediante la anotación diffgr:id.

<diffgr:errors> Este bloque del formato DiffGram contiene información de error para una fila determinada en el bloque DataInstance . Los elementos de este bloque se hacen coincidir con los del bloque DataInstance mediante la anotación diffgr:id.

Anotaciones de DiffGram

Los DiffGrams utilizan varias anotaciones para relacionar elementos de los distintos bloques de DiffGram que representan versiones de fila o información de error diferentes en el DataSet.

En la siguiente tabla se describen las anotaciones de DiffGram definidas en el espacio de nombres urn:schemas-microsoft-com:xml-diffgram-v1.

Anotación Descripción
id Se utiliza para emparejar los elementos en los bloques <diffgr:before> y <diffgr:errors> con los elementos en el bloque <DataInstance>. Los valores con la anotación diffgr:id tienen el formato [TableName][RowIdentifier]. Por ejemplo: <Customers diffgr:id="Customers1">.
parentId Identifica qué elemento del bloque <DataInstance> es el elemento principal del elemento actual. Los valores con la anotación diffgr:parentId tienen el formato [TableName][RowIdentifier]. Por ejemplo: <Orders diffgr:parentId="Customers1">.
hasChanges Identifica una fila en el bloque <DataInstance> como modificada. La hasChanges anotación puede tener uno de los dos valores siguientes:

insertado
Identifica una Added fila.

modificado
Identifica una Modified fila que contiene una Original versión de fila en el <diffgr:before> bloque. Tenga en cuenta que las filas Deleted tendrán una versión de fila Original en el bloque <diffgr:before>, pero no habrá ningún elemento anotado en el <DataInstance> bloque.
hasErrors Identifica una fila del bloque <DataInstance> como que tiene un RowError. El elemento error se coloca en el <diffgr:errors> bloque .
Error Contiene el texto de para RowError un elemento determinado del <diffgr:errors> bloque .

El DataSet incluye otras anotaciones al leer o escribir su contenido como un DiffGram. En la siguiente tabla se describen estas anotaciones adicionales, que se definen en el espacio de nombres urn:schemas-microsoft-com:xml-msdata.

Anotación Descripción
RowOrder Conserva el orden de fila de los datos originales e identifica el índice de una fila de una DataTable determinada.
Oculto Identifica una columna como tener una ColumnMapping propiedad establecida en MappingType.Hidden. El atributo se escribe con el formato msdata:hidden[ColumnName]="value". Por ejemplo: <Customers diffgr:id="Customers1" msdata:hiddenContactTitle="Owner">.

Hay que tener en cuenta que las columnas ocultas solo se escriben como un atributo de DiffGram si contienen datos. En caso contrario, se pasan por alto.

DiffGram de ejemplo

A continuación se muestra un ejemplo del formato DiffGram. En este ejemplo se muestra el resultado de una actualización de una fila de una tabla antes de que se hayan confirmado los cambios. La fila cuyo CustomerID es "ALFKI" se ha modificado, pero no se ha actualizado. Como resultado, hay una Current fila con un diffgr:id de "Customers1" en el < bloque DataInstance> y una Original fila con un diffgr:id de "Customers1" en el <diffgr:before> bloque. La fila con un CustomerID de "ANATR" incluye RowError, por lo que se anota con diffgr:hasErrors="true" y hay un elemento relacionado en el bloque <diffgr:errors>.

<diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">
  <CustomerDataSet>
    <Customers diffgr:id="Customers1" msdata:rowOrder="0" diffgr:hasChanges="modified">
      <CustomerID>ALFKI</CustomerID>
      <CompanyName>New Company</CompanyName>
    </Customers>
    <Customers diffgr:id="Customers2" msdata:rowOrder="1" diffgram:hasErrors="true">
      <CustomerID>ANATR</CustomerID>
      <CompanyName>Ana Trujillo Emparedados y Helados</CompanyName>
    </Customers>
    <Customers diffgr:id="Customers3" msdata:rowOrder="2">
      <CustomerID>ANTON</CustomerID>
      <CompanyName>Antonio Moreno Taquera</CompanyName>
    </Customers>
    <Customers diffgr:id="Customers4" msdata:rowOrder="3">
      <CustomerID>AROUT</CustomerID>
      <CompanyName>Around the Horn</CompanyName>
    </Customers>
  </CustomerDataSet>
  <diffgr:before>
    <Customers diffgr:id="Customers1" msdata:rowOrder="0">
      <CustomerID>ALFKI</CustomerID>
      <CompanyName>Alfreds Futterkiste</CompanyName>
    </Customers>
  </diffgr:before>
  <diffgr:errors>
    <Customers diffgr:id="Customers2" diffgr:Error="An optimistic concurrency violation has occurred for this row."/>
  </diffgr:errors>
</diffgr:diffgram>

Vea también

  • Last updated on