Package com.linkedin.venice.helix

Class HelixReadOnlyZKSharedSystemStoreRepository

java.lang.Object

com.linkedin.venice.helix.CachedReadOnlyStoreRepository

com.linkedin.venice.helix.HelixReadOnlyStoreRepository

com.linkedin.venice.helix.HelixReadOnlyZKSharedSystemStoreRepository

All Implemented Interfaces:

ReadOnlyStoreRepository, VeniceResource

Direct Known Subclasses:

SharedHelixReadOnlyZKSharedSystemStoreRepository

public class HelixReadOnlyZKSharedSystemStoreRepository
extends HelixReadOnlyStoreRepository

This repository provides an interface to access zk shared system stores only. With this implementation, we will minimize the zwatches required to the system store cluster. But there is a shortcoming with current implementation, since all the system store related operations will be constrained by the healthiness of system store cluster.

Field Summary

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

clusterLockManager, clusterName, clusterStoreRepositoryPath, STORE_REPOSITORY_PATH, storeMap, zkClient, zkDataAccessor

Constructor Summary

Constructors

Constructor	Description
HelixReadOnlyZKSharedSystemStoreRepository(org.apache.helix.zookeeper.impl.client.ZkClient zkClient, HelixAdapterSerializer compositeSerializer, String systemStoreClusterName)

Method Summary

Modifier and Type	Method	Description
void	clear()
int	getBatchGetLimit(String storeName)	Only return zk shared system store related info, otherwise VeniceException will be thrown.
Store	getStore(String storeName)	Only the zk shared system store can be returned, otherwise this function will return null.
Store	getStoreOrThrow(String storeName)	Only the zk shared system store can be returned, otherwise this function will throw VeniceNoStoreException.
protected List<Store>	getStoresFromZk()	This function is used to filter out non system stores from the system store cluster, and this is very important since CachedReadOnlyStoreRepository.refresh() is relying on this function to retrieve all the stores in this cluster and put a watch against each znode, and we need to filter out non-system stores to avoid unnecessary zk watches.
long	getTotalStoreReadQuota()	Get total read quota of all stores.
boolean	hasStore(String storeName)	Only return true for the existing zk shared system store.
boolean	isReadComputationEnabled(String storeName)	Only return zk shared system store related info, otherwise VeniceException will be thrown.
protected void	onRepositoryChanged(Collection<String> newZkStoreNames)	This function is used to filter out non system stores to avoid unnecessary zk watches against the newly added regular stores.
void	refresh()
Store	refreshOneStore(String storeName)	Only zk shared system store can be refreshed here, otherwise VeniceException will be thrown.

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

onStoreChanged, putStore, removeStore

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

getAllStores, getStoreFromZk, getStoresFromZk, getStoreZkPath, notifyStoreChanged, notifyStoreCreated, notifyStoreDeleted, registerStoreDataChangedListener, 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

waitVersion, waitVersion

Constructor Details

HelixReadOnlyZKSharedSystemStoreRepository

public HelixReadOnlyZKSharedSystemStoreRepository(org.apache.helix.zookeeper.impl.client.ZkClient zkClient,
 HelixAdapterSerializer compositeSerializer,
 String systemStoreClusterName)

Method Details

getStore

public Store getStore(String storeName)

Only the zk shared system store can be returned, otherwise this function will return null.

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

Only the zk shared system store can be returned, otherwise this function will throw VeniceNoStoreException.

Specified by:

getStoreOrThrow in interface ReadOnlyStoreRepository

Overrides:

getStoreOrThrow in class CachedReadOnlyStoreRepository

Throws:

VeniceNoStoreException

hasStore

public boolean hasStore(String storeName)

Only return true for the existing zk shared system store.

Specified by:

hasStore in interface ReadOnlyStoreRepository

Overrides:

hasStore in class CachedReadOnlyStoreRepository

Parameters:

storeName - store name

Returns:

refreshOneStore

public Store refreshOneStore(String storeName)

Only zk shared system store can be refreshed here, otherwise VeniceException will be thrown.

Specified by:

refreshOneStore in interface ReadOnlyStoreRepository

Overrides:

refreshOneStore in class CachedReadOnlyStoreRepository

Parameters:

storeName - store name

Returns:

the newly refreshed store

getStoresFromZk

protected List<Store> getStoresFromZk()

This function is used to filter out non system stores from the system store cluster, and this is very important since CachedReadOnlyStoreRepository.refresh() is relying on this function to retrieve all the stores in this cluster and put a watch against each znode, and we need to filter out non-system stores to avoid unnecessary zk watches.

Overrides:

getStoresFromZk in class CachedReadOnlyStoreRepository

Returns:

onRepositoryChanged

protected void onRepositoryChanged(Collection<String> newZkStoreNames)

This function is used to filter out non system stores to avoid unnecessary zk watches against the newly added regular stores.

Overrides:

onRepositoryChanged in class HelixReadOnlyStoreRepository

Parameters:

newZkStoreNames -

getTotalStoreReadQuota

public long getTotalStoreReadQuota()

Description copied from interface: ReadOnlyStoreRepository

Get total read quota of all stores.

Specified by:

getTotalStoreReadQuota in interface ReadOnlyStoreRepository

Overrides:

getTotalStoreReadQuota in class CachedReadOnlyStoreRepository

getBatchGetLimit

public int getBatchGetLimit(String storeName)

Only return zk shared system store related info, otherwise VeniceException will be thrown.

Specified by:

getBatchGetLimit in interface ReadOnlyStoreRepository

Overrides:

getBatchGetLimit in class CachedReadOnlyStoreRepository

Returns:

isReadComputationEnabled

public boolean isReadComputationEnabled(String storeName)

Only return zk shared system store related info, otherwise VeniceException will be thrown.

Specified by:

isReadComputationEnabled in interface ReadOnlyStoreRepository

Overrides:

isReadComputationEnabled in class CachedReadOnlyStoreRepository

Parameters:

storeName - store name

Returns:

refresh

public void refresh()

Specified by:

refresh in interface VeniceResource

Overrides:

refresh in class HelixReadOnlyStoreRepository

clear

public void clear()

Specified by:

clear in interface VeniceResource

Overrides:

clear in class HelixReadOnlyStoreRepository