Package com.terracottatech.store.manager

Interface EmbeddedDatasetManagerBuilder

public interface EmbeddedDatasetManagerBuilder
An EmbeddedDatasetManagerBuilder allows configuration of the interaction with embedded storage.

  • Method Details

    • build

      DatasetManager build() throws StoreException
      Creates the DatasetManager that has been configured using this EmbeddedDatasetManagerBuilder
      Returns:
      a DatasetManager instance
      Throws:
      StoreException - if using a disk resource that fails or using multiple disk resources that contain duplicated Dataset names

    • offheap

      EmbeddedDatasetManagerBuilder offheap(String resourceName, long unitCount, MemoryUnit memoryUnit)
      Registers an amount of offheap memory
      Parameters:
      resourceName - the name that can later be used to refer to this memory
      unitCount - the number of memory units
      memoryUnit - the unit of memory
      Returns:
      a EmbeddedDatasetManagerBuilder to allow further configuration

    • disk

      EmbeddedDatasetManagerBuilder disk(String resourceName, Path dataRootDirectory, EmbeddedDatasetManagerBuilder.PersistenceMode persistenceMode, EmbeddedDatasetManagerBuilder.FileMode fileMode)
      Registers a location for local disk storage.

      NOTE: This API is deprecated and is here ONLY for backward compatibility purposes. Please use disk(String, Path, FileMode) instead.

      Parameters:
      resourceName - the name that can later be used to refer to this location
      dataRootDirectory - the location on local disk for storage
      persistenceMode - persistence mode used for this location
      fileMode - file open mode used for this location
      Returns:
      a EmbeddedDatasetManagerBuilder to allow further configuration

    • disk

      EmbeddedDatasetManagerBuilder disk(String resourceName, Path dataRootDirectory, EmbeddedDatasetManagerBuilder.FileMode fileMode)
      Registers a location for local disk storage.
      Parameters:
      resourceName - the name that can later be used to refer to this location
      dataRootDirectory - the location on local disk for storage
      fileMode - file open mode used for this location
      Returns:
      a EmbeddedDatasetManagerBuilder to allow further configuration