Package com.apple.foundationdb.record.provider.foundationdb.keyspace

Class ScopedDirectoryLayer

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.keyspace.LocatableResolver

com.apple.foundationdb.record.provider.foundationdb.keyspace.ScopedDirectoryLayer

@API(MAINTAINED)
public class ScopedDirectoryLayer
extends LocatableResolver

An implementation of LocatableResolver that uses the FDB directory layer to keep track of the allocation of strings to integers. The KeySpacePath that it is created with will be the root where the node subspace of the directory layer is located.

Nested Class Summary

Nested classes/interfaces inherited from class com.apple.foundationdb.record.provider.foundationdb.keyspace.LocatableResolver

LocatableResolver.LocatableResolverLockedException

Field Summary

Fields inherited from class com.apple.foundationdb.record.provider.foundationdb.keyspace.LocatableResolver

database, hashCode, location

Constructor Summary

Constructors

Constructor	Description
ScopedDirectoryLayer(FDBDatabase database, ResolvedKeySpacePath path)	Create a scoped directory layer.
ScopedDirectoryLayer(FDBRecordContext context, KeySpacePath path)	Deprecated. use ScopedDirectoryLayer(FDBDatabase, ResolvedKeySpacePath) instead

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<ResolverResult>	create(FDBRecordContext context, String key, byte[] metadata)
ResolverResult	deserializeValue(byte[] value)	Deserialize the raw bytes value stored in the mapping subspace.
CompletableFuture<Subspace>	getBaseSubspaceAsync()	Get a CompletableFuture that will contain the Subspace this resolver is rooted at (e.g.
Subspace	getContentSubspace()
CompletableFuture<Subspace>	getMappingSubspaceAsync()	Get a CompletableFuture that will contain the Subspace where this resolver stores the mappings from key Strings to value Long.
CompletableFuture<Subspace>	getNodeSubspace(FDBRecordContext context)
protected CompletableFuture<Subspace>	getStateSubspaceAsync()
static ScopedDirectoryLayer	global(FDBDatabase database)	Creates a default instance of the scoped directory layer.
protected CompletableFuture<Optional<ResolverResult>>	read(FDBRecordContext context, String key)
protected CompletableFuture<Optional<String>>	readReverse(FDBStoreTimer timer, Long value)
CompletableFuture<Void>	setMapping(FDBRecordContext context, String key, ResolverResult value)
CompletableFuture<Void>	setWindow(long count)
CompletableFuture<Void>	updateMetadata(FDBRecordContext context, String key, byte[] metadata)

Methods inherited from class com.apple.foundationdb.record.provider.foundationdb.keyspace.LocatableResolver

create, disableWriteLock, enableWriteLock, equals, exclusiveLock, getBaseSubspace, getDatabase, getMappingSubspace, getVersion, hashCode, incrementVersion, mustResolve, mustResolveWithMetadata, resolve, resolve, resolve, resolve, resolve, resolve, resolveWithMetadata, resolveWithMetadata, resolveWithMetadata, retired, retiredSkipCache, retireLayer, reverseLookup, setMapping, toString, updateMetadataAndVersion, wrap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScopedDirectoryLayer

@Deprecated
@API(DEPRECATED)
public ScopedDirectoryLayer(@Nonnull
                            FDBRecordContext context,
                            @Nonnull
                            KeySpacePath path)

Deprecated.

use ScopedDirectoryLayer(FDBDatabase, ResolvedKeySpacePath) instead

Creates a scoped directory layer.

Parameters:

context - a context that is used only during the construction of this scope in order to resolve the provided path into a subspace

path - the path at which the directory layer should live

ScopedDirectoryLayer

public ScopedDirectoryLayer(@Nonnull
                            FDBDatabase database,
                            @Nonnull
                            ResolvedKeySpacePath path)

Create a scoped directory layer.

Parameters:

database - database that will be used when resolving values

path - the path at which the directory layer should store its mappings.

Method Detail

global

public static ScopedDirectoryLayer global(@Nonnull
                                          FDBDatabase database)

Creates a default instance of the scoped directory layer. This is a LocatableResolver that is backed by the default instance of the FDB directory layer.

Parameters:

database - the FDBDatabase for this resolver

Returns:

the global ScopedDirectoryLayer for this database

create

protected CompletableFuture<ResolverResult> create(@Nonnull
                                                   FDBRecordContext context,
                                                   @Nonnull
                                                   String key,
                                                   @Nullable
                                                   byte[] metadata)

Specified by:

create in class LocatableResolver

read

protected CompletableFuture<Optional<ResolverResult>> read(@Nonnull
                                                           FDBRecordContext context,
                                                           String key)

Specified by:

read in class LocatableResolver

readReverse

protected CompletableFuture<Optional<String>> readReverse(FDBStoreTimer timer,
                                                          Long value)

Specified by:

readReverse in class LocatableResolver

setMapping

public CompletableFuture<Void> setMapping(FDBRecordContext context,
                                          String key,
                                          ResolverResult value)

Specified by:

setMapping in class LocatableResolver

updateMetadata

public CompletableFuture<Void> updateMetadata(FDBRecordContext context,
                                              String key,
                                              byte[] metadata)

Specified by:

updateMetadata in class LocatableResolver

setWindow

public CompletableFuture<Void> setWindow(long count)

Specified by:

setWindow in class LocatableResolver

getMappingSubspaceAsync

@Nonnull
public CompletableFuture<Subspace> getMappingSubspaceAsync()

Description copied from class: LocatableResolver

Get a CompletableFuture that will contain the Subspace where this resolver stores the mappings from key Strings to value Long. Direct access to this subspace is not needed by general users and extreme care should be taken when interacting with it.

Specified by:

getMappingSubspaceAsync in class LocatableResolver

Returns:

a future that, when ready, will hold the mapping subspace

getStateSubspaceAsync

protected CompletableFuture<Subspace> getStateSubspaceAsync()

Specified by:

getStateSubspaceAsync in class LocatableResolver

deserializeValue

@Nonnull
public ResolverResult deserializeValue(byte[] value)

Description copied from class: LocatableResolver

Deserialize the raw bytes value stored in the mapping subspace.

Specified by:

deserializeValue in class LocatableResolver

Parameters:

value - raw value bytes.

Returns:

the deserialized ResolverResult.

getBaseSubspaceAsync

@Nonnull
public CompletableFuture<Subspace> getBaseSubspaceAsync()

Description copied from class: LocatableResolver

Get a CompletableFuture that will contain the Subspace this resolver is rooted at (e.g. the global resolver ExtendedDirectoryLayer.global(FDBDatabase) has a base subspace at the root of the FDB keyspace. Note that this is not the subspace where the resolver maintains its allocation keys (see LocatableResolver.getMappingSubspaceAsync()).

Specified by:

getBaseSubspaceAsync in class LocatableResolver

Returns:

a future that, when ready, will hold the base subspace

getNodeSubspace

public CompletableFuture<Subspace> getNodeSubspace(FDBRecordContext context)

getContentSubspace

public Subspace getContentSubspace()