Package com.linkedin.davinci.repository

Class NativeMetadataRepositoryViewAdapter

java.lang.Object

com.linkedin.davinci.repository.NativeMetadataRepositoryViewAdapter

All Implemented Interfaces:

SubscribedViewStoreProvider, ClusterInfoProvider, ReadOnlySchemaRepository, ReadOnlyStoreRepository, SubscriptionBasedReadOnlyStoreRepository, VeniceResource

public class NativeMetadataRepositoryViewAdapter
extends Object
implements SubscriptionBasedReadOnlyStoreRepository, ReadOnlySchemaRepository, ClusterInfoProvider, SubscribedViewStoreProvider

Adapter that provides read only interface to access store, schema and cluster info using the underlying NativeMetadataRepository for both regular Venice stores and Venice view stores. Intended for client libraries like DaVinci and CC clients which need to consume and materialize store views.

Constructor Summary

Constructors

Constructor	Description
NativeMetadataRepositoryViewAdapter(NativeMetadataRepository nativeMetadataRepository)

Method Summary

Modifier and Type	Method	Description
void	clear()
List<Store>	getAllStores()	This method will only return all the subscribed Venice stores and not include the view stores for the following reasons: 1.
int	getBatchGetLimit(String storeName)	Get batch-get limit for the specified store
DerivedSchemaEntry	getDerivedSchema(String storeName, int valueSchemaId, int writeComputeSchemaId)
GeneratedSchemaID	getDerivedSchemaId(String storeName, String derivedSchemaStr)	Look up derived schema id and its corresponding value schema id by given store name and derived schema.
Collection<DerivedSchemaEntry>	getDerivedSchemas(String storeName)
SchemaEntry	getKeySchema(String storeName)	Get key schema for the given store.
DerivedSchemaEntry	getLatestDerivedSchema(String storeName, int valueSchemaId)	Get the most recent derived schema added to the given store and value schema id
RmdSchemaEntry	getReplicationMetadataSchema(String storeName, int valueSchemaId, int replicationMetadataVersionId)
Collection<RmdSchemaEntry>	getReplicationMetadataSchemas(String storeName)
Store	getStore(String storeName)	Get one store by given name from repository.
Store	getStoreOrThrow(String storeName)
Set<String>	getSubscribedViewStores(String storeName)
SchemaEntry	getSupersetOrLatestValueSchema(String storeName)	Get the most recent value schema or superset value schema if one exists.
SchemaEntry	getSupersetSchema(String storeName)	Get the superset value schema for a given store.
long	getTotalStoreReadQuota()	Get total read quota of all stores.
SchemaEntry	getValueSchema(String storeName, int id)	Get value schema for the given store and value schema id.
int	getValueSchemaId(String storeName, String valueSchemaStr)	Return the schema ID of any schema that has the same parsing canonical form as the schema provided.
Collection<SchemaEntry>	getValueSchemas(String storeName)	Get all the value schemas for the given store.
String	getVeniceCluster(String storeName)	Get the associated Venice cluster name given a Venice store name.
boolean	hasStore(String storeName)	Whether the store exists or not.
boolean	hasValueSchema(String storeName, int id)	Check whether the specified schema id is valid or not
boolean	isReadComputationEnabled(String storeName)	Whether computation is enabled for the specified store.
void	refresh()
Store	refreshOneStore(String storeName)	Selective refresh operation which fetches one store from ZK
void	registerStoreDataChangedListener(StoreDataChangedListener listener)	Register store data change listener.
void	subscribe(String storeName)
void	unregisterStoreDataChangedListener(StoreDataChangedListener listener)	Unregister store data change listener.
void	unsubscribe(String storeName)

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.ReadOnlySchemaRepository

getLatestDerivedSchema

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

waitVersion, waitVersion

Constructor Details

NativeMetadataRepositoryViewAdapter

public NativeMetadataRepositoryViewAdapter(NativeMetadataRepository nativeMetadataRepository)

Method Details

refresh

public void refresh()

Specified by:

refresh in interface VeniceResource

clear

public void clear()

Specified by:

clear in interface VeniceResource

getVeniceCluster

public String getVeniceCluster(String storeName)

Description copied from interface: ClusterInfoProvider

Get the associated Venice cluster name given a Venice store name.

Specified by:

getVeniceCluster in interface ClusterInfoProvider

Returns:

the cluster name that the store belongs to or null if such information cannot be provided.

getKeySchema

public SchemaEntry getKeySchema(String storeName)

Description copied from interface: ReadOnlySchemaRepository

Get key schema for the given store.

Specified by:

getKeySchema in interface ReadOnlySchemaRepository

getValueSchema

public SchemaEntry getValueSchema(String storeName,
 int id)

Description copied from interface: ReadOnlySchemaRepository

Get value schema for the given store and value schema id.

Specified by:

getValueSchema in interface ReadOnlySchemaRepository

hasValueSchema

public boolean hasValueSchema(String storeName,
 int id)

Description copied from interface: ReadOnlySchemaRepository

Check whether the specified schema id is valid or not

Specified by:

hasValueSchema in interface ReadOnlySchemaRepository

getValueSchemaId

public int getValueSchemaId(String storeName,
 String valueSchemaStr)

Description copied from interface: ReadOnlySchemaRepository

Return the schema ID of any schema that has the same parsing canonical form as the schema provided. If multiple schemas have the same parsing canonical form, return the one with the largest ID.

Specified by:

getValueSchemaId in interface ReadOnlySchemaRepository

getValueSchemas

