XmlIndexSpecification::setAutoIndexing API Ref

#include <DbXml.hpp>

void XmlIndexSpecification::setAutoIndexing(bool value)

bool XmlIndexSpecification::getAutoIndexing() const


Description: XmlIndexSpecification::setAutoIndexing

Sets the auto-indexing state which will affect the container when set using XmlContainer::setIndexSpecification.

Parameters
value

If the value on the container is true (the default for newly-created containers) then indexes are added automatically for leaf elements and attributes. The indexes added are "node-equality-string" and "node-equality-double" for elements and attributes. If auto-indexing is not desired it should be disabled using this interface upon container creation. Auto-indexing is recognized by insertion of new documents as well as updates of existing documents, including modification via XQuery Update. The auto-indexing state is persistent and will remain stable across container close/re-open operations. Indexes added via auto-indexing are normal indexes and can be removed using the normal mechanisms.

A significant implication of auto-indexing is that any operation that may add an index (e.g. XmlContainer::putDocument) can have the side effect of reindexing the entire container. For this reason auto-indexing is not recommended for containers of heterogenous documents and that it be disabled once a representative set of documents has been inserted.


Description: bool XmlIndexSpecification::getAutoIndexing() const

Returns the current value of the auto-indexing state.


APIRef

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