query_builder.js 8.4 KB

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