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

Class FDBRecordStore.Builder

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.FDBRecordStore.Builder

All Implemented Interfaces:

FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Enclosing class:

FDBRecordStore

@API(STABLE)
public static class FDBRecordStore.Builder
extends Object
implements FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

A builder for FDBRecordStore. Methods for getting a record store from the builder:

• FDBRecordStoreBase.BaseBuilder.createOrOpen(): open an existing record store or create it the first time.
• FDBRecordStoreBase.BaseBuilder.open(): open an existing record store or throw an exception if it has never been created.
• FDBRecordStoreBase.BaseBuilder.create(): create a record store or throw an exception if it has already been created.
• build(): return a record store without checking its state in the database. One should almost always call FDBRecordStore.checkVersion(com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.UserVersionChecker, com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.StoreExistenceCheck) before actually using the record store.

 FDBRecordStore.newBuilder().setMetaDataProvider(md).setContext(ctx).setSubspace(s).createOrOpen()
 

Field Summary

Fields

Modifier and Type	Field	Description
protected SubspaceProvider	subspaceProvider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(FDBRecordStore store)
protected	Builder(FDBRecordStore.Builder other)

Method Summary

Modifier and Type	Method	Description
FDBRecordStore	build()	Build the record store.
FDBRecordStore.Builder	copyBuilder()	Make a copy of this builder.
void	copyFrom(FDBRecordStore store)	Copy state from a record store.
void	copyFrom(FDBRecordStore.Builder other)	Copy state from another store builder.
CompletableFuture<FDBRecordStore>	createOrOpenAsync(FDBRecordStoreBase.StoreExistenceCheck existenceCheck)	Opens a FDBRecordStore instance in the given path with the given meta-data.
FDBRecordContext	getContext()	Get the record context (transaction) to use for the record store.
int	getFormatVersion()	Get the storage format version for this store.
IndexMaintainerRegistry	getIndexMaintainerRegistry()	Get the registry of index maintainers to be used by the record store.
IndexMaintenanceFilter	getIndexMaintenanceFilter()	Get the index filter to be used by the record store.
RecordMetaDataProvider	getMetaDataProvider()	Get the provider for the record store's meta-data.
FDBMetaDataStore	getMetaDataStore()	Get the FDBMetaDataStore to use as the source of meta-data.
FDBRecordStoreBase.PipelineSizer	getPipelineSizer()	Get the object to be used to determine the depth of pipelines run by the record store.
RecordSerializer<Message>	getSerializer()	Get the serializer used to convert records into byte arrays.
FDBRecordStoreStateCache	getStoreStateCache()	Get the store state cache to be used by the record store.
SubspaceProvider	getSubspaceProvider()	Get the subspace provider.
FDBRecordStoreBase.UserVersionChecker	getUserVersionChecker()	Get the function to be used to check the meta-data version of the record store.
FDBRecordStore.Builder	setContext(FDBRecordContext context)	Set the record context (transaction) to use for the record store.
FDBRecordStore.Builder	setFormatVersion(int formatVersion)	Set the storage format version for this store.
FDBRecordStore.Builder	setIndexMaintainerRegistry(IndexMaintainerRegistry indexMaintainerRegistry)	Set the registry of index maintainers to be used by the record store.
FDBRecordStore.Builder	setIndexMaintenanceFilter(IndexMaintenanceFilter indexMaintenanceFilter)	Set the index filter to be used by the record store.
FDBRecordStore.Builder	setKeySpacePath(KeySpacePath keySpacePath)	Sets the KeySpacePath location of the FDBRecordStore.
FDBRecordStore.Builder	setMetaDataProvider(RecordMetaDataProvider metaDataProvider)	Set the provider for the record store's meta-data.
FDBRecordStore.Builder	setMetaDataStore(FDBMetaDataStore metaDataStore)	Set the FDBMetaDataStore to use as the source of meta-data.
FDBRecordStore.Builder	setPipelineSizer(FDBRecordStoreBase.PipelineSizer pipelineSizer)	Set the object to be used to determine the depth of pipelines run by the record store.
FDBRecordStore.Builder	setSerializer(RecordSerializer<Message> serializer)	Set the serializer used to convert records into byte arrays.
FDBRecordStore.Builder	setStoreStateCache(FDBRecordStoreStateCache storeStateCache)	Set the store state cache to be used by the record store.
FDBRecordStore.Builder	setSubspace(Subspace subspace)	Set the subspace to use for the record store.
FDBRecordStore.Builder	setSubspaceProvider(SubspaceProvider subspaceProvider)	Set the subspace provider from a subspace provider.
FDBRecordStore.Builder	setUserVersionChecker(FDBRecordStoreBase.UserVersionChecker userVersionChecker)	Set the function to be used to check the meta-data version of the record store.
CompletableFuture<FDBRecordStore>	uncheckedOpenAsync()	Opens a FDBRecordStore instance without calling FDBRecordStore.checkVersion(com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.UserVersionChecker, com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.StoreExistenceCheck).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.BaseBuilder

create, createAsync, createOrOpen, createOrOpen, createOrOpenAsync, open, openAsync, uncheckedOpen

Field Detail

subspaceProvider

@Nullable
protected SubspaceProvider subspaceProvider

Constructor Detail

Builder

protected Builder()

Builder

protected Builder(FDBRecordStore.Builder other)

Builder

protected Builder(FDBRecordStore store)

Method Detail

copyFrom

public void copyFrom(@Nonnull
                     FDBRecordStore.Builder other)

Copy state from another store builder.

Parameters:

other - the record store builder whose state to take

copyFrom

public void copyFrom(@Nonnull
                     FDBRecordStore store)

Copy state from a record store.

Parameters:

store - the record store whose state to take

getSerializer

@Nullable
public RecordSerializer<Message> getSerializer()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the serializer used to convert records into byte arrays.

Specified by:

getSerializer in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the serializer to use

setSerializer

@Nonnull
public FDBRecordStore.Builder setSerializer(@Nonnull
                                            RecordSerializer<Message> serializer)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the serializer used to convert records into byte arrays.

Specified by:

setSerializer in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

serializer - the serializer to use

Returns:

this builder

getFormatVersion

public int getFormatVersion()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the storage format version for this store.

Specified by:

getFormatVersion in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the format version to use

setFormatVersion

@Nonnull
public FDBRecordStore.Builder setFormatVersion(int formatVersion)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the storage format version for this store. Normally, this should be set to the highest format version supported by all code that may access the record store. FDBRecordStoreBase.BaseBuilder.open() will set the store's format version to max(max_supported_version, current_version). This is to support cases where the target cannot be changed everywhere at once and some instances write the new version before others know that they are licensed to do so. It is still critically important that all instances know how to handle the new version before any instance allows it. When installing a new version of the record layer library that includes a format change, first install everywhere having arranged for FDBRecordStoreBase.BaseBuilder.setFormatVersion(int) to be called with the old format version. Then, after that install is complete, change to the newer version.

Specified by:

setFormatVersion in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

formatVersion - the format version to use

Returns:

this builder

getMetaDataProvider

@Nullable
public RecordMetaDataProvider getMetaDataProvider()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the provider for the record store's meta-data.

Specified by:

getMetaDataProvider in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the meta-data source to use

setMetaDataProvider

@Nonnull
public FDBRecordStore.Builder setMetaDataProvider(@Nullable
                                                  RecordMetaDataProvider metaDataProvider)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the provider for the record store's meta-data. If FDBRecordStoreBase.BaseBuilder.setMetaDataStore(com.apple.foundationdb.record.provider.foundationdb.FDBMetaDataStore) is also called, the provider will only be used to initialize the meta-data store when it is empty. The record store will be built using the store as its provider.

