XmlIndexSpecification::replaceIndex |
![]() ![]() |
#include <DbXml.hpp>void XmlIndexSpecification::replaceIndex(const std::string &uri, const std::string &name, const std::string &index)
void XmlIndexSpecification::replaceIndex(const std::string &uri, const std::string &name, Type type, XmlValue::Type syntax)
Replaces the indexing strategies for a named document or metadata node. All existing indexing strategies for that node are deleted, and the indexing strategy identified by this method is set for the node.
Identifies one or more indexing strategies to set for the identified node. The strategies are identified using a space-separated listing of strings.
Parametersunique-{path type}-{node type}-{key type}-{syntax}
where:
unique indicates that the indexed value is unique in the container. If this keyword does not appear on the index string, then the indexed value is not required to be unique in the container.
{path type} is either node or edge.
{node type} is one of element, attribute, or metadata. If metadata is specified, then {path type} must be node.
{key type} is one of presence, equality, or substring.
{syntax} identifies the type of information being indexed. It must be one of the following values:
Note that if {key type} is presence, then {syntax} must be none or simply not specified.
For example, examples index strings are:
unique-node-element-presence
node-element-equality-string
edge-element-presence-none
node-element-equality-float
The XmlIndexSpecification::replaceIndex method may fail and throw XmlException, encapsulating one of the following non-zero errors:
Identifies a single indexing strategy to set for the identified node.
ParametersTo indicate whether the indexed value must be unique container-wide, use one of the following, or leave the value out entirely:
To identify the path type, use one of the following:
To identify the node type, use one of the following:
Note that if XmlIndexSpecification::NODE_METADATA is used, then XmlIndexSpecification::PATH_NODE must also be used as well.
To identify the key type, use one of the following:
For example:
XmlIndexSpecification::PATH_NODE | XmlIndexSpecification::NODE_ELEMENT | XmlIndexSpecification::KEY_SUBSTRING
Identifies the type of information being indexed. The value must be one of the XmlValue enumerated types:
Note that if XmlIndexSpecification::KEY_PRESENCE is specified for type, then this parameter must be XmlValue::NONE.
The XmlIndexSpecification::replaceIndex method may fail and throw XmlException, encapsulating one of the following non-zero errors:
![]() ![]() |
Copyright (c) 1996-2009 Oracle. All rights reserved.