mdex:dimension-search-query()

The mdex:dimension-search-query() function executes a dimension search query.

Note: Dimension names have to match the NCName syntax rule defined in the XML specification. In particular, there can be no spaces or colons in names. If dimension names are not NCName compliant, Dgidx issues a warning to its log file, but execution is not halted.

Function Signature

mdex:dimension-search-query($query as element(mdata:Query, xs:untyped)) as element(mdata:Results, xs:untyped)

Function Summary

Executes a dimension search query.

Parameters

$query: An element representing a dimension search query. This element should be of type mdata:DimensionSearchQuery.

Return Values

Returns a Results element of type mdata:DimensionSearchResult containing the results of the query.

Example

The following example would return the results from a dimension search query for the term Merlot. 
mdex:dimension-search-query(
<Query>
   <DimensionSearch>
      Merlot
   </DimensionSearch>
</Query>)
Errors Thrown
  • endeca-err:SCHM0001 if the input to the function did not pass schema validation.
  • endeca-err:MDEX0001 if the input to the function contextually invalid.
  • endeca-err:EXTF0001 if an unexpected internal error of a different nature occurred.

For more details about the errors thrown by external functions, see the topic "Error code listing."