From fcc9bf4f269fd63e3248bdc01d93c5718565d7d0 Mon Sep 17 00:00:00 2001 From: fjy Date: Thu, 29 May 2014 10:19:11 -0700 Subject: [PATCH] document limitspec in groupby, fixes #394 --- docs/content/GroupByQuery.md | 4 ++-- docs/content/{OrderBy.md => LimitSpec.md} | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) rename docs/content/{OrderBy.md => LimitSpec.md} (64%) diff --git a/docs/content/GroupByQuery.md b/docs/content/GroupByQuery.md index 00cdf613ea..6781d77cbf 100644 --- a/docs/content/GroupByQuery.md +++ b/docs/content/GroupByQuery.md @@ -43,14 +43,14 @@ An example groupBy query object is shown below: } ``` -There are 9 main parts to a groupBy query: +There are 11 main parts to a groupBy query: |property|description|required?| |--------|-----------|---------| |queryType|This String should always be "groupBy"; this is the first thing Druid looks at to figure out how to interpret the query|yes| |dataSource|A String defining the data source to query, very similar to a table in a relational database, or a [DataSource](DataSource.html) structure.|yes| |dimensions|A JSON list of dimensions to do the groupBy over|yes| -|orderBy|See [OrderBy](OrderBy.html).|no| +|limitSpec|See [LimitSpec](LimitSpec.html).|no| |having|See [Having](Having.html).|no| |granularity|Defines the granularity of the query. See [Granularities](Granularities.html)|yes| |filter|See [Filters](Filters.html)|no| diff --git a/docs/content/OrderBy.md b/docs/content/LimitSpec.md similarity index 64% rename from docs/content/OrderBy.md rename to docs/content/LimitSpec.md index 97f999cad8..e2ad6c9121 100644 --- a/docs/content/OrderBy.md +++ b/docs/content/LimitSpec.md @@ -2,7 +2,7 @@ layout: doc_page --- # Sort groupBy Query Results -The orderBy field provides the functionality to sort and limit the set of results from a groupBy query. If you group by a single dimension and are ordering by a single metric, we highly recommend using [TopN Queries](TopNQuery.html) instead. The performance will be substantially better. Available options are: +The limitSpec field provides the functionality to sort and limit the set of results from a groupBy query. If you group by a single dimension and are ordering by a single metric, we highly recommend using [TopN Queries](TopNQuery.html) instead. The performance will be substantially better. Available options are: ### DefaultLimitSpec -- GitLab