OPH_LIST

Description

Type

Metadata Access.

Behaviour

It shows information about folders, container and datacubes fragmentation (file system). Levels from 0 to 2 show information about the folder tree. If the cwd is empty, the current path is shown. Level 3 is similar to level 2 but it also shows additional information about the data cubes. Level 4 shows the location of the specified datacube. Levels from 5 to 8 show information about fragmentation of the input datacube. If a container is hidden, a “* ” is set next to its name. Folders are identified by an ending “/”. Any filter can use SQL wildcards (%, _, etc.).

Parameters

  • level: level of verbosity.
    • 0: shows folders
    • 1: shows folders and containers (default)
    • 2: shows folders, containers and datacubes
    • 3: shows containers path, datacubes pid, measure, source and transformation level
    • 4: shows containers path and datacubes
    • 5: shows containers, datacubes and hosts
    • 6: shows containers, datacubes, hosts and dbmss
    • 7: shows containers, datacubes, hosts, dbmss and dbs
    • 8: shows containers, datacubes, hosts, dbmss, dbs and fragments
  • path: optional filter on absolute/relative path. Path is expanded, so it can also contain ‘.’ and ‘..’
  • cwd: absolute path corresponding to the current working directory, necessary to correctly parse paths. All resolved paths must be associated to the calling session, so they should contain /<session-code>.
  • container_filter: optional filter on containers. The argument is considered only for the first three levels. Default is “all”.
  • cube: name of the requested datacube. This argument is mandatory only when level is > = 3, otherwise it is not considered. The name must be in PID format.
  • host_filter: optional filter on hosts. Default is “all”.
  • dbms_filter: optional filter on DBMSs. Default is “all”.
  • db_filter: optional filter on databases. Default is “all”.
  • measure_filter: optional filter on measure. Default is “all”.
  • ntransform: optional filter on operation level (number of transformation applied since import). Default is “all”.
  • src_filter: optional filter on source file. Default is “all”.
  • recursive: specifies if the search is done recursively or not. The argument is considered only for the first three levels and may have the following values:
    • no: research only in current path (default)
    • yes: research recursively starting from current path
  • hidden: type of containers to be shown. The argument is considered only for the first three levels and may have the following values:
    • no: only visible containers are shown (default)
    • yes: both hidden and visible containers are shown.

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, list => show operator’s output table).

Examples

Show folders, visible containers and datacubes within a session:

[OPH_TERM] >>  oph_list level=2;cwd=/session-code;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
level “int” “no” “0|1|2|3|4|5|6|7|8” “1” “0” / “8”
exec_mode “string” “no” “async|sync” “async”  
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
path “string” “no”   “-“  
cwd “string” “yes”      
container_filter “string” “no”   “all”  
cube “string” “no”   “all”  
host_filter “string” “no”   “all”  
dbms_filter “int” “no”   “all”  
measure_filter “string” “no”   “all”  
ntransform “int” “no”   “all”  
src_filter “string” “no”   “all”  
db_filter “string” “no”   “all”  
recursive “string” “no” “yes|no” “no”  
hidden “string” “no” “yes|no” “no”  
objkey_filter “string” “no” “all|none|list” “all”