gerrit/Documentation/user-search-groups.txt
Alice Kober-Sotzek 498e592c3e Add fields for members and subgroups to the group index
When groups are read from NoteDb, we won't be able to quickly determine
the parent groups of a group or the groups in which an account is a
member. For this reason, we need to add those details to the group index
so that we can perform those lookups from the index.

For convenience and testing reasons, we also expose them via the query
interface.

Change-Id: Ida10ac131318c06db53568e105ef7e223a099d7f
2017-09-13 14:57:46 +02:00

95 lines
2.2 KiB
Plaintext

= Gerrit Code Review - Searching Groups
Group queries only match internal groups. External groups and system
groups are not included in the query result.
== Basic Group Search
Similar to many popular search engines on the web, just enter some
text and let Gerrit figure out the meaning:
[options="header"]
|======================================================
|Description | Examples
|Name | Foo-Verifiers
|UUID | 6a1e70e1a88782771a91808c8af9bbb7a9871389
|Description | deprecated
|======================================================
[[search-operators]]
== Search Operators
Operators act as restrictions on the search. As more operators
are added to the same query string, they further restrict the
returned results. Search can also be performed by typing only a text
with no operator, which will match against a variety of fields.
[[description]]
description:'DESCRIPTION'::
+
Matches groups that have a description that contains 'DESCRIPTION'
(case-insensitive).
[[inname]]
inname:'NAMEPART'::
+
Matches groups that have a name part that starts with 'NAMEPART'
(case-insensitive).
[[is]]
[[is-visibletoall]]
is:visibletoall::
+
Matches groups that are in the groups options marked as visible to all
registered users.
[[name]]
name:'NAME'::
+
Matches groups that have the name 'NAME' (case-insensitive).
[[owner]]
owner:'OWNER'::
+
Matches groups that are owned by the group whose name best matches
'OWNER' or that has the UUID 'OWNER'.
[[uuid]]
uuid:'UUID'::
+
Matches groups that have the UUID 'UUID'.
[[member]]
member:'MEMBER'::
+
Matches groups that have the account represented by 'MEMBER' as a member.
[[subgroup]]
subgroup:'SUBGROUP'::
+
Matches groups that have a subgroup whose name best matches 'SUBGROUP' or
whose UUID is 'SUBGROUP'.
== Magical Operators
[[is-visible]]
is:visible::
+
Magical internal flag to prove the current user has access to read
the group. This flag is always added to any query.
[[limit]]
limit:'CNT'::
+
Limit the returned results to no more than 'CNT' records. This is
automatically set to the page size configured in the current user's
preferences. Including it in a web query may lead to unpredictable
results with regards to pagination.
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------