Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added support for QueryStringQuery in rollups #616

Merged
merged 4 commits into from
Jan 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ import org.opensearch.indexmanagement.rollup.resthandler.RestStartRollupAction
import org.opensearch.indexmanagement.rollup.resthandler.RestStopRollupAction
import org.opensearch.indexmanagement.rollup.settings.LegacyOpenDistroRollupSettings
import org.opensearch.indexmanagement.rollup.settings.RollupSettings
import org.opensearch.indexmanagement.rollup.util.QueryShardContextFactory
import org.opensearch.indexmanagement.rollup.util.RollupFieldValueExpressionResolver
import org.opensearch.indexmanagement.settings.IndexManagementSettings
import org.opensearch.indexmanagement.snapshotmanagement.api.resthandler.RestCreateSMPolicyHandler
Expand Down Expand Up @@ -359,6 +360,14 @@ class IndexManagementPlugin : JobSchedulerExtension, NetworkPlugin, ActionPlugin
): Collection<Any> {
val settings = environment.settings()
this.clusterService = clusterService
QueryShardContextFactory.init(
client,
clusterService,
scriptService,
xContentRegistry,
namedWriteableRegistry,
environment
)
rollupInterceptor = RollupInterceptor(clusterService, settings, indexNameExpressionResolver)
val jvmService = JvmService(environment.settings())
val transformRunner = TransformRunner.initialize(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import org.opensearch.index.query.DisMaxQueryBuilder
import org.opensearch.index.query.MatchAllQueryBuilder
import org.opensearch.index.query.MatchPhraseQueryBuilder
import org.opensearch.index.query.QueryBuilder
import org.opensearch.index.query.QueryStringQueryBuilder
import org.opensearch.index.query.RangeQueryBuilder
import org.opensearch.index.query.TermQueryBuilder
import org.opensearch.index.query.TermsQueryBuilder
Expand All @@ -23,12 +24,14 @@ import org.opensearch.indexmanagement.common.model.dimension.Dimension
import org.opensearch.indexmanagement.rollup.model.Rollup
import org.opensearch.indexmanagement.rollup.model.RollupFieldMapping
import org.opensearch.indexmanagement.rollup.model.RollupFieldMapping.Companion.UNKNOWN_MAPPING
import org.opensearch.indexmanagement.rollup.query.QueryStringQueryUtil
import org.opensearch.indexmanagement.rollup.settings.RollupSettings
import org.opensearch.indexmanagement.rollup.util.getDateHistogram
import org.opensearch.indexmanagement.rollup.util.getRollupJobs
import org.opensearch.indexmanagement.rollup.util.isRollupIndex
import org.opensearch.indexmanagement.rollup.util.populateFieldMappings
import org.opensearch.indexmanagement.rollup.util.rewriteSearchSourceBuilder
import org.opensearch.indexmanagement.util.IndexUtils
import org.opensearch.search.aggregations.AggregationBuilder
import org.opensearch.search.aggregations.bucket.histogram.DateHistogramAggregationBuilder
import org.opensearch.search.aggregations.bucket.histogram.DateHistogramInterval
Expand Down Expand Up @@ -84,8 +87,13 @@ class RollupInterceptor(
val indices = request.indices().map { it.toString() }.toTypedArray()
val concreteIndices = indexNameExpressionResolver
.concreteIndexNames(clusterService.state(), request.indicesOptions(), *indices)

val queryFieldMappings = getQueryMetadata(request.source().query())
// To extract fields from QueryStringQueryBuilder we need concrete source index name.
val rollupJob = clusterService.state().metadata.index(index).getRollupJobs()?.get(0)
?: throw IllegalArgumentException("No rollup job associated with target_index")
val queryFieldMappings = getQueryMetadata(
request.source().query(),
IndexUtils.getConcreteIndex(rollupJob.sourceIndex, concreteIndices, clusterService.state())
)
val aggregationFieldMappings = getAggregationMetadata(request.source().aggregations()?.aggregatorFactories)
val fieldMappings = queryFieldMappings + aggregationFieldMappings

Expand Down Expand Up @@ -160,9 +168,10 @@ class RollupInterceptor(
return fieldMappings
}

@Suppress("ComplexMethod")
@Suppress("ComplexMethod", "ThrowsCount")
private fun getQueryMetadata(
query: QueryBuilder?,
concreteSourceIndexName: String,
fieldMappings: MutableSet<RollupFieldMapping> = mutableSetOf()
): Set<RollupFieldMapping> {
if (query == null) {
Expand All @@ -183,32 +192,41 @@ class RollupInterceptor(
// do nothing
}
is BoolQueryBuilder -> {
query.must()?.forEach { this.getQueryMetadata(it, fieldMappings) }
query.mustNot()?.forEach { this.getQueryMetadata(it, fieldMappings) }
query.should()?.forEach { this.getQueryMetadata(it, fieldMappings) }
query.filter()?.forEach { this.getQueryMetadata(it, fieldMappings) }
query.must()?.forEach { this.getQueryMetadata(it, concreteSourceIndexName, fieldMappings) }
query.mustNot()?.forEach { this.getQueryMetadata(it, concreteSourceIndexName, fieldMappings) }
query.should()?.forEach { this.getQueryMetadata(it, concreteSourceIndexName, fieldMappings) }
query.filter()?.forEach { this.getQueryMetadata(it, concreteSourceIndexName, fieldMappings) }
}
is BoostingQueryBuilder -> {
this.getQueryMetadata(query.positiveQuery(), fieldMappings)
this.getQueryMetadata(query.negativeQuery(), fieldMappings)
this.getQueryMetadata(query.positiveQuery(), concreteSourceIndexName, fieldMappings)
this.getQueryMetadata(query.negativeQuery(), concreteSourceIndexName, fieldMappings)
}
is ConstantScoreQueryBuilder -> {
this.getQueryMetadata(query.innerQuery(), fieldMappings)
this.getQueryMetadata(query.innerQuery(), concreteSourceIndexName, fieldMappings)
}
is DisMaxQueryBuilder -> {
query.innerQueries().forEach { this.getQueryMetadata(it, fieldMappings) }
query.innerQueries().forEach { this.getQueryMetadata(it, concreteSourceIndexName, fieldMappings) }
}
is MatchPhraseQueryBuilder -> {
if (!query.analyzer().isNullOrEmpty() || query.slop() != MatchQuery.DEFAULT_PHRASE_SLOP ||
query.zeroTermsQuery() != MatchQuery.DEFAULT_ZERO_TERMS_QUERY
) {
throw IllegalArgumentException(
"The ${query.name} query is currently not supported with analyzer/slop/zero_terms_query in " +
"rollups"
"The ${query.name} query is currently not supported with analyzer/slop/zero_terms_query in rollups"
)
}
fieldMappings.add(RollupFieldMapping(RollupFieldMapping.Companion.FieldType.DIMENSION, query.fieldName(), Dimension.Type.TERMS.type))
}
is QueryStringQueryBuilder -> {
// Throws IllegalArgumentException if unable to parse query
val (queryFields, otherFields) = QueryStringQueryUtil.extractFieldsFromQueryString(query, concreteSourceIndexName)
for (field in queryFields) {
fieldMappings.add(RollupFieldMapping(RollupFieldMapping.Companion.FieldType.DIMENSION, field, Dimension.Type.TERMS.type))
}
for (field in otherFields.keys) {
fieldMappings.add(RollupFieldMapping(RollupFieldMapping.Companion.FieldType.DIMENSION, field, Dimension.Type.TERMS.type))
}
}
else -> {
throw IllegalArgumentException("The ${query.name} query is currently not supported in rollups")
}
Expand Down Expand Up @@ -285,9 +303,9 @@ class RollupInterceptor(
val matchedRollup = pickRollupJob(matchingRollupJobs.keys)
val fieldNameMappingTypeMap = matchingRollupJobs.getValue(matchedRollup).associateBy({ it.fieldName }, { it.mappingType })
if (searchAllJobs) {
request.source(request.source().rewriteSearchSourceBuilder(matchingRollupJobs.keys, fieldNameMappingTypeMap))
request.source(request.source().rewriteSearchSourceBuilder(matchingRollupJobs.keys, fieldNameMappingTypeMap, matchedRollup.sourceIndex))
} else {
request.source(request.source().rewriteSearchSourceBuilder(matchedRollup, fieldNameMappingTypeMap))
request.source(request.source().rewriteSearchSourceBuilder(matchedRollup, fieldNameMappingTypeMap, matchedRollup.sourceIndex))
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/

package org.opensearch.indexmanagement.rollup.query

import org.apache.lucene.search.Query
import org.opensearch.common.regex.Regex
import org.opensearch.index.query.QueryShardContext
import org.opensearch.index.search.QueryStringQueryParser

const val EXISTS = "_exists_"

class QueryStringQueryParserExt : QueryStringQueryParser {

val discoveredFields = mutableListOf<String>()
var hasLonelyTerms = false

constructor(context: QueryShardContext?, lenient: Boolean) : super(context, lenient)
constructor(context: QueryShardContext?, defaultField: String, lenient: Boolean) : super(context, defaultField, lenient)
constructor(context: QueryShardContext, resolvedFields: Map<String, Float>, lenient: Boolean) : super(context, resolvedFields, lenient)

override fun getFuzzyQuery(field: String?, termStr: String?, minSimilarity: Float): Query? {
handleFieldQueryDiscovered(field)
return super.getFuzzyQuery(field, termStr, minSimilarity)
}
override fun getPrefixQuery(field: String?, termStr: String?): Query {
handleFieldQueryDiscovered(field)
return super.getPrefixQuery(field, termStr)
}
override fun getFieldQuery(field: String?, queryText: String?, quoted: Boolean): Query {
handleFieldQueryDiscovered(field, queryText)
return super.getFieldQuery(field, queryText, quoted)
}
override fun getWildcardQuery(field: String?, termStr: String?): Query {
handleFieldQueryDiscovered(field)
return super.getWildcardQuery(field, termStr)
}
override fun getFieldQuery(field: String?, queryText: String?, slop: Int): Query {
handleFieldQueryDiscovered(field, queryText)
return super.getFieldQuery(field, queryText, slop)
}
override fun getRangeQuery(field: String?, part1: String?, part2: String?, startInclusive: Boolean, endInclusive: Boolean): Query {
handleFieldQueryDiscovered(field)
return super.getRangeQuery(field, part1, part2, startInclusive, endInclusive)
}
override fun getRegexpQuery(field: String?, termStr: String?): Query {
handleFieldQueryDiscovered(field)
return super.getRegexpQuery(field, termStr)
}

private fun handleFieldQueryDiscovered(field: String?, queryText: String? = null) {
if (field == null || Regex.isSimpleMatchPattern(field)) {
hasLonelyTerms = true
} else {
if (field == EXISTS && queryText?.isNotEmpty() == true) discoveredFields.add(queryText)
else discoveredFields.add(field)
}
}
}
Loading