[ARVADOS] updated: 2.1.0-2140-gb9262c0e8

Git user git at public.arvados.org
Mon Mar 21 20:44:15 UTC 2022


Summary of changes:
 doc/api/methods/collections.html.textile.liquid | 30 +++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

       via  b9262c0e8c04f6b3d68f1ca301cc2ec56c2ef164 (commit)
       via  ad9170e0371fe45da29405338efd5f5da58c0abc (commit)
       via  84471cca8804a3360f4eb49cc889cb2ade989bbd (commit)
      from  44c93373e97da98645d41ae8f09c6eef6788bb26 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit b9262c0e8c04f6b3d68f1ca301cc2ec56c2ef164
Merge: 44c93373e ad9170e03
Author: Peter Amstutz <peter.amstutz at curii.com>
Date:   Mon Mar 21 16:43:59 2022 -0400

    Merge branch '18767-filename-search-doc' refs #18767
    
    Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz at curii.com>


commit ad9170e0371fe45da29405338efd5f5da58c0abc
Author: Peter Amstutz <peter.amstutz at curii.com>
Date:   Mon Mar 21 16:30:02 2022 -0400

    18767: Move to 'list' section and mention ways to list files.
    
    Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz at curii.com>

diff --git a/doc/api/methods/collections.html.textile.liquid b/doc/api/methods/collections.html.textile.liquid
index cb2069360..a2a6a77e1 100644
--- a/doc/api/methods/collections.html.textile.liquid
+++ b/doc/api/methods/collections.html.textile.liquid
@@ -55,36 +55,6 @@ Referenced blocks are protected from garbage collection in Keep.
 
 Data can be shared with other users via the Arvados permission model.
 
-h3. Searching Collections for names of file or directories
-
-You can search collections for specific file or directory names (whole or part) using the following filter in a "list":../methods.html#index query.
-
-<pre>
-filters: [["file_names", "ilike", "%sample1234.fastq%"]]
-</pre>
-
-Note: @file_names@ is a hidden field used for indexing.  It is not returned by any API call.  On the client, to get the list of files, you will need to parse the @manifest_text at .
-
-As of this writing (Arvados 2.4), you can also search for directory paths, but _not_ complete file paths.
-
-In other words, this will work (when @dir3@ is a directory):
-
-<pre>
-filters: [["file_names", "ilike", "%dir1/dir2/dir3%"]]
-</pre>
-
-However, this will _not_ return the desired results (where @sample1234.fastq@ is a file):
-
-<pre>
-filters: [["file_names", "ilike", "%dir1/dir2/dir3/sample1234.fastq%"]]
-</pre>
-
-As a workaround, you can search for both the directory path and file name separately, and then filter on the client side.
-
-<pre>
-filters: [["file_names", "ilike", "%dir1/dir2/dir3%"], ["file_names", "ilike", "%sample1234.fastq%"]]
-</pre>
-
 h2. Methods
 
 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update at .
@@ -139,6 +109,36 @@ table(table table-bordered table-condensed).
 
 Note: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in results by default.  If you need it, pass a @select@ parameter that includes @manifest_text at .
 
+h4. Searching Collections for names of file or directories
+
+You can search collections for specific file or directory names (whole or part) using the following filter in a @list@ query.
+
+<pre>
+filters: [["file_names", "ilike", "%sample1234.fastq%"]]
+</pre>
+
+Note: @file_names@ is a hidden field used for indexing.  It is not returned by any API call.  On the client, you can programmatically enumerate all the files in a collection using @arv-ls@, the Python SDK @Collection@ class, Go SDK @FileSystem@ struct, the WebDAV API, or the S3-compatible API.
+
+As of this writing (Arvados 2.4), you can also search for directory paths, but _not_ complete file paths.
+
+In other words, this will work (when @dir3@ is a directory):
+
+<pre>
+filters: [["file_names", "ilike", "%dir1/dir2/dir3%"]]
+</pre>
+
+However, this will _not_ return the desired results (where @sample1234.fastq@ is a file):
+
+<pre>
+filters: [["file_names", "ilike", "%dir1/dir2/dir3/sample1234.fastq%"]]
+</pre>
+
+As a workaround, you can search for both the directory path and file name separately, and then filter on the client side.
+
+<pre>
+filters: [["file_names", "ilike", "%dir1/dir2/dir3%"], ["file_names", "ilike", "%sample1234.fastq%"]]
+</pre>
+
 h3. update
 
 Update attributes of an existing Collection.

-----------------------------------------------------------------------


hooks/post-receive
-- 




More information about the arvados-commits mailing list