query_builder.js 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  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.buildNestedAgg = function(aggDef, queryNode, target) {
  52. var metric, y;
  53. if (!aggDef.settings) {
  54. return queryNode;
  55. }
  56. var settings = aggDef.settings;
  57. queryNode.nested = {};
  58. queryNode.nested.path = settings.nested.path;
  59. queryNode.aggs = {
  60. nested_aggs: {
  61. filter: {},
  62. aggs: {}
  63. }
  64. };
  65. queryNode.aggs.nested_aggs.filter.term = {};
  66. queryNode.aggs.nested_aggs.filter.term[settings.nested.term] = settings.nested.query;
  67. queryNode.aggs.nested_aggs.aggs = {};
  68. for (y = 0; y < target.metrics.length; y++) {
  69. metric = target.metrics[y];
  70. queryNode.aggs.nested_aggs.aggs[metric.id] = {};
  71. queryNode.aggs.nested_aggs.aggs[metric.id][metric.type] = {field: metric.field};
  72. }
  73. return queryNode;
  74. };
  75. ElasticQueryBuilder.prototype.getDateHistogramAgg = function(aggDef) {
  76. var esAgg = {};
  77. var settings = aggDef.settings || {};
  78. esAgg.interval = settings.interval;
  79. esAgg.field = this.timeField;
  80. esAgg.min_doc_count = settings.min_doc_count || 0;
  81. esAgg.extended_bounds = {min: "$timeFrom", max: "$timeTo"};
  82. esAgg.format = "epoch_millis";
  83. if (esAgg.interval === 'auto') {
  84. esAgg.interval = "$__interval";
  85. }
  86. if (settings.missing) {
  87. esAgg.missing = settings.missing;
  88. }
  89. return esAgg;
  90. };
  91. ElasticQueryBuilder.prototype.getFiltersAgg = function(aggDef) {
  92. var filterObj = {};
  93. for (var i = 0; i < aggDef.settings.filters.length; i++) {
  94. var query = aggDef.settings.filters[i].query;
  95. filterObj[query] = {
  96. query_string: {
  97. query: query,
  98. analyze_wildcard: true
  99. }
  100. };
  101. }
  102. return filterObj;
  103. };
  104. ElasticQueryBuilder.prototype.documentQuery = function(query) {
  105. query.size = 500;
  106. query.sort = {};
  107. query.sort[this.timeField] = {order: 'desc', unmapped_type: 'boolean'};
  108. // fields field not supported on ES 5.x
  109. if (this.esVersion < 5) {
  110. query.fields = ["*", "_source"];
  111. }
  112. query.script_fields = {},
  113. query.fielddata_fields = [this.timeField];
  114. return query;
  115. };
  116. ElasticQueryBuilder.prototype.addAdhocFilters = function(query, adhocFilters) {
  117. if (!adhocFilters) {
  118. return;
  119. }
  120. var i, filter, condition;
  121. for (i = 0; i < adhocFilters.length; i++) {
  122. filter = adhocFilters[i];
  123. condition = {};
  124. condition[filter.key] = filter.value;
  125. switch(filter.operator){
  126. case "=":
  127. query.query.bool.filter.push({"term": condition});
  128. break;
  129. case "!=":
  130. query.query.bool.filter.push({"bool": {"must_not": {"term": condition}}});
  131. break;
  132. case "<":
  133. condition[filter.key] = {"lt": filter.value};
  134. query.query.bool.filter.push({"range": condition});
  135. break;
  136. case ">":
  137. condition[filter.key] = {"gt": filter.value};
  138. query.query.bool.filter.push({"range": condition});
  139. break;
  140. case "=~":
  141. query.query.bool.filter.push({"regexp": condition});
  142. break;
  143. case "!~":
  144. query.query.bool.filter.push({"bool": {"must_not": {"regexp": condition}}});
  145. break;
  146. }
  147. }
  148. };
  149. ElasticQueryBuilder.prototype.build = function(target, adhocFilters, queryString) {
  150. // make sure query has defaults;
  151. target.metrics = target.metrics || [{ type: 'count', id: '1' }];
  152. target.dsType = 'elasticsearch';
  153. target.bucketAggs = target.bucketAggs || [{type: 'date_histogram', id: '2', settings: {interval: 'auto'}}];
  154. target.timeField = this.timeField;
  155. var i, nestedAggs, metric;
  156. var query = {
  157. "size": 0,
  158. "query": {
  159. "bool": {
  160. "filter": [
  161. {"range": this.getRangeFilter()},
  162. {
  163. "query_string": {
  164. "analyze_wildcard": true,
  165. "query": queryString,
  166. }
  167. }
  168. ]
  169. }
  170. }
  171. };
  172. this.addAdhocFilters(query, adhocFilters);
  173. // handle document query
  174. if (target.bucketAggs.length === 0) {
  175. metric = target.metrics[0];
  176. if (metric && metric.type !== 'raw_document') {
  177. throw {message: 'Invalid query'};
  178. }
  179. return this.documentQuery(query, target);
  180. }
  181. nestedAggs = query;
  182. var foundNested = false;
  183. for (i = 0; i < target.bucketAggs.length; i++) {
  184. var aggDef = target.bucketAggs[i];
  185. var esAgg = {};
  186. switch(aggDef.type) {
  187. case 'date_histogram': {
  188. esAgg["date_histogram"] = this.getDateHistogramAgg(aggDef);
  189. break;
  190. }
  191. case 'filters': {
  192. esAgg["filters"] = {filters: this.getFiltersAgg(aggDef)};
  193. break;
  194. }
  195. case 'terms': {
  196. this.buildTermsAgg(aggDef, esAgg, target);
  197. break;
  198. }
  199. case 'geohash_grid': {
  200. esAgg['geohash_grid'] = {field: aggDef.field, precision: aggDef.settings.precision};
  201. break;
  202. }
  203. case 'nested': {
  204. foundNested = true;
  205. this.buildNestedAgg(aggDef, esAgg, target);
  206. }
  207. }
  208. nestedAggs.aggs = nestedAggs.aggs || {};
  209. nestedAggs.aggs[aggDef.id] = esAgg;
  210. nestedAggs = esAgg;
  211. }
  212. if (!foundNested) {
  213. nestedAggs.aggs = {};
  214. for (i = 0; i < target.metrics.length; i++) {
  215. metric = target.metrics[i];
  216. if (metric.type === 'count') {
  217. continue;
  218. }
  219. var aggField = {};
  220. var metricAgg = null;
  221. if (queryDef.isPipelineAgg(metric.type)) {
  222. if (metric.pipelineAgg && /^\d*$/.test(metric.pipelineAgg)) {
  223. metricAgg = { buckets_path: metric.pipelineAgg };
  224. } else {
  225. continue;
  226. }
  227. } else {
  228. metricAgg = {field: metric.field};
  229. }
  230. for (var prop in metric.settings) {
  231. if (metric.settings.hasOwnProperty(prop) && metric.settings[prop] !== null) {
  232. metricAgg[prop] = metric.settings[prop];
  233. }
  234. }
  235. aggField[metric.type] = metricAgg;
  236. nestedAggs.aggs[metric.id] = aggField;
  237. }
  238. }
  239. return query;
  240. };
  241. ElasticQueryBuilder.prototype.getTermsQuery = function(queryDef) {
  242. var query = {
  243. "size": 0,
  244. "query": {
  245. "bool": {
  246. "filter": [{"range": this.getRangeFilter()}]
  247. }
  248. }
  249. };
  250. if (queryDef.query) {
  251. query.query.bool.filter.push({
  252. "query_string": {
  253. "analyze_wildcard": true,
  254. "query": queryDef.query,
  255. }
  256. });
  257. }
  258. var size = 500;
  259. if(queryDef.size){
  260. size = queryDef.size;
  261. }
  262. query.aggs = {
  263. "1": {
  264. "terms": {
  265. "field": queryDef.field,
  266. "size": size,
  267. "order": {
  268. "_term": "asc"
  269. }
  270. },
  271. }
  272. };
  273. return query;
  274. };
  275. return ElasticQueryBuilder;
  276. });