Package com.linkedin.venice.helix

Class HelixReadWriteStoreRepository

java.lang.Object

com.linkedin.venice.helix.CachedReadOnlyStoreRepository

com.linkedin.venice.helix.HelixReadWriteStoreRepository

All Implemented Interfaces:

ReadOnlyStoreRepository, ReadWriteStoreRepository, VeniceResource

public class HelixReadWriteStoreRepository
extends CachedReadOnlyStoreRepository
implements ReadWriteStoreRepository

Read write store repository which uses Helix as storage.

This repository does NOT listen the change of store from ZK. Because in Venice, this is the only once place to modify stores.

Persistence layout (only when perVersionZnodeEnabled is true):

• /<cluster>/Stores/<name> holds the Store JSON. Its embedded versions list is the legacy set inherited from stores that pre-date the per-version-znode layout. The list is never appended to; it can only shrink (when the caller removes a legacy version) or have its entries mutated in place (e.g. via updateVersionStatus, which mutates the shared Avro record).
• /<cluster>/Stores/<name>/versions/<n> holds each non-legacy Version as its own JSON znode. Every newly added version lands here; mutations to existing znode-versions are propagated by re-writing the znode on the next updateStore call.

When the flag is false, the entire Store (including its versions list) is persisted to the single store znode — the layout every Venice cluster used before this work. The read path is unconditionally smart and supports both layouts so readers can roll out ahead of writers.

Invariant (split layout only): a given version number lives in exactly one of the two layers. The write path enforces this by upserting target versions to /versions/<n> iff their number is NOT in the prior embedded list, and by deleting any stale per-version znode whose number remains embedded. There is no migration step that moves a legacy embedded version into a per-version znode.

Field Summary

Fields inherited from class com.linkedin.venice.helix.CachedReadOnlyStoreRepository

clusterLockManager, clusterStoreRepositoryPath, STORE_REPOSITORY_PATH, storeMap, versionAccessor, zkClient, zkDataAccessor

Constructor Summary

Constructors

Constructor	Description
HelixReadWriteStoreRepository(org.apache.helix.zookeeper.impl.client.ZkClient zkClient, HelixAdapterSerializer compositeSerializer, String clusterName, Optional<MetaStoreWriter> metaStoreWriter, ClusterLockManager storeLock)
HelixReadWriteStoreRepository(org.apache.helix.zookeeper.impl.client.ZkClient zkClient, HelixAdapterSerializer compositeSerializer, String clusterName, Optional<MetaStoreWriter> metaStoreWriter, ClusterLockManager storeLock, boolean perVersionZnodeEnabled)

Method Summary

Modifier and Type	Method	Description
void	addStore(Store store)	Add store into repository.
void	deleteStore(String storeName)	Delete store from repository.
List<Store>	getAllStores()	Get all stores in the current repository
Store	getStore(String storeName)	Get one store by given name from repository.
Store	getStoreOrThrow(String storeName)
Store	refreshOneStore(String storeName)	Selective refresh operation which fetches one store from ZK
void	updateStore(Store store)	Update store in repository.

Methods inherited from class com.linkedin.venice.helix.CachedReadOnlyStoreRepository

clear, getBatchGetLimit, getStoreFromZk, getStoresFromZk, getStoresFromZk, getStoreZkPath, getTotalStoreReadQuota, hasStore, hydrateVersionsFromZk, isReadComputationEnabled, notifyStoreChanged, notifyStoreCreated, notifyStoreDeleted, putStore, refresh, registerStoreDataChangedListener, removeStore, unregisterStoreDataChangedListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linkedin.venice.meta.ReadOnlyStoreRepository

getBatchGetLimit, getTotalStoreReadQuota, hasStore, isReadComputationEnabled, registerStoreDataChangedListener, unregisterStoreDataChangedListener, waitVersion, waitVersion

Methods inherited from interface com.linkedin.venice.VeniceResource

clear, refresh

Constructor Details

HelixReadWriteStoreRepository

public HelixReadWriteStoreRepository(org.apache.helix.zookeeper.impl.client.ZkClient zkClient,
 HelixAdapterSerializer compositeSerializer,
 String clusterName,
 Optional<MetaStoreWriter> metaStoreWriter,
 ClusterLockManager storeLock)

HelixReadWriteStoreRepository

public HelixReadWriteStoreRepository(org.apache.helix.zookeeper.impl.client.ZkClient zkClient,
 HelixAdapterSerializer compositeSerializer,
 String clusterName,
 Optional<MetaStoreWriter> metaStoreWriter,
 ClusterLockManager storeLock,
 boolean perVersionZnodeEnabled)

Method Details

addStore

public void addStore(Store store)

Description copied from interface: ReadWriteStoreRepository

Add store into repository.

Specified by:

addStore in interface ReadWriteStoreRepository

Parameters:

store - store need to be added.

updateStore

public void updateStore(Store store)

Description copied from interface: ReadWriteStoreRepository

Update store in repository.

Specified by:

updateStore in interface ReadWriteStoreRepository

Parameters:

store - store need to be udpated.

deleteStore

public void deleteStore(String storeName)

Description copied from interface: ReadWriteStoreRepository

Delete store from repository.

Specified by:

deleteStore in interface ReadWriteStoreRepository

Parameters:

storeName - name of wantted store.

getStore

public Store getStore(String storeName)

Description copied from interface: ReadOnlyStoreRepository

Get one store by given name from repository.

Specified by:

getStore in interface ReadOnlyStoreRepository

Overrides:

getStore in class CachedReadOnlyStoreRepository

Parameters:

storeName - name of wanted store.

Returns:

Store for given name.

getStoreOrThrow

public Store getStoreOrThrow(String storeName)
                      throws VeniceNoStoreException

Specified by:

getStoreOrThrow in interface ReadOnlyStoreRepository

Overrides:

getStoreOrThrow in class CachedReadOnlyStoreRepository

Throws:

VeniceNoStoreException

getAllStores

public List<Store> getAllStores()

Description copied from interface: ReadOnlyStoreRepository

Get all stores in the current repository

Specified by:

getAllStores in interface ReadOnlyStoreRepository

Overrides:

getAllStores in class CachedReadOnlyStoreRepository

Returns:

refreshOneStore

public Store refreshOneStore(String storeName)

Description copied from interface: ReadOnlyStoreRepository

Selective refresh operation which fetches one store from ZK

Specified by:

refreshOneStore in interface ReadOnlyStoreRepository

Overrides:

refreshOneStore in class CachedReadOnlyStoreRepository

Parameters:

storeName - store name

Returns:

the newly refreshed store