User-Defined Function API 10.0
marklogic::RangeIndex Class Reference

Encapsulation of the configuration of a range index. More...

#include <MarkLogic.h>

Public Types

enum   Type {
  INT , UNSIGNED_INT , LONG , UNSIGNED_LONG ,
  FLOAT , DOUBLE , DECIMAL , DATE_TIME ,
  TIME , DATE , G_YEAR_MONTH , G_YEAR ,
  G_MONTH , G_DAY , YEAR_MONTH_DURATION , DAY_TIME_DURATION ,
  STRING , ANY_URI , POINT
}
  The type of the values in a range index. More...
 
enum   Order { ASCENDING , DESCENDING }
  Whether the index values are in ascending or descending order.
 

Detailed Description

Encapsulation of the configuration of a range index.

Member Enumeration Documentation

◆ Type

The type of the values in a range index.

These types represent the input value types that can be in a TupleIterator passed to AggregateUDF::map. The API supports seamless conversion between these types and C++ types, as described in "Type Conversions in Aggregate UDFs" in the Application Developer's Guide.

Enumerator
INT 

xs:int

UNSIGNED_INT 

xs:unsignedInt

LONG 

xs:long

UNSIGNED_LONG 

xs:unsignedLong

FLOAT 

xs:float

DOUBLE 

xs:double

DECIMAL 

xs:decimal

DATE_TIME 

xs:dateTime

TIME 

xs:time

DATE 

xs:date

G_YEAR_MONTH 

xs:gYearMonth

G_YEAR 

xs:gYear

G_MONTH 

xs:gMonth

G_DAY 

xs:gDay

YEAR_MONTH_DURATION 

xs:yearMonthDuration

DAY_TIME_DURATION 

xs:dayTimeDuration

STRING 

xs:string

ANY_URI 

xs:anyURI

POINT 

cts:point (MarkLogic XQuery dialect)


The documentation for this class was generated from the following file: