From: Ward Vandewege <ward@curii.com>
Date: Mon, 27 Sep 2021 16:29:52 +0000 (-0400)
Subject: Add an example to the Python cookbook, "Delete a file from an existing
X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/a31420c0b77005cbe44f90d312c9091ca7f07fdf

Add an example to the Python cookbook, "Delete a file from an existing
collection".

No issue #

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <ward@curii.com>
---

diff --git a/doc/sdk/python/cookbook.html.textile.liquid b/doc/sdk/python/cookbook.html.textile.liquid
index ff3bcf90e0..eda6563d7a 100644
--- a/doc/sdk/python/cookbook.html.textile.liquid
+++ b/doc/sdk/python/cookbook.html.textile.liquid
@@ -242,8 +242,8 @@ h2. Copy files from a collection to a new collection
 {% codeblock as python %}
 import arvados.collection
 
-source_collection = "x1u39-4zz18-krzg64ufvehgitl"
-target_project = "x1u39-j7d0g-67q94einb8ptznm"
+source_collection = "zzzzz-4zz18-zzzzzzzzzzzzzzz"
+target_project = "zzzzz-j7d0g-zzzzzzzzzzzzzzz"
 target_name = "Files copied from source_collection"
 files_to_copy = ["folder1/sample1/sample1_R1.fastq",
                  "folder1/sample2/sample2_R1.fastq"]
@@ -263,8 +263,8 @@ h2. Copy files from a collection to another collection
 {% codeblock as python %}
 import arvados.collection
 
-source_collection = "x1u39-4zz18-krzg64ufvehgitl"
-target_collection = "x1u39-4zz18-67q94einb8ptznm"
+source_collection = "zzzzz-4zz18-zzzzzzzzzzzzzzz"
+target_collection = "zzzzz-4zz18-aaaaaaaaaaaaaaa"
 files_to_copy = ["folder1/sample1/sample1_R1.fastq",
                  "folder1/sample2/sample2_R1.fastq"]
 
@@ -277,6 +277,16 @@ for f in files_to_copy:
 target.save()
 {% endcodeblock %}
 
+h2. Delete a file from an existing collection
+
+{% codeblock as python %}
+import arvados
+
+c = arvados.collection.Collection("zzzzz-4zz18-zzzzzzzzzzzzzzz")
+c.remove("file2.txt")
+c.save()
+{% endcodeblock %}
+
 h2. Listing records with paging
 
 Use the @arvados.util.keyset_list_all@ helper method to iterate over all the records matching an optional filter.  This method handles paging internally and returns results incrementally using a Python iterator.  The first parameter of the method takes a @list@ method of an Arvados resource (@collections@, @container_requests@, etc).