com.palantir.atlasdb.keyvalue.impl.ValidatingQueryRewritingKeyValueService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-client Show documentation
Show all versions of atlasdb-client Show documentation
Palantir open source project
/*
* (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
*
* 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.palantir.atlasdb.keyvalue.impl;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSetMultimap;
import com.google.common.collect.Iterables;
import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.palantir.atlasdb.AtlasDbConstants;
import com.palantir.atlasdb.keyvalue.api.Cell;
import com.palantir.atlasdb.keyvalue.api.ClusterAvailabilityStatus;
import com.palantir.atlasdb.keyvalue.api.ColumnSelection;
import com.palantir.atlasdb.keyvalue.api.KeyAlreadyExistsException;
import com.palantir.atlasdb.keyvalue.api.KeyValueService;
import com.palantir.atlasdb.keyvalue.api.RangeRequest;
import com.palantir.atlasdb.keyvalue.api.RowResult;
import com.palantir.atlasdb.keyvalue.api.TableReference;
import com.palantir.atlasdb.keyvalue.api.Value;
import com.palantir.atlasdb.transaction.impl.TransactionConstants;
import com.palantir.logsafe.Preconditions;
import com.palantir.logsafe.logger.SafeLogger;
import com.palantir.logsafe.logger.SafeLoggerFactory;
import com.palantir.util.paging.TokenBackedBasicResultsPage;
import java.util.Arrays;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import org.apache.commons.lang3.Validate;
/**
* This wrapper KVS should ensure that we're consistent across KVSs with:
* - How we apply tricks to avoid work when people make fairly stupid queries
* (i.e. call out to the database to read in nothing, etc)
* - How we validate query inputs for sanity / correctness
* - Not having a ton of boilerplate in each KVS
*/
public class ValidatingQueryRewritingKeyValueService extends ForwardingKeyValueService {
private static final SafeLogger log = SafeLoggerFactory.get(ValidatingQueryRewritingKeyValueService.class);
private static final String TRANSACTION_ERROR =
"shouldn't be putting into the transaction table at this level of KVS abstraction";
public static ValidatingQueryRewritingKeyValueService create(KeyValueService delegate) {
return new ValidatingQueryRewritingKeyValueService(delegate);
}
private final KeyValueService delegate;
protected ValidatingQueryRewritingKeyValueService(KeyValueService delegate) {
this.delegate = delegate;
}
@Override
public KeyValueService delegate() {
return delegate;
}
@Override
public void createTable(TableReference tableRef, byte[] tableMetadata) {
sanityCheckTableName(tableRef);
sanityCheckTableMetadata(tableRef, tableMetadata);
delegate.createTable(tableRef, tableMetadata);
}
@Override
public void createTables(Map tableRefToTableMetadata) {
if (tableRefToTableMetadata.isEmpty()) {
return;
}
if (tableRefToTableMetadata.size() == 1) {
Map.Entry element = Iterables.getOnlyElement(tableRefToTableMetadata.entrySet());
createTable(element.getKey(), element.getValue());
return;
}
tableRefToTableMetadata.keySet().forEach(this::sanityCheckTableName);
tableRefToTableMetadata.forEach(ValidatingQueryRewritingKeyValueService::sanityCheckTableMetadata);
delegate.createTables(tableRefToTableMetadata);
}
@SuppressWarnings("ValidateConstantMessage") // https://github.com/palantir/gradle-baseline/pull/175
protected void sanityCheckTableName(TableReference tableRef) {
String tableName = tableRef.getQualifiedName();
Validate.isTrue(
(!tableName.startsWith("_") && tableName.contains("."))
|| AtlasDbConstants.HIDDEN_TABLES.contains(tableRef)
|| tableName.startsWith(AtlasDbConstants.NAMESPACE_PREFIX),
"invalid tableName: %s",
tableName);
}
protected static void sanityCheckTableMetadata(TableReference tableRef, byte[] tableMetadata) {
if (tableMetadata == null || Arrays.equals(tableMetadata, AtlasDbConstants.EMPTY_TABLE_METADATA)) {
throw new IllegalArgumentException(String.format(
"Passing in empty table metadata for table '%s' is disallowed,"
+ " as reasoning about such tables is hard. Consider using"
+ " AtlasDbConstants.GENERIC_TABLE_METADATA instead.",
tableRef));
}
}
@Override
public void delete(TableReference tableRef, Multimap keys) {
if (keys.isEmpty()) {
return;
}
delegate.delete(tableRef, keys);
}
@Override
public void deleteRange(TableReference tableRef, RangeRequest rangeRequest) {
if (!rangeRequest.getColumnNames().isEmpty()) {
throw new UnsupportedOperationException(
"We don't anticipate supporting deleting ranges with partial column selections.");
}
delegate.deleteRange(tableRef, rangeRequest);
}
@Override
public Map get(TableReference tableRef, Map timestampByCell) {
if (timestampByCell.isEmpty()) {
return ImmutableMap.of();
}
return delegate.get(tableRef, timestampByCell);
}
@Override
public Multimap getAllTimestamps(TableReference tableRef, Set cells, long timestamp) {
if (cells.isEmpty()) {
return ImmutableSetMultimap.of();
} else {
return delegate.getAllTimestamps(tableRef, cells, timestamp);
}
}
@Override
public ClusterAvailabilityStatus getClusterAvailabilityStatus() {
return delegate.getClusterAvailabilityStatus();
}
@Override
public Collection getDelegates() {
return ImmutableList.of(delegate);
}
@Override
public Map, byte[]>> getFirstBatchForRanges(
TableReference tableRef, Iterable rangeRequests, long timestamp) {
if (Iterables.isEmpty(rangeRequests)) {
return ImmutableMap.of();
}
return delegate.getFirstBatchForRanges(tableRef, rangeRequests, timestamp);
}
@Override
public Map getLatestTimestamps(TableReference tableRef, Map timestampByCell) {
if (timestampByCell.isEmpty()) {
return ImmutableMap.of();
}
return delegate.getLatestTimestamps(tableRef, timestampByCell);
}
@Override
public Map getRows(
TableReference tableRef, Iterable rows, ColumnSelection columnSelection, long timestamp) {
if (Iterables.isEmpty(rows) || columnSelection.noColumnsSelected()) {
return ImmutableMap.of();
}
return delegate.getRows(tableRef, rows, columnSelection, timestamp);
}
@Override
public void multiPut(Map> valuesByTable, long timestamp)
throws KeyAlreadyExistsException {
if (valuesByTable.isEmpty()) {
return;
}
if (valuesByTable.size() == 1) {
Map.Entry> entry =
Iterables.getOnlyElement(valuesByTable.entrySet());
put(entry.getKey(), entry.getValue(), timestamp);
return;
}
delegate.multiPut(valuesByTable, timestamp);
}
@Override
public void put(TableReference tableRef, Map values, long timestamp)
throws KeyAlreadyExistsException {
Preconditions.checkArgument(timestamp != Long.MAX_VALUE);
Preconditions.checkArgument(timestamp >= 0);
Preconditions.checkArgument(!tableRef.equals(TransactionConstants.TRANSACTION_TABLE), TRANSACTION_ERROR);
if (values.isEmpty()) {
return;
}
delegate.put(tableRef, values, timestamp);
}
@Override
public void putMetadataForTable(TableReference tableRef, byte[] tableMetadata) {
sanityCheckTableMetadata(tableRef, tableMetadata);
delegate.putMetadataForTable(tableRef, tableMetadata);
}
@Override
public void putMetadataForTables(Map tableRefToMetadata) {
if (tableRefToMetadata.isEmpty()) {
return;
}
if (tableRefToMetadata.size() == 1) {
Map.Entry entry = Iterables.getOnlyElement(tableRefToMetadata.entrySet());
putMetadataForTable(entry.getKey(), entry.getValue());
return;
}
tableRefToMetadata.forEach(ValidatingQueryRewritingKeyValueService::sanityCheckTableMetadata);
delegate.putMetadataForTables(tableRefToMetadata);
}
@Override
public void putUnlessExists(TableReference tableRef, Map values) throws KeyAlreadyExistsException {
if (values.isEmpty()) {
return;
}
delegate.putUnlessExists(tableRef, values);
}
@Override
public void putWithTimestamps(TableReference tableRef, Multimap cellValues)
throws KeyAlreadyExistsException {
if (cellValues.isEmpty()) {
return;
}
Preconditions.checkArgument(!tableRef.equals(TransactionConstants.TRANSACTION_TABLE), TRANSACTION_ERROR);
long lastTimestamp = -1;
boolean allAtSameTimestamp = true;
for (Value value : cellValues.values()) {
long timestamp = value.getTimestamp();
Preconditions.checkArgument(timestamp != Long.MAX_VALUE);
Preconditions.checkArgument(timestamp >= 0);
if (lastTimestamp != -1 && timestamp != lastTimestamp) {
allAtSameTimestamp = false;
}
lastTimestamp = timestamp;
}
if (allAtSameTimestamp) {
Multimap cellValuesWithStrippedTimestamp =
Multimaps.transformValues(cellValues, Value.GET_VALUE);
Map putMap = Maps.transformValues(cellValuesWithStrippedTimestamp.asMap(), input -> {
try {
return Iterables.getOnlyElement(input);
} catch (IllegalArgumentException e) {
log.error(
"Application tried to put multiple same-cell values in at same timestamp; attempting to"
+ " perform last-write-wins, but ordering is not guaranteed.",
e);
return Iterables.getLast(input);
}
});
put(tableRef, putMap, lastTimestamp);
return;
}
delegate.putWithTimestamps(tableRef, cellValues);
}
@Override
public void truncateTables(Set tableRefs) {
if (tableRefs.isEmpty()) {
return;
}
if (tableRefs.size() == 1) {
truncateTable(Iterables.getOnlyElement(tableRefs));
return;
}
delegate.truncateTables(tableRefs);
}
}
|