1PMSEARCHTEXTQUERY(3)       Library Functions Manual       PMSEARCHTEXTQUERY(3)
2
3
4

NAME

6       pmSearchTextQuery - fulltext search for metrics, instances and instance
7       domains provided by PCP search services
8

C SYNOPSIS

10       #include <pcp/pmwebapi.h>
11
12       int pmSearchTextQuery(pmSearchSettings  *settings,  pmSearchTextRequest
13       *request, void *arg)
14
15       cc ... -lpcp_web
16

DESCRIPTION

18       Executes  fulltext  search in name, oneline help, helptext (when avail‐
19       able) as specified by request:
20
21       query
22            Query string that will be used to search.
23
24       count
25            Limits number of results. Defaults to 10.
26
27       offset
28            Search offset. Defaults to 0.
29
30       type_metric, type_indom, type_inst
31            Bit flags that limit query to only take into the account  specific
32            type of entities. Defaults to all.
33
34       highlight_name, highlight_oneline, highlight_helptext
35            Bit  flags  that specify whether or not to highlight matched terms
36            in results. Defaults to none. Highlighted terms are  wrapped  with
37            `<b>' and `</b>'.
38
39       infields_name, infields_oneline, infields_helptext
40            Bit  flags that allow limiting fulltext search query matching only
41            to specified fields. Defaults to all.
42
43       return_name, return_indom, return_oneline, return_helptext, return_type
44            Bit flags for omitting specific fields from  result.  Defaults  to
45            all.  Fields may be omitted either way if value of a field doesn't
46            exist for a given record.
47
48       Each entity matched by the request above will be passed to  on_text_re‐
49       sult callback provided by settings.
50

DIAGNOSTICS

52       This  function  always  returns zero on success.  On failure a negative
53       PMAPI error code is returned.
54

SEE ALSO

56       pmproxy(1),  pmlogger(1),   pmsearch(1),   redis-server(1),   pmSearch‐
57       Setup(3), PMAPI(3) and PMWEBAPI(3).
58
59
60
61Performance Co-Pilot                  PCP                 PMSEARCHTEXTQUERY(3)
Impressum