[ARVADOS] created: 9165c95ead28f64f2337a5210cedc2bda393e9e5

git at public.curoverse.com git at public.curoverse.com
Thu Nov 20 15:38:48 EST 2014


        at  9165c95ead28f64f2337a5210cedc2bda393e9e5 (commit)


commit 9165c95ead28f64f2337a5210cedc2bda393e9e5
Author: Tim Pierce <twp at curoverse.com>
Date:   Thu Nov 20 15:38:14 2014 -0500

    4595: add documentation for list --filters

diff --git a/doc/user/reference/sdk-cli.html.textile.liquid b/doc/user/reference/sdk-cli.html.textile.liquid
index e696250..23c2ebf 100644
--- a/doc/user/reference/sdk-cli.html.textile.liquid
+++ b/doc/user/reference/sdk-cli.html.textile.liquid
@@ -44,3 +44,37 @@ Get list of groups
 
 Delete a group
 @arv group delete --uuid 6dnxa-j7d0g-iw7i6n43d37jtog@
+
+
+h3. Common commands
+
+Most @arv@ resources accept the following commands:
+
+* @get@
+* @list@
+* @create@
+* @update@
+* @delete@
+
+
+h4. @list@
+
+Arguments accepted by the @list@ subcommand include:
+
+<pre>
+    --limit, -l <i>:     Maximum number of resources to return.
+   --offset, -o <i>:     Number of users to skip before first returned record.
+  --filters, -f <s>:     Conditions for filtering users.
+    --order, -r <s>:     Order in which to return matching users.
+   --select, -s <s>:     Select which fields to return
+     --distinct, -d:     Return each distinct object
+</pre>
+
+The @--filters@ option takes a string describing a JSON list of filters on which the returned resources should be returned. Each filter is a three-element list of _[field, operator, value]_, where the _operator_ may be one of @=@, @<@, @<=@, @>@, @>=@, @!=@, @like@, or @ilike at .
+
+Example:
+
+ at arv collection list --filters '[["name", "=", "PGP VAR inputs"], ["created_at", ">=", "2014-10-01"]]'@
+
+will return a list of all collections visible to the current user which are named "PGP VAR inputs" and were created on or after October 1, 2014.
+

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


hooks/post-receive
-- 




More information about the arvados-commits mailing list