Description
Type
Data Process.
Behaviour
It removes a container with related dimensions and grids. The container can be deleted logically or physically.
Parameters
- container: name of the input container.
- cwd: absolute path corresponding to the current working directory.
- delete_type: type of removal:
- logical: logical cancellation (default), that is to set container status to hidden
- physical: physical cancellation
- hidden: status of container to be deleted, considered only when delete_type is ‘physical’:
- yes: container to be removed is hidden (default)
- no: container to be removed isn’t hidden
- force: flag used to force the removal of a non-empy container. Considered only when delete_type is ‘physical’.
- with “yes” all datacubes inside the container will be deleted
- with “no” (default) the container will be removed only if it is already empty
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.
- nthreads: maximum number of parallel threads to be used (min. 1). Used only when the force argument is set to “yes”.
- 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, deletecontainer => no output).
Examples
Logically remove the empty visible container “container1”:
[OPH_TERM] >> oph_deletecontainer container=container1;cwd=/session-code;
