dsl-builder
Version:
OpenSearch Query Builder - Extract from OpenSearch Dashboards
237 lines (236 loc) • 9.63 kB
JavaScript
;
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Any modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.toOpenSearchQuery = exports.buildNodeParams = void 0;
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const lodash_1 = require("lodash");
const filters_1 = require("../../filters");
const get_fields_1 = require("./utils/get_fields");
const utils_1 = require("../../utils");
const get_full_field_name_node_1 = require("./utils/get_full_field_name_node");
const ast = __importStar(require("../ast"));
const literal = __importStar(require("../node_types/literal"));
const wildcard = __importStar(require("../node_types/wildcard"));
function buildNodeParams(fieldName, value, isPhrase = false) {
if ((0, lodash_1.isUndefined)(fieldName)) {
throw new Error('fieldName is a required argument');
}
if ((0, lodash_1.isUndefined)(value)) {
throw new Error('value is a required argument');
}
const fieldNode = typeof fieldName === 'string'
? ast.fromLiteralExpression(fieldName)
: literal.buildNode(fieldName);
const valueNode = typeof value === 'string'
? ast.fromLiteralExpression(value)
: literal.buildNode(value);
const isPhraseNode = literal.buildNode(isPhrase);
return {
arguments: [fieldNode, valueNode, isPhraseNode],
};
}
exports.buildNodeParams = buildNodeParams;
function toOpenSearchQuery(node, indexPattern, config = {}, context = {}) {
const { arguments: [fieldNameArg, valueArg, isPhraseArg], } = node;
const fullFieldNameArg = (0, get_full_field_name_node_1.getFullFieldNameNode)(fieldNameArg, indexPattern, (context === null || context === void 0 ? void 0 : context.nested) ? context.nested.path : undefined);
const fieldName = ast.toOpenSearchQuery(fullFieldNameArg);
const value = !(0, lodash_1.isUndefined)(valueArg)
? ast.toOpenSearchQuery(valueArg)
: valueArg;
const type = isPhraseArg.value ? 'phrase' : 'best_fields';
if (fullFieldNameArg.value === null) {
if (valueArg.type === 'wildcard') {
return {
query_string: {
query: wildcard.toQueryStringQuery(valueArg),
},
};
}
return {
multi_match: {
type,
query: value,
lenient: true,
},
};
}
const fields = indexPattern ? (0, get_fields_1.getFields)(fullFieldNameArg, indexPattern) : [];
// If no fields are found in the index pattern we send through the given field name as-is. We do this to preserve
// the behaviour of lucene on dashboards where there are panels based on different index patterns that have different
// fields. If a user queries on a field that exists in one pattern but not the other, the index pattern without the
// field should return no results. It's debatable whether this is desirable, but it's been that way forever, so we'll
// keep things familiar for now.
if (fields && fields.length === 0) {
fields.push({
name: ast.toOpenSearchQuery(fullFieldNameArg),
scripted: false,
type: '',
});
}
const isExistsQuery = valueArg.type === 'wildcard' && value === '*';
const isAllFieldsQuery = (fullFieldNameArg.type === 'wildcard' &&
fieldName === '*') ||
(fields && indexPattern && fields.length === indexPattern.fields.length);
const isMatchAllQuery = isExistsQuery && isAllFieldsQuery;
if (isMatchAllQuery) {
return { match_all: {} };
}
const queries = fields.reduce((accumulator, field) => {
var _a;
const wrapWithNestedQuery = (query) => {
// Wildcards can easily include nested and non-nested fields. There isn't a good way to let
// users handle this themselves so we automatically add nested queries in this scenario.
if (!(fullFieldNameArg.type === 'wildcard') ||
!(0, lodash_1.get)(field, 'subType.nested') ||
(context === null || context === void 0 ? void 0 : context.nested)) {
return query;
}
else {
return {
nested: {
path: field.subType.nested.path,
query,
score_mode: 'none',
},
};
}
};
if (field.scripted) {
// Exists queries don't make sense for scripted fields
if (!isExistsQuery) {
return [
...accumulator,
{
script: {
...(0, filters_1.getPhraseScript)(field, value),
},
},
];
}
}
else if (isExistsQuery) {
return [
...accumulator,
wrapWithNestedQuery({
exists: {
field: field.name,
},
}),
];
}
else if (valueArg.type === 'wildcard') {
return [
...accumulator,
wrapWithNestedQuery({
query_string: {
fields: [field.name],
query: wildcard.toQueryStringQuery(valueArg),
},
}),
];
}
else if (field.type === 'date') {
/*
If we detect that it's a date field and the user wants an exact date, we need to convert the query to both >= and <= the value provided to force a range query. This is because match and match_phrase queries do not accept a timezone parameter.
dateFormatTZ can have the value of 'Browser', in which case we guess the timezone using moment.tz.guess.
*/
const timeZoneParam = config.dateFormatTZ
? { time_zone: (0, utils_1.getTimeZoneFromSettings)(config.dateFormatTZ) }
: {};
return [
...accumulator,
wrapWithNestedQuery({
range: {
[field.name]: {
gte: value,
lte: value,
...timeZoneParam,
},
},
}),
];
}
else if (((_a = field.esTypes) === null || _a === void 0 ? void 0 : _a.length) === 1 && field.esTypes.includes('keyword')) {
return [
...accumulator,
wrapWithNestedQuery({
term: {
[field.name]: {
value,
...(typeof config.caseInsensitive === 'boolean' && {
case_insensitive: config.caseInsensitive,
}),
},
},
}),
];
}
else {
const queryType = type === 'phrase' ? 'match_phrase' : 'match';
return [
...accumulator,
wrapWithNestedQuery({
[queryType]: {
[field.name]: value,
},
}),
];
}
}, []);
return {
bool: {
should: queries || [],
minimum_should_match: 1,
},
};
}
exports.toOpenSearchQuery = toOpenSearchQuery;