SearchElasticsearch 2025.5.31.15¶

Bundle¶

org.apache.nifi | nifi-elasticsearch-restapi-nar

Beschreibung¶

Ein Prozessor, mit dem der Benutzer wiederholt eine paginierte Abfrage (mit Aggregationen) ausführen kann, die mit Elasticsearch JSON DSL geschrieben wurde. „Search After“-/„Point in Time“-Abfragen müssen ein gültiges „Sort“-Feld enthalten. Der Prozessor ruft mehrere Ergebnisseiten ab, bis entweder keine Ergebnisse mehr verfügbar sind oder das Zeitlimit für „Pagination Keep Alive“ erreicht ist. Danach wird die Abfrage mit der ersten Ergebnisseite neu gestartet.

Tags¶

elasticsearch, elasticsearch5, elasticsearch6, elasticsearch7, elasticsearch8, json, page, query, scroll, search

Eingabeanforderung¶

FORBIDDEN

Unterstützt sensible dynamische Eigenschaften¶

false

Eigenschaften¶

Eigenschaft	Beschreibung
Max JSON Field String Length	Die maximal zulässige Länge eines Zeichenfolgenwertes bei der Analyse eines JSON-Dokuments oder -Attributs.
el-abfrage-attribut	Wenn diese Option gesetzt ist, wird die ausgeführte Abfrage auf jedes Ergebnis-Flowfile im angegebenen Attribut gesetzt.
el-rest-client-service	Ein Elasticsearch-Clientdienst, der für Abfragen verwendet wird.
el-rest-fetch-index	Der Name des zu verwendenden Indexes.
el-rest-format-aggregations	Format der Aggregationsausgabe.
el-rest-format-hits	Format der Trefferausgabe.
el-rest-output-no-hits	Ein „Treffer“-FlowFile ausgeben, auch wenn keine Treffer für die Abfrage gefunden wurden. Bei „true“ wird ein leeres „Treffer“-Flowfile ausgegeben, auch wenn „Aggregationen“ ausgegeben werden.
el-rest-pagination-keep-alive	„Keep_alive“-Zeitraum der Paginierung. Zeitraum, in dem Elasticsearch den Scroll-/PIT-Cursor zwischen Anfragen aktiv hält (dies ist nicht die erwartete Zeit zur Rückgabe aller Seiten, sondern die maximal zulässige Zeit zwischen den Seitenabrufen).
el-rest-pagination-type	Zu verwendende Paginierungsmethode. Nicht alle Typen sind für alle Elasticsearch-Versionen verfügbar. Prüfen Sie in der Elasticsearch-Dokumentation, welche Typen für Ihren Dienst geeignet und empfohlen sind.
el-rest-query	Eine Abfrage in JSON-Syntax, nicht in Lucene-Syntax. Beispiel: {„query“:{„match“:{„somefield“:“somevalue“}}}. Wenn die Abfrage leer ist, wird ein standardmäßiges JSON-Objekt verwendet, was zu einer „match_all“-Abfrage in Elasticsearch führt.
el-rest-query-clause	Eine „Abfrage“-Klausel in JSON-Syntax, nicht in Lucene-Syntax. Beispiel: {„match“:{„somefield“:“somevalue“}}. Wenn die Abfrage leer ist, wird ein standardmäßiges JSON-Objekt verwendet, was zu einer „match_all“-Abfrage in Elasticsearch führt.
el-rest-query-definition-style	Wie die JSON-Abfrage für die Verwendung durch den Prozessor definiert werden soll.
el-rest-split-up-aggregations	Ob ein FlowFile mit allen Aggregationen oder ein FlowFile für jede einzelne Aggregation ausgegeben wird.
el-rest-split-up-hits	Ob ein FlowFile mit allen Treffern oder ein FlowFile für jeden einzelnen Treffer oder ein FlowFile mit allen Treffern aus allen paginierten Antworten ausgegeben wird.
el-rest-type	Der Typ dieses Dokuments (wird von Elasticsearch für die Indizierung und Suche verwendet).
es-rest-query-aggs	Eine oder mehrere Abfrage-Aggregationen (oder „aggs“), in der JSON-Syntax. Bsp.: {„items“: {„terms“: {„field“: „product“, „size“: 10}}}
es-rest-query-fields	Felder der indizierten Dokumente, die abgerufen werden sollen, in JSON-Syntax. Bsp: [„user.id“, „http.response.*“, {„field“: „@timestamp“, „format“: „epoch_millis“}]
es-rest-query-script-fields	Felder, die mithilfe der Skriptauswertung zur Laufzeit der Abfrage erstellt werden, in der JSON-Syntax. Bsp: {„test1“: {„script“: {„lang“: „painless“, „source“: „doc[‚price‘].value * 2“}}, „test2“: {„script“: {„lang“: „painless“, „source“: „doc[‚price‘].value * params.factor“, „params“: {„factor“: 2.0}}}}
es-rest-query-sort	Sortieren der Ergebnisse nach einem oder mehreren Feldern, in der JSON-Syntax. Bsp: [{„price“ : {„order“ : „asc“, „mode“ : „avg“}}, {„post_date“ : {„format“: „strict_date_optional_time_nanos“}}]
es-rest-size	Die maximale Anzahl von Dokumenten, die in der Abfrage abgerufen werden sollen. Wenn die Abfrage paginiert ist, gilt diese Größe für jede Seite der Abfrage, nicht für die Größe des gesamten Resultsets.
restart-on-finish	Ob der Prozessor eine weitere Suche mit der gleichen Abfrage starten soll, nachdem eine paginierte Suche abgeschlossen wurde.

Statusmanagement¶

Bereiche	Beschreibung
LOCAL	Der Paginierungsstatus (scrollId, searchAfter, pitId, hitCount, pageCount, pageExpirationTimestamp) wird zwischen den Aufrufen dieses Prozessors beibehalten, bis Scroll/PiT abgelaufen ist (wenn die aktuelle Zeit nach der letzten Abfrageausführung plus dem Keep-Alive-Intervall lder Paginierung liegt).

Beziehungen¶

Name	Beschreibung
aggregate	Aggregationen werden an diese Beziehung weitergeleitet.
failure	Alle FlowFiles, die aus Gründen, die nicht mit der Serververfügbarkeit zusammenhängen, fehlschlagen, werden an diese Beziehung weitergeleitet.
hits	Suchtreffer werden an diese Beziehung weitergeleitet.
retry	Alle FlowFiles, die aufgrund der Server-/Clusterverfügbarkeit fehlschlagen, werden an diese Beziehung weitergeleitet.

Schreibt Attribute¶

Name	Beschreibung
mime.type	application/json
aggregation.name	Der Name der Aggregation, deren Ergebnisse im Ausgabe-FlowFile enthalten sind
aggregation.number	Die Nummer der Aggregation, deren Ergebnisse im Ausgabe-FlowFile enthalten sind
page.number	Die Nummer der Seite (Anfrage), beginnend bei 1, auf der die im Ausgabe-FlowFile enthaltenen Ergebnisse zurückgegeben wurden.
hit.count	Die Anzahl im Ausgabe-FlowFile enthaltenen Treffer
elasticsearch.query.error	Die von Elasticsearch bereitgestellte Fehlermeldung, wenn beim Abfragen des Index ein Fehler auftritt.