Skip navigation links
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Index
  • Help

Deprecated API

Contents

  • Terminally Deprecated
  • Classes
  • Fields
  • Methods
  • Constructors
  • Enum Constants
  • Terminally Deprecated Elements
    Element
    Description
    com.apple.foundationdb.record.PlanHashable.iterablePlanHash(PlanHashable.PlanHashKind, Iterable<?>)
    com.apple.foundationdb.record.PlanHashable.objectPlanHash(PlanHashable.PlanHashKind, Object)
    com.apple.foundationdb.record.PlanHashable.objectsPlanHash(PlanHashable.PlanHashKind, Object...)
    com.apple.foundationdb.record.PlanHashable.planHash()
    com.apple.foundationdb.record.PlanHashable.planHash(PlanHashable.PlanHashKind)
    com.apple.foundationdb.record.PlanHashable.planHash(PlanHashable.PlanHashKind, PlanHashable...)
    com.apple.foundationdb.record.PlanHashable.planHash(PlanHashable.PlanHashKind, Iterable<? extends PlanHashable>)
    com.apple.foundationdb.record.PlanHashable.planHashUnordered(PlanHashable.PlanHashKind, Iterable<? extends PlanHashable>)
    com.apple.foundationdb.record.PlanHashable.stringHashUnordered(Iterable<String>)
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.Builder.getFormatVersion()
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.Builder.setFormatVersion(int)
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.CACHEABLE_STATE_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.CHECK_INDEX_BUILD_TYPE_DURING_UPDATE_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.DEFAULT_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.FORMAT_CONTROL_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.getFormatVersion()
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.HEADER_USER_FIELDS_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.INFO_ADDED_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.MAX_SUPPORTED_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.READABLE_UNIQUE_PENDING_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.RECORD_COUNT_ADDED_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.RECORD_COUNT_KEY_ADDED_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.SAVE_UNSPLIT_WITH_SUFFIX_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.SAVE_VERSION_WITH_RECORD_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.BaseBuilder.getFormatVersion()
    use FDBRecordStoreBase.BaseBuilder.getFormatVersionEnum()
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.BaseBuilder.setFormatVersion(int)
    This is deprecated, and instead, one should use FDBRecordStoreBase.BaseBuilder.setFormatVersion(FormatVersion).
    com.apple.foundationdb.record.provider.foundationdb.FDBTypedRecordStore.Builder.getFormatVersion()
    com.apple.foundationdb.record.provider.foundationdb.FDBTypedRecordStore.Builder.setFormatVersion(int)
    com.apple.foundationdb.record.provider.foundationdb.OnlineIndexOperationBaseBuilder.setFormatVersion(int)
    Instead, provide a FDBRecordStore or FDBRecordStore.Builder with an appropriate format version to OnlineIndexOperationBaseBuilder.setRecordStore(FDBRecordStore) or OnlineIndexOperationBaseBuilder.setRecordStoreBuilder(FDBRecordStore.Builder) respectively
    com.apple.foundationdb.record.provider.foundationdb.OnlineIndexScrubber.ScrubbingPolicy.Builder.ignoreIndexTypeCheck()
    because this option is associated with legacy code only (see OnlineIndexScrubber.ScrubbingPolicy.Builder.useLegacyScrubber(boolean)).
    com.apple.foundationdb.record.provider.foundationdb.OnlineIndexScrubber.ScrubbingPolicy.Builder.useLegacyScrubber(boolean)
    because allowing legacy code is temporary. After gaining confidence in the new code, the old code (and this function) will be deleted.
  • Deprecated Classes
    Class
    Description
    com.apple.foundationdb.record.cursors.MapCursor
    Use RecordCursor.map(java.util.function.Function<T, V>) or MapResultCursor instead
  • Deprecated Fields
    Field
    Description
    com.apple.foundationdb.record.metadata.IndexTypes.MAX_EVER
    use IndexTypes.MAX_EVER_LONG for compatibility with existing data or IndexTypes.MAX_EVER_TUPLE for more flexibility
    com.apple.foundationdb.record.metadata.IndexTypes.MIN_EVER
    use IndexTypes.MIN_EVER_LONG for compatibility with existing data or IndexTypes.MIN_EVER_TUPLE for more flexibility
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.CACHEABLE_STATE_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.CHECK_INDEX_BUILD_TYPE_DURING_UPDATE_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.DEFAULT_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.FORMAT_CONTROL_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.HEADER_USER_FIELDS_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.INFO_ADDED_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.MAX_SUPPORTED_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.READABLE_UNIQUE_PENDING_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.RECORD_COUNT_ADDED_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.RECORD_COUNT_KEY_ADDED_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.SAVE_UNSPLIT_WITH_SUFFIX_FORMAT_VERSION
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.SAVE_VERSION_WITH_RECORD_FORMAT_VERSION
  • Deprecated Methods
    Method
    Description
    com.apple.foundationdb.record.PlanHashable.iterablePlanHash(PlanHashable.PlanHashKind, Iterable<?>)
    com.apple.foundationdb.record.PlanHashable.objectPlanHash(PlanHashable.PlanHashKind, Object)
    com.apple.foundationdb.record.PlanHashable.objectsPlanHash(PlanHashable.PlanHashKind, Object...)
    com.apple.foundationdb.record.PlanHashable.planHash()
    com.apple.foundationdb.record.PlanHashable.planHash(PlanHashable.PlanHashKind)
    com.apple.foundationdb.record.PlanHashable.planHash(PlanHashable.PlanHashKind, PlanHashable...)
    com.apple.foundationdb.record.PlanHashable.planHash(PlanHashable.PlanHashKind, Iterable<? extends PlanHashable>)
    com.apple.foundationdb.record.PlanHashable.planHashUnordered(PlanHashable.PlanHashKind, Iterable<? extends PlanHashable>)
    com.apple.foundationdb.record.PlanHashable.stringHashUnordered(Iterable<String>)
    com.apple.foundationdb.record.provider.foundationdb.FDBDatabaseFactory.getThreadsPerClientVersion()
    Call directly on FDBDatabaseFactoryImpl. This will be removed in a future release.
    com.apple.foundationdb.record.provider.foundationdb.FDBDatabaseFactory.setThreadsPerClientVersion(int)
    Call directly on FDBDatabaseFactoryImpl. This will be removed in a future release.
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.Builder.getFormatVersion()
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.Builder.setFormatVersion(int)
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.getFormatVersion()
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.BaseBuilder.getFormatVersion()
    use FDBRecordStoreBase.BaseBuilder.getFormatVersionEnum()
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.BaseBuilder.setFormatVersion(int)
    This is deprecated, and instead, one should use FDBRecordStoreBase.BaseBuilder.setFormatVersion(FormatVersion).
    com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.UserVersionChecker.checkUserVersion(int, int, RecordMetaDataProvider)
    use FDBRecordStoreBase.UserVersionChecker.checkUserVersion(RecordMetaDataProto.DataStoreInfo, RecordMetaDataProvider) instead
    com.apple.foundationdb.record.provider.foundationdb.FDBTransactionContext.setTimer(FDBStoreTimer)
    in favor of setting the timer in FDBDatabase.openContext(FDBRecordContextConfig)
    com.apple.foundationdb.record.provider.foundationdb.FDBTypedRecordStore.Builder.getFormatVersion()
    com.apple.foundationdb.record.provider.foundationdb.FDBTypedRecordStore.Builder.setFormatVersion(int)
    com.apple.foundationdb.record.provider.foundationdb.InstrumentedTransaction.clearRangeStartsWith(byte[])
    com.apple.foundationdb.record.provider.foundationdb.keyspace.ExtendedDirectoryLayer.readReverse(FDBStoreTimer, Long)
    implementors should switch to using ExtendedDirectoryLayer.readReverse(FDBRecordContext, Long) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpace.list(FDBRecordContext, String)
    use KeySpace.listDirectory(FDBRecordContext, String) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpace.list(FDBRecordContext, String, ScanProperties)
    use KeySpace.listDirectoryAsync(FDBRecordContext, String, byte[], ScanProperties) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpace.listAsync(FDBRecordContext, String, byte[], ScanProperties)
    use KeySpace.listDirectoryAsync(FDBRecordContext, String, byte[], ScanProperties) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpace.pathFromKey(FDBRecordContext, Tuple)
    use KeySpace.resolveFromKey(FDBRecordContext, Tuple) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpace.pathFromKeyAsync(FDBRecordContext, Tuple)
    use KeySpace.resolveFromKeyAsync(FDBRecordContext, Tuple) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath.getRemainder()
    use KeySpace.resolveFromKey(FDBRecordContext, Tuple) and ResolvedKeySpacePath.getRemainder() instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath.getStoredValue()
    use KeySpace.resolveFromKey(FDBRecordContext, Tuple) and ResolvedKeySpacePath.getResolvedPathValue() instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath.hasStoredValue()
    use KeySpace.resolveFromKey(FDBRecordContext, Tuple) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath.list(FDBRecordContext, String)
    use KeySpacePath.listSubdirectory(FDBRecordContext, String) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath.list(FDBRecordContext, String, ScanProperties)
    use KeySpacePath.listSubdirectory(FDBRecordContext, String, ScanProperties) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath.list(FDBRecordContext, String, ValueRange<?>, byte[], ScanProperties)
    use KeySpacePath.listSubdirectory(FDBRecordContext, String, ValueRange, byte[], ScanProperties) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath.listAsync(FDBRecordContext, String, byte[], ScanProperties)
    use KeySpacePath.listSubdirectoryAsync(FDBRecordContext, String, byte[], ScanProperties) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath.listAsync(FDBRecordContext, String, ValueRange<?>, byte[], ScanProperties)
    use KeySpacePath.listSubdirectoryAsync(FDBRecordContext, String, ValueRange, byte[], ScanProperties) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePathWrapper.getRemainder()
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePathWrapper.getStoredValue()
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePathWrapper.hasStoredValue()
    com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePathWrapper.listAsync(FDBRecordContext, String, ValueRange<?>, byte[], ScanProperties)
    com.apple.foundationdb.record.provider.foundationdb.keyspace.LocatableResolver.readReverse(FDBStoreTimer, Long)
    implementors should switch to using LocatableResolver.readReverse(FDBRecordContext, Long) instead
    com.apple.foundationdb.record.provider.foundationdb.keyspace.ScopedDirectoryLayer.readReverse(FDBStoreTimer, Long)
    implementors should switch to using ScopedDirectoryLayer.readReverse(FDBRecordContext, Long) instead
    com.apple.foundationdb.record.provider.foundationdb.layers.interning.ScopedInterningLayer.readReverse(FDBStoreTimer, Long)
    implementors should switch to using ScopedInterningLayer.readReverse(FDBRecordContext, Long) instead
    com.apple.foundationdb.record.provider.foundationdb.OnlineIndexer.Builder.setIndexStatePrecondition(OnlineIndexer.IndexStatePrecondition)
    use OnlineIndexer.IndexingPolicy.Builder instead. Example:

    setIndexingPolicy(OnlineIndexer.IndexingPolicy.newBuilder() .setIfDisabled(OnlineIndexer.IndexingPolicy.DesiredAction.CONTINUE) .setIfWriteOnly(OnlineIndexer.IndexingPolicy.DesiredAction.CONTINUE) .setIfMismatchPrevious(OnlineIndexer.IndexingPolicy.DesiredAction.REBUILD) .setIfReadable(OnlineIndexer.IndexingPolicy.DesiredAction.ERROR));

    For backward compatibility, calling this function in any order will override the OnlineIndexer.IndexingPolicy.Builder methods: setIfDisabled, setIfWriteOnly, setIfMismatchPrevious, setIfReadable
    com.apple.foundationdb.record.provider.foundationdb.OnlineIndexOperationBaseBuilder.setFormatVersion(int)
    Instead, provide a FDBRecordStore or FDBRecordStore.Builder with an appropriate format version to OnlineIndexOperationBaseBuilder.setRecordStore(FDBRecordStore) or OnlineIndexOperationBaseBuilder.setRecordStoreBuilder(FDBRecordStore.Builder) respectively
    com.apple.foundationdb.record.provider.foundationdb.OnlineIndexScrubber.ScrubbingPolicy.Builder.ignoreIndexTypeCheck()
    because this option is associated with legacy code only (see OnlineIndexScrubber.ScrubbingPolicy.Builder.useLegacyScrubber(boolean)).
    com.apple.foundationdb.record.provider.foundationdb.OnlineIndexScrubber.ScrubbingPolicy.Builder.useLegacyScrubber(boolean)
    because allowing legacy code is temporary. After gaining confidence in the new code, the old code (and this function) will be deleted.
    com.apple.foundationdb.record.RecordMetaDataBuilder.getRecordCountKey()
    use COUNT type indexes instead
    com.apple.foundationdb.record.RecordMetaDataBuilder.setRecordCountKey(KeyExpression)
    use COUNT type indexes instead
  • Deprecated Constructors
    Constructor
    Description
    com.apple.foundationdb.record.provider.foundationdb.keyspace.ScopedDirectoryLayer(FDBRecordContext, KeySpacePath)
    use ScopedDirectoryLayer(FDBDatabase, ResolvedKeySpacePath) instead
    com.apple.foundationdb.record.provider.foundationdb.layers.interning.ScopedInterningLayer(FDBRecordContext, KeySpacePath)
    use ScopedInterningLayer(FDBDatabase, ResolvedKeySpacePath) instead
    com.apple.foundationdb.record.query.plan.cascades.expressions.LogicalSortExpression(List<Value>, boolean, Quantifier)
  • Deprecated Enum Constants
    Enum Constant
    Description
    com.apple.foundationdb.record.logging.LogMessageKeys.DIRECTOY
    use LogMessageKeys.DIRECTORY instead