Package com.linkedin.venice.controller.server

Class StoresRoutes

java.lang.Object

com.linkedin.venice.controller.server.AbstractRoute

com.linkedin.venice.controller.server.StoresRoutes

public class StoresRoutes
extends AbstractRoute

Constructor Summary

Constructors

Constructor	Description
StoresRoutes(boolean sslEnabled, Optional<DynamicAccessController> accessController, PubSubTopicRepository pubSubTopicRepository)

Method Summary

Modifier and Type	Method	Description
spark.Route	abortMigration(Admin admin)
spark.Route	autoMigrateStore(Admin admin)
spark.Route	cleanExecutionIds(Admin admin)
spark.Route	compareStore(Admin admin)
spark.Route	completeMigration(Admin admin)
spark.Route	deleteAllVersions(Admin admin)
spark.Route	deleteKafkaTopic(Admin admin)
spark.Route	deleteOldVersions(Admin admin)
spark.Route	deleteStore(Admin admin)
spark.Route	enableActiveActiveReplicationForCluster(Admin admin)
spark.Route	enableStore(Admin admin)	enable/disable store read/write ability
spark.Route	getAllStores(Admin admin)	No ACL check; any user can try to list stores.
spark.Route	getAllStoresStatuses(Admin admin)	No ACL check; any user can try to list store statuses.
spark.Route	getBackupVersion(Admin admin)
spark.Route	getDeadStores(Admin admin)
spark.Route	getDeletableStoreTopics(Admin admin)
spark.Route	getFutureVersion(Admin admin)
spark.Route	getHeartbeatFromSystemStore(Admin admin)
spark.Route	getInUseSchemaIds(Admin admin)
spark.Route	getRegionPushDetails(Admin admin)
spark.Route	getRepushInfo(Admin admin)
spark.Route	getStaleStoresInCluster(Admin admin)
spark.Route	getStorageEngineOverheadRatio(Admin admin)
spark.Route	getStore(Admin admin)
spark.Route	getStoreLargestUsedVersion(Admin admin)
spark.Route	getStoresForCompaction(Admin admin)
spark.Route	getStoresInCluster(Admin admin)
spark.Route	listStorePushInfo(Admin admin)
spark.Route	migrateStore(Admin admin)
spark.Route	removeStoreFromGraveyard(Admin admin)
spark.Route	repushStore(Admin admin)
spark.Route	rollbackToBackupVersion(Admin admin)	Set backup version as current version.
spark.Route	rollForwardToFutureVersion(Admin admin)
spark.Route	sendHeartbeatToSystemStore(Admin admin)
spark.Route	setCurrentVersion(Admin admin)
spark.Route	setOwner(Admin admin)
spark.Route	setPartitionCount(Admin admin)
spark.Route	setTopicCompaction(Admin admin)
spark.Route	updateStore(Admin admin)
spark.Route	validateStoreDeleted(Admin admin)

Methods inherited from class com.linkedin.venice.controller.server.AbstractRoute

getCertificate, getPrincipalId, hasAccessToStore, hasReadAccessToTopic, hasWriteAccessToTopic, isAclEnabled, isAllowListUser, isSslEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

StoresRoutes

public StoresRoutes(boolean sslEnabled,
 Optional<DynamicAccessController> accessController,
 PubSubTopicRepository pubSubTopicRepository)

Method Details

getAllStores

public spark.Route getAllStores(Admin admin)

No ACL check; any user can try to list stores. If we get abused in future, we should only allow Venice admins to run this command.

See Also:

• Admin.getAllStores(String)

cleanExecutionIds

public spark.Route cleanExecutionIds(Admin admin)

getAllStoresStatuses

public spark.Route getAllStoresStatuses(Admin admin)

No ACL check; any user can try to list store statuses.

See Also:

• Admin.getAllStoreStatuses(String)

getInUseSchemaIds

public spark.Route getInUseSchemaIds(Admin admin)

getRepushInfo

public spark.Route getRepushInfo(Admin admin)

See Also:

• Admin.getRepushInfo(String, String, Optional)

getStore

public spark.Route getStore(Admin admin)

See Also:

• Admin.getStore(String, String)

getFutureVersion

public spark.Route getFutureVersion(Admin admin)

getBackupVersion

public spark.Route getBackupVersion(Admin admin)

migrateStore

public spark.Route migrateStore(Admin admin)