Specified by:

setMetaDataProvider in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

metaDataProvider - the meta-data source to use

Returns:

this builder

getMetaDataStore

@Nullable
public FDBMetaDataStore getMetaDataStore()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the FDBMetaDataStore to use as the source of meta-data.

Specified by:

getMetaDataStore in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the meta-data store to use

setMetaDataStore

@Nonnull
public FDBRecordStore.Builder setMetaDataStore(@Nullable
                                               FDBMetaDataStore metaDataStore)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the FDBMetaDataStore to use as the source of meta-data. If FDBRecordStoreBase.BaseBuilder.setMetaDataProvider(com.apple.foundationdb.record.RecordMetaDataProvider) is also called, it will be used to seed the store.

Specified by:

setMetaDataStore in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

metaDataStore - the meta-data store to use

Returns:

this builder

getContext

@Nullable
public FDBRecordContext getContext()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the record context (transaction) to use for the record store.

Specified by:

getContext in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

context the record context / transaction to use

setContext

@Nonnull
public FDBRecordStore.Builder setContext(@Nullable
                                         FDBRecordContext context)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the record context (transaction) to use for the record store.

Specified by:

setContext in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

context - the record context / transaction to use

Returns:

this builder

getSubspaceProvider

@Nullable
public SubspaceProvider getSubspaceProvider()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the subspace provider.

Specified by:

getSubspaceProvider in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the subspace provider

setSubspaceProvider

@Nonnull
public FDBRecordStore.Builder setSubspaceProvider(@Nullable
                                                  SubspaceProvider subspaceProvider)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the subspace provider from a subspace provider.

Specified by:

setSubspaceProvider in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

subspaceProvider - the subspace provider

Returns:

this builder

setSubspace

@Nonnull
@API(UNSTABLE)
public FDBRecordStore.Builder setSubspace(@Nullable
                                          Subspace subspace)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the subspace to use for the record store. The record store is allowed to use the entire subspace, so it should not overlap any other record store's subspace. It is preferred to FDBRecordStoreBase.BaseBuilder.setKeySpacePath(com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpacePath) rather than this because key space path provides more meaningful logs.

Specified by:

setSubspace in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

subspace - the subspace to use

Returns:

this builder

setKeySpacePath

@Nonnull
public FDBRecordStore.Builder setKeySpacePath(@Nullable
                                              KeySpacePath keySpacePath)

Sets the KeySpacePath location of the FDBRecordStore.

Specified by:

setKeySpacePath in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

keySpacePath - the key space path to use

Returns:

this builder

getUserVersionChecker

@Nullable
public FDBRecordStoreBase.UserVersionChecker getUserVersionChecker()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the function to be used to check the meta-data version of the record store.

Specified by:

getUserVersionChecker in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the checker function to use

setUserVersionChecker

@Nonnull
public FDBRecordStore.Builder setUserVersionChecker(@Nullable
                                                    FDBRecordStoreBase.UserVersionChecker userVersionChecker)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the function to be used to check the meta-data version of the record store.

Specified by:

setUserVersionChecker in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

userVersionChecker - the checker function to use

Returns:

this builder

getIndexMaintainerRegistry

@Nonnull
public IndexMaintainerRegistry getIndexMaintainerRegistry()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the registry of index maintainers to be used by the record store.

Specified by:

getIndexMaintainerRegistry in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the index registry to use

setIndexMaintainerRegistry

@Nonnull
public FDBRecordStore.Builder setIndexMaintainerRegistry(@Nonnull
                                                         IndexMaintainerRegistry indexMaintainerRegistry)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the registry of index maintainers to be used by the record store.

Specified by:

setIndexMaintainerRegistry in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

indexMaintainerRegistry - the index registry to use

Returns:

this builder

See Also:

FDBRecordStore.getIndexMaintainer(com.apple.foundationdb.record.metadata.Index), RecordMetaDataBuilder.setIndexMaintainerRegistry(com.apple.foundationdb.record.provider.foundationdb.IndexMaintainerRegistry)

getIndexMaintenanceFilter

@Nonnull
public IndexMaintenanceFilter getIndexMaintenanceFilter()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the index filter to be used by the record store.

Specified by:

getIndexMaintenanceFilter in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the index filter to use

setIndexMaintenanceFilter

@Nonnull
public FDBRecordStore.Builder setIndexMaintenanceFilter(@Nonnull
                                                        IndexMaintenanceFilter indexMaintenanceFilter)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the index filter to be used by the record store.

Specified by:

setIndexMaintenanceFilter in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

indexMaintenanceFilter - the index filter to use

Returns:

this builder

getPipelineSizer

@Nonnull
public FDBRecordStoreBase.PipelineSizer getPipelineSizer()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the object to be used to determine the depth of pipelines run by the record store.

Specified by:

getPipelineSizer in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the sizer to use

setPipelineSizer

@Nonnull
public FDBRecordStore.Builder setPipelineSizer(@Nonnull
                                               FDBRecordStoreBase.PipelineSizer pipelineSizer)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the object to be used to determine the depth of pipelines run by the record store.

Specified by:

setPipelineSizer in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

pipelineSizer - the sizer to use

Returns:

this builder

See Also:

FDBRecordStoreBase.getPipelineSize(com.apple.foundationdb.record.PipelineOperation)

getStoreStateCache

@Nullable
public FDBRecordStoreStateCache getStoreStateCache()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Get the store state cache to be used by the record store. If the builder returns null, the produced record store will use the default store state cache provided by the FDBDatabase when initializing the record store state.

Specified by:

getStoreStateCache in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

the store state cached used by this record store of null if it uses the database default

setStoreStateCache

@Nonnull
public FDBRecordStore.Builder setStoreStateCache(@Nullable
                                                 FDBRecordStoreStateCache storeStateCache)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Set the store state cache to be used by the record store. If null is provided or if this method is never called, the produced record store will use the default store state cache provided by the FDBDatabase.

Specified by:

setStoreStateCache in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

storeStateCache - the store state cache to used by this record store or null to specify that this should use the database default

Returns:

this builder

copyBuilder

@Nonnull
public FDBRecordStore.Builder copyBuilder()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Make a copy of this builder. This can be used to share enough of the state to connect to the same record store several times in different transactions.

     builder = FDBRecordStore.newBuilder().setMetaDataProvider(metadata).setSubspace(subspace)
     store1 = builder.copyBuilder().setContext(context1).build()
     store2 = builder.copyBuilder().setContext(context2).build()
 

Specified by:

copyBuilder in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

a new builder with the same state as this builder

build

@Nonnull
public FDBRecordStore build()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Build the record store.

Specified by:

build in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

a new record store with the desired state.

uncheckedOpenAsync

@Nonnull
public CompletableFuture<FDBRecordStore> uncheckedOpenAsync()

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Opens a FDBRecordStore instance without calling FDBRecordStore.checkVersion(com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.UserVersionChecker, com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase.StoreExistenceCheck).

Specified by:

uncheckedOpenAsync in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Returns:

a future that will contain a store with the appropriate parameters set when ready

createOrOpenAsync

@Nonnull
public CompletableFuture<FDBRecordStore> createOrOpenAsync(@Nonnull
                                                           FDBRecordStoreBase.StoreExistenceCheck existenceCheck)

Description copied from interface: FDBRecordStoreBase.BaseBuilder

Opens a FDBRecordStore instance in the given path with the given meta-data.

Specified by:

createOrOpenAsync in interface FDBRecordStoreBase.BaseBuilder<Message,FDBRecordStore>

Parameters:

existenceCheck - whether the store must already exist

Returns:

a future that will contain a store with the appropriate parameters set when ready