XmlContainer::getAllDocuments

API Ref

#include <DbXml.hpp>

XmlResults XmlContainer::getAllDocuments(u_int32_t flags)

XmlResults XmlContainer::getAllDocuments(XmlTransaction &txn, u_int32_t flags)


Description: XmlContainer::getAllDocuments

Return all of the documents in the container in a lazily evaluated XmlResult set.

Parameters

txn
If the operation is to be transaction-protected, the txn parameter is an XmlTransaction handle returned from XmlManager::createTransaction.
flags
The flags parameter must be set to 0 or by bitwise inclusively OR'ing together one or more of the following values:
DB_DIRTY_READ
Only meaningful for transactional containers. Causes the container to support degree 1 isolation; that is, read operations on the container may return data that has been modified by other transactions but which has not yet been committed.
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.
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. DBXML_LAZY_DOCS defaults to on.

APIRef

Copyright (c) 1996-2005 Sleepycat Software, Inc. - All rights reserved.