See Also:

• Admin.migrateStore(String, String, String)

completeMigration

public spark.Route completeMigration(Admin admin)

See Also:

• Admin.completeMigration(String, String, String)

abortMigration

public spark.Route abortMigration(Admin admin)

See Also:

• Admin.abortMigration(String, String, String)

autoMigrateStore

public spark.Route autoMigrateStore(Admin admin)

See Also:

• Admin#autoMigrateStore(String, String, String, int, boolean)

deleteStore

public spark.Route deleteStore(Admin admin)

See Also:

• Admin.deleteStore(String, String, boolean, int, boolean)

updateStore

public spark.Route updateStore(Admin admin)

See Also:

• Admin.updateStore(String, String, UpdateStoreQueryParams)

setOwner

public spark.Route setOwner(Admin admin)

See Also:

• Admin.setStoreOwner(String, String, String)

setPartitionCount

public spark.Route setPartitionCount(Admin admin)

setCurrentVersion

public spark.Route setCurrentVersion(Admin admin)

See Also:

• Admin.setStoreCurrentVersion(String, String, int)

rollbackToBackupVersion

public spark.Route rollbackToBackupVersion(Admin admin)

Set backup version as current version.

rollForwardToFutureVersion

public spark.Route rollForwardToFutureVersion(Admin admin)

enableStore

public spark.Route enableStore(Admin admin)

enable/disable store read/write ability

deleteAllVersions

public spark.Route deleteAllVersions(Admin admin)

See Also:

• Admin.deleteAllVersionsInStore(String, String)

deleteOldVersions

public spark.Route deleteOldVersions(Admin admin)

See Also:

• Admin.deleteOldVersionInStore(String, String, int)

getStorageEngineOverheadRatio

public spark.Route getStorageEngineOverheadRatio(Admin admin)

See Also:

• Admin.getStorageEngineOverheadRatio(String)

enableActiveActiveReplicationForCluster

public spark.Route enableActiveActiveReplicationForCluster(Admin admin)

See Also:

• Admin.configureActiveActiveReplication(String, VeniceUserStoreType, Optional, boolean, Optional)

setTopicCompaction

public spark.Route setTopicCompaction(Admin admin)

See Also:

• TopicManager.updateTopicCompactionPolicy(PubSubTopic, boolean)

getDeletableStoreTopics

public spark.Route getDeletableStoreTopics(Admin admin)

See Also:

• TopicCleanupService.extractVersionTopicsToCleanup(Admin, Map, int, int)

compareStore

public spark.Route compareStore(Admin admin)

See Also:

• Admin.compareStore(String, String, String, String)

getStaleStoresInCluster

public spark.Route getStaleStoresInCluster(Admin admin)

See Also:

• Admin.getClusterStaleStores(String)

getStoresInCluster

public spark.Route getStoresInCluster(Admin admin)

See Also:

• Admin.getClusterStores(String)

getStoresForCompaction

public spark.Route getStoresForCompaction(Admin admin)

See Also:

• Admin.getStoresForCompaction(String)

repushStore

public spark.Route repushStore(Admin admin)

See Also:

• Admin.repushStore(RepushJobRequest)

getStoreLargestUsedVersion

public spark.Route getStoreLargestUsedVersion(Admin admin)

See Also:

• Admin.getLargestUsedVersion(String, String)

getDeadStores

public spark.Route getDeadStores(Admin admin)

See Also:

• Admin.getDeadStores(String, String, Map)

listStorePushInfo

public spark.Route listStorePushInfo(Admin admin)

See Also:

• Admin.listStorePushInfo(String, String, boolean)

getRegionPushDetails

public spark.Route getRegionPushDetails(Admin admin)

See Also:

• Admin.getRegionPushDetails(String, String, boolean)

deleteKafkaTopic

public spark.Route deleteKafkaTopic(Admin admin)

See Also:

• Admin.truncateKafkaTopic(String)

removeStoreFromGraveyard

public spark.Route removeStoreFromGraveyard(Admin admin)

sendHeartbeatToSystemStore

public spark.Route sendHeartbeatToSystemStore(Admin admin)

getHeartbeatFromSystemStore

public spark.Route getHeartbeatFromSystemStore(Admin admin)

validateStoreDeleted

public spark.Route validateStoreDeleted(Admin admin)

See Also:

• Admin.validateStoreDeleted(String, String)