OPH_CUBESCHEMA

Description

Type

Metadata Access.

Behaviour

It shows metadata information about a datacube and the dimensions related to it.

Parameters

  • cube: name of the input datacube. The name must be in PID format.
  • level: level of information shown.
    • 0: shows only metadata (default)
    • 1: shows only dimension values
    • 2: shows metadata and dimension values
  • dim: names of dimensions to show. Only valid with level bigger than 0. Multiple-value field: list of dimensions separated by “|” can be provided. If not specified, all dimension are shown.
  • show_index: if “no” (default), it won’t show dimension ids. With “yes”, it will also show the dimension id next to the value.
  • show_time: if “no” (default), the values of time dimension are shown as numbers. With “yes”, the values are converted as a string with date and time.
  • base64: if “no” (default), dimension values are returned as strings (with possible trucantion errors). With “yes”, raw dimension values are returned as base64-coded strings.

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, cubeschema_cubeinfo => shows cube information as grid, cubeschema_morecubeinfo => shows more cube information as grid cubeschema_diminfo => shows the list of cube dimensions as grid, cubeschema_dimvalues => shows the values of cube dimensions as grid).

Examples

Show metadata information about the datacube identified by the PID “URL/1/1”:

[OPH_TERM] >>  oph_cubeschema cube=URL/1/1;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
cube “string” “yes”      
level “int” “no” “0|1|2” “0” “0” / “2”
dim “string” “no”   “all”  
show_index “string” “no” “yes|no” “no”  
show_time “string” “no” “yes|no” “no”  
base64 “string” “no” “yes|no” “no”  
exec_mode “string” “no” “async|sync” “async”  
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
objkey_filter “string” “no” “all|none|cubeschema_cube info|cubeschema_morecubeinfo|cubeschema_diminfo|cubeschema_dimvalues” “all”