From a1ed3a407dc3031810bf3db6e18be13c2f859c25 Mon Sep 17 00:00:00 2001 From: Charles Smith <38529548+techdocsmith@users.noreply.github.com> Date: Fri, 11 Jun 2021 13:48:17 -0700 Subject: [PATCH] clarify bySegment is native only (#11331) --- docs/querying/query-context.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/querying/query-context.md b/docs/querying/query-context.md index 27f4bb245f2..54b09746a69 100644 --- a/docs/querying/query-context.md +++ b/docs/querying/query-context.md @@ -35,7 +35,7 @@ HTTP POST API, or as properties to the JDBC connection. Note that setting query context will override both the default value and the runtime properties value in the format of `druid.query.default.context.{property_key}` (if set). -These parameters apply to all query types. +Unless otherwise noted, the following parameters apply to all query types. |property |default | description | |-----------------|----------------------------------------|----------------------| @@ -47,7 +47,7 @@ These parameters apply to all query types. |populateCache | `true` | Flag indicating whether to save the results of the query to the query cache. Primarily used for debugging. When set to false, it disables saving the results of this query to the query cache. When set to true, Druid uses `druid.broker.cache.populateCache` or `druid.historical.cache.populateCache` to determine whether or not to save the results of this query to the query cache | |useResultLevelCache | `true` | Flag indicating whether to leverage the result level cache for this query. When set to false, it disables reading from the query cache for this query. When set to true, Druid uses `druid.broker.cache.useResultLevelCache` to determine whether or not to read from the result-level query cache | |populateResultLevelCache | `true` | Flag indicating whether to save the results of the query to the result level cache. Primarily used for debugging. When set to false, it disables saving the results of this query to the query cache. When set to true, Druid uses `druid.broker.cache.populateResultLevelCache` to determine whether or not to save the results of this query to the result-level query cache | -|bySegment | `false` | Return "by segment" results. Primarily used for debugging, setting it to `true` returns results associated with the data segment they came from | +|bySegment | `false` | Native queries only. Return "by segment" results. Primarily used for debugging, setting it to `true` returns results associated with the data segment they came from | |finalize | `true` | Flag indicating whether to "finalize" aggregation results. Primarily used for debugging. For instance, the `hyperUnique` aggregator will return the full HyperLogLog sketch instead of the estimated cardinality when this flag is set to `false` | |maxScatterGatherBytes| `druid.server.http.maxScatterGatherBytes` | Maximum number of bytes gathered from data processes such as Historicals and realtime processes to execute a query. This parameter can be used to further reduce `maxScatterGatherBytes` limit at query time. See [Broker configuration](../configuration/index.md#broker) for more details.| |maxQueuedBytes | `druid.broker.http.maxQueuedBytes` | Maximum number of bytes queued per query before exerting backpressure on the channel to the data server. Similar to `maxScatterGatherBytes`, except unlike that configuration, this one will trigger backpressure rather than query failure. Zero means disabled.|