XmlIndexLookup::setIndex

#include <DbXml.hpp>

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

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

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

Parameters

index

A comma-separated list of strings that represent the indexing strategy. The strings 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, equality, or substring.

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

    nonedoublegYear
    base64BinarydurationgYearMonth
    booleanfloathexBinary
    dategDaystring
    dateTimegMonthtime
    decimalgMonthDay 

Note that if {key type} is presence, then {syntax} must be none or simply not specified.

Some example index strings are:

    unique-node-element-presence

    node-element-equality-string

    edge-element-presence-none

    node-element-equality-float 

Class

XmlIndexLookup

See Also

XmlIndexLookup Methods