XmlContainerConfig::setIndexNodes

#include <DbXml.hpp>

void XmlContainerConfig::setIndexNodes(
            XmlContainerConfig::ConfigState state) 

Sets whether the index targets reference nodes or documents. The default setting is UseDefault. This value is ignored unless the container is being created or reindexed.

If set to On it causes the indexer to create index targets that reference nodes rather than documents. This allows index lookups during query processing to more efficiently find target nodes and avoid walking the document tree. It can apply to both container types, and is the default for containers of type XmlContainer::NodeContainer.

If set to Off it causes the indexer to create index targets that reference documents rather than nodes. This can be more desirable for simple queries that only need to return documents and do relatively little navigation during querying. It can apply to both container types, and is the default for containers of type XmlContainer::WholedocContainer.

If set to UseDefault, then the container type will decide whether nodes or documents are referenced.

Parameters

state

Whether the index references nodes or documents. The container property must have one of the following values:

  • XmlContainerConfig::On

    The container property is turned on.

  • XmlContainerConfig::Off

    The container property is turned off.

  • XmlContainerConfig::UseDefaults

    The container property is set to whatever the default is for the given container type.

Class

XmlContainerConfig

See Also

XmlContainerConfig Methods