improve docstrings for downloadTableColumns

Description

Bulk download of table-associated files.

aram table: table query result

the parameter name is not indicative of what it has to be (the result of a table query, not just a table). We could change behavior if a user passed a synapse id of a table, or at least a data frame that has file handle ids in it.

aram columns: a list of column names as strings

be clear that the column names are file handle ids

:returns: a dictionary from file handle ID to path in the local file system.

For example, consider a Synapse table whose ID is "syn12345" with two columns of type FILEHANDLEID named 'foo'
and 'bar'. The associated files are JSON encoded, so we might retrieve the files from Synapse and load for the
second 100 of those rows as shown here::

import json

results = syn.tableQuery('SELECT * FROM syn12345 LIMIT 100 OFFSET 100')
file_map = syn.downloadTableColumns(results, ['foo', 'bar'])

simplify this example to not have limiting and offset. or, if limiting just do 'LIMIT 1'.

Environment

None

Assignee

Unassigned

Reporter

Kenneth Daily

Labels

Validator

Kenneth Daily

Development Area

None

Release Version History

None

Slack Channel

None

Epic Link

Components

Priority

Major