Skip to content
Snippets Groups Projects
Select Git revision
  • rework_legacy_napi
  • ewm10069-DetermineGaugeVolume
  • cppcheck_fixes
  • alma9-test-pipeline
  • main default
  • abs-corr-raster-gauge-volume-check-shape
  • 39013-highlight-bool-keywords-in-script-editor
  • 38301-unpin-mkl
  • bayes_quasi_test_tolerance
  • hb2a_merge_fix
  • update-snap-idf
  • 38668_disable_unsupported_Rietveld_from_diffraction_interface
  • getting_started_mantid_developer_update_info
  • ewm9983_deprecate_unwrapsns
  • EWM10343_ragged_workspace_write_slab_segfault
  • 38968_expose_fitting_params
  • 38701_pearl_transfit_improvements
  • 39082-ornl-next
  • 36084_fix_mdhisto
  • ewm8451-scrap-nappy
  • v6.12.20250324.1657
  • v6.12.0.1
  • v6.12.20250321.0927
  • v6.12.20250320.1713
  • v6.12.0.1rc3
  • v6.12.20250314.1925
  • v6.12.0.1rc2
  • v6.12.20250313.1634
  • v6.12.20250312.2000
  • v6.12.0.1rc1
  • v6.12.20250310.1545
  • v6.12.20250306.2035
  • v6.12.20250304.2007
  • v6.12.20250303.2021
  • v6.12.20250228.2045
  • v6.11.0.5
  • v6.12.0
  • v6.11.0.5rc1
  • v6.11.20250220.1815
  • v6.11.20250218.1111
40 results
Blame Permalink
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
RenameWorkspace-v1.rst 5.06 KiB

Description

Renames a workspace to a different name in the data service. If the same name is provided for input and output then the algorithm will fail with an error. The Renaming is implemented as a removal of the original workspace from the data service and re-addition under the new name.

If run on a group workspace, the members of the group will be renamed if their names follow the pattern groupName_1, groupName_2, etc. (they will be renamed to newName_1, newname_2, etc.). Otherwise, only the group itself will be renamed - the members will keep their previous names.

The new name can be the same as any existing workspaces if the overwrite flag is set to true. This will replace the existing workspace. If the Overwrite flag is set to false and any name is in use RenameWorkspace will not rename the workspace and log an error.

Warning

RenameWorkspace is set to overwrite by default to maintain backwards compatibility. Ensure the overwrite flag is set to false to prevent any existing workspaces being replaced with the renamed workspace.

Usage

Example

Output:

Example - Setting Overwrite on and off:

Output: