109 lines
3.0 KiB
JavaScript
109 lines
3.0 KiB
JavaScript
// Licensed to Elasticsearch B.V under one or more agreements.
|
|
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
|
|
// See the LICENSE file in the project root for more information
|
|
|
|
'use strict'
|
|
|
|
/* eslint camelcase: 0 */
|
|
/* eslint no-unused-vars: 0 */
|
|
|
|
function buildExplain (opts) {
|
|
// eslint-disable-next-line no-unused-vars
|
|
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
|
|
|
|
const acceptedQuerystring = [
|
|
'analyze_wildcard',
|
|
'analyzer',
|
|
'default_operator',
|
|
'df',
|
|
'stored_fields',
|
|
'lenient',
|
|
'preference',
|
|
'q',
|
|
'routing',
|
|
'_source',
|
|
'_source_excludes',
|
|
'_source_exclude',
|
|
'_source_includes',
|
|
'_source_include',
|
|
'pretty',
|
|
'human',
|
|
'error_trace',
|
|
'source',
|
|
'filter_path'
|
|
]
|
|
|
|
const snakeCase = {
|
|
analyzeWildcard: 'analyze_wildcard',
|
|
defaultOperator: 'default_operator',
|
|
storedFields: 'stored_fields',
|
|
_sourceExcludes: '_source_excludes',
|
|
_sourceExclude: '_source_exclude',
|
|
_sourceIncludes: '_source_includes',
|
|
_sourceInclude: '_source_include',
|
|
errorTrace: 'error_trace',
|
|
filterPath: 'filter_path'
|
|
}
|
|
|
|
/**
|
|
* Perform a explain request
|
|
* Returns information about why a specific matches (or doesn't match) a query.
|
|
* https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html
|
|
*/
|
|
return function explain (params, options, callback) {
|
|
options = options || {}
|
|
if (typeof options === 'function') {
|
|
callback = options
|
|
options = {}
|
|
}
|
|
if (typeof params === 'function' || params == null) {
|
|
callback = params
|
|
params = {}
|
|
options = {}
|
|
}
|
|
|
|
// check required parameters
|
|
if (params['id'] == null) {
|
|
const err = new ConfigurationError('Missing required parameter: id')
|
|
return handleError(err, callback)
|
|
}
|
|
if (params['index'] == null) {
|
|
const err = new ConfigurationError('Missing required parameter: index')
|
|
return handleError(err, callback)
|
|
}
|
|
|
|
// validate headers object
|
|
if (options.headers != null && typeof options.headers !== 'object') {
|
|
const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
|
|
return handleError(err, callback)
|
|
}
|
|
|
|
var warnings = []
|
|
var { method, body, id, index, ...querystring } = params
|
|
querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
|
|
|
|
var ignore = options.ignore
|
|
if (typeof ignore === 'number') {
|
|
options.ignore = [ignore]
|
|
}
|
|
|
|
var path = ''
|
|
|
|
if (method == null) method = body == null ? 'GET' : 'POST'
|
|
path = '/' + encodeURIComponent(index) + '/' + '_explain' + '/' + encodeURIComponent(id)
|
|
|
|
// build request object
|
|
const request = {
|
|
method,
|
|
path,
|
|
body: body || '',
|
|
querystring
|
|
}
|
|
|
|
options.warnings = warnings.length === 0 ? null : warnings
|
|
return makeRequest(request, options, callback)
|
|
}
|
|
}
|
|
|
|
module.exports = buildExplain
|