Package com.terracottatech.store.configuration

Interface DatasetConfigurationBuilder

All Known Subinterfaces:
AdvancedDatasetConfigurationBuilder
public interface DatasetConfigurationBuilder

  • Method Details

    • build

      DatasetConfiguration build()
      Creates the DatasetConfiguration as defined by the builder state
      Returns:
      a DatasetConfiguration

    • offheap

      DatasetConfigurationBuilder offheap(String resourceName)
      Set the name of the resource to use for offheap storage
      Parameters:
      resourceName - the name of the resource to use
      Returns:
      a DatasetConfigurationBuilder to continue with configuration

    • disk

      DatasetConfigurationBuilder disk(String resourceName)
      Set the name of the resource to use for disk storage and use/deploy the persistent storage engine configured as system wide default.
      Parameters:
      resourceName - the name of the resource to use
      Returns:
      a DatasetConfigurationBuilder to continue with configuration

    • disk

      DatasetConfigurationBuilder disk(String resourceName, PersistentStorageType storageType)
      Set the name of the resource to use for disk storage and use/deploy the specified persistent storage engine type.
      Parameters:
      resourceName - the name of the disk resource to use
      storageType - the type of persistent storage engine to deploy/use
      Returns:
      a DatasetConfigurationBuilder to continue with configuration

    • index

      DatasetConfigurationBuilder index(CellDefinition<?> cellDefinition, IndexSettings settings)
      Configure indexing for given cell.
      Parameters:
      cellDefinition - cell to index
      settings - index settings
      Returns:
      a DatasetConfigurationBuilder to continue with configuration

    • durabilityEventual

      DatasetConfigurationBuilder durabilityEventual()
      Configure this dataset to leave durability flushing to the operating system. This is suitable in HA situations, where multiple servers will store the values. Note that this is a constraint, and the implementation is free to be more conservative.
      Returns:
      a DatasetConfigurationBuilder to continue with configuration

    • durabilityEveryMutation

      DatasetConfigurationBuilder durabilityEveryMutation()
      Configure this dataset to forceable push every mutative operation to disk. This is the safest approach, but has an obvious performance impact. Note that this is a constraint, and the implementation is free to be more conservative.
      Returns:
      a DatasetConfigurationBuilder to continue with configuration

    • durabilityTimed

      DatasetConfigurationBuilder durabilityTimed(long duration, TimeUnit units)
      Configure this dataset to allow a mutative change to linger unflushed to disk for no more than the specified duration. Note that this is a constraint, and the implementation is free to be more conservative.

      The duration provided is truncated to millisecond precision.

      Parameters:
      duration - the positive duration value
      units - the non-null duration units
      Returns:
      a DatasetConfigurationBuilder to continue with configuration
      Throws:
      IllegalArgumentException - if duration is zero or negative

    • advanced

      AdvancedDatasetConfigurationBuilder advanced()
      Access more advanced configuration options than are generally needed.