public Collection<SchemaEntry> getValueSchemas(String storeName)

Description copied from interface: ReadOnlySchemaRepository

Get all the value schemas for the given store.

Specified by:

getValueSchemas in interface ReadOnlySchemaRepository

getSupersetOrLatestValueSchema

public SchemaEntry getSupersetOrLatestValueSchema(String storeName)

Description copied from interface: ReadOnlySchemaRepository

Get the most recent value schema or superset value schema if one exists.

Specified by:

getSupersetOrLatestValueSchema in interface ReadOnlySchemaRepository

getSupersetSchema

public SchemaEntry getSupersetSchema(String storeName)

Description copied from interface: ReadOnlySchemaRepository

Get the superset value schema for a given store. Each store has at most one active superset schema. Specifically a store must have some features enabled (e.g. read compute, write compute) to have a superset value schema which evolves as new value schemas are added.

Specified by:

getSupersetSchema in interface ReadOnlySchemaRepository

Returns:

Superset value schema or null if store does not have any superset value schema.

getDerivedSchemaId

public GeneratedSchemaID getDerivedSchemaId(String storeName,
 String derivedSchemaStr)

Description copied from interface: ReadOnlySchemaRepository

Look up derived schema id and its corresponding value schema id by given store name and derived schema. This is likely used by clients that write to Venice

Specified by:

getDerivedSchemaId in interface ReadOnlySchemaRepository

Returns:

a pair where the first value is value schema id and the second value is derived schema id

getDerivedSchema

public DerivedSchemaEntry getDerivedSchema(String storeName,
 int valueSchemaId,
 int writeComputeSchemaId)

Specified by:

getDerivedSchema in interface ReadOnlySchemaRepository

getDerivedSchemas

public Collection<DerivedSchemaEntry> getDerivedSchemas(String storeName)

Specified by:

getDerivedSchemas in interface ReadOnlySchemaRepository

getLatestDerivedSchema

public DerivedSchemaEntry getLatestDerivedSchema(String storeName,
 int valueSchemaId)

Description copied from interface: ReadOnlySchemaRepository

Get the most recent derived schema added to the given store and value schema id

Specified by:

getLatestDerivedSchema in interface ReadOnlySchemaRepository

getReplicationMetadataSchema

public RmdSchemaEntry getReplicationMetadataSchema(String storeName,
 int valueSchemaId,
 int replicationMetadataVersionId)

Specified by:

getReplicationMetadataSchema in interface ReadOnlySchemaRepository

getReplicationMetadataSchemas

public Collection<RmdSchemaEntry> getReplicationMetadataSchemas(String storeName)

Specified by:

getReplicationMetadataSchemas in interface ReadOnlySchemaRepository

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

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

Throws:

VeniceNoStoreException

hasStore

public boolean hasStore(String storeName)

Description copied from interface: ReadOnlyStoreRepository

Whether the store exists or not.

Specified by:

hasStore in interface ReadOnlyStoreRepository

Parameters:

storeName - store name

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

Parameters:

storeName - store name

Returns:

the newly refreshed store

getAllStores

public List<Store> getAllStores()

This method will only return all the subscribed Venice stores and not include the view stores for the following reasons: 1. Currently, there is no usage of get all view stores. 2. The purpose of this adapter is to allow consumers to work with view stores without having to leak view store specific logic everywhere. If the repository included view stores in getAllStores() then callers will need to understand and differentiate view stores in order to avoid unexpected behaviors.

Specified by:

getAllStores in interface ReadOnlyStoreRepository

Returns:

getTotalStoreReadQuota

public long getTotalStoreReadQuota()

Description copied from interface: ReadOnlyStoreRepository

Get total read quota of all stores.

Specified by:

getTotalStoreReadQuota in interface ReadOnlyStoreRepository

registerStoreDataChangedListener

public void registerStoreDataChangedListener(StoreDataChangedListener listener)

Description copied from interface: ReadOnlyStoreRepository

Register store data change listener.

Specified by:

registerStoreDataChangedListener in interface ReadOnlyStoreRepository

unregisterStoreDataChangedListener

public void unregisterStoreDataChangedListener(StoreDataChangedListener listener)

Description copied from interface: ReadOnlyStoreRepository

Unregister store data change listener.

Specified by:

unregisterStoreDataChangedListener in interface ReadOnlyStoreRepository

getBatchGetLimit

public int getBatchGetLimit(String storeName)

Description copied from interface: ReadOnlyStoreRepository

Get batch-get limit for the specified store

Specified by:

getBatchGetLimit in interface ReadOnlyStoreRepository

Returns:

isReadComputationEnabled

public boolean isReadComputationEnabled(String storeName)

Description copied from interface: ReadOnlyStoreRepository

Whether computation is enabled for the specified store.

Specified by:

isReadComputationEnabled in interface ReadOnlyStoreRepository

Parameters:

storeName - store name

Returns:

subscribe

public void subscribe(String storeName)
               throws InterruptedException

Specified by:

subscribe in interface SubscriptionBasedReadOnlyStoreRepository

Throws:

InterruptedException

unsubscribe

public void unsubscribe(String storeName)

Specified by:

unsubscribe in interface SubscriptionBasedReadOnlyStoreRepository

getSubscribedViewStores

@Nonnull
public Set<String> getSubscribedViewStores(String storeName)

Specified by:

getSubscribedViewStores in interface SubscribedViewStoreProvider

Parameters:

storeName - of the Venice store.

Returns:

a set of subscribed view store names associated with the provided Venice store.