Package com.google.cloud.spanner.connection

Enum SavepointSupport

java.lang.Object
java.lang.Enum<SavepointSupport>
com.google.cloud.spanner.connection.SavepointSupport
All Implemented Interfaces:
Serializable, Comparable<SavepointSupport>
public enum SavepointSupport extends Enum<SavepointSupport>
Option value used for determining the behavior of savepoints.

  • Enum Constant Details

    • ENABLED

      public static final SavepointSupport ENABLED
      Savepoints are enabled and can be used on the connection. Rolling back to a savepoint will trigger a retry of the transaction up to the point where the savepoint was set.

    • FAIL_AFTER_ROLLBACK

      public static final SavepointSupport FAIL_AFTER_ROLLBACK
      Savepoints are enabled and can be used on the connection. Rolling back to a savepoint will not trigger a retry. Further attempts to use a read/write transaction after a rollback to savepoint will fail. This mode can be used for frameworks that require savepoint support, for example if the framework automatically creates a savepoint for a specific feature, but that do not need to support rolling back to a savepoint. This value should also be used for transactions that return non-deterministic data, for example auto-generated primary key values, as retries would always fail. This option will not affect rolling back to a savepoint in a read-only transaction, as those transactions do not require a retry after rolling back to a savepoint.

    • DISABLED

      public static final SavepointSupport DISABLED
      Savepoints are disabled. Any attempt to create a savepoint will fail.

  • Method Details

    • values

      public static SavepointSupport[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SavepointSupport valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • isSavepointCreationAllowed

      public boolean isSavepointCreationAllowed()
      Returns true if this mode allows the creation of savepoints.