Package com.terracottatech.store

Interface Dataset<K extends Comparable<K>>

Type Parameters:
K - key type
All Superinterfaces:
AutoCloseable
public interface Dataset<K extends Comparable<K>> extends AutoCloseable
Main access point in to a Terracotta Store dataset. A dataset consists of a collection of uniquely keyed records. Records are composed of a required key, and a set of uniquely named cells. Each cell holds a single value of that cells type.

Operations against a Dataset, and its subordinate objects, using a clustered configuration may throw a StoreOperationAbandonedException if a server reconnection occurs during the operation. It is up to the application to determine the proper recourse for retying or recovering the operation.

See Also:

  • Method Details

    • reader

      DatasetReader<K> reader()
      Provides read-only access on to this dataset.
      Returns:
      a dataset reader

    • writerReader

      DatasetWriterReader<K> writerReader()
      Provides read-write access on to this dataset.
      Returns:
      a dataset writer reader

    • getIndexing

      Indexing getIndexing()
      Exposes the indexing instance used to create, alter and delete indexes for this dataset.
      Returns:
      the indexing instance used to manipulate indexes

    • getResourceUsageMetrics

      ResourceUsageMetrics getResourceUsageMetrics()

    • close

      void close()
      Closes the Dataset. Calls to Dataset accessor methods following a call to this method are likely to be aborted with a StoreRuntimeException. Note: the possibility of operations on associated streams after calling this method is implementation dependent.
      Specified by:
      close in interface AutoCloseable