GLOBUS SEARCH QUERY
DESCRIPTION
Query a Globus Search index by ID using either a simple query string, or a complex
query document. At least one of -q or --query-document must be provided.
If a query document and command-line options are provided, the options used will override any options which were present on the query document.
OPTIONS
-
-q
TEXT -
The query-string to use to search the index.
-
--query-document
[JSON_FILE|JSON|file:JSON_FILE] -
A complete query document to use to search the index. Use the special
-value to read from stdin instead of a file. -
--limit
INTEGER -
Limit the number of results to return
- --advanced
-
Perform the search using the advanced query syntax
- --bypass-visible-to
-
Bypass the visible_to restriction on searches. This option is only available to the admins of an index
-
--filter-principal-sets
TEXT,TEXT,… -
A principal-sets filter to apply to the results, allowing filtering by predefined sets of identities or groups. Supplied as a comma-delimited list.
- -v, --verbose
-
Control level of output, make it more verbose.
- --quiet
-
Suppress non-essential output. This is higher precedence than
--verbose. - -h, --help
-
Show this message and exit.
-
-F, --format
[unix|json|text] -
Output format for stdout. Defaults to text.
-
--jmespath, --jq
TEXT -
A JMESPath expression to apply to json output. Forces the format to be json processed by this expression.
-
--map-http-status
TEXT -
Map HTTP statuses to any of these exit codes: 0,1,50-99. e.g. "404=50,403=51"
EXIT STATUS
0 on success.
1 if a network or server error occurred, unless --map-http-status has been used to change exit behavior on http error codes.
2 if the command was used improperly.
3 if the command was used on the wrong type of object, e.g. a collection command used on an endpoint.
4 if the command has authentication or authorization requirements which were not met, as in ConsentRequired errors or missing logins.