|
6 | 6 | <head> |
7 | 7 | <meta charset="utf-8" /> |
8 | 8 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
9 | | - <title>Synapse Client — Synapse Python Client 2.1.1 documentation</title> |
| 9 | + <title>Synapse Client — Synapse Python Client 2.2.0 documentation</title> |
10 | 10 | <link rel="stylesheet" href="_static/custom.css" type="text/css" /> |
11 | 11 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
12 | 12 |
|
@@ -46,7 +46,7 @@ <h3>Navigation</h3> |
46 | 46 | <li class="right" > |
47 | 47 | <a href="S3Storage.html" title="S3 Storage Features" |
48 | 48 | accesskey="P">previous</a> |</li> |
49 | | - <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.1.1 documentation</a> »</li> |
| 49 | + <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.0 documentation</a> »</li> |
50 | 50 | <li class="nav-item nav-item-this"><a href="">Synapse Client</a></li> |
51 | 51 | </ul> |
52 | 52 | </div> |
@@ -235,13 +235,14 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli |
235 | 235 |
|
236 | 236 | <dl class="py method"> |
237 | 237 | <dt id="synapseclient.Synapse.downloadTableColumns"> |
238 | | -<code class="sig-name descname">downloadTableColumns</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">table</span></em>, <em class="sig-param"><span class="n">columns</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.downloadTableColumns" title="Permalink to this definition">¶</a></dt> |
| 238 | +<code class="sig-name descname">downloadTableColumns</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">table</span></em>, <em class="sig-param"><span class="n">columns</span></em>, <em class="sig-param"><span class="n">downloadLocation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.downloadTableColumns" title="Permalink to this definition">¶</a></dt> |
239 | 239 | <dd><p>Bulk download of table-associated files.</p> |
240 | 240 | <dl class="field-list simple"> |
241 | 241 | <dt class="field-odd">Parameters</dt> |
242 | 242 | <dd class="field-odd"><ul class="simple"> |
243 | 243 | <li><p><strong>table</strong> – table query result</p></li> |
244 | 244 | <li><p><strong>columns</strong> – a list of column names as strings</p></li> |
| 245 | +<li><p><strong>downloadLocation</strong> – directory into which to download the files</p></li> |
245 | 246 | </ul> |
246 | 247 | </dd> |
247 | 248 | <dt class="field-even">Returns</dt> |
@@ -303,8 +304,6 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli |
303 | 304 | <li><p><strong>limitSearch</strong> – a Synanpse ID used to limit the search in Synapse if entity is specified as a local |
304 | 305 | file. That is, if the file is stored in multiple locations in Synapse only the ones |
305 | 306 | in the specified folder/project will be returned.</p></li> |
306 | | -<li><p><strong>maxThreads</strong> – The maximum number of threads to use when downloading the file (currently only |
307 | | -applies to S3 uploads)</p></li> |
308 | 307 | </ul> |
309 | 308 | </dd> |
310 | 309 | <dt class="field-even">Returns</dt> |
@@ -1397,6 +1396,7 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli |
1397 | 1396 | <li><p><strong>separator</strong> – defaults to comma</p></li> |
1398 | 1397 | <li><p><strong>header</strong> – True by default</p></li> |
1399 | 1398 | <li><p><strong>includeRowIdAndRowVersion</strong> – True by default</p></li> |
| 1399 | +<li><p><strong>downloadLocation</strong> – directory path to download the CSV file to</p></li> |
1400 | 1400 | </ul> |
1401 | 1401 | </dd> |
1402 | 1402 | <dt class="field-even">Returns</dt> |
@@ -1526,13 +1526,13 @@ <h3>Navigation</h3> |
1526 | 1526 | <li class="right" > |
1527 | 1527 | <a href="S3Storage.html" title="S3 Storage Features" |
1528 | 1528 | >previous</a> |</li> |
1529 | | - <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.1.1 documentation</a> »</li> |
| 1529 | + <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.0 documentation</a> »</li> |
1530 | 1530 | <li class="nav-item nav-item-this"><a href="">Synapse Client</a></li> |
1531 | 1531 | </ul> |
1532 | 1532 | </div> |
1533 | 1533 | <div class="footer"> |
1534 | 1534 | © <a href="http://sagebase.org/">Sage Bionetworks</a>. |
1535 | | - Last updated on Aug 03, 2020. |
| 1535 | + Last updated on Aug 31, 2020. |
1536 | 1536 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2. |
1537 | 1537 | </div> |
1538 | 1538 | <script type="text/javascript"> |
|
0 commit comments