This is an automated email from the ASF dual-hosted git repository.
exceptionfactory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push:
new 94bb8aec97 NIFI-12063 Clarified Elasticsearch Query Documentation
94bb8aec97 is described below
commit 94bb8aec97e83607f5c084a6261923e224dadc58
Author: Chris Sampson <[email protected]>
AuthorDate: Thu Sep 14 20:34:15 2023 +0100
NIFI-12063 Clarified Elasticsearch Query Documentation
Clarify paginated Elasticsearch with SCROLL does not use query parameters
from dynamic properties
This closes #7695
Signed-off-by: David Handermann <[email protected]>
---
.../processors/elasticsearch/PaginatedJsonQueryElasticsearch.java | 4 +++-
.../apache/nifi/processors/elasticsearch/SearchElasticsearch.java | 4 +++-
.../apache/nifi/processors/elasticsearch/api/PaginationType.java | 6 +++---
3 files changed, 9 insertions(+), 5 deletions(-)
diff --git
a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/PaginatedJsonQueryElasticsearch.java
b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/PaginatedJsonQueryElasticsearch.java
index 111053841f..553d338dbe 100644
---
a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/PaginatedJsonQueryElasticsearch.java
+++
b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/PaginatedJsonQueryElasticsearch.java
@@ -54,7 +54,9 @@ import java.util.List;
value = "The value of the URL query parameter",
expressionLanguageScope = ExpressionLanguageScope.FLOWFILE_ATTRIBUTES,
description = "Adds the specified property name/value as a query
parameter in the Elasticsearch URL used for processing. " +
- "These parameters will override any matching parameters in the
query request body")
+ "These parameters will override any matching parameters in the
query request body. " +
+ "For SCROLL type queries, these parameters are only used in
the initial (first page) query as the " +
+ "Elasticsearch Scroll API does not support the same query
parameters for subsequent pages of data.")
@SystemResourceConsideration(resource = SystemResource.MEMORY, description =
"Care should be taken on the size of each page because each response " +
"from Elasticsearch will be loaded into memory all at once and
converted into the resulting flowfiles.")
public class PaginatedJsonQueryElasticsearch extends
AbstractPaginatedJsonQueryElasticsearch {
diff --git
a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/SearchElasticsearch.java
b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/SearchElasticsearch.java
index a7d39a1576..23a7fa3fe5 100644
---
a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/SearchElasticsearch.java
+++
b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/SearchElasticsearch.java
@@ -73,7 +73,9 @@ import java.util.Set;
value = "The value of the URL query parameter",
expressionLanguageScope = ExpressionLanguageScope.FLOWFILE_ATTRIBUTES,
description = "Adds the specified property name/value as a query
parameter in the Elasticsearch URL used for processing. " +
- "These parameters will override any matching parameters in the
query request body")
+ "These parameters will override any matching parameters in the
query request body. " +
+ "For SCROLL type queries, these parameters are only used in
the initial (first page) query as the " +
+ "Elasticsearch Scroll API does not support the same query
parameters for subsequent pages of data.")
@Stateful(scopes = Scope.LOCAL, description = "The pagination state (scrollId,
searchAfter, pitId, hitCount, pageCount, pageExpirationTimestamp) " +
"is retained in between invocations of this processor until the
Scroll/PiT has expired " +
"(when the current time is later than the last query execution plus
the Pagination Keep Alive interval).")
diff --git
a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/api/PaginationType.java
b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/api/PaginationType.java
index 1e33153cb5..35d6d71cee 100644
---
a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/api/PaginationType.java
+++
b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/api/PaginationType.java
@@ -22,9 +22,9 @@ import org.apache.nifi.components.DescribedValue;
import java.util.Arrays;
public enum PaginationType implements DescribedValue {
- SCROLL("pagination-scroll", "Use Elasticsearch \"scroll\" to page
results."),
- SEARCH_AFTER("pagination-search_after", "Use Elasticsearch
\"search_after\" to page sorted results."),
- POINT_IN_TIME("pagination-pit", "Use Elasticsearch (7.10+ with XPack)
\"point in time\" to page sorted results.");
+ SCROLL("pagination-scroll", "Use Elasticsearch \"_scroll\" API to page
results. Does not accept additional query parameters."),
+ SEARCH_AFTER("pagination-search_after", "Use Elasticsearch
\"search_after\" _search API to page sorted results."),
+ POINT_IN_TIME("pagination-pit", "Use Elasticsearch (7.10+ with XPack)
\"point in time\" _search API to page sorted results.");
private final String value;
private final String description;
