NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated 2nd bullet & last statement for HPCDATAMGM-1745.
Excerpt
hiddentrue

dm_delete_collection

Note

This page is a work in progress.

If your user account has the Group Administrator role, and if you have write permission on a collection, the following command allows you to permanently delete that collection, and associated metadata: 

...

You can delete a collection, including subcollections, files, links, and associated metadata, if the following criteria are all true:

  • Your user account has the group administrator role.
  • You own that collection. For information on the Own permission level, refer to About Permission Levels.

To delete a collection: 

  1. Run the following command:

    Panel
    borderColorsilver
    borderStylesolid
    Clipboard
    AllowLineWraptrue

    dm_delete_collection

...

  1. [

...

  1. optional parameters]

...

  1. <collection-path>


    The following table describes each parameter:

    ParameterDescription

    [-f]

    By default, the system performs a soft deletion. The system retains the specified collection for two years and then permanently deletes it. To perform immediately permanent deletion, include the -f parameter.

    [-r]

    An optional parameter:

    • If you specify this parameter, the system deletes all the files and

...

    • subcollections under the specified collection recursively.
    • If you do not specify this parameter, the system deletes the collection only if it is empty.
    <collection-path>
    A path within DME. Specify the collection that you want to delete.

    The system prompts you to confirm the deletion.

  1. Type Y and press Enter. If you specified the recursive (-r) parameter, the system asks whether you want to see the data that will be deleted. 
  2. Respond to the prompt and press Enter. The system lists or describes the data to be deleted and prompts you to confirm the deletion again.
  3. Type Y and press Enter. The system responds based on your parameters. 

For example, the following command deletes the  /TEST_NO_HIERExample_Archive/downloads collection, all sub-collections subcollections within that collection, and all files within those collections.

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_delete_collection

–r

/

TEST_NO_HIER

Example_Archive/downloads


For instructions on performing a similar task deleting an empty collection in the GUI, refer to Deleting an Empty a Collection via the GUI. To request deletion of data you do not own or older data, contact NCIDataVault@mail.nih.gov.