com.google.gerrit.index.query.InternalQuery Maven / Gradle / Ivy
// Copyright (C) 2016 The Android Open Source Project
//
// Licensed 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.
package com.google.gerrit.index.query;
import static com.google.common.base.Preconditions.checkArgument;
import static java.util.stream.Collectors.toSet;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.exceptions.StorageException;
import com.google.gerrit.index.Index;
import com.google.gerrit.index.IndexCollection;
import com.google.gerrit.index.IndexConfig;
import com.google.gerrit.index.Schema;
import com.google.gerrit.index.SchemaFieldDefs.SchemaField;
import java.util.Arrays;
import java.util.List;
import java.util.function.Supplier;
/**
* Execute a single query over a secondary index, for use by Gerrit internals.
*
* By default, visibility of returned entities is not enforced (unlike in {@link
* QueryProcessor}). The methods in this class are not typically used by user-facing paths, but
* rather by internal callers that need to process all matching results.
*
*
Instances are one-time-use. Other singleton classes should inject a Provider rather than
* holding on to a single instance.
*/
public class InternalQuery> {
private final QueryProcessor queryProcessor;
protected final IndexCollection> indexes;
protected final IndexConfig indexConfig;
protected InternalQuery(
QueryProcessor queryProcessor,
IndexCollection> indexes,
IndexConfig indexConfig) {
this.queryProcessor = queryProcessor.enforceVisibility(false);
this.indexes = indexes;
this.indexConfig = indexConfig;
}
@SuppressWarnings("unchecked")
protected final Q self() {
return (Q) this;
}
@CanIgnoreReturnValue
final Q setStart(int start) {
queryProcessor.setStart(start);
return self();
}
@CanIgnoreReturnValue
public final Q setLimit(int n) {
queryProcessor.setUserProvidedLimit(n, /* applyDefaultLimit */ false);
return self();
}
@CanIgnoreReturnValue
public final Q enforceVisibility(boolean enforce) {
queryProcessor.enforceVisibility(enforce);
return self();
}
@SafeVarargs
@CanIgnoreReturnValue
public final Q setRequestedFields(SchemaField... fields) {
checkArgument(fields.length > 0, "requested field list is empty");
queryProcessor.setRequestedFields(
Arrays.stream(fields).map(SchemaField::getName).collect(toSet()));
return self();
}
@CanIgnoreReturnValue
public final Q noFields() {
queryProcessor.setRequestedFields(ImmutableSet.of());
return self();
}
public final ImmutableList query(Predicate p) {
return queryResults(p).entities();
}
final QueryResult queryResults(Predicate p) {
try {
return queryProcessor.query(p);
} catch (QueryParseException e) {
throw new StorageException(e);
}
}
/**
* Run multiple queries in parallel.
*
* If a limit was specified using {@link #setLimit(int)}, that limit is applied to each query
* independently.
*
* @param queries list of queries.
* @return results of the queries, one list of results per input query, in the same order as the
* input.
*/
public final List> query(List> queries) {
try {
return Lists.transform(queryProcessor.query(queries), QueryResult::entities);
} catch (QueryParseException e) {
throw new StorageException(e);
}
}
@Nullable
protected final Schema schema() {
Index index = indexes != null ? indexes.getSearchIndex() : null;
return index != null ? index.getSchema() : null;
}
/**
* Query a predicate repeatedly until all results are exhausted.
*
* Capable of iterating through all results regardless of limits. The passed {@code
* querySupplier} may choose to pre-set limits or not; this only affects the number of queries
* that may be issued, not the size of the final results.
*
*
Since multiple queries may be issued, this method is subject to races when the result set
* changes mid-iteration. This may result in skipped results, if an entity gets modified to jump
* to the front of the list after this method has passed it. It may also result in duplicate
* results, if an entity at the end of one batch of results gets pushed back further, putting it
* at the beginning of the next batch. This race cannot be avoided unless we change the underlying
* index interface to support true continuation tokens.
*
* @param querySupplier supplier for queries. Callers will generally pass a lambda that invokes an
* underlying {@code Provider}, since the instances are not reusable. The
* lambda may also call additional methods on the newly-created query, such as {@link
* #enforceVisibility(boolean)}.
* @param predicate predicate to search for.
* @param result type.
* @return exhaustive list of results, subject to the race condition described above.
*/
protected static ImmutableList queryExhaustively(
Supplier> querySupplier, Predicate predicate) {
ImmutableList.Builder b = null;
int start = 0;
while (true) {
QueryResult qr = querySupplier.get().setStart(start).queryResults(predicate);
if (b == null) {
if (!qr.more()) {
return qr.entities();
}
b = ImmutableList.builder();
}
b.addAll(qr.entities());
if (!qr.more()) {
return b.build();
}
start += qr.entities().size();
}
}
}