OPH_HIERARCHY

Description

Type

Metadata Access.

Behaviour

It shows the list of the hierarchies or the description of a specified hierarchy.

Parameters

  • hierarchy: name of the requested hierarchy. If the value “all” is specified, then the list of all hierarchies is shown.
  • hierarchy_version: version of the requested hierarchy. If not specified, it will be used its default value “latest” in order to get info about the latest version of the hierarchy.

System parameters

  • exec_mode: operator execution mode. Possible values are async (default) for asynchronous mode, sync for synchronous mode with json-compliant output.
  • ncores: number of parallel processes to be used (min. 1). This operator is not parallel, so the only possible value is 1.
  • sessionid: session identifier used server-side to manage sessions and jobs. Usually, users don’t need to use/modify it, except when it is necessary to create a new session or switch to another one.
  • objkey_filter: filter on the output of the operator written to file (default=all => no filter, none => no output, hierarchy_list => shows operator’s output table, hierarchy_tip => shows operator’s output help message, hierarchy_attrs => shows hierarchy attribute table, hierarchy_function => shows hierarchy name and version).

Examples

Get the description of “oph_time” hierarchy:

[OPH_TERM] >>  oph_hierarchy hierarchy=oph_time;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
hierarchy “string” “no”   “all”  
hierarchy_version “string” “no”   “latest”  
exec_mode “string” “no” “async|sync” “async”  
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
objkey_filter “string” “no” “all|none|hierarchy_list| hierarchy_tip|hierarchy_attrs|hierarchy_function” “all”