OPH_PRIMITIVES_LIST

Description

Type

Metadata Access.

Behaviour

It shows a list with info about active Ophidia Primitives loaded into a specific DBMS instance.

Parameters

  • level: level of verbosity:
    • 1: shows the primitive’s name
    • 2: shows also the type of the returned value, array or number
    • 3: shows also the name of the related dynamic library
    • 4: shows also the type of the primitive, simple or aggregate
    • 5: shows also the related DBMS id.
  • dbms_filter: id of the specific DBMS instance to look up. If no values is specified, then DBMS used will be the first available.
  • return_type: optional filter on the type of the returned value. Possible values are “array” for a set of data and “number” for a singleton. Mute this filter with the default value “all”.
  • primitive_type: optional filter on the type of the primitive. Possible values are “simple” for row-based functions and “aggregate” for column-based aggregate functions. Mute this filter with the default value “all”.
  • primitive_filter : optional filter on the name of the displayed primitives, with pattern “filter” .
  • limit_filter: optional filter on the maximum number of displayed primitives. Default value is 0, used to show all primitives.

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, primitives_list_list => shows the list of primitives as a grid, primitives_list_tip => shows the operator help message as text).

Examples

Get at most 10 primitives related to dbms instance 1:

[OPH_TERM] >>  oph_primitives_list level=5;dbms_filter=1;return_type=all;primitive_type=all;primitive_filter=oph;limit_filter=10;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
level “int” “no” “1|2|3|4|5” “1” “1” / “5”
dbms_filter “int” “no”   “-“ “1” /
return_type “string” “no” “all|array|number” “all”  
primitive_type “string” “no” “all|simple|aggregate” “all”  
primitive_filter “string” “no”   “”  
limit_filter “int” “no”   “0” “0” /
exec_mode “string” “no” “async|sync” “async”  
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
objkey_filter “string” “no” “all|none|primitives_list _list|primitives_list_tip “ “all”