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 Detail

      • NON_EXISTING_VERSION

        static final int NON_EXISTING_VERSION
        Special version number indicates none of version is available to read.
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • SYSTEM_STORE_NAME_PREFIX

        static final java.lang.String SYSTEM_STORE_NAME_PREFIX
        See Also:
        Constant Field Values
      • BOOTSTRAP_TO_ONLINE_TIMEOUT_IN_HOURS

        static final int BOOTSTRAP_TO_ONLINE_TIMEOUT_IN_HOURS
        See Also:
        Constant Field Values
      • DEFAULT_RT_RETENTION_TIME

        static final long DEFAULT_RT_RETENTION_TIME
      • storeNamePattern

        static final java.util.regex.Pattern storeNamePattern
        Store name rules: 1. Only letters, numbers, underscore or dash 2. No double dashes
    • Method Detail

      • isValidStoreName

        static boolean isValidStoreName​(java.lang.String name)
      • isSystemStore

        static boolean isSystemStore​(java.lang.String storeName)
      • getName

        java.lang.String getName()
      • getOwner

        java.lang.String getOwner()
      • setOwner

        void setOwner​(java.lang.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)
      • setPersistenceType

        void setPersistenceType​(PersistenceType persistenceType)
      • getLargestUsedVersionNumber

        int getLargestUsedVersionNumber()
      • setLargestUsedVersionNumber

        void setLargestUsedVersionNumber​(int largestUsedVersionNumber)
      • getStorageQuotaInByte

        long getStorageQuotaInByte()
      • setStorageQuotaInByte

        void setStorageQuotaInByte​(long storageQuotaInByte)
      • getPartitionCount

        int getPartitionCount()
      • setPartitionCount

        void setPartitionCount​(int partitionCount)
      • isEnableWrites

        boolean isEnableWrites()
      • setEnableWrites

        void setEnableWrites​(boolean enableWrites)
      • isEnableReads

        boolean isEnableReads()
      • setEnableReads

        void setEnableReads​(boolean enableReads)
      • getReadQuotaInCU

        long getReadQuotaInCU()
      • setReadQuotaInCU

        void setReadQuotaInCU​(long readQuotaInCU)
      • setHybridStoreConfig

        void setHybridStoreConfig​(HybridStoreConfig hybridStoreConfig)
      • getViewConfigs

        java.util.Map<java.lang.String,​ViewConfig> getViewConfigs()
      • setViewConfigs

        void setViewConfigs​(java.util.Map<java.lang.String,​ViewConfig> viewConfigMap)
      • isHybrid

        boolean isHybrid()
      • 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

        java.lang.String getPushStreamSourceAddress()
      • setPushStreamSourceAddress

        void setPushStreamSourceAddress​(java.lang.String sourceAddress)
      • isNativeReplicationEnabled

        boolean isNativeReplicationEnabled()
      • getRmdVersion

        int getRmdVersion()
      • setRmdVersion

        void setRmdVersion​(int rmdVersion)
      • setNativeReplicationEnabled

        void setNativeReplicationEnabled​(boolean nativeReplicationEnabled)
      • isSchemaAutoRegisterFromPushJobEnabled

        boolean isSchemaAutoRegisterFromPushJobEnabled()
      • setSchemaAutoRegisterFromPushJobEnabled

        void setSchemaAutoRegisterFromPushJobEnabled​(boolean value)
      • getLatestSuperSetValueSchemaId

        int getLatestSuperSetValueSchemaId()
      • setLatestSuperSetValueSchemaId

        void setLatestSuperSetValueSchemaId​(int valueSchemaId)
      • isHybridStoreDiskQuotaEnabled

        boolean isHybridStoreDiskQuotaEnabled()
      • setHybridStoreDiskQuotaEnabled

        void setHybridStoreDiskQuotaEnabled​(boolean enabled)
      • 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

        java.lang.String getNativeReplicationSourceFabric()
      • setNativeReplicationSourceFabric

        void setNativeReplicationSourceFabric​(java.lang.String nativeReplicationSourceFabric)
      • isActiveActiveReplicationEnabled

        boolean isActiveActiveReplicationEnabled()
      • setActiveActiveReplicationEnabled

        void setActiveActiveReplicationEnabled​(boolean activeActiveReplicationEnabled)
      • setSystemStores

        void setSystemStores​(java.util.Map<java.lang.String,​SystemStoreAttributes> systemStores)
      • isDaVinciPushStatusStoreEnabled

        boolean isDaVinciPushStatusStoreEnabled()
      • setDaVinciPushStatusStoreEnabled

        void setDaVinciPushStatusStoreEnabled​(boolean daVinciPushStatusStoreEnabled)
      • cloneStore

        Store cloneStore()
      • getVersions

        java.util.List<Version> getVersions()
      • setVersions

        void setVersions​(java.util.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​(java.lang.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 {@param versionNumber}, or null if no such version exists
      • getVersionStatus

        VersionStatus getVersionStatus​(int versionNumber)
      • retrieveVersionsToDelete

        java.util.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

        java.lang.String getTargetSwapRegion()
      • getTargetSwapRegionWaitTime

        int getTargetSwapRegionWaitTime()
      • setTargetSwapRegion

        void setTargetSwapRegion​(java.lang.String targetRegion)
      • setTargetSwapRegionWaitTime

        void setTargetSwapRegionWaitTime​(int waitTime)
      • setIsDavinciHeartbeatReported

        void setIsDavinciHeartbeatReported​(boolean isReported)
      • getIsDavinciHeartbeatReported

        boolean getIsDavinciHeartbeatReported()
      • updateVersionForDaVinciHeartbeat

        void updateVersionForDaVinciHeartbeat​(int versionNumber,
                                              boolean reported)