pmSearchTextQuery(3) — Linux manual page


PMSEARCHTEXTQUERY(3)      Library Functions Manual      PMSEARCHTEXTQUERY(3)

NAME         top

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

C SYNOPSIS         top

       #include <pcp/pmwebapi.h>

       int pmSearchTextQuery(pmSearchSettings *settings, pmSearchTextRequest
       *request, void *arg)

       cc ... -lpcp_web

DESCRIPTION         top

       Executes fulltext search in name, oneline help, helptext (when
       available) as specified by request:

            Query string that will be used to search.

            Limits number of results. Defaults to 10.

            Search offset. Defaults to 0.

       type_metric, type_indom, type_inst
            Bit flags that limit query to only take into the account
            specific type of entities. Defaults to all.

       highlight_name, highlight_oneline, highlight_helptext
            Bit flags that specify whether or not to highlight matched terms
            in results. Defaults to none. Highlighted terms are wrapped with
            `<b>' and `</b>'.

       infields_name, infields_oneline, infields_helptext
            Bit flags that allow limiting fulltext search query matching
            only to specified fields. Defaults to all.

       return_name, return_indom, return_oneline, return_helptext,
            Bit flags for omitting specific fields from result. Defaults to
            all. Fields may be omitted either way if value of a field
            doesn't exist for a given record.

       Each entity matched by the request above will be passed to
       on_text_result callback provided by settings.

DIAGNOSTICS         top

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

SEE ALSO         top

       pmproxy(1), pmlogger(1), pmsearch(1), redis-server(1),
       pmSearchSetup(3), PMAPI(3) and PMWEBAPI(3).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at ⟨⟩.
       If you have a bug report for this manual page, send it to  This page was obtained from the project's upstream
       Git repository ⟨⟩ on
       2020-09-18.  (At that time, the date of the most recent commit that
       was found in the repository was 2020-09-18.)  If you discover any
       rendering problems in this HTML version of the page, or you believe
       there is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

Performance Co-Pilot                 PCP                PMSEARCHTEXTQUERY(3)

Pages that refer to this page: pmSearchClose(3)pmSearchSetConfiguration(3)pmSearchSetEventLoop(3)pmSearchSetMetricRegistry(3)pmSearchSetSlots(3)pmsearchsetup(3)pmSearchSetup(3)pmwebapi(3)PMWEBAPI(3)