dsl-builder
Version:
OpenSearch Query Builder - Extract from OpenSearch Dashboards
151 lines (150 loc) • 4.91 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.
*/
/*
* 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.
*/
import { getOsdFieldOverrides, getOsdFieldType } from '../../osd_field_types';
import { OSD_FIELD_TYPES } from '../../osd_field_types/types';
export class IndexPatternField {
constructor(spec, displayName) {
this.spec = { ...spec, type: spec.name === '_source' ? '_source' : spec.type };
this.displayName = displayName;
this.osdFieldType = getOsdFieldType(spec.type);
}
// writable attrs
/**
* Count is used for field popularity
*/
get count() {
return this.spec.count || 0;
}
set count(count) {
this.spec.count = count;
}
/**
* Script field code
*/
get script() {
return this.spec.script;
}
set script(script) {
this.spec.script = script;
}
/**
* Script field language
*/
get lang() {
return this.spec.lang;
}
set lang(lang) {
this.spec.lang = lang;
}
/**
* Description of field type conflicts across different indices in the same index pattern
*/
get conflictDescriptions() {
return this.spec.conflictDescriptions;
}
set conflictDescriptions(conflictDescriptions) {
this.spec.conflictDescriptions = conflictDescriptions;
}
// read only attrs
get name() {
return this.spec.name;
}
get type() {
return this.spec.type;
}
get esTypes() {
return this.spec.esTypes;
}
get scripted() {
return !!this.spec.scripted;
}
get searchable() {
return !!(this.spec.searchable || this.scripted);
}
get aggregatable() {
return !!(this.spec.aggregatable || this.scripted);
}
get readFromDocValues() {
return !!(this.spec.readFromDocValues && !this.scripted);
}
get subType() {
return this.spec.subType;
}
// not writable, not serialized
get sortable() {
return (this.name === '_score' ||
((this.spec.indexed || this.aggregatable) && this.osdFieldType.sortable));
}
get filterable() {
if (getOsdFieldOverrides().filterable !== undefined)
return !!getOsdFieldOverrides().filterable;
return (this.name === '_id' ||
this.scripted ||
((this.spec.indexed || this.searchable) && this.osdFieldType.filterable));
}
get visualizable() {
if (getOsdFieldOverrides().visualizable !== undefined)
return !!getOsdFieldOverrides().visualizable;
const notVisualizableFieldTypes = [OSD_FIELD_TYPES.UNKNOWN, OSD_FIELD_TYPES.CONFLICT];
return this.aggregatable && !notVisualizableFieldTypes.includes(this.spec.type);
}
toJSON() {
return {
count: this.count,
script: this.script,
lang: this.lang,
conflictDescriptions: this.conflictDescriptions,
name: this.name,
type: this.type,
esTypes: this.esTypes,
scripted: this.scripted,
searchable: this.searchable,
aggregatable: this.aggregatable,
readFromDocValues: this.readFromDocValues,
subType: this.subType,
};
}
toSpec({ getFormatterForField, } = {}) {
return {
count: this.count,
script: this.script,
lang: this.lang,
conflictDescriptions: this.conflictDescriptions,
name: this.name,
type: this.type,
esTypes: this.esTypes,
scripted: this.scripted,
searchable: this.searchable,
aggregatable: this.aggregatable,
readFromDocValues: this.readFromDocValues,
subType: this.subType,
format: getFormatterForField ? getFormatterForField(this).toJSON() : undefined,
};
}
}