#include <DbXml.hpp>

XmlDocument getDocument(const std::string &name, u_int32_t flags = 0)

XmlDocument getDocument(
    XmlTransaction &txn, const std::string &name, u_int32_t flags = 0)

Description: XmlContainer::getDocument

The XmlContainer::getDocument method returns the XmlDocument with the specified name.

Parameters

txn

If the operation is to be transaction-protected, the txn parameter is an XmlTransaction handle returned from XmlManager::createTransaction.

name

The name of the XmlDocument to be retrieved from the container.

flags

The flags parameter must be set to 0 or one of the following values:

DBXML_LAZY_DOCS

Retrieve the document lazily. That is, retrieve document content and document metadata only on an as needed basis when reading the document.

DB_READ_UNCOMMITTED

This operation will support degree 1 isolation; that is, read operations may return data that has been modified by other transactions but which has not yet been committed. Silently ignored if the DB_READ_UNCOMMITTED flag was not specified when the underlying container was opened.

DB_READ_COMMITTED

This operation will have degree 2 isolation. This provides for cursor stability but not repeatable reads. Data items which have been previously read by this transaction may be deleted or modified by other transactions before this transaction completes.

DB_RMW

Acquire write locks instead of read locks when doing the retrieval. Setting this flag can eliminate deadlock during a read-modify-write cycle by acquiring the write lock during the read part of the cycle so that another thread of control acquiring a read lock for the same item, in its own read-modify-write cycle, will not result in deadlock.

Errors

The XmlContainer::getDocument method may fail and throw XmlException, encapsulating one of the following non-zero errors:

DATABASE_ERROR

An error occurred in an underlying Berkeley DB database. The XmlException::getDbErrno method will return the error code for the error.

DOCUMENT_NOT_FOUND

The specified document is not in the XmlContainer.