NAME
pmSearchTextSuggest - search for suggestions of metric or instance names using PCP search services
C SYNOPSIS
#include <pcp/pmwebapi.h>
int pmSearchTextSuggest(pmSearchSettings *settings, pmSearchTextRequest *request, void *arg);
cc ... -lpcp_web
DESCRIPTION
Executes full-text search for names of metrics or instances suitable for auto-completion, specified by request:
- query
-
Query string that will be used to search.
- count
-
Limits number of results. Defaults to 10.
This search performs prefix matching on entity names using FTS5 prefix indexes. Terms in query are appended with a wildcard so that partial names match (e.g. ker matches kernel).
Each entity matched by the request above will be passed to on_text_result callback provided by settings.
DIAGNOSTICS
This function always returns zero on success. On failure a negative PMAPI error code is returned.
SEE ALSO
pmproxy(1), pmlogger(1), pmsearch(1), pmSearchSetup(3), PMAPI(3) and PMWEBAPI(3).