Package com.linkedin.venice.writer

Class AbstractVeniceWriter<K,V,U>

java.lang.Object

com.linkedin.venice.writer.AbstractVeniceWriter<K,V,U>

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BatchingVeniceWriter, CompositeVeniceWriter, DualWriteVeniceWriter, VeniceWriter

public abstract class AbstractVeniceWriter<K,V,U>
extends Object
implements Closeable

A base class which users of VeniceWriter can leverage in order to make unit tests easier.

See Also:

• // @see MockVeniceWriter in the VPJ tests (commented because this module does not depend on VPJ)

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	topicName

Constructor Summary

Constructors

Constructor	Description
AbstractVeniceWriter(String topicName)

Method Summary

Modifier and Type	Method	Description
abstract void	close(boolean gracefulClose)
abstract CompletableFuture<PubSubProduceResult>	delete(K key, long logicalTimestamp, PubSubProducerCallback callback)
abstract CompletableFuture<PubSubProduceResult>	delete(K key, PubSubProducerCallback callback)
abstract CompletableFuture<PubSubProduceResult>	delete(K key, PubSubProducerCallback callback, DeleteMetadata deleteMetadata)
abstract void	flush()
int	getPartitionIdForSerializedKey(byte[] serializedKey)	Returns the partition id for an already-serialized key.
String	getTopicName()
CompletableFuture<PubSubProduceResult>	put(K key, V value, int valueSchemaId)
abstract CompletableFuture<PubSubProduceResult>	put(K key, V value, int valueSchemaId, long logicalTimestamp, PubSubProducerCallback callback)
abstract CompletableFuture<PubSubProduceResult>	put(K key, V value, int valueSchemaId, long logicalTimestamp, PubSubProducerCallback callback, PutMetadata putMetadata)
abstract CompletableFuture<PubSubProduceResult>	put(K key, V value, int valueSchemaId, PubSubProducerCallback callback)
abstract CompletableFuture<PubSubProduceResult>	put(K key, V value, int valueSchemaId, PubSubProducerCallback callback, PutMetadata putMetadata)
abstract CompletableFuture<PubSubProduceResult>	update(K key, U update, int valueSchemaId, int derivedSchemaId, long logicalTimestamp, PubSubProducerCallback callback)
abstract Future<PubSubProduceResult>	update(K key, U update, int valueSchemaId, int derivedSchemaId, PubSubProducerCallback callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Field Details

topicName

protected final String topicName

Constructor Details

AbstractVeniceWriter

public AbstractVeniceWriter(String topicName)

Method Details

getTopicName

public String getTopicName()

put

public CompletableFuture<PubSubProduceResult> put(K key,
 V value,
 int valueSchemaId)

close

public abstract void close(boolean gracefulClose)
                    throws IOException

Throws:

IOException

put

public abstract CompletableFuture<PubSubProduceResult> put(K key,
 V value,
 int valueSchemaId,
 PubSubProducerCallback callback)

put

public abstract CompletableFuture<PubSubProduceResult> put(K key,
 V value,
 int valueSchemaId,
 long logicalTimestamp,
 PubSubProducerCallback callback)

update

public abstract Future<PubSubProduceResult> update(K key,
 U update,
 int valueSchemaId,
 int derivedSchemaId,
 PubSubProducerCallback callback)

update

public abstract CompletableFuture<PubSubProduceResult> update(K key,
 U update,
 int valueSchemaId,
 int derivedSchemaId,
 long logicalTimestamp,
 PubSubProducerCallback callback)

delete

public abstract CompletableFuture<PubSubProduceResult> delete(K key,
 PubSubProducerCallback callback)

delete

public abstract CompletableFuture<PubSubProduceResult> delete(K key,
 long logicalTimestamp,
 PubSubProducerCallback callback)

put

public abstract CompletableFuture<PubSubProduceResult> put(K key,
 V value,
 int valueSchemaId,
 PubSubProducerCallback callback,
 PutMetadata putMetadata)

put

public abstract CompletableFuture<PubSubProduceResult> put(K key,
 V value,
 int valueSchemaId,
 long logicalTimestamp,
 PubSubProducerCallback callback,
 PutMetadata putMetadata)

delete

public abstract CompletableFuture<PubSubProduceResult> delete(K key,
 PubSubProducerCallback callback,
 DeleteMetadata deleteMetadata)

flush

public abstract void flush()

getPartitionIdForSerializedKey

public int getPartitionIdForSerializedKey(byte[] serializedKey)

Returns the partition id for an already-serialized key. Writers used for partition-striped dispatch must override this with their exact eventual write route.

Parameters:

serializedKey - the serialized key bytes to route

Returns:

a non-negative partition id

Throws:

UnsupportedOperationException - if this writer does not expose partition routing