temporal.collectionGetAxis

temporal.collectiongetaxistemporalcollectiongetaxis

/apidoc/8.0/temporal:collection-get-axis.xml

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."

The name of the collection.

temporal-collection

String

The type of axis. Value types are system and valid.

axis

String

ValueIterator

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

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

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