com.apple.foundationdb.record.provider.foundationdb

Class FDBStoreBase

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.FDBStoreBase

Direct Known Subclasses:

FDBMetaDataStore, FDBRecordStore

@API(value=STABLE)
public abstract class FDBStoreBase
extends Object

Base class for record stores and meta-data stores, which have in common that they are opened by an FDBRecordContext and occupy some Subspace in the database.

Field Summary

Fields

Modifier and Type	Field and Description
protected FDBRecordContext	context
protected SubspaceProvider	subspaceProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FDBStoreBase(FDBRecordContext context, Subspace subspace)
protected	FDBStoreBase(FDBRecordContext context, SubspaceProvider subspaceProvider)

Method Summary

Modifier and Type	Method and Description
void	addConflictForSubspace(boolean write)
Transaction	ensureContextActive()
Executor	getExecutor()
FDBRecordContext	getRecordContext() Get the FDBRecordContext within which this store operates.
Subspace	getSubspace()
CompletableFuture<Subspace>	getSubspaceAsync()
SubspaceProvider	getSubspaceProvider()
FDBStoreTimer	getTimer()
void	increment(StoreTimer.Count count) Record that an event occurred one time.
void	increment(StoreTimer.Count count, int amount) Record that an event occurred one or more times.
<T> CompletableFuture<T>	instrument(Set<StoreTimer.Event> events, CompletableFuture<T> future)
<T> CompletableFuture<T>	instrument(StoreTimer.Event event, CompletableFuture<T> future)
<T> CompletableFuture<T>	instrument(StoreTimer.Event event, CompletableFuture<T> future, long startTime)
void	record(StoreTimer.Count count) Deprecated. use increment(StoreTimer.Count) instead
void	record(StoreTimer.Event event, long timeDelta) Record the amount of time an event took to run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

context

@Nonnull
protected final FDBRecordContext context

subspaceProvider

@Nonnull
protected final SubspaceProvider subspaceProvider

Constructor Detail

FDBStoreBase

@API(value=UNSTABLE)
protected FDBStoreBase(@Nonnull
                                            FDBRecordContext context,
                                            @Nonnull
                                            Subspace subspace)

FDBStoreBase

protected FDBStoreBase(@Nonnull
                       FDBRecordContext context,
                       @Nonnull
                       SubspaceProvider subspaceProvider)

Method Detail

getExecutor

@Nonnull
public Executor getExecutor()

getRecordContext

@Nonnull
public FDBRecordContext getRecordContext()

Get the FDBRecordContext within which this store operates.

Returns:

the associated context

ensureContextActive

@Nonnull
public Transaction ensureContextActive()

getSubspaceProvider

@Nonnull
public SubspaceProvider getSubspaceProvider()

getSubspaceAsync

@Nonnull
public CompletableFuture<Subspace> getSubspaceAsync()

getSubspace

@Nonnull
public Subspace getSubspace()

addConflictForSubspace

public void addConflictForSubspace(boolean write)

getTimer

@Nullable
public FDBStoreTimer getTimer()

instrument

public <T> CompletableFuture<T> instrument(StoreTimer.Event event,
                                           CompletableFuture<T> future)

instrument

public <T> CompletableFuture<T> instrument(Set<StoreTimer.Event> events,
                                           CompletableFuture<T> future)

instrument

public <T> CompletableFuture<T> instrument(StoreTimer.Event event,
                                           CompletableFuture<T> future,
                                           long startTime)

record

@Deprecated
public void record(@Nonnull
                               StoreTimer.Count count)

Deprecated. use increment(StoreTimer.Count) instead

Deprecated. Users should use increment(StoreTimer.Count) instead.

Parameters:

count - the event being recorded

record

public void record(@Nonnull
                   StoreTimer.Event event,
                   long timeDelta)

Record the amount of time an event took to run.

Parameters:

event - the event being recorded

timeDelta - the time the event took to complete

See Also:

StoreTimer.record()

increment

public void increment(@Nonnull
                      StoreTimer.Count count)

Record that an event occurred one time.

Parameters:

count - the event being recorded

See Also:

StoreTimer.increment()

increment

public void increment(@Nonnull
                      StoreTimer.Count count,
                      int amount)

Record that an event occurred one or more times.

Parameters:

count - the event being recorded

amount - the number of times the event occurred

See Also:

StoreTimer.increment()