io.ebeanservice.docstore.api.DocStoreTransaction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

composite of common runtime dependencies for all platforms

There is a newer version: 15.8.1

package io.ebeanservice.docstore.api;

/**
 * A document store transaction.
 * 
 * This might just be a buffer to batch persist requests to the document store and may not
 * support transactional semantics (like rollback).
 */
public interface DocStoreTransaction {

  /**
   * Obtain a context to persist to (like a buffer).
   */
  DocStoreUpdateContext obtain();

  /**
   * Add changes that should be queued to the DocStoreUpdates.
   * 

   * This mostly means nested/embedded updates that need to be processed after the source
   * persist event has propagated.
   * 
   */
  DocStoreUpdates queue();

  /**
   * Flush all changes to the document store.
   */
  void flush();
}