KAFKA-14491: [13/N] Add versioned store builder and materializer #13274
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,23 +17,30 @@ | |
| package org.apache.kafka.streams.kstream.internals; | ||
|
|
||
| import org.apache.kafka.common.utils.Bytes; | ||
| import org.apache.kafka.common.utils.Time; | ||
| import org.apache.kafka.streams.state.KeyValueBytesStoreSupplier; | ||
| import org.apache.kafka.streams.state.KeyValueStore; | ||
| import org.apache.kafka.streams.state.StoreBuilder; | ||
| import org.apache.kafka.streams.state.Stores; | ||
| import org.apache.kafka.streams.state.VersionedBytesStoreSupplier; | ||
| import org.apache.kafka.streams.state.internals.TimestampedKeyValueStoreBuilder; | ||
| import org.apache.kafka.streams.state.internals.VersionedKeyValueStoreBuilder; | ||
|
|
||
| /** | ||
| * Materializes a key-value store as either a {@link TimestampedKeyValueStoreBuilder} or a | ||
| * {@link VersionedKeyValueStoreBuilder} depending on whether the store is versioned or not. | ||
| */ | ||
| public class KeyValueStoreMaterializer<K, V> { | ||
| private final MaterializedInternal<K, V, KeyValueStore<Bytes, byte[]>> materialized; | ||
|
|
||
| public KeyValueStoreMaterializer(final MaterializedInternal<K, V, KeyValueStore<Bytes, byte[]>> materialized) { | ||
| this.materialized = materialized; | ||
| } | ||
|
|
||
| /** | ||
| * @return StoreBuilder | ||
| */ | ||
| public StoreBuilder<?> materialize() { | ||
| KeyValueBytesStoreSupplier supplier = (KeyValueBytesStoreSupplier) materialized.storeSupplier(); | ||
| if (supplier == null) { | ||
| switch (materialized.storeType()) { | ||
|
|
@@ -48,20 +55,30 @@ public StoreBuilder<TimestampedKeyValueStore<K, V>> materialize() { | |
| } | ||
| } | ||
|
|
||
| final StoreBuilder<?> builder; | ||
| if (supplier instanceof VersionedBytesStoreSupplier) { | ||
| builder = new VersionedKeyValueStoreBuilder<>( | ||
| (VersionedBytesStoreSupplier) supplier, | ||
| materialized.keySerde(), | ||
| materialized.valueSerde(), | ||
| Time.SYSTEM); | ||
| } else { | ||
| builder = Stores.timestampedKeyValueStoreBuilder( | ||
| supplier, | ||
| materialized.keySerde(), | ||
| materialized.valueSerde()); | ||
| } | ||
|
|
||
| if (materialized.loggingEnabled()) { | ||
| builder.withLoggingEnabled(materialized.logConfig()); | ||
| } else { | ||
| builder.withLoggingDisabled(); | ||
| } | ||
|
|
||
| // versioned stores do not support caching | ||
|
Contributor
Author
There was a problem hiding this comment. Regardless of whether the I think the most we should do is log a warning. Curious to hear other opinions.
Member
There was a problem hiding this comment. Don't have a strong opinion. Pinging @guozhangwang and @vvcephei for input.
Member
There was a problem hiding this comment. I guess it can't hurt to log at INFO/WARN level about it?
Contributor
Author
There was a problem hiding this comment. OK, I've added an INFO log statement for now, while we wait for additional opinions.
Contributor
There was a problem hiding this comment. +1 on an INFO log (or no log at all). Caching is non-functional behavior, so it makes sense for a store that doesn't support it (yet) just to treat it as a request and ignore it. |
||
| if (materialized.cachingEnabled() && !(builder instanceof VersionedKeyValueStoreBuilder)) { | ||
| builder.withCachingEnabled(); | ||
| } | ||
| return builder; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| * 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.kafka.streams.state.internals; | ||
|
|
||
| import org.apache.kafka.common.serialization.Serde; | ||
| import org.apache.kafka.common.utils.Bytes; | ||
| import org.apache.kafka.common.utils.Time; | ||
| import org.apache.kafka.streams.state.KeyValueStore; | ||
|
|
||
| import java.util.Objects; | ||
| import org.apache.kafka.streams.state.StoreBuilder; | ||
| import org.apache.kafka.streams.state.ValueAndTimestamp; | ||
| import org.apache.kafka.streams.state.VersionedBytesStore; | ||
| import org.apache.kafka.streams.state.VersionedBytesStoreSupplier; | ||
| import org.apache.kafka.streams.state.VersionedKeyValueStore; | ||
|
|
||
| public class VersionedKeyValueStoreBuilder<K, V> | ||
| extends AbstractStoreBuilder<K, V, VersionedKeyValueStore<K, V>> { | ||
|
|
||
| private final VersionedBytesStoreSupplier storeSupplier; | ||
|
|
||
| public VersionedKeyValueStoreBuilder(final VersionedBytesStoreSupplier storeSupplier, | ||
| final Serde<K> keySerde, | ||
| final Serde<V> valueSerde, | ||
| final Time time) { | ||
| super( | ||
| storeSupplier.name(), | ||
| keySerde, | ||
| valueSerde, | ||
| time); | ||
| Objects.requireNonNull(storeSupplier, "storeSupplier can't be null"); | ||
| Objects.requireNonNull(storeSupplier.metricsScope(), "storeSupplier's metricsScope can't be null"); | ||
| this.storeSupplier = storeSupplier; | ||
| } | ||
|
|
||
| @Override | ||
| public VersionedKeyValueStore<K, V> build() { | ||
| final KeyValueStore<Bytes, byte[]> store = storeSupplier.get(); | ||
| if (!(store instanceof VersionedBytesStore)) { | ||
| throw new IllegalStateException("VersionedBytesStoreSupplier.get() must return an instance of VersionedBytesStore"); | ||
| } | ||
|
|
||
| final Serde<ValueAndTimestamp<V>> valueAndTimestampSerde = valueSerde == null | ||
| ? null | ||
| : new NullableValueAndTimestampSerde<>(valueSerde); | ||
|
|
||
| return new MeteredVersionedKeyValueStore<>( | ||
| maybeWrapLogging((VersionedBytesStore) store), // no caching layer for versioned stores | ||
| storeSupplier.metricsScope(), | ||
| time, | ||
| keySerde, | ||
| valueAndTimestampSerde); | ||
| } | ||
|
|
||
| @Override | ||
| public StoreBuilder<VersionedKeyValueStore<K, V>> withCachingEnabled() { | ||
| throw new IllegalStateException("Versioned stores do not support caching"); | ||
| } | ||
|
|
||
| private VersionedBytesStore maybeWrapLogging(final VersionedBytesStore inner) { | ||
| if (!enableLogging) { | ||
| return inner; | ||
| } | ||
| return new ChangeLoggingVersionedKeyValueBytesStore(inner); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While renaming this class in IntelliJ, I got a warning that a class with this name existed in a previous version of Kafka Streams. I think this is fine since it's an internal class, but wanted to call it out in case there are compatibility concerns I'm not aware of.