Package com.linkedin.venice.meta
Interface Store
- All Known Implementing Classes:
AbstractStore,ReadOnlyStore,ReadOnlyViewStore,SystemStore,ZKStore
public interface Store
This interface defines all the public APIs, and if you need to add accessors to
some new fields, this interface needs to be changed accordingly.
IMPORTANT: getter functions must start with `is` for boolean result and `get` for other types, and setter functions
must start with `set`!
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final longstatic final intstatic final intSpecial version number indicates none of version is available to read.static final intDefault value of numVersionPreserve, by default we should use cluster level config instead of store level config.static final Stringstatic final Stringstatic final long -
Method Summary
Modifier and TypeMethodDescriptionvoidaddVersion(Version version) voidaddVersion(Version version, boolean isClonedVersion, int currentRTVersionNumber) voidcheckDisableStoreWrite(String action, int version) booleancontainsVersion(int versionNumber) deleteVersion(int versionNumber) voidvoidforceAddVersion(Version version, boolean isClonedVersion) longintintbooleanlonglongintbooleanintintintlonglonglongintintlonggetName()intintgetOwner()intlongintlongintlongintgetVersion(int versionNumber) default it.unimi.dsi.fastutil.ints.IntSetgetVersionOrThrow(int versionNumber) getVersionStatus(int versionNumber) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisHybrid()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanstatic booleanisSystemStore(String storeName) booleanbooleanbooleanintvoidputSystemStore(VeniceSystemStoreType systemStoreType, SystemStoreAttributes systemStoreAttributes) retrieveVersionsToDelete(int clusterNumVersionsToPreserve) voidsetAccessControlled(boolean accessControlled) voidsetActiveActiveReplicationEnabled(boolean activeActiveReplicationEnabled) voidsetBackupStrategy(BackupStrategy value) voidsetBackupVersionRetentionMs(long backupVersionRetentionMs) voidsetBatchGetLimit(int batchGetLimit) voidsetBlobTransferEnabled(boolean blobTransferEnabled) voidsetBlobTransferInServerEnabled(String blobTransferInServerEnabled) voidsetBootstrapToOnlineTimeoutInHours(int bootstrapToOnlineTimeoutInHours) voidsetChunkingEnabled(boolean chunkingEnabled) voidsetClientDecompressionEnabled(boolean clientDecompressionEnabled) voidsetCompactionEnabled(boolean compactionEnabled) voidsetCompactionThresholdMilliseconds(long compactionThreshold) voidsetCompressionStrategy(CompressionStrategy compressionStrategy) voidsetCurrentVersion(int currentVersion) voidsetCurrentVersionWithoutCheck(int currentVersion) voidsetDaVinciPushStatusStoreEnabled(boolean daVinciPushStatusStoreEnabled) voidsetEnableReads(boolean enableReads) voidsetEnableWrites(boolean enableWrites) voidsetEnumSchemaEvolutionAllowed(boolean enumSchemaEvolutionAllowed) voidsetEtlStoreConfig(ETLStoreConfig etlStoreConfig) voidsetGlobalRtDivEnabled(boolean globalRtDivEnabled) voidsetHybridStoreConfig(HybridStoreConfig hybridStoreConfig) voidsetHybridStoreDiskQuotaEnabled(boolean enabled) voidsetIncrementalPushEnabled(boolean incrementalPushEnabled) voidsetIsDavinciHeartbeatReported(boolean isReported) voidsetKeyUrnCompressionEnabled(boolean keyUrnCompressionEnabled) voidsetKeyUrnFields(List<String> keyUrnFields) voidsetLargestUsedRTVersionNumber(int largestUsedRTVersionNumber) voidsetLargestUsedVersionNumber(int largestUsedVersionNumber) voidsetLatestSuperSetValueSchemaId(int valueSchemaId) voidsetLatestVersionPromoteToCurrentTimestamp(long latestVersionPromoteToCurrentTimestamp) voidsetLowWatermark(long lowWatermark) voidsetMaxCompactionLagSeconds(long maxCompactionLagSeconds) voidsetMaxNearlineRecordSizeBytes(int maxNearlineRecordSizeBytes) voidsetMaxRecordSizeBytes(int maxRecordSizeBytes) voidsetMigrating(boolean migrating) voidsetMigrationDuplicateStore(boolean migrationDuplicateStore) voidsetMinCompactionLagSeconds(long minCompactionLagSeconds) voidsetNativeReplicationEnabled(boolean nativeReplicationEnabled) voidsetNativeReplicationSourceFabric(String nativeReplicationSourceFabric) voidsetNearlineProducerCompressionEnabled(boolean compressionEnabled) voidsetNearlineProducerCountPerWriter(int producerCnt) voidsetNumVersionsToPreserve(int numVersionsToPreserve) voidvoidsetPartitionCount(int partitionCount) voidvoidsetPersistenceType(PersistenceType persistenceType) voidsetPushStreamSourceAddress(String sourceAddress) voidsetReadComputationEnabled(boolean readComputationEnabled) voidsetReadQuotaInCU(long readQuotaInCU) voidsetReplicationFactor(int replicationFactor) voidsetRmdChunkingEnabled(boolean rmdChunkingEnabled) voidsetRmdVersion(int rmdVersion) voidsetSchemaAutoRegisterFromPushJobEnabled(boolean value) voidsetSeparateRealTimeTopicEnabled(boolean separateRealTimeTopicEnabled) voidsetStorageNodeReadQuotaEnabled(boolean storageNodeReadQuotaEnabled) voidsetStorageQuotaInByte(long storageQuotaInByte) voidsetStoreLifecycleHooks(List<LifecycleHooksRecord> storeLifecycleHooks) voidsetStoreMetadataSystemStoreEnabled(boolean storeMetadataSystemStoreEnabled) voidsetStoreMetaSystemStoreEnabled(boolean storeMetaSystemStoreEnabled) voidsetSystemStores(Map<String, SystemStoreAttributes> systemStores) voidsetTargetSwapRegion(String targetRegion) voidsetTargetSwapRegionWaitTime(int waitTime) voidsetTTLRepushEnabled(boolean ttlRepushEnabled) voidsetUnusedSchemaDeletionEnabled(boolean unusedSchemaDeletionEnabled) voidsetVersions(List<Version> versions) voidsetViewConfigs(Map<String, ViewConfig> viewConfigMap) voidsetWriteComputationEnabled(boolean writeComputationEnabled) voidupdateVersionForDaVinciHeartbeat(int versionNumber, boolean reported) voidupdateVersionStatus(int versionNumber, VersionStatus status)
-
Field Details
-
NON_EXISTING_VERSION
static final int NON_EXISTING_VERSIONSpecial version number indicates none of version is available to read.- See Also:
-
NUM_VERSION_PRESERVE_NOT_SET
static final int NUM_VERSION_PRESERVE_NOT_SETDefault value of numVersionPreserve, by default we should use cluster level config instead of store level config.- See Also:
-
SYSTEM_STORE_NAME_PREFIX
- See Also:
-
SYSTEM_STORE_FORMAT
- See Also:
-
UNLIMITED_STORAGE_QUOTA
static final long UNLIMITED_STORAGE_QUOTA- See Also:
-
IGNORE_VERSION
static final int IGNORE_VERSION- See Also:
-
BOOTSTRAP_TO_ONLINE_TIMEOUT_IN_HOURS
static final int BOOTSTRAP_TO_ONLINE_TIMEOUT_IN_HOURS- See Also:
-
DEFAULT_RT_RETENTION_TIME
static final long DEFAULT_RT_RETENTION_TIME -
DEFAULT_BATCH_GET_LIMIT
static final int DEFAULT_BATCH_GET_LIMIT- See Also:
-
-
Method Details
-
isSystemStore
-
getName
String getName() -
getOwner
String getOwner() -
setOwner
-
getCreatedTime
long getCreatedTime() -
getCurrentVersion
int getCurrentVersion() -
setCurrentVersion
void setCurrentVersion(int currentVersion) -
setCurrentVersionWithoutCheck
void setCurrentVersionWithoutCheck(int currentVersion) -
getLowWatermark
long getLowWatermark() -
setLowWatermark
void setLowWatermark(long lowWatermark) -
getPersistenceType
PersistenceType getPersistenceType() -
setPersistenceType
-
getRoutingStrategy
RoutingStrategy getRoutingStrategy() -
getReadStrategy
ReadStrategy getReadStrategy() -
getOffLinePushStrategy
OfflinePushStrategy getOffLinePushStrategy() -
getLargestUsedVersionNumber
int getLargestUsedVersionNumber() -
setLargestUsedVersionNumber
void setLargestUsedVersionNumber(int largestUsedVersionNumber) -
getLargestUsedRTVersionNumber
int getLargestUsedRTVersionNumber() -
setLargestUsedRTVersionNumber
void setLargestUsedRTVersionNumber(int largestUsedRTVersionNumber) -
getStorageQuotaInByte
long getStorageQuotaInByte() -
setStorageQuotaInByte
void setStorageQuotaInByte(long storageQuotaInByte) -
getPartitionCount
int getPartitionCount() -
setPartitionCount
void setPartitionCount(int partitionCount) -
getPartitionerConfig
PartitionerConfig getPartitionerConfig() -
setPartitionerConfig
-
isEnableWrites
boolean isEnableWrites() -
setEnableWrites
void setEnableWrites(boolean enableWrites) -
isEnableReads
boolean isEnableReads() -
setEnableReads
void setEnableReads(boolean enableReads) -
getReadQuotaInCU
long getReadQuotaInCU() -
setReadQuotaInCU
void setReadQuotaInCU(long readQuotaInCU) -
getHybridStoreConfig
HybridStoreConfig getHybridStoreConfig() -
setHybridStoreConfig
-
getViewConfigs
Map<String,ViewConfig> getViewConfigs() -
setViewConfigs
-
isHybrid
boolean isHybrid() -
getCompressionStrategy
CompressionStrategy getCompressionStrategy() -
setCompressionStrategy
-
getClientDecompressionEnabled
boolean getClientDecompressionEnabled() -
setClientDecompressionEnabled
void setClientDecompressionEnabled(boolean clientDecompressionEnabled) -
isChunkingEnabled
boolean isChunkingEnabled() -
setChunkingEnabled
void setChunkingEnabled(boolean chunkingEnabled) -
isRmdChunkingEnabled
boolean isRmdChunkingEnabled() -
setRmdChunkingEnabled
void setRmdChunkingEnabled(boolean rmdChunkingEnabled) -
getBatchGetLimit
int getBatchGetLimit() -
setBatchGetLimit
void setBatchGetLimit(int batchGetLimit) -
isIncrementalPushEnabled
boolean isIncrementalPushEnabled() -
setIncrementalPushEnabled
void setIncrementalPushEnabled(boolean incrementalPushEnabled) -
isSeparateRealTimeTopicEnabled
boolean isSeparateRealTimeTopicEnabled() -
setSeparateRealTimeTopicEnabled
void setSeparateRealTimeTopicEnabled(boolean separateRealTimeTopicEnabled) -
isAccessControlled
boolean isAccessControlled() -
setAccessControlled
void setAccessControlled(boolean accessControlled) -
isMigrating
boolean isMigrating() -
setMigrating
void setMigrating(boolean migrating) -
getNumVersionsToPreserve
int getNumVersionsToPreserve() -
setNumVersionsToPreserve
void setNumVersionsToPreserve(int numVersionsToPreserve) -
isWriteComputationEnabled
boolean isWriteComputationEnabled() -
setWriteComputationEnabled
void setWriteComputationEnabled(boolean writeComputationEnabled) -
isReadComputationEnabled
boolean isReadComputationEnabled() -
setReadComputationEnabled
void setReadComputationEnabled(boolean readComputationEnabled) -
getBootstrapToOnlineTimeoutInHours
int getBootstrapToOnlineTimeoutInHours() -
setBootstrapToOnlineTimeoutInHours
void setBootstrapToOnlineTimeoutInHours(int bootstrapToOnlineTimeoutInHours) -
getPushStreamSourceAddress
String getPushStreamSourceAddress() -
setPushStreamSourceAddress
-
isNativeReplicationEnabled
boolean isNativeReplicationEnabled() -
getRmdVersion
int getRmdVersion() -
setRmdVersion
void setRmdVersion(int rmdVersion) -
setNativeReplicationEnabled
void setNativeReplicationEnabled(boolean nativeReplicationEnabled) -
getBackupStrategy
BackupStrategy getBackupStrategy() -
setBackupStrategy
-
isSchemaAutoRegisterFromPushJobEnabled
boolean isSchemaAutoRegisterFromPushJobEnabled() -
setSchemaAutoRegisterFromPushJobEnabled
void setSchemaAutoRegisterFromPushJobEnabled(boolean value) -
getLatestSuperSetValueSchemaId
int getLatestSuperSetValueSchemaId() -
setLatestSuperSetValueSchemaId
void setLatestSuperSetValueSchemaId(int valueSchemaId) -
isHybridStoreDiskQuotaEnabled
boolean isHybridStoreDiskQuotaEnabled() -
setHybridStoreDiskQuotaEnabled
void setHybridStoreDiskQuotaEnabled(boolean enabled) -
getEtlStoreConfig
ETLStoreConfig getEtlStoreConfig() -
setEtlStoreConfig
-
isStoreMetadataSystemStoreEnabled
boolean isStoreMetadataSystemStoreEnabled() -
setStoreMetadataSystemStoreEnabled
void setStoreMetadataSystemStoreEnabled(boolean storeMetadataSystemStoreEnabled) -
isStoreMetaSystemStoreEnabled
boolean isStoreMetaSystemStoreEnabled() -
setStoreMetaSystemStoreEnabled
void setStoreMetaSystemStoreEnabled(boolean storeMetaSystemStoreEnabled) -
getLatestVersionPromoteToCurrentTimestamp
long getLatestVersionPromoteToCurrentTimestamp() -
setLatestVersionPromoteToCurrentTimestamp
void setLatestVersionPromoteToCurrentTimestamp(long latestVersionPromoteToCurrentTimestamp) -
getBackupVersionRetentionMs
long getBackupVersionRetentionMs() -
setBackupVersionRetentionMs
void setBackupVersionRetentionMs(long backupVersionRetentionMs) -
getRetentionTime
long getRetentionTime() -
getReplicationFactor
int getReplicationFactor() -
setReplicationFactor
void setReplicationFactor(int replicationFactor) -
isMigrationDuplicateStore
boolean isMigrationDuplicateStore() -
setMigrationDuplicateStore
void setMigrationDuplicateStore(boolean migrationDuplicateStore) -
getNativeReplicationSourceFabric
String getNativeReplicationSourceFabric() -
setNativeReplicationSourceFabric
-
isActiveActiveReplicationEnabled
boolean isActiveActiveReplicationEnabled() -
setActiveActiveReplicationEnabled
void setActiveActiveReplicationEnabled(boolean activeActiveReplicationEnabled) -
getSystemStores
Map<String,SystemStoreAttributes> getSystemStores() -
setSystemStores
-
putSystemStore
void putSystemStore(VeniceSystemStoreType systemStoreType, SystemStoreAttributes systemStoreAttributes) -
isDaVinciPushStatusStoreEnabled
boolean isDaVinciPushStatusStoreEnabled() -
setDaVinciPushStatusStoreEnabled
void setDaVinciPushStatusStoreEnabled(boolean daVinciPushStatusStoreEnabled) -
cloneStore
Store cloneStore() -
getVersions
-
getVersionNumbers
default it.unimi.dsi.fastutil.ints.IntSet getVersionNumbers() -
setVersions
-
addVersion
-
addVersion
-
forceAddVersion
-
checkDisableStoreWrite
-
deleteVersion
-
containsVersion
boolean containsVersion(int versionNumber) -
updateVersionStatus
-
peekNextVersionNumber
int peekNextVersionNumber() -
getVersion
-
getVersionOrThrow
- Throws:
StoreVersionNotFoundException
-
getVersionStatus
-
retrieveVersionsToDelete
-
isSystemStore
boolean isSystemStore() -
fixMissingFields
void fixMissingFields() -
isStorageNodeReadQuotaEnabled
boolean isStorageNodeReadQuotaEnabled() -
setStorageNodeReadQuotaEnabled
void setStorageNodeReadQuotaEnabled(boolean storageNodeReadQuotaEnabled) -
isCompactionEnabled
boolean isCompactionEnabled() -
setCompactionEnabled
void setCompactionEnabled(boolean compactionEnabled) -
getCompactionThresholdMilliseconds
long getCompactionThresholdMilliseconds() -
setCompactionThresholdMilliseconds
void setCompactionThresholdMilliseconds(long compactionThreshold) -
getMinCompactionLagSeconds
long getMinCompactionLagSeconds() -
setMinCompactionLagSeconds
void setMinCompactionLagSeconds(long minCompactionLagSeconds) -
getMaxCompactionLagSeconds
long getMaxCompactionLagSeconds() -
setMaxCompactionLagSeconds
void setMaxCompactionLagSeconds(long maxCompactionLagSeconds) -
getMaxRecordSizeBytes
int getMaxRecordSizeBytes() -
setMaxRecordSizeBytes
void setMaxRecordSizeBytes(int maxRecordSizeBytes) -
getMaxNearlineRecordSizeBytes
int getMaxNearlineRecordSizeBytes() -
setMaxNearlineRecordSizeBytes
void setMaxNearlineRecordSizeBytes(int maxNearlineRecordSizeBytes) -
setUnusedSchemaDeletionEnabled
void setUnusedSchemaDeletionEnabled(boolean unusedSchemaDeletionEnabled) -
isUnusedSchemaDeletionEnabled
boolean isUnusedSchemaDeletionEnabled() -
isBlobTransferEnabled
boolean isBlobTransferEnabled() -
setBlobTransferEnabled
void setBlobTransferEnabled(boolean blobTransferEnabled) -
setBlobTransferInServerEnabled
-
getBlobTransferInServerEnabled
String getBlobTransferInServerEnabled() -
isNearlineProducerCompressionEnabled
boolean isNearlineProducerCompressionEnabled() -
setNearlineProducerCompressionEnabled
void setNearlineProducerCompressionEnabled(boolean compressionEnabled) -
getNearlineProducerCountPerWriter
int getNearlineProducerCountPerWriter() -
setNearlineProducerCountPerWriter
void setNearlineProducerCountPerWriter(int producerCnt) -
getTargetSwapRegion
String getTargetSwapRegion() -
getTargetSwapRegionWaitTime
int getTargetSwapRegionWaitTime() -
setTargetSwapRegion
-
setTargetSwapRegionWaitTime
void setTargetSwapRegionWaitTime(int waitTime) -
setIsDavinciHeartbeatReported
void setIsDavinciHeartbeatReported(boolean isReported) -
getIsDavinciHeartbeatReported
boolean getIsDavinciHeartbeatReported() -
updateVersionForDaVinciHeartbeat
void updateVersionForDaVinciHeartbeat(int versionNumber, boolean reported) -
isGlobalRtDivEnabled
boolean isGlobalRtDivEnabled() -
setGlobalRtDivEnabled
void setGlobalRtDivEnabled(boolean globalRtDivEnabled) -
isTTLRepushEnabled
boolean isTTLRepushEnabled() -
setTTLRepushEnabled
void setTTLRepushEnabled(boolean ttlRepushEnabled) -
isEnumSchemaEvolutionAllowed
boolean isEnumSchemaEvolutionAllowed() -
setEnumSchemaEvolutionAllowed
void setEnumSchemaEvolutionAllowed(boolean enumSchemaEvolutionAllowed) -
getStoreLifecycleHooks
List<LifecycleHooksRecord> getStoreLifecycleHooks() -
setStoreLifecycleHooks
-
setKeyUrnCompressionEnabled
void setKeyUrnCompressionEnabled(boolean keyUrnCompressionEnabled) -
isKeyUrnCompressionEnabled
boolean isKeyUrnCompressionEnabled() -
setKeyUrnFields
-
getKeyUrnFields
-