query_builder.js 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  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, size) {
  94. query.size = size;
  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. if (this.esVersion < 5) {
  103. query.fielddata_fields = [this.timeField];
  104. } else {
  105. query.docvalue_fields = [this.timeField];
  106. }
  107. return query;
  108. };
  109. ElasticQueryBuilder.prototype.addAdhocFilters = function(query, adhocFilters) {
  110. if (!adhocFilters) {
  111. return;
  112. }
  113. var i, filter, condition;
  114. for (i = 0; i < adhocFilters.length; i++) {
  115. filter = adhocFilters[i];
  116. condition = {};
  117. condition[filter.key] = filter.value;
  118. switch(filter.operator){
  119. case "=":
  120. query.query.bool.filter.push({"term": condition});
  121. break;
  122. case "!=":
  123. query.query.bool.filter.push({"bool": {"must_not": {"term": condition}}});
  124. break;
  125. case "<":
  126. condition[filter.key] = {"lt": filter.value};
  127. query.query.bool.filter.push({"range": condition});
  128. break;
  129. case ">":
  130. condition[filter.key] = {"gt": filter.value};
  131. query.query.bool.filter.push({"range": condition});
  132. break;
  133. case "=~":
  134. query.query.bool.filter.push({"regexp": condition});
  135. break;
  136. case "!~":
  137. query.query.bool.filter.push({"bool": {"must_not": {"regexp": condition}}});
  138. break;
  139. }
  140. }
  141. };
  142. ElasticQueryBuilder.prototype.build = function(target, adhocFilters, queryString) {
  143. // make sure query has defaults;
  144. target.metrics = target.metrics || [{ type: 'count', id: '1' }];
  145. target.dsType = 'elasticsearch';
  146. target.bucketAggs = target.bucketAggs || [{type: 'date_histogram', id: '2', settings: {interval: 'auto'}}];
  147. target.timeField = this.timeField;
  148. var i, nestedAggs, metric;
  149. var query = {
  150. "size": 0,
  151. "query": {
  152. "bool": {
  153. "filter": [
  154. {"range": this.getRangeFilter()},
  155. {
  156. "query_string": {
  157. "analyze_wildcard": true,
  158. "query": queryString,
  159. }
  160. }
  161. ]
  162. }
  163. }
  164. };
  165. this.addAdhocFilters(query, adhocFilters);
  166. // handle document query
  167. if (target.bucketAggs.length === 0) {
  168. metric = target.metrics[0];
  169. if (!metric || metric.type !== 'raw_document') {
  170. throw {message: 'Invalid query'};
  171. }
  172. var size = (metric.settings && metric.settings.size) || 500;
  173. return this.documentQuery(query, size);
  174. }
  175. nestedAggs = query;
  176. for (i = 0; i < target.bucketAggs.length; i++) {
  177. var aggDef = target.bucketAggs[i];
  178. var esAgg = {};
  179. switch(aggDef.type) {
  180. case 'date_histogram': {
  181. esAgg["date_histogram"] = this.getDateHistogramAgg(aggDef);
  182. break;
  183. }
  184. case 'histogram': {
  185. esAgg["histogram"] = this.getHistogramAgg(aggDef);
  186. break;
  187. }
  188. case 'filters': {
  189. esAgg["filters"] = {filters: this.getFiltersAgg(aggDef)};
  190. break;
  191. }
  192. case 'terms': {
  193. this.buildTermsAgg(aggDef, esAgg, target);
  194. break;
  195. }
  196. case 'geohash_grid': {
  197. esAgg['geohash_grid'] = {field: aggDef.field, precision: aggDef.settings.precision};
  198. break;
  199. }
  200. }
  201. nestedAggs.aggs = nestedAggs.aggs || {};
  202. nestedAggs.aggs[aggDef.id] = esAgg;
  203. nestedAggs = esAgg;
  204. }
  205. nestedAggs.aggs = {};
  206. for (i = 0; i < target.metrics.length; i++) {
  207. metric = target.metrics[i];
  208. if (metric.type === 'count') {
  209. continue;
  210. }
  211. var aggField = {};
  212. var metricAgg = null;
  213. if (queryDef.isPipelineAgg(metric.type)) {
  214. if (metric.pipelineAgg && /^\d*$/.test(metric.pipelineAgg)) {
  215. metricAgg = { buckets_path: metric.pipelineAgg };
  216. } else {
  217. continue;
  218. }
  219. } else {
  220. metricAgg = {field: metric.field};
  221. }
  222. for (var prop in metric.settings) {
  223. if (metric.settings.hasOwnProperty(prop) && metric.settings[prop] !== null) {
  224. metricAgg[prop] = metric.settings[prop];
  225. }
  226. }
  227. aggField[metric.type] = metricAgg;
  228. nestedAggs.aggs[metric.id] = aggField;
  229. }
  230. return query;
  231. };
  232. ElasticQueryBuilder.prototype.getTermsQuery = function(queryDef) {
  233. var query = {
  234. "size": 0,
  235. "query": {
  236. "bool": {
  237. "filter": [{"range": this.getRangeFilter()}]
  238. }
  239. }
  240. };
  241. if (queryDef.query) {
  242. query.query.bool.filter.push({
  243. "query_string": {
  244. "analyze_wildcard": true,
  245. "query": queryDef.query,
  246. }
  247. });
  248. }
  249. var size = 500;
  250. if (queryDef.size) {
  251. size = queryDef.size;
  252. }
  253. query.aggs = {
  254. "1": {
  255. "terms": {
  256. "field": queryDef.field,
  257. "size": size,
  258. "order": {
  259. "_term": "asc"
  260. }
  261. },
  262. }
  263. };
  264. return query;
  265. };
  266. return ElasticQueryBuilder;
  267. });