blob: fccad659a158d82c505d2a0b391963f853fa8a61 [file] [log] [blame]
Edwin Kempin6cfbb292017-01-04 09:40:50 +01001= Gerrit Code Review - Searching Groups
2
3Group queries only match internal groups. External groups and system
4groups are not included in the query result.
5
Edwin Kempinbad45912017-01-04 13:42:51 +01006== Basic Group Search
7
8Similar to many popular search engines on the web, just enter some
9text and let Gerrit figure out the meaning:
10
11[options="header"]
12|======================================================
13|Description | Examples
14|Name | Foo-Verifiers
15|UUID | 6a1e70e1a88782771a91808c8af9bbb7a9871389
16|Description | deprecated
17|======================================================
18
Edwin Kempin6cfbb292017-01-04 09:40:50 +010019[[search-operators]]
20== Search Operators
21
22Operators act as restrictions on the search. As more operators
23are added to the same query string, they further restrict the
Edwin Kempinbad45912017-01-04 13:42:51 +010024returned results. Search can also be performed by typing only a text
25with no operator, which will match against a variety of fields.
Edwin Kempin6cfbb292017-01-04 09:40:50 +010026
Edwin Kempinc109ec12017-01-04 11:09:09 +010027[[description]]
28description:'DESCRIPTION'::
29+
30Matches groups that have a description that contains 'DESCRIPTION'
31(case-insensitive).
32
Edwin Kempina45b0722017-01-03 16:15:01 +010033[[inname]]
34inname:'NAMEPART'::
35+
36Matches groups that have a name part that starts with 'NAMEPART'
37(case-insensitive).
38
Edwin Kempinb07a4f92017-01-04 12:59:25 +010039[[is]]
Edwin Kempin2086cbb2017-01-16 13:49:15 +010040[[is-visibletoall]]
41is:visibletoall::
Edwin Kempinb07a4f92017-01-04 12:59:25 +010042+
43Matches groups that are in the groups options marked as visible to all
44registered users.
45
Edwin Kempina45b0722017-01-03 16:15:01 +010046[[name]]
47name:'NAME'::
48+
49Matches groups that have the name 'NAME' (case-insensitive).
50
Edwin Kempine661af02017-01-04 12:00:33 +010051[[owner]]
Edwin Kempindad613e2017-01-13 17:08:10 +010052owner:'OWNER'::
Edwin Kempine661af02017-01-04 12:00:33 +010053+
Edwin Kempindad613e2017-01-13 17:08:10 +010054Matches groups that are owned by the group whose name best matches
55'OWNER' or that has the UUID 'OWNER'.
Edwin Kempine661af02017-01-04 12:00:33 +010056
Edwin Kempin6cfbb292017-01-04 09:40:50 +010057[[uuid]]
58uuid:'UUID'::
59+
60Matches groups that have the UUID 'UUID'.
61
62== Magical Operators
63
64[[is-visible]]
65is:visible::
66+
67Magical internal flag to prove the current user has access to read
68the group. This flag is always added to any query.
69
70[[limit]]
71limit:'CNT'::
72+
73Limit the returned results to no more than 'CNT' records. This is
74automatically set to the page size configured in the current user's
75preferences. Including it in a web query may lead to unpredictable
76results with regards to pagination.
77
78GERRIT
79------
80Part of link:index.html[Gerrit Code Review]
81
82SEARCHBOX
83---------