doc/user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Trashing and untrashing data"
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 Collections have a sophisticated data lifecycle, which is documented in the architecture guide at "Collection lifecycle":{{ site.baseurl }}/architecture/keep-data-lifecycle.html#collection_lifecycle.
  13
  14 Arvados supports trashing (deletion) of collections. For a period of time after a collection is trashed, it can be "untrashed". After that period, the collection is permanently deleted, though there may still be ways to recover the data, see "Recovering data":{{ site.baseurl }}/admin/keep-recovering-data.html in the admin guide for more details.
  15
  16 # "*Trashing (deleting) collections*":#delete-collection
  17 # "*Recovering trashed collections*":#trash-recovery
  18
  19 {% include 'tutorial_expectations' %}
  20
  21 h2(#delete-collection). Trashing (deleting) collections
  22
  23 A collection can be trashed using workbench or the arv command line tool.
  24
  25 h3. Trashing a collection using workbench
  26
  27 To trash a collection using workbench, go to the Data collections tab in the project, and use the <i class="fa fa-fw fa-trash-o"></i> trash icon for this collection row.
  28
  29 h3. Trashing a collection using arv command line tool
  30
  31 <pre>
  32 arv collection delete --uuid=zzzzz-4zz18-xxxxxxxxxxxxxxx
  33 </pre>
  34
  35 h2(#trash-recovery). Recovering trashed collections
  36
  37 A collection can be untrashed / recovered using workbench or the arv command line tool.
  38
  39 h3. Untrashing a collection using workbench
  40
  41 To untrash a collection using workbench, go to trash page on workbench by clicking on the "Trash" icon in the top navigation in workbench and use the recycle icon or selection dropdown option.
  42
  43 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/trash-button-topnav.png!
  44
  45 h3. Untrashing a collection using arv command line tool
  46
  47 You can list the trashed collections using the list command.
  48
  49 <pre>
  50 arv collection list --include-trash=true --filters '[["is_trashed", "=", "true"]]'
  51 </pre>
  52
  53 You can then untrash a particular collection using arv using it's uuid.
  54
  55 <pre>
  56 arv collection untrash --uuid=zzzzz-4zz18-xxxxxxxxxxxxxxx
  57 </pre>
  58
  59 The architecture section has a more detailed description of the "data lifecycle":{{ site.baseurl }}/architecture/keep-data-lifecycle.html  in Keep.