PXP-7328 Add delete_records and delete_nodes functions (#68)

Author: paulineribeyre

docs/_build/doctrees/environment.pickle

@@ -655,7 +655,7 @@ <h1>Source code for gen3.index</h1><div class="highlight"><pre>
             <span class="n">json</span><span class="p">[</span><span class="s2">&quot;authz&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">authz</span>
 
         <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">_put</span><span class="p">(</span>
-            <span class="s2">&quot;index/blank/&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;index/blank&quot;</span><span class="p">,</span>
             <span class="n">guid</span><span class="p">,</span>
             <span class="n">headers</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;content-type&quot;</span><span class="p">:</span> <span class="s2">&quot;application/json&quot;</span><span class="p">},</span>
             <span class="n">params</span><span class="o">=</span><span class="n">params</span><span class="p">,</span>

docs/_build/doctrees/submission.doctree

@@ -149,10 +149,14 @@ <h2 id="D">D</h2>
 </li>
       <li><a href="metadata.html#gen3.metadata.Gen3Metadata.delete_index_key_path">delete_index_key_path() (gen3.metadata.Gen3Metadata method)</a>
 </li>
-      <li><a href="submission.html#gen3.submission.Gen3Submission.delete_program">delete_program() (gen3.submission.Gen3Submission method)</a>
+      <li><a href="submission.html#gen3.submission.Gen3Submission.delete_node">delete_node() (gen3.submission.Gen3Submission method)</a>
+</li>
+      <li><a href="submission.html#gen3.submission.Gen3Submission.delete_nodes">delete_nodes() (gen3.submission.Gen3Submission method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="submission.html#gen3.submission.Gen3Submission.delete_program">delete_program() (gen3.submission.Gen3Submission method)</a>
+</li>
       <li><a href="submission.html#gen3.submission.Gen3Submission.delete_project">delete_project() (gen3.submission.Gen3Submission method)</a>
 </li>
       <li><a href="indexing.html#gen3.index.Gen3Index.delete_record">delete_record() (gen3.index.Gen3Index method)</a>
@@ -161,6 +165,8 @@ <h2 id="D">D</h2>
         <li><a href="submission.html#gen3.submission.Gen3Submission.delete_record">(gen3.submission.Gen3Submission method)</a>
 </li>
       </ul></li>
+      <li><a href="submission.html#gen3.submission.Gen3Submission.delete_records">delete_records() (gen3.submission.Gen3Submission method)</a>
+</li>
   </ul></td>
 </tr></table>
 

docs/_build/doctrees/tools/indexing.doctree

@@ -97,6 +97,54 @@ <h1>Gen3 Submission Class<a class="headerlink" href="#gen3-submission-class" tit
 </div>
 </dd></dl>
 
+<dl class="method">
+<dt id="gen3.submission.Gen3Submission.delete_node">
+<code class="descname">delete_node</code><span class="sig-paren">(</span><em>program</em>, <em>project</em>, <em>node_name</em>, <em>verbose=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gen3/submission.html#Gen3Submission.delete_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gen3.submission.Gen3Submission.delete_node" title="Permalink to this definition">¶</a></dt>
+<dd><p>Delete all records for a node from a project.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>program</strong> (<em>str</em>) – The program to delete from.</li>
+<li><strong>project</strong> (<em>str</em>) – The project to delete from.</li>
+<li><strong>node_name</strong> (<em>str</em>) – Name of the node to delete</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<p>This deletes a node from the CCLE project in the sandbox commons.</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Gen3Submission</span><span class="o">.</span><span class="n">delete_record</span><span class="p">(</span><span class="s2">&quot;DCF&quot;</span><span class="p">,</span> <span class="s2">&quot;CCLE&quot;</span><span class="p">,</span> <span class="s2">&quot;demographic&quot;</span><span class="p">)</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="gen3.submission.Gen3Submission.delete_nodes">
+<code class="descname">delete_nodes</code><span class="sig-paren">(</span><em>program</em>, <em>project</em>, <em>ordered_node_list</em>, <em>batch_size=100</em>, <em>verbose=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gen3/submission.html#Gen3Submission.delete_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gen3.submission.Gen3Submission.delete_nodes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Delete all records for a list of nodes from a project.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>program</strong> (<em>str</em>) – The program to delete from.</li>
+<li><strong>project</strong> (<em>str</em>) – The project to delete from.</li>
+<li><strong>ordered_node_list</strong> (<em>list</em>) – The list of nodes to delete, in reverse graph submission order</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<p>This deletes a list of nodes from the CCLE project in the sandbox commons.</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Gen3Submission</span><span class="o">.</span><span class="n">delete_record</span><span class="p">(</span><span class="s2">&quot;DCF&quot;</span><span class="p">,</span> <span class="s2">&quot;CCLE&quot;</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;demographic&quot;</span><span class="p">,</span> <span class="s2">&quot;subject&quot;</span><span class="p">,</span> <span class="s2">&quot;experiment&quot;</span><span class="p">])</span>
+</pre></div>
+</div>
+</dd></dl>
+
 <dl class="method">
 <dt id="gen3.submission.Gen3Submission.delete_program">
 <code class="descname">delete_program</code><span class="sig-paren">(</span><em>program</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gen3/submission.html#Gen3Submission.delete_program"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gen3.submission.Gen3Submission.delete_program" title="Permalink to this definition">¶</a></dt>
@@ -144,20 +192,51 @@ <h1>Gen3 Submission Class<a class="headerlink" href="#gen3-submission-class" tit
 <dl class="method">
 <dt id="gen3.submission.Gen3Submission.delete_record">
 <code class="descname">delete_record</code><span class="sig-paren">(</span><em>program</em>, <em>project</em>, <em>uuid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gen3/submission.html#Gen3Submission.delete_record"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gen3.submission.Gen3Submission.delete_record" title="Permalink to this definition">¶</a></dt>
-<dd><p>Delete a record from a project.
-:param program: The program to delete from.
-:type program: str
-:param project: The project to delete from.
-:type project: str
-:param uuid: The uuid of the record to delete
-:type uuid: str</p>
+<dd><p>Delete a record from a project.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>program</strong> (<em>str</em>) – The program to delete from.</li>
+<li><strong>project</strong> (<em>str</em>) – The project to delete from.</li>
+<li><strong>uuid</strong> (<em>str</em>) – The uuid of the record to delete</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
 <p class="rubric">Examples</p>
 <p>This deletes a record from the CCLE project in the sandbox commons.</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Gen3Submission</span><span class="o">.</span><span class="n">delete_record</span><span class="p">(</span><span class="s2">&quot;DCF&quot;</span><span class="p">,</span> <span class="s2">&quot;CCLE&quot;</span><span class="p">,</span> <span class="n">uuid</span><span class="p">)</span>
 </pre></div>
 </div>
 </dd></dl>
 
+<dl class="method">
+<dt id="gen3.submission.Gen3Submission.delete_records">
+<code class="descname">delete_records</code><span class="sig-paren">(</span><em>program</em>, <em>project</em>, <em>uuids</em>, <em>batch_size=100</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gen3/submission.html#Gen3Submission.delete_records"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gen3.submission.Gen3Submission.delete_records" title="Permalink to this definition">¶</a></dt>
+<dd><p>Delete a list of records from a project.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>program</strong> (<em>str</em>) – The program to delete from.</li>
+<li><strong>project</strong> (<em>str</em>) – The project to delete from.</li>
+<li><strong>uuids</strong> (<em>list</em>) – The list of uuids of the records to delete</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<p>This deletes a list of records from the CCLE project in the sandbox commons.</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Gen3Submission</span><span class="o">.</span><span class="n">delete_record</span><span class="p">(</span><span class="s2">&quot;DCF&quot;</span><span class="p">,</span> <span class="s2">&quot;CCLE&quot;</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;uuid1&quot;</span><span class="p">,</span> <span class="s2">&quot;uuid2&quot;</span><span class="p">])</span>
+</pre></div>
+</div>
+</dd></dl>
+
 <dl class="method">
 <dt id="gen3.submission.Gen3Submission.export_node">
 <code class="descname">export_node</code><span class="sig-paren">(</span><em>program</em>, <em>project</em>, <em>node_type</em>, <em>fileformat</em>, <em>filename=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gen3/submission.html#Gen3Submission.export_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gen3.submission.Gen3Submission.export_node" title="Permalink to this definition">¶</a></dt>