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.
  • action : command type; use
    • “read” to access information (default)
    • “add” to add a new dimension. Dimension size will be 1
    • “clear” to delete collapsed dimensions.
  • level: In case of action “read”, 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. Valid with level bigger than 0 only. In case of action “read”, all dimension are shown by default and multiple values can be set (separated by “|”). In case of action “add”, only one dimension has to be set.
  • 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.
  • concept_level: concept level short name (must be a single char) of the new dimension. Default value is “c”.
  • dim_level: level of the new dimension to be added in dimension table.
  • dim_array: use “yes” to add an implicit dimension (default), use “no” to add an explicit dimension.

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”      
action “string” “no” “read|add|clear” “read”  
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”  
concept_level “string” “no”   “c”  
dim_level “int” “no”   “1” “1” /
dim_array “string” “no” “yes|no” “yes”  
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”