Class VeniceChangelogConsumerImpl<K,​V>

    • Method Detail

      • subscribe

        public java.util.concurrent.CompletableFuture<java.lang.Void> subscribe​(java.util.Set<java.lang.Integer> partitions)
        Description copied from interface: VeniceChangelogConsumer
        Subscribe a set of partitions for a store to this VeniceChangelogConsumer. The VeniceChangelogConsumer should try to consume messages from all partitions that are subscribed to it.
        Specified by:
        subscribe in interface VeniceChangelogConsumer<K,​V>
        Parameters:
        partitions - the set of partition to subscribe and consume
        Returns:
        a future which completes when the partitions are ready to be consumed data
      • internalSubscribe

        public java.util.concurrent.CompletableFuture<java.lang.Void> internalSubscribe​(java.util.Set<java.lang.Integer> partitions,
                                                                                        PubSubTopic topic)
      • seekToBeginningOfPush

        public java.util.concurrent.CompletableFuture<java.lang.Void> seekToBeginningOfPush​(java.util.Set<java.lang.Integer> partitions)
        Description copied from interface: VeniceChangelogConsumer
        Seek to the beginning of the push for a set of partitions. This is analogous to doing a bootstrap of data for the consumer. This seek will ONLY seek to the beginning of the version which is currently serving data, and the consumer will switch to reading data from a new version (should one get created) once it has read up to the point in the change capture stream that indicates the version swap (which can only occur after consuming all the data in the last push). This instructs the consumer to consume data from the batch push.
        Specified by:
        seekToBeginningOfPush in interface VeniceChangelogConsumer<K,​V>
        Parameters:
        partitions - the set of partitions to seek with
        Returns:
        a future which completes when the operation has succeeded for all partitions.
      • seekToEndOfPush

        public java.util.concurrent.CompletableFuture<java.lang.Void> seekToEndOfPush​(java.util.Set<java.lang.Integer> partitions)
        Description copied from interface: VeniceChangelogConsumer
        Seek to the end of the last push for a given set of partitions. This instructs the consumer to begin consuming events which are transmitted to Venice following the last batch push.
        Specified by:
        seekToEndOfPush in interface VeniceChangelogConsumer<K,​V>
        Parameters:
        partitions - the set of partitions to seek with
        Returns:
        a future which completes when the operation has succeeded for all partitions.
      • resume

        public void resume​(java.util.Set<java.lang.Integer> partitions)
        Description copied from interface: VeniceChangelogConsumer
        Resume the client on all or subset of partitions this client is subscribed to and has paused.
        Specified by:
        resume in interface VeniceChangelogConsumer<K,​V>
      • seekToTail

        public java.util.concurrent.CompletableFuture<java.lang.Void> seekToTail​(java.util.Set<java.lang.Integer> partitions)
        Description copied from interface: VeniceChangelogConsumer
        Seek to the end of events which have been transmitted to Venice and start consuming new events. This will ONLY consume events transmitted via nearline and incremental push. It will not read batch push data.
        Specified by:
        seekToTail in interface VeniceChangelogConsumer<K,​V>
        Parameters:
        partitions - the set of partitions to seek with
        Returns:
        a future which completes when the operation has succeeded for all partitions.
      • internalSeekToTail

        public java.util.concurrent.CompletableFuture<java.lang.Void> internalSeekToTail​(java.util.Set<java.lang.Integer> partitions,
                                                                                         java.lang.String topicSuffix)
      • seekToCheckpoint

        public java.util.concurrent.CompletableFuture<java.lang.Void> seekToCheckpoint​(java.util.Set<VeniceChangeCoordinate> checkpoints)
        Description copied from interface: VeniceChangelogConsumer
        Seek the provided checkpoints for the specified partitions. Note about checkpoints: Checkpoints have the following properties and should be considered: -Checkpoints are NOT comparable or valid across partitions. -Checkpoints are NOT comparable or valid across colos -Checkpoints are NOT comparable across store versions -It is not possible to determine the number of events between two checkpoints -It is possible that a checkpoint is no longer on retention. In such case, we will return an exception to the caller.
        Specified by:
        seekToCheckpoint in interface VeniceChangelogConsumer<K,​V>
        Returns:
        a future which completes when seek has completed for all partitions
      • subscribeAll

        public java.util.concurrent.CompletableFuture<java.lang.Void> subscribeAll()
        Description copied from interface: VeniceChangelogConsumer
        Subscribe all partitions belonging to a specific store.
        Specified by:
        subscribeAll in interface VeniceChangelogConsumer<K,​V>
        Returns:
        a future which completes when all partitions are ready to be consumed data
      • seekToTimestamps

        public java.util.concurrent.CompletableFuture<java.lang.Void> seekToTimestamps​(java.util.Map<java.lang.Integer,​java.lang.Long> timestamps)
        Description copied from interface: VeniceChangelogConsumer
        Seek to the provided timestamps for the specified partitions based on wall clock time for when this message was processed by Venice and produced to change capture. Note, this API can only be used to seek on nearline data applied to the current serving version in Venice. This will not seek on data transmitted via Batch Push. If the provided timestamp is lower than the earliest timestamp on a given stream, the earliest event will be returned. THIS WILL NOT SEEK TO DATA WHICH WAS APPLIED ON A PREVIOUS VERSION. You should never seek back in time to a timestamp which is smaller than the current time - rewindTimeInSeconds configured in the hybrid settings for this Venice store. The timestamp passed to this function should be associated to timestamps processed by this interface. The timestamp returned by {@link PubSubMessage.getPubSubMessageTime()} refers to the time when Venice processed the event, and calls to this method will seek based on that sequence of events. Note: it bears no relation to timestamps provided by upstream producers when writing to Venice where a user may optionally provide a timestamp at time of producing a record.
        Specified by:
        seekToTimestamps in interface VeniceChangelogConsumer<K,​V>
        Parameters:
        timestamps - a map keyed by a partition ID, and the timestamp checkpoints to seek for each partition.
        Returns:
      • internalSeekToTimestamps

        public java.util.concurrent.CompletableFuture<java.lang.Void> internalSeekToTimestamps​(java.util.Map<java.lang.Integer,​java.lang.Long> timestamps,
                                                                                               java.lang.String topicSuffix)
      • internalSeek

        protected java.util.concurrent.CompletableFuture<java.lang.Void> internalSeek​(java.util.Set<java.lang.Integer> partitions,
                                                                                      PubSubTopic targetTopic,
                                                                                      com.linkedin.davinci.consumer.VeniceChangelogConsumerImpl.SeekFunction seekAction)
      • unsubscribe

        public void unsubscribe​(java.util.Set<java.lang.Integer> partitions)
        Description copied from interface: VeniceChangelogConsumer
        Stop ingesting messages from a set of partitions for a specific store.
        Specified by:
        unsubscribe in interface VeniceChangelogConsumer<K,​V>
        Parameters:
        partitions - The set of topic partitions to unsubscribe
      • poll

        public java.util.Collection<PubSubMessage<K,​ChangeEvent<V>,​VeniceChangeCoordinate>> poll​(long timeoutInMs)
        Description copied from interface: VeniceChangelogConsumer
        Polling function to get any available messages from the underlying system for all partitions subscribed.
        Specified by:
        poll in interface VeniceChangelogConsumer<K,​V>
        Parameters:
        timeoutInMs - The maximum time to block/wait in between two polling requests (must not be greater than Long.MAX_VALUE milliseconds)
        Returns:
        a collection of messages since the last fetch for the subscribed list of topic partitions
      • handleControlMessage

        protected boolean handleControlMessage​(ControlMessage controlMessage,
                                               PubSubTopicPartition pubSubTopicPartition,
                                               java.lang.String topicSuffix)
        Handle control message from the given topic. Returns true if a topic switch should occur and records should be returned
        Parameters:
        controlMessage - the encountered control message
        pubSubTopicPartition - the topic that this control message was concerned
        Returns:
        true if a version switch happened, false if otherwise
      • processRecordBytes

        protected <T> T processRecordBytes​(java.nio.ByteBuffer decompressedBytes,
                                           T deserializedValue,
                                           byte[] key,
                                           java.nio.ByteBuffer value,
                                           PubSubTopicPartition partition,
                                           int valueSchemaId,
                                           long recordOffset)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • extractOffsetVectorFromMessage

        protected java.util.List<java.lang.Long> extractOffsetVectorFromMessage​(int replicationMetadataVersionId,
                                                                                java.nio.ByteBuffer replicationMetadataPayload)
      • handleVersionSwapControlMessage

        protected boolean handleVersionSwapControlMessage​(ControlMessage controlMessage,
                                                          PubSubTopicPartition pubSubTopicPartition,
                                                          java.lang.String topicSuffix)
      • switchToNewTopic

        protected void switchToNewTopic​(PubSubTopic newTopic,
                                        java.lang.String topicSuffix,
                                        java.lang.Integer partition)
      • getTopicPartition

        protected PubSubTopicPartition getTopicPartition​(java.lang.Integer partition)