Package com.linkedin.venice.client.schema

Class RouterBasedStoreSchemaFetcher

java.lang.Object

com.linkedin.venice.client.schema.RouterBasedStoreSchemaFetcher

All Implemented Interfaces:

StoreSchemaFetcher, Closeable, AutoCloseable

public class RouterBasedStoreSchemaFetcher
extends Object
implements StoreSchemaFetcher

Router based implementation of StoreSchemaFetcher. It supports schema look up for key schema, the latest value schema and latest update schema of a provided value schema version. Notice that this class does not contain any caching of schema so each API invocation will send a new request to Venice Router to fetch the desired store schema.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_GET_UPDATE_SCHEMA
static final String	TYPE_KEY_SCHEMA
static final String	TYPE_LATEST_VALUE_SCHEMA
static final String	TYPE_VALUE_SCHEMA

Constructor Summary

Constructors

Constructor	Description
RouterBasedStoreSchemaFetcher(AbstractAvroStoreClient client)

Method Summary

Modifier and Type	Method	Description
void	close()
Map<Integer,org.apache.avro.Schema>	getAllValueSchemasWithId()	Returns all value schemas of the store as a map with schema id as the key.
org.apache.avro.Schema	getKeySchema()	Returns Key schema of the store.
org.apache.avro.Schema	getLatestValueSchema()	Returns the latest available Value schema of the store.
SchemaEntry	getLatestValueSchemaEntry()
String	getStoreName()	Returns the Venice store name this class is associated with.
org.apache.avro.Schema	getUpdateSchema(org.apache.avro.Schema valueSchema)	Returns the Update (Write Compute) schema of the provided Value schema.
DerivedSchemaEntry	getUpdateSchemaEntry(int valueSchemaId)	Get the latest derived schema of a value schema.

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.client.schema.StoreSchemaFetcher

getAllValueSchemas

Field Details

TYPE_KEY_SCHEMA

public static final String TYPE_KEY_SCHEMA

See Also:

• Constant Field Values

TYPE_VALUE_SCHEMA

public static final String TYPE_VALUE_SCHEMA

See Also:

• Constant Field Values

TYPE_GET_UPDATE_SCHEMA

public static final String TYPE_GET_UPDATE_SCHEMA

See Also:

• Constant Field Values

TYPE_LATEST_VALUE_SCHEMA

public static final String TYPE_LATEST_VALUE_SCHEMA

See Also:

• Constant Field Values

Constructor Details

RouterBasedStoreSchemaFetcher

public RouterBasedStoreSchemaFetcher(AbstractAvroStoreClient client)

Method Details

getKeySchema

public org.apache.avro.Schema getKeySchema()

Description copied from interface: StoreSchemaFetcher

Returns Key schema of the store.

Specified by:

getKeySchema in interface StoreSchemaFetcher

getLatestValueSchema

public org.apache.avro.Schema getLatestValueSchema()

Description copied from interface: StoreSchemaFetcher

Returns the latest available Value schema of the store. The latest superset schema is: 1. If a superset schema exists for the store, return the superset schema 2. If no superset schema exists for the store, return the value schema with the largest schema id

Specified by:

getLatestValueSchema in interface StoreSchemaFetcher

getLatestValueSchemaEntry

public SchemaEntry getLatestValueSchemaEntry()

Specified by:

getLatestValueSchemaEntry in interface StoreSchemaFetcher

getAllValueSchemasWithId

public Map<Integer,org.apache.avro.Schema> getAllValueSchemasWithId()

Description copied from interface: StoreSchemaFetcher

Returns all value schemas of the store as a map with schema id as the key.

Specified by:

getAllValueSchemasWithId in interface StoreSchemaFetcher

getUpdateSchemaEntry

public DerivedSchemaEntry getUpdateSchemaEntry(int valueSchemaId)

Description copied from interface: StoreSchemaFetcher

Get the latest derived schema of a value schema. Return the derived schema in DerivedSchemaEntry format, which contains Schema and protocol ID.

Specified by:

getUpdateSchemaEntry in interface StoreSchemaFetcher

getUpdateSchema

public org.apache.avro.Schema getUpdateSchema(org.apache.avro.Schema valueSchema)
                                       throws VeniceException

Description copied from interface: StoreSchemaFetcher

Returns the Update (Write Compute) schema of the provided Value schema. The returned schema is used to construct a GenericRecord that partially updates a record value that is associated with this value schema. This method is expected to throw InvalidVeniceSchemaException when the provided value schema could not be found in the Venice backend. For other unexpected errors like store is not write-compute enabled or corresponding update schema is not found in the Venice backend, this method will throw general VeniceException with corresponding error message.

Specified by:

getUpdateSchema in interface StoreSchemaFetcher

Throws:

VeniceException

getStoreName

public String getStoreName()

Description copied from interface: StoreSchemaFetcher

Returns the Venice store name this class is associated with.

Specified by:

getStoreName in interface StoreSchemaFetcher

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException