XmlIndexLookup::setIndex

API Ref

#include <DbXml.hpp>

void XmlIndexLookup::setIndex(const std::string &index)

const std::string &XmlIndexLookup::getIndex() const


Description: XmlIndexLookup::setIndex

Sets the indexing strategy to be used for the index lookup operation. Only one index may be specified, and substring indexes are not supported.

Parameters

index
A string that represents the indexing strategy. The string must contain the following information in the following order:
unique-{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 or equality.

{syntax} identifies the type of information being indexed. It must be one of the following values:

  • none
  • base64Binary
  • boolean
  • date
  • dateTime
  • dayTimeDuration
  • decimal
  • double
  • duration
  • float
  • gDay
  • gMonth
  • gMonthDay
  • gYear
  • gYearMonth
  • hexBinary
  • string
  • time
  • yearMonthDuration
  • untypedAtomic

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
node-attribute-equality-decimal
edge-element-presence-none

APIRef

Copyright (c) 1996,2007 Oracle. All rights reserved.