gerrit/Documentation/user-search-projects.txt
Patrick Hiesel 36de336dc1 Add STATE field to ProjectIndex
This commit adds the ProjectState to the project index and makes it
queryable. V2 was added in this series, so adding a field does not
require creating V3.

Our post processors filter out hidden projects, so it doesn't make much
sense for users to query for them. As a future optimisation we can make
the default query exclude hidden projects by adding 'not state:hidden'
so that we have to do less post-filtering.

Change-Id: I98434e4b4ea232e257cca4b551fcaba21b3db656
2018-07-12 09:24:49 +02:00

54 lines
1.1 KiB
Plaintext

= Gerrit Code Review - Searching Projects
[[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.
[[name]]
name:'NAME'::
+
Matches projects that have exactly the name 'NAME'.
[[inname]]
inname:'NAME'::
+
Matches projects that a name part that starts with 'NAME' (case
insensitive).
[[description]]
description:'DESCRIPTION'::
+
Matches projects whose description contains 'DESCRIPTION', using a
full-text search.
[[state]]
state:'STATE'::
+
Matches project's state. Can be either 'active' or 'read-only'.
== Magical Operators
[[is-visible]]
is:visible::
+
Magical internal flag to prove the current user has access to read
the projects and all the refs. 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
---------