Interface Store

All Known Implementing Classes:
AbstractStore, ReadOnlyStore, 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 Details

    • NON_EXISTING_VERSION

      static final int NON_EXISTING_VERSION
      Special version number indicates none of version is available to read.
      See Also:
    • NUM_VERSION_PRESERVE_NOT_SET

      static final int NUM_VERSION_PRESERVE_NOT_SET
      Default value of numVersionPreserve, by default we should use cluster level config instead of store level config.
      See Also:
    • SYSTEM_STORE_NAME_PREFIX

      static final String SYSTEM_STORE_NAME_PREFIX
      See Also:
    • SYSTEM_STORE_FORMAT

      static final String 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

      static boolean isSystemStore(String storeName)
    • getName

      String getName()
    • getOwner

      String getOwner()
    • setOwner

      void setOwner(String owner)
    • 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

      void setPersistenceType(PersistenceType persistenceType)
    • getRoutingStrategy

      RoutingStrategy getRoutingStrategy()
    • getReadStrategy

      ReadStrategy getReadStrategy()
    • getOffLinePushStrategy

      OfflinePushStrategy getOffLinePushStrategy()
    • getLargestUsedVersionNumber

      int getLargestUsedVersionNumber()
    • setLargestUsedVersionNumber

      void setLargestUsedVersionNumber(int largestUsedVersionNumber)
    • getStorageQuotaInByte

      long getStorageQuotaInByte()
    • setStorageQuotaInByte

      void setStorageQuotaInByte(long storageQuotaInByte)
    • getPartitionCount

      int getPartitionCount()
    • setPartitionCount

      void setPartitionCount(int partitionCount)
    • getPartitionerConfig

      PartitionerConfig getPartitionerConfig()
    • setPartitionerConfig

      void setPartitionerConfig(PartitionerConfig value)
    • 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

      void setHybridStoreConfig(HybridStoreConfig hybridStoreConfig)
    • getViewConfigs

      Map<String,ViewConfig> getViewConfigs()
    • setViewConfigs

      void setViewConfigs(Map<String,ViewConfig> viewConfigMap)
    • isHybrid

      boolean isHybrid()
    • getCompressionStrategy

      CompressionStrategy getCompressionStrategy()
    • setCompressionStrategy

      void setCompressionStrategy(CompressionStrategy compressionStrategy)
    • 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

      void setPushStreamSourceAddress(String sourceAddress)
    • isNativeReplicationEnabled

      boolean isNativeReplicationEnabled()
    • getRmdVersion

      int getRmdVersion()
    • setRmdVersion

      void setRmdVersion(int rmdVersion)
    • setNativeReplicationEnabled

      void setNativeReplicationEnabled(boolean nativeReplicationEnabled)
    • getBackupStrategy

      BackupStrategy getBackupStrategy()
    • setBackupStrategy

      void setBackupStrategy(BackupStrategy value)
    • 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

      void setEtlStoreConfig(ETLStoreConfig etlStoreConfig)
    • 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

      void setNativeReplicationSourceFabric(String nativeReplicationSourceFabric)
    • isActiveActiveReplicationEnabled

      boolean isActiveActiveReplicationEnabled()
    • setActiveActiveReplicationEnabled

      void setActiveActiveReplicationEnabled(boolean activeActiveReplicationEnabled)
    • getSystemStores

      Map<String,SystemStoreAttributes> getSystemStores()
    • setSystemStores

      void setSystemStores(Map<String,SystemStoreAttributes> systemStores)
    • putSystemStore

      void putSystemStore(VeniceSystemStoreType systemStoreType, SystemStoreAttributes systemStoreAttributes)
    • isDaVinciPushStatusStoreEnabled

      boolean isDaVinciPushStatusStoreEnabled()
    • setDaVinciPushStatusStoreEnabled

      void setDaVinciPushStatusStoreEnabled(boolean daVinciPushStatusStoreEnabled)
    • cloneStore

      Store cloneStore()
    • getVersions

      List<Version> getVersions()
    • setVersions

      void setVersions(List<Version> versions)
    • addVersion

      void addVersion(Version version)
    • addVersion

      void addVersion(Version version, boolean isClonedVersion)
    • forceAddVersion

      void forceAddVersion(Version version, boolean isClonedVersion)
    • checkDisableStoreWrite

      void checkDisableStoreWrite(String action, int version)
    • deleteVersion

      Version deleteVersion(int versionNumber)
    • containsVersion

      boolean containsVersion(int versionNumber)
    • updateVersionStatus

      void updateVersionStatus(int versionNumber, VersionStatus status)
    • peekNextVersion

      Version peekNextVersion()
    • getVersion

      @Nullable Version getVersion(int versionNumber)
      Parameters:
      versionNumber - for which to get the Version
      Returns:
      the Version corresponding to the provided , or null if no such version exists
    • getVersionOrThrow

      @Nonnull Version getVersionOrThrow(int versionNumber) throws StoreVersionNotFoundException
      Throws:
      StoreVersionNotFoundException
    • getVersionStatus

      VersionStatus getVersionStatus(int versionNumber)
    • retrieveVersionsToDelete

      List<Version> retrieveVersionsToDelete(int clusterNumVersionsToPreserve)
    • isSystemStore

      boolean isSystemStore()
    • fixMissingFields

      void fixMissingFields()
    • isStorageNodeReadQuotaEnabled

      boolean isStorageNodeReadQuotaEnabled()
    • setStorageNodeReadQuotaEnabled

      void setStorageNodeReadQuotaEnabled(boolean storageNodeReadQuotaEnabled)
    • 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)
    • isNearlineProducerCompressionEnabled

      boolean isNearlineProducerCompressionEnabled()
    • setNearlineProducerCompressionEnabled

      void setNearlineProducerCompressionEnabled(boolean compressionEnabled)
    • getNearlineProducerCountPerWriter

      int getNearlineProducerCountPerWriter()
    • setNearlineProducerCountPerWriter

      void setNearlineProducerCountPerWriter(int producerCnt)
    • getTargetSwapRegion

      String getTargetSwapRegion()
    • getTargetSwapRegionWaitTime

      int getTargetSwapRegionWaitTime()
    • setTargetSwapRegion

      void setTargetSwapRegion(String targetRegion)
    • setTargetSwapRegionWaitTime

      void setTargetSwapRegionWaitTime(int waitTime)
    • setIsDavinciHeartbeatReported

      void setIsDavinciHeartbeatReported(boolean isReported)
    • getIsDavinciHeartbeatReported

      boolean getIsDavinciHeartbeatReported()
    • updateVersionForDaVinciHeartbeat

      void updateVersionForDaVinciHeartbeat(int versionNumber, boolean reported)