MarkLogic 9 Product Documentation

temporal.collectionGetAxis

temporal.collectionGetAxis(
   temporal-collection as String,
   axis as String
) as Sequence

Summary

This function returns the name of either the system or valid axis in the named temporal collection.

A TEMPORAL-COLLECTIONNOTFOUND exception is thrown if the collection does not exist. A TEMPORAL-INVALIDAXIS if axis is not "system" or "valid."

Example

var temporal = require("/MarkLogic/temporal.xqy");

temporal.collectionGetAxis("temporalCollection", "valid") ;

//  Returns the name of the valid axis for the "temporalCollection" 
//  collection.