query_builder.js 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. define([
  2. './query_def'
  3. ],
  4. function (queryDef) {
  5. 'use strict';
  6. function ElasticQueryBuilder(options) {
  7. this.timeField = options.timeField;
  8. this.esVersion = options.esVersion;
  9. }
  10. ElasticQueryBuilder.prototype.getRangeFilter = function() {
  11. var filter = {};
  12. filter[this.timeField] = {
  13. gte: "$timeFrom",
  14. lte: "$timeTo",
  15. format: "epoch_millis",
  16. };
  17. return filter;
  18. };
  19. ElasticQueryBuilder.prototype.buildTermsAgg = function(aggDef, queryNode, target) {
  20. var metricRef, metric, y;
  21. queryNode.terms = { "field": aggDef.field };
  22. if (!aggDef.settings) {
  23. return queryNode;
  24. }
  25. queryNode.terms.size = parseInt(aggDef.settings.size, 10) === 0 ? 500 : parseInt(aggDef.settings.size, 10);
  26. if (aggDef.settings.orderBy !== void 0) {
  27. queryNode.terms.order = {};
  28. queryNode.terms.order[aggDef.settings.orderBy] = aggDef.settings.order;
  29. // if metric ref, look it up and add it to this agg level
  30. metricRef = parseInt(aggDef.settings.orderBy, 10);
  31. if (!isNaN(metricRef)) {
  32. for (y = 0; y < target.metrics.length; y++) {
  33. metric = target.metrics[y];
  34. if (metric.id === aggDef.settings.orderBy) {
  35. queryNode.aggs = {};
  36. queryNode.aggs[metric.id] = {};
  37. queryNode.aggs[metric.id][metric.type] = {field: metric.field};
  38. break;
  39. }
  40. }
  41. }
  42. }
  43. if (aggDef.settings.min_doc_count !== void 0) {
  44. queryNode.terms.min_doc_count = parseInt(aggDef.settings.min_doc_count, 10);
  45. }
  46. if (aggDef.settings.missing) {
  47. queryNode.terms.missing = aggDef.settings.missing;
  48. }
  49. return queryNode;
  50. };
  51. ElasticQueryBuilder.prototype.getDateHistogramAgg = function(aggDef) {
  52. var esAgg = {};
  53. var settings = aggDef.settings || {};
  54. esAgg.interval = settings.interval;
  55. esAgg.field = this.timeField;
  56. esAgg.min_doc_count = settings.min_doc_count || 0;
  57. esAgg.extended_bounds = {min: "$timeFrom", max: "$timeTo"};
  58. esAgg.format = "epoch_millis";
  59. if (esAgg.interval === 'auto') {
  60. esAgg.interval = "$__interval";
  61. }
  62. if (settings.missing) {
  63. esAgg.missing = settings.missing;
  64. }
  65. return esAgg;
  66. };
  67. ElasticQueryBuilder.prototype.getHistogramAgg = function(aggDef) {
  68. var esAgg = {};
  69. var settings = aggDef.settings || {};
  70. esAgg.interval = settings.interval;
  71. esAgg.field = aggDef.field;
  72. esAgg.min_doc_count = settings.min_doc_count || 0;
  73. if (settings.missing) {
  74. esAgg.missing = settings.missing;
  75. }
  76. return esAgg;
  77. };
  78. ElasticQueryBuilder.prototype.getFiltersAgg = function(aggDef) {
  79. var filterObj = {};
  80. for (var i = 0; i < aggDef.settings.filters.length; i++) {
  81. var query = aggDef.settings.filters[i].query;
  82. var label = aggDef.settings.filters[i].label;
  83. label = label === '' || label === undefined ? query : label;
  84. filterObj[label] = {
  85. query_string: {
  86. query: query,
  87. analyze_wildcard: true
  88. }
  89. };
  90. }
  91. return filterObj;
  92. };
  93. ElasticQueryBuilder.prototype.documentQuery = function(query) {
  94. query.size = 500;
  95. query.sort = {};
  96. query.sort[this.timeField] = {order: 'desc', unmapped_type: 'boolean'};
  97. // fields field not supported on ES 5.x
  98. if (this.esVersion < 5) {
  99. query.fields = ["*", "_source"];
  100. }
  101. query.script_fields = {},
  102. query.docvalue_fields = [this.timeField];
  103. return query;
  104. };
  105. ElasticQueryBuilder.prototype.addAdhocFilters = function(query, adhocFilters) {
  106. if (!adhocFilters) {
  107. return;
  108. }
  109. var i, filter, condition;
  110. for (i = 0; i < adhocFilters.length; i++) {
  111. filter = adhocFilters[i];
  112. condition = {};
  113. condition[filter.key] = filter.value;
  114. switch(filter.operator){
  115. case "=":
  116. query.query.bool.filter.push({"term": condition});
  117. break;
  118. case "!=":
  119. query.query.bool.filter.push({"bool": {"must_not": {"term": condition}}});
  120. break;
  121. case "<":
  122. condition[filter.key] = {"lt": filter.value};
  123. query.query.bool.filter.push({"range": condition});
  124. break;
  125. case ">":
  126. condition[filter.key] = {"gt": filter.value};
  127. query.query.bool.filter.push({"range": condition});
  128. break;
  129. case "=~":
  130. query.query.bool.filter.push({"regexp": condition});
  131. break;
  132. case "!~":
  133. query.query.bool.filter.push({"bool": {"must_not": {"regexp": condition}}});
  134. break;
  135. }
  136. }
  137. };
  138. ElasticQueryBuilder.prototype.build = function(target, adhocFilters, queryString) {
  139. // make sure query has defaults;
  140. target.metrics = target.metrics || [{ type: 'count', id: '1' }];
  141. target.dsType = 'elasticsearch';
  142. target.bucketAggs = target.bucketAggs || [{type: 'date_histogram', id: '2', settings: {interval: 'auto'}}];
  143. target.timeField = this.timeField;
  144. var i, nestedAggs, metric;
  145. var query = {
  146. "size": 0,
  147. "query": {
  148. "bool": {
  149. "filter": [
  150. {"range": this.getRangeFilter()},
  151. {
  152. "query_string": {
  153. "analyze_wildcard": true,
  154. "query": queryString,
  155. }
  156. }
  157. ]
  158. }
  159. }
  160. };
  161. this.addAdhocFilters(query, adhocFilters);
  162. // handle document query
  163. if (target.bucketAggs.length === 0) {
  164. metric = target.metrics[0];
  165. if (metric && metric.type !== 'raw_document') {
  166. throw {message: 'Invalid query'};
  167. }
  168. return this.documentQuery(query, target);
  169. }
  170. nestedAggs = query;
  171. for (i = 0; i < target.bucketAggs.length; i++) {
  172. var aggDef = target.bucketAggs[i];
  173. var esAgg = {};
  174. switch(aggDef.type) {
  175. case 'date_histogram': {
  176. esAgg["date_histogram"] = this.getDateHistogramAgg(aggDef);
  177. break;
  178. }
  179. case 'histogram': {
  180. esAgg["histogram"] = this.getHistogramAgg(aggDef);
  181. break;
  182. }
  183. case 'filters': {
  184. esAgg["filters"] = {filters: this.getFiltersAgg(aggDef)};
  185. break;
  186. }
  187. case 'terms': {
  188. this.buildTermsAgg(aggDef, esAgg, target);
  189. break;
  190. }
  191. case 'geohash_grid': {
  192. esAgg['geohash_grid'] = {field: aggDef.field, precision: aggDef.settings.precision};
  193. break;
  194. }
  195. }
  196. nestedAggs.aggs = nestedAggs.aggs || {};
  197. nestedAggs.aggs[aggDef.id] = esAgg;
  198. nestedAggs = esAgg;
  199. }
  200. nestedAggs.aggs = {};
  201. for (i = 0; i < target.metrics.length; i++) {
  202. metric = target.metrics[i];
  203. if (metric.type === 'count') {
  204. continue;
  205. }
  206. var aggField = {};
  207. var metricAgg = null;
  208. if (queryDef.isPipelineAgg(metric.type)) {
  209. if (metric.pipelineAgg && /^\d*$/.test(metric.pipelineAgg)) {
  210. metricAgg = { buckets_path: metric.pipelineAgg };
  211. } else {
  212. continue;
  213. }
  214. } else {
  215. metricAgg = {field: metric.field};
  216. }
  217. for (var prop in metric.settings) {
  218. if (metric.settings.hasOwnProperty(prop) && metric.settings[prop] !== null) {
  219. metricAgg[prop] = metric.settings[prop];
  220. }
  221. }
  222. aggField[metric.type] = metricAgg;
  223. nestedAggs.aggs[metric.id] = aggField;
  224. }
  225. return query;
  226. };
  227. ElasticQueryBuilder.prototype.getTermsQuery = function(queryDef) {
  228. var query = {
  229. "size": 0,
  230. "query": {
  231. "bool": {
  232. "filter": [{"range": this.getRangeFilter()}]
  233. }
  234. }
  235. };
  236. if (queryDef.query) {
  237. query.query.bool.filter.push({
  238. "query_string": {
  239. "analyze_wildcard": true,
  240. "query": queryDef.query,
  241. }
  242. });
  243. }
  244. var size = 500;
  245. if (queryDef.size) {
  246. size = queryDef.size;
  247. }
  248. query.aggs = {
  249. "1": {
  250. "terms": {
  251. "field": queryDef.field,
  252. "size": size,
  253. "order": {
  254. "_term": "asc"
  255. }
  256. },
  257. }
  258. };
  259. return query;
  260. };
  261. return ElasticQueryBuilder;
  262. });