Repository: nifi Updated Branches: refs/heads/master 1e75f8c78 -> 12e384b4b
NIFI-5389 Added additional documentation for JsonQueryElasticsearch. Signed-off-by: Matthew Burgess <[email protected]> This closes #2864 Project: http://git-wip-us.apache.org/repos/asf/nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/12e384b4 Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/12e384b4 Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/12e384b4 Branch: refs/heads/master Commit: 12e384b4be1a186e7e5bb3cf2ebe58124d3c56b5 Parents: 1e75f8c Author: Mike Thomsen <[email protected]> Authored: Mon Jul 9 07:25:44 2018 -0400 Committer: Matthew Burgess <[email protected]> Committed: Mon Jul 9 12:24:02 2018 -0400 ---------------------------------------------------------------------- .../additionalDetails.html | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi/blob/12e384b4/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/resources/docs/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/resources/docs/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/additionalDetails.html b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/resources/docs/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/additionalDetails.html new file mode 100644 index 0000000..3430cde --- /dev/null +++ b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/resources/docs/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/additionalDetails.html @@ -0,0 +1,58 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8" /> + <title>JsonQueryElasticsearch</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> +<body> + <p>This processor is intended for use with the ElasticSearch JSON DSL and ElasticSearch 5.X and newer. It is designed + to be able to take a query from Kibana and execute it as-is against an ElasticSearch cluster. Like all processors in the + "restapi" bundle, it uses the official Elastic client APIs, so it supports leader detection.</p> + <p>The query to execute can be provided either in the Query configuration property or in an attribute on a flowfile. In + the latter case, the name of the attribute (Expression Language is supported here) must be provided in the Query Attribute + property.</p> + <p>Additionally, search results and aggregation results can be split up into multiple flowfiles. Aggregation results + will only be split at the top level because nested aggregations lose their context (and thus lose their value) if + separated from their parent aggregation. The following is an example query that would be accepted:</p> + <pre> + { + "query": { + "match": { + "restaurant.keyword": "Local Pizzaz FTW Inc" + } + }, + "aggs": { + "weekly_sales": { + "date_histogram": { + "field": "date", + "interval": "week" + }, + "aggs": { + "items": { + "terms": { + "field": "product", + "size": 10 + } + } + } + } + } + } + </pre> +</body> +</html> \ No newline at end of file
