XmlModify

API Ref

#include <DbXml.hpp>

class DbXml::XmlModify { public: XmlModify() XmlModify(const XmlModify &o) XmlModify &operator=(const XmlModify &o) ~XmlModify(); ... };


Description: XmlModify

The XmlModify class encapsulates the context within which a set of one or more documents specified by an XQuery query can be modified in place. The modification is performed using an XmlModify object, and a series of methods of that object that specify how the document is to be modified. Using these methods, the modification steps are identified. When the object is executed, these steps are performed in the order that they were specified.

The modification steps are executed against one or more documents using XmlModify::execute. This method can operate on a single document stored in an XmlValue, or against multiple documents stored in an XmlResults set that was created as the result of a container or document query.

By default, document modifications are written back to their respective containers. It is possible to avoid this, in order to perform temporary modifications, or group multiple modification sets. Use XmlUpdateContext::setApplyChangesToContainers to control this behavior.

Documents in containers of type XmlContainer::NodeContainer are updated partially, and only affected nodes and indices are modified, if possible. Documents in containers of type XmlContainer::WholedocContainer are entirely rewritten and re-indexed.

XmlModify objects are created using XmlManager::createModify.

During construction, XmlModify objects are not free-threaded. They must be constructed in a thread-safe manner. However, a single XmlModify object, once constructed, can be used simultaneously by multiple threads.


APIRef

Copyright (c) 1996,2007 Oracle. All rights reserved.