XmlContainer::lookupStatistics API Ref

#include <DbXml.hpp>

XmlStatistics XmlContainer::lookupStatistics(const std::string &uri, const std::string &name, const std::string &index, const XmlValue &value = XmlValue())

XmlStatistics XmlContainer::lookupStatistics(XmlTransaction &txn, const std::string &uri, const std::string &name, const std::string &index, const XmlValue &value = XmlValue())

XmlStatistics XmlContainer::lookupStatistics(const std::string &uri, const std::string &name, const std::string &parent_uri, const std::string &parent_name, const std::string &index, const XmlValue &value = XmlValue())

XmlStatistics XmlContainer::lookupStatistics(XmlTransaction &txn, const std::string &uri, const std::string &name, const std::string &parent_uri, const std::string &parent_name, const std::string &index, const XmlValue &value = XmlValue())


Description: XmlContainer::lookupStatistics

Returns an XmlStatistics object for the identified index. This object identifies the number of keys (both total and unique) maintained for the identified index.


Description: XmlStatistics XmlContainer::lookupStatistics(XmlTransaction &txn, const std::string &uri, const std::string &name, const std::string &index, const XmlValue &value = XmlValue())

Lookup statistics for the identified index. Note that this form of this method cannot be used to return statistics on edge indices.

Parameters
txn uri name index value

Errors

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


UNKNOWN_INDEX

Description: XmlStatistics XmlContainer::lookupStatistics(XmlTransaction &txn, const std::string &uri, const std::string &name, const std::string &parent_uri, const std::string &parent_name, const std::string &index, const XmlValue &value = XmlValue())

Lookup statistics for the identified index. Use this form of this method to return statistics on edge indices.

Edge indices are indices maintained for those locations in a document where two nodes (a parent node and a child node) meet. See the Berkeley DB XML Getting Started Guide for details.

Parameters
txn uri name parent_uri parent_name index value

Errors

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


UNKNOWN_INDEX

APIRef

Copyright (c) 1996-2009 Oracle. All rights reserved.