org.apache.ignite.internal.table.KeyValueBinaryViewImpl Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.
*/
package org.apache.ignite.internal.table;
import static org.apache.ignite.internal.lang.IgniteExceptionMapperUtil.convertToPublicFuture;
import static org.apache.ignite.internal.util.CompletableFutures.trueCompletedFuture;
import static org.apache.ignite.internal.util.ViewUtils.checkKeysForNulls;
import static org.apache.ignite.internal.util.ViewUtils.sync;
import java.util.ArrayList;
import java.util.BitSet;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Flow;
import java.util.concurrent.Flow.Publisher;
import java.util.function.Function;
import org.apache.ignite.internal.lang.IgniteBiTuple;
import org.apache.ignite.internal.marshaller.MarshallersProvider;
import org.apache.ignite.internal.replicator.TablePartitionId;
import org.apache.ignite.internal.schema.BinaryRow;
import org.apache.ignite.internal.schema.BinaryRowEx;
import org.apache.ignite.internal.schema.SchemaDescriptor;
import org.apache.ignite.internal.schema.SchemaRegistry;
import org.apache.ignite.internal.schema.row.Row;
import org.apache.ignite.internal.streamer.StreamerBatchSender;
import org.apache.ignite.internal.table.criteria.SqlRowProjection;
import org.apache.ignite.internal.table.distributed.schema.SchemaVersions;
import org.apache.ignite.internal.thread.PublicApiThreading;
import org.apache.ignite.internal.tx.InternalTransaction;
import org.apache.ignite.internal.util.IgniteUtils;
import org.apache.ignite.lang.MarshallerException;
import org.apache.ignite.lang.NullableValue;
import org.apache.ignite.sql.IgniteSql;
import org.apache.ignite.sql.ResultSetMetadata;
import org.apache.ignite.sql.SqlRow;
import org.apache.ignite.table.DataStreamerItem;
import org.apache.ignite.table.DataStreamerOptions;
import org.apache.ignite.table.KeyValueView;
import org.apache.ignite.table.ReceiverDescriptor;
import org.apache.ignite.table.Tuple;
import org.apache.ignite.tx.Transaction;
import org.jetbrains.annotations.Nullable;
/**
* Key-value view implementation for binary user-object representation.
*
* NB: Binary view doesn't allow null tuples. Methods return either a tuple that represents the value, or {@code null} if no value
* exists for the given key.
*/
public class KeyValueBinaryViewImpl extends AbstractTableView> implements KeyValueView {
private final TupleMarshallerCache marshallerCache;
/**
* The constructor.
*
* @param tbl Table storage.
* @param schemaReg Schema registry.
* @param schemaVersions Schema versions access.
* @param sql Ignite SQL facade.
* @param marshallers Marshallers provider.
*/
public KeyValueBinaryViewImpl(
InternalTable tbl,
SchemaRegistry schemaReg,
SchemaVersions schemaVersions,
IgniteSql sql,
MarshallersProvider marshallers
) {
super(tbl, schemaVersions, schemaReg, sql, marshallers);
marshallerCache = new TupleMarshallerCache(schemaReg);
}
/** {@inheritDoc} */
@Override
public Tuple get(@Nullable Transaction tx, Tuple key) {
return sync(getAsync(tx, key));
}
/** {@inheritDoc} */
@Override
public CompletableFuture getAsync(@Nullable Transaction tx, Tuple key) {
Objects.requireNonNull(key, "key");
return doOperation(tx, (schemaVersion) -> {
Row keyRow = marshal(key, null, schemaVersion);
return tbl.get(keyRow, (InternalTransaction) tx).thenApply(row -> unmarshalValue(row, schemaVersion));
});
}
/** {@inheritDoc} */
@Override
public NullableValue getNullable(@Nullable Transaction tx, Tuple key) {
return sync(getNullableAsync(tx, key));
}
/** {@inheritDoc} */
@Override
public CompletableFuture> getNullableAsync(@Nullable Transaction tx, Tuple key) {
// This method implemented for consistency and has the same semantics as regular get().
// NullableValue.get() will never return null and there is no ambiguity between value absence and null result.
return getAsync(tx, key).thenApply(r -> r == null ? null : NullableValue.of(r));
}
/** {@inheritDoc} */
@Override
public Tuple getOrDefault(@Nullable Transaction tx, Tuple key, Tuple defaultValue) {
return sync(getOrDefaultAsync(tx, key, defaultValue));
}
/** {@inheritDoc} */
@Override
public CompletableFuture getOrDefaultAsync(@Nullable Transaction tx, Tuple key, Tuple defaultValue) {
Objects.requireNonNull(key, "key");
return doOperation(tx, (schemaVersion) -> {
BinaryRowEx keyRow = marshal(key, null, schemaVersion);
return tbl.get(keyRow, (InternalTransaction) tx)
.thenApply(r -> IgniteUtils.nonNullOrElse(unmarshalValue(r, schemaVersion), defaultValue));
});
}
/** {@inheritDoc} */
@Override
public Map getAll(@Nullable Transaction tx, Collection keys) {
return sync(getAllAsync(tx, keys));
}
/** {@inheritDoc} */
@Override
public CompletableFuture> getAllAsync(@Nullable Transaction tx, Collection keys) {
checkKeysForNulls(keys);
return doOperation(tx, (schemaVersion) -> {
List keyRows = marshalKeys(keys, schemaVersion);
return tbl.getAll(keyRows, (InternalTransaction) tx).thenApply(rows -> unmarshalValues(rows, schemaVersion));
});
}
/** {@inheritDoc} */
@Override
public boolean contains(@Nullable Transaction tx, Tuple key) {
return get(tx, key) != null;
}
/** {@inheritDoc} */
@Override
public CompletableFuture containsAsync(@Nullable Transaction tx, Tuple key) {
return getAsync(tx, key).thenApply(Objects::nonNull);
}
@Override
public boolean containsAll(@Nullable Transaction tx, Collection keys) {
return sync(containsAllAsync(tx, keys));
}
@Override
public CompletableFuture containsAllAsync(@Nullable Transaction tx, Collection keys) {
checkKeysForNulls(keys);
if (keys.isEmpty()) {
return trueCompletedFuture();
}
return doOperation(tx, (schemaVersion) -> {
List keyRows = marshalKeys(keys, schemaVersion);
return tbl.getAll(keyRows, (InternalTransaction) tx).thenApply(rows -> {
for (BinaryRow row : rows) {
if (row == null) {
return false;
}
}
return true;
});
});
}
/** {@inheritDoc} */
@Override
public void put(@Nullable Transaction tx, Tuple key, Tuple val) {
sync(putAsync(tx, key, val));
}
/** {@inheritDoc} */
@Override
public CompletableFuture putAsync(@Nullable Transaction tx, Tuple key, Tuple val) {
Objects.requireNonNull(key, "key");
Objects.requireNonNull(val, "val");
return doOperation(tx, (schemaVersion) -> {
Row row = marshal(key, val, schemaVersion);
return tbl.upsert(row, (InternalTransaction) tx);
});
}
/** {@inheritDoc} */
@Override
public void putAll(@Nullable Transaction tx, Map pairs) {
sync(putAllAsync(tx, pairs));
}
/** {@inheritDoc} */
@Override
public CompletableFuture putAllAsync(@Nullable Transaction tx, Map pairs) {
Objects.requireNonNull(pairs, "pairs");
for (Entry entry : pairs.entrySet()) {
Objects.requireNonNull(entry.getKey(), "key");
Objects.requireNonNull(entry.getValue(), "val");
}
return doOperation(tx, (schemaVersion) -> {
return tbl.upsertAll(marshalPairs(pairs.entrySet(), schemaVersion, null), (InternalTransaction) tx);
});
}
/** {@inheritDoc} */
@Override
public Tuple getAndPut(@Nullable Transaction tx, Tuple key, Tuple val) {
return sync(getAndPutAsync(tx, key, val));
}
/** {@inheritDoc} */
@Override
public CompletableFuture getAndPutAsync(@Nullable Transaction tx, Tuple key, Tuple val) {
Objects.requireNonNull(key, "key");
Objects.requireNonNull(val, "val");
return doOperation(tx, (schemaVersion) -> {
Row row = marshal(key, val, schemaVersion);
return tbl.getAndUpsert(row, (InternalTransaction) tx).thenApply(resultRow -> unmarshalValue(resultRow, schemaVersion));
});
}
/** {@inheritDoc} */
@Override
public NullableValue getNullableAndPut(@Nullable Transaction tx, Tuple key, Tuple val) {
return sync(getNullableAndPutAsync(tx, key, val));
}
/** {@inheritDoc} */
@Override
public CompletableFuture> getNullableAndPutAsync(@Nullable Transaction tx, Tuple key, Tuple val) {
// This method implemented for consistency and has the same semantics as regular get().
// NullableValue.get() will never return null and there is no ambiguity between value absence and null result.
return getAndPutAsync(tx, key, val).thenApply(r -> r == null ? null : NullableValue.of(r));
}
/** {@inheritDoc} */
@Override
public boolean putIfAbsent(@Nullable Transaction tx, Tuple key, Tuple val) {
return sync(putIfAbsentAsync(tx, key, val));
}
/** {@inheritDoc} */
@Override
public CompletableFuture putIfAbsentAsync(@Nullable Transaction tx, Tuple key, Tuple val) {
Objects.requireNonNull(key, "key");
Objects.requireNonNull(val, "val");
return doOperation(tx, (schemaVersion) -> {
Row row = marshal(key, val, schemaVersion);
return tbl.insert(row, (InternalTransaction) tx);
});
}
/** {@inheritDoc} */
@Override
public boolean remove(@Nullable Transaction tx, Tuple key) {
return sync(removeAsync(tx, key));
}
/** {@inheritDoc} */
@Override
public boolean remove(@Nullable Transaction tx, Tuple key, Tuple val) {
return sync(removeAsync(tx, key, val));
}
/** {@inheritDoc} */
@Override
public CompletableFuture removeAsync(@Nullable Transaction tx, Tuple key) {
Objects.requireNonNull(key, "key");
return doOperation(tx, (schemaVersion) -> {
Row row = marshal(key, null, schemaVersion);
return tbl.delete(row, (InternalTransaction) tx);
});
}
/** {@inheritDoc} */
@Override
public CompletableFuture removeAsync(@Nullable Transaction tx, Tuple key, Tuple val) {
Objects.requireNonNull(key, "key");
Objects.requireNonNull(val, "val");
return doOperation(tx, (schemaVersion) -> {
Row row = marshal(key, val, schemaVersion);
return tbl.deleteExact(row, (InternalTransaction) tx);
});
}
/** {@inheritDoc} */
@Override
public Collection removeAll(@Nullable Transaction tx, Collection keys) {
return sync(removeAllAsync(tx, keys));
}
/** {@inheritDoc} */
@Override
public CompletableFuture> removeAllAsync(@Nullable Transaction tx, Collection keys) {
checkKeysForNulls(keys);
return doOperation(tx, (schemaVersion) -> {
List keyRows = marshalKeys(keys, schemaVersion);
return tbl.deleteAll(keyRows, (InternalTransaction) tx).thenApply(rows -> unmarshalKeys(rows, schemaVersion));
});
}
/** {@inheritDoc} */
@Override
public Tuple getAndRemove(@Nullable Transaction tx, Tuple key) {
Objects.requireNonNull(key, "key");
return sync(getAndRemoveAsync(tx, key));
}
/** {@inheritDoc} */
@Override
public CompletableFuture getAndRemoveAsync(@Nullable Transaction tx, Tuple key) {
Objects.requireNonNull(key, "key");
return doOperation(tx, (schemaVersion) -> {
return tbl.getAndDelete(marshal(key, null, schemaVersion), (InternalTransaction) tx)
.thenApply(row -> unmarshalValue(row, schemaVersion));
});
}
/** {@inheritDoc} */
@Override
public NullableValue getNullableAndRemove(@Nullable Transaction tx, Tuple key) {
return sync(getNullableAndRemoveAsync(tx, key));
}
/** {@inheritDoc} */
@Override
public CompletableFuture> getNullableAndRemoveAsync(@Nullable Transaction tx, Tuple key) {
// This method implemented for consistency and has the same semantics as regular get().
// NullableValue.get() will never return null and there is no ambiguity between value absence and null result.
return getAndRemoveAsync(tx, key).thenApply(r -> r == null ? null : NullableValue.of(r));
}
/** {@inheritDoc} */
@Override
public boolean replace(@Nullable Transaction tx, Tuple key, Tuple val) {
return sync(replaceAsync(tx, key, val));
}
/** {@inheritDoc} */
@Override
public boolean replace(@Nullable Transaction tx, Tuple key, Tuple oldVal, Tuple newVal) {
return sync(replaceAsync(tx, key, oldVal, newVal));
}
/** {@inheritDoc} */
@Override
public CompletableFuture replaceAsync(@Nullable Transaction tx, Tuple key, Tuple val) {
Objects.requireNonNull(key, "key");
Objects.requireNonNull(val, "val");
return doOperation(tx, (schemaVersion) -> {
Row row = marshal(key, val, schemaVersion);
return tbl.replace(row, (InternalTransaction) tx);
});
}
/** {@inheritDoc} */
@Override
public CompletableFuture replaceAsync(
@Nullable Transaction tx,
Tuple key,
Tuple oldVal,
Tuple newVal
) {
Objects.requireNonNull(key, "key");
Objects.requireNonNull(oldVal, "oldVal");
Objects.requireNonNull(newVal, "newVal");
return doOperation(tx, (schemaVersion) -> {
Row oldRow = marshal(key, oldVal, schemaVersion);
Row newRow = marshal(key, newVal, schemaVersion);
return tbl.replace(oldRow, newRow, (InternalTransaction) tx);
});
}
/** {@inheritDoc} */
@Override
public Tuple getAndReplace(@Nullable Transaction tx, Tuple key, Tuple val) {
return sync(getAndReplaceAsync(tx, key, val));
}
/** {@inheritDoc} */
@Override
public CompletableFuture getAndReplaceAsync(@Nullable Transaction tx, Tuple key, Tuple val) {
Objects.requireNonNull(key, "key");
Objects.requireNonNull(val, "val");
return doOperation(tx, (schemaVersion) -> {
return tbl.getAndReplace(marshal(key, val, schemaVersion), (InternalTransaction) tx)
.thenApply(row -> unmarshalValue(row, schemaVersion));
});
}
/** {@inheritDoc} */
@Override
public NullableValue getNullableAndReplace(@Nullable Transaction tx, Tuple key, Tuple val) {
return sync(getNullableAndReplaceAsync(tx, key, val));
}
/** {@inheritDoc} */
@Override
public CompletableFuture> getNullableAndReplaceAsync(@Nullable Transaction tx, Tuple key, Tuple val) {
// This method implemented for consistency and has the same semantics as regular get().
// NullableValue.get() will never return null and there is no ambiguity between value absence and null result.
return getAndReplaceAsync(tx, key, val).thenApply(r -> r == null ? null : NullableValue.of(r));
}
/**
* Marshal key-value pair to a row.
*
* @param key Key.
* @param val Value.
* @param schemaVersion Schema version to use when marshalling
* @return Row.
* @throws MarshallerException If failed to marshal key and/or value.
*/
private Row marshal(Tuple key, @Nullable Tuple val, int schemaVersion) {
return marshallerCache.marshaller(schemaVersion).marshal(key, val);
}
/**
* Returns value tuple of given row.
*
* @param row Binary row.
* @param schemaVersion The version to use when unmarshalling.
* @return Value tuple.
*/
private @Nullable Tuple unmarshalValue(BinaryRow row, int schemaVersion) {
if (row == null) {
return null;
}
return TableRow.valueTuple(rowConverter.resolveRow(row, schemaVersion));
}
/**
* Returns key-value pairs of tuples for given rows.
*
* @param rows Binary rows.
* @param schemaVersion The version to use when unmarshalling.
* @return Key-value pairs of tuples.
*/
private Map unmarshalValues(Collection rows, int schemaVersion) {
Map pairs = IgniteUtils.newHashMap(rows.size());
for (Row row : rowConverter.resolveRows(rows, schemaVersion)) {
if (row != null) {
pairs.put(TableRow.keyTuple(row), TableRow.valueTuple(row));
}
}
return pairs;
}
/**
* Marshal key tuples to rows.
*
* @param keys Key tuples.
* @param schemaVersion Schema version to use when marshalling.
* @return Rows.
*/
private List marshalKeys(Collection keys, int schemaVersion) {
if (keys.isEmpty()) {
return Collections.emptyList();
}
List keyRows = new ArrayList<>(keys.size());
for (Tuple keyRec : keys) {
keyRows.add(marshal(Objects.requireNonNull(keyRec, "keyRec"), null, schemaVersion));
}
return keyRows;
}
/**
* Returns key tuples of given row.
*
* @param rows Binary rows.
* @param schemaVersion Schema version to use when marshalling.
* @return Keys.
*/
private Collection unmarshalKeys(Collection rows, int schemaVersion) {
if (rows.isEmpty()) {
return Collections.emptyList();
}
List tuples = new ArrayList<>(rows.size());
for (Row row : rowConverter.resolveKeys(rows, schemaVersion)) {
tuples.add(TableRow.keyTuple(row));
}
return tuples;
}
/** {@inheritDoc} */
@Override
public CompletableFuture streamData(
Publisher>> publisher,
@Nullable DataStreamerOptions options) {
Objects.requireNonNull(publisher, "publisher");
var partitioner = new KeyValueTupleStreamerPartitionAwarenessProvider(rowConverter.registry(), tbl.partitions());
@SuppressWarnings({"rawtypes", "unchecked"})
StreamerBatchSender, Integer, Void> batchSender = (partitionId, items, deleted) ->
PublicApiThreading.execUserAsyncOperation(() -> (CompletableFuture) withSchemaSync(
null,
schemaVersion -> this.tbl.updateAll(marshalPairs(items, schemaVersion, deleted), deleted, partitionId)
));
CompletableFuture future = DataStreamer.streamData(publisher, options, batchSender, partitioner, tbl.streamerFlushExecutor());
return convertToPublicFuture(future);
}
@Override
public CompletableFuture streamData(
Publisher publisher,
Function> keyFunc,
Function payloadFunc,
ReceiverDescriptor receiver,
@Nullable Flow.Subscriber resultSubscriber,
@Nullable DataStreamerOptions options,
@Nullable A receiverArg) {
Objects.requireNonNull(publisher);
Objects.requireNonNull(keyFunc);
Objects.requireNonNull(payloadFunc);
Objects.requireNonNull(receiver);
var partitioner = new KeyValueTupleStreamerPartitionAwarenessProvider(rowConverter.registry(), tbl.partitions());
StreamerBatchSender batchSender = (partitionId, rows, deleted) ->
PublicApiThreading.execUserAsyncOperation(() ->
tbl.partitionLocation(new TablePartitionId(tbl.tableId(), partitionId))
.thenCompose(node -> tbl.streamerReceiverRunner().runReceiverAsync(
receiver, receiverArg, rows, node, receiver.units())));
CompletableFuture future = DataStreamer.streamData(
publisher,
keyFunc,
payloadFunc,
x -> false,
options,
batchSender,
resultSubscriber,
partitioner,
tbl.streamerFlushExecutor());
return convertToPublicFuture(future);
}
private List marshalPairs(Collection> pairs, int schemaVersion, @Nullable BitSet deleted) {
List rows = new ArrayList<>(pairs.size());
for (Entry pair : pairs) {
boolean isDeleted = deleted != null && deleted.get(rows.size());
Tuple key = Objects.requireNonNull(pair.getKey(), "key");
Tuple val = isDeleted ? null : Objects.requireNonNull(pair.getValue(), "val");
Row row = marshal(key, val, schemaVersion);
rows.add(row);
}
return rows;
}
/** {@inheritDoc} */
@Override
protected Function> queryMapper(ResultSetMetadata meta, SchemaDescriptor schema) {
return (row) -> new IgniteBiTuple<>(
new SqlRowProjection(row, meta, columnNames(schema.keyColumns())),
new SqlRowProjection(row, meta, columnNames(schema.valueColumns()))
);
}
}