pmSearchTextSuggest(3)

pmSearchTextSuggest3

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

Overview

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.

Releases

4 releases since Debian 11 (Bullseye); the text changed 3 times.

  1. 11
  2. 12
  3. 13
  4. Arch

From pcp 7.2.2-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.