|
NAME | C SYNOPSIS | DESCRIPTION | DIAGNOSTICS | SEE ALSO | COLOPHON |
PMSEARCHTEXTQUERY(3) Library Functions Manual PMSEARCHTEXTQUERY(3)
pmSearchTextQuery - fulltext search for metrics, instances and
instance domains provided by PCP search services
#include <pcp/pmwebapi.h>
int pmSearchTextQuery(pmSearchSettings *settings, pmSearchTextRequest
*request, void *arg)
cc ... -lpcp_web
Executes fulltext search in name, oneline help, helptext (when
available) as specified by request:
query
Query string that will be used to search.
count
Limits number of results. Defaults to 10.
offset
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,
return_type
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.
This function always returns zero on success. On failure a negative
PMAPI error code is returned.
pmproxy(1), pmlogger(1), pmsearch(1), redis-server(1),
pmSearchSetup(3), PMAPI(3) and PMWEBAPI(3).
This page is part of the PCP (Performance Co-Pilot) project.
Information about the project can be found at ⟨http://www.pcp.io/⟩.
If you have a bug report for this manual page, send it to
pcp@groups.io. This page was obtained from the project's upstream
Git repository ⟨https://github.com/performancecopilot/pcp.git⟩ on
2020-08-13. (At that time, the date of the most recent commit that
was found in the repository was 2020-08-11.) 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
man-pages@man7.org
Performance Co-Pilot PCP PMSEARCHTEXTQUERY(3)