Package com.apple.foundationdb

## Class TransactionOptions

- java.lang.Object
- - com.apple.foundationdb.TransactionOptions

    public class TransactionOptions
    extends java.lang.Object

A set of options that can be set on a `Transaction`.

### Constructor Summary

Constructors
`TransactionOptions​(OptionConsumer consumer)`

### Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
`OptionConsumer` `getOptionConsumer()` Returns the object on which these options are being set.
`void` `setAccessSystemKeys()` Allows this transaction to read and modify system keys (those that start with the byte 0xFF).
`void` `setAutoThrottleTag​(java.lang.String value)` Adds a tag to the transaction that can be used to apply manual or automatic targeted throttling.
`void` `setBypassUnreadable()` Allows `get` operations to read from sections of keyspace that have become unreadable because of versionstamp operations.
`void` `setCausalReadDisable()`
`void` `setCausalReadRisky()` The read version will be committed, and usually will be the latest committed, but might not be the latest committed in the event of a simultaneous fault and misbehaving clock.
`void` `setCausalWriteRisky()` The transaction, if not self-conflicting, may be committed a second time after commit succeeds, in the event of a fault.
`void` `setDebugRetryLogging​(java.lang.String value)`
`void` `setDebugTransactionIdentifier​(java.lang.String value)` Sets a client provided identifier for the transaction that will be used in scenarios like tracing or profiling.
`void` `setDurabilityDatacenter()`
`void` `setDurabilityDevNullIsWebScale()` Deprecated.
`void` `setDurabilityRisky()`
`void` `setExpensiveClearCostEstimationEnable()` Asks storage servers for how many bytes a clear key range contains.
`void` `setIncludePortInAddress()` Addresses returned by get_addresses_for_key include the port when enabled.
`void` `setInitializeNewDatabase()` This is a write-only transaction which sets the initial configuration.
`void` `setLockAware()` The transaction can read and write to locked databases, and is responsible for checking that it took the lock.
`void` `setLogTransaction()` Enables tracing for this transaction and logs results to the client trace logs.
`void` `setMaxRetryDelay​(long value)` Set the maximum amount of backoff delay incurred in the call to `onError` if the error is retryable.
`void` `setNextWriteNoWriteConflictRange()` The next write performed on this transaction will not generate a write conflict range.
`void` `setPriorityBatch()` Specifies that this transaction should be treated as low priority and that default priority transactions will be processed first.
`void` `setPrioritySystemImmediate()` Specifies that this transaction should be treated as highest priority and that lower priority transactions should block behind this one.
`void` `setRawAccess()` Allows this transaction to access the raw key-space when tenant mode is on.
`void` `setReadAheadDisable()` Deprecated.
`void` `setReadLockAware()` The transaction can read from locked databases.
`void` `setReadSystemKeys()` Allows this transaction to read system keys (those that start with the byte 0xFF).
`void` `setReadYourWritesDisable()` Reads performed by a transaction will not see any prior mutations that occured in that transaction, instead seeing the value which was in the database at the transaction's read version.
`void` `setReportConflictingKeys()` The transaction can retrieve keys that are conflicting with other transactions.
`void` `setRetryLimit​(long value)` Set a maximum number of retries after which additional calls to `onError` will throw the most recently seen error code.
`void` `setServerRequestTracing()` Sets an identifier for server tracing of this transaction.
`void` `setSizeLimit​(long value)` Set the transaction size limit in bytes.
`void` `setSnapshotRywDisable()` Snapshot read operations will not see the results of writes done in the same transaction.
`void` `setSnapshotRywEnable()` Snapshot read operations will see the results of writes done in the same transaction.
`void` `setSpanParent​(byte[] value)` Adds a parent to the Span of this transaction.
`void` `setSpecialKeySpaceEnableWrites()` By default, users are not allowed to write to special keys.
`void` `setSpecialKeySpaceRelaxed()` By default, the special key space will only allow users to read from exactly one module (a subspace in the special key space).
`void` `setTag​(java.lang.String value)` Adds a tag to the transaction that can be used to apply manual targeted throttling.
`void` `setTimeout​(long value)` Set a timeout in milliseconds which, when elapsed, will cause the transaction automatically to be cancelled.
`void` `setTransactionLoggingEnable​(java.lang.String value)` Deprecated.
`void` `setTransactionLoggingMaxFieldLength​(long value)` Sets the maximum escaped length of key and value fields to be logged to the trace file via the LOG_TRANSACTION option, after which the field will be truncated.
`void` `setUsedDuringCommitProtectionDisable()` By default, operations that are performed on a transaction while it is being committed will not only fail themselves, but they will attempt to fail other in-flight operations (such as the commit) as well.
`void` `setUseGrvCache()` Allows this transaction to use cached GRV from the database context.
`void` `setUseProvisionalProxies()` This option should only be used by tools which change the database configuration.

### Methods inherited from class java.lang.Object

`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

### Constructor Detail

#### TransactionOptions

    public TransactionOptions​(OptionConsumer consumer)

### Method Detail

#### setCausalWriteRisky

    public void setCausalWriteRisky()

The transaction, if not self-conflicting, may be committed a second time after commit succeeds, in the event of a fault.

#### setCausalReadRisky

    public void setCausalReadRisky()

The read version will be committed, and usually will be the latest committed, but might not be the latest committed in the event of a simultaneous fault and misbehaving clock.

#### setIncludePortInAddress

    public void setIncludePortInAddress()

Addresses returned by get_addresses_for_key include the port when enabled. As of api version 630, this option is enabled by default and setting this has no effect.

#### setNextWriteNoWriteConflictRange

    public void setNextWriteNoWriteConflictRange()

The next write performed on this transaction will not generate a write conflict range. As a result, other transactions which read the key(s) being modified by the next write will not conflict with this transaction. Care needs to be taken when using this option on a transaction that is shared between multiple threads. When setting this option, write conflict ranges will be disabled on the next write operation, regardless of what thread it is on.

#### setReadYourWritesDisable

    public void setReadYourWritesDisable()

Reads performed by a transaction will not see any prior mutations that occured in that transaction, instead seeing the value which was in the database at the transaction's read version. This option may provide a small performance benefit for the client, but also disables a number of client-side optimizations which are beneficial for transactions which tend to read and write the same keys within a single transaction. It is an error to set this option after performing any reads or writes on the transaction.

#### setReadAheadDisable

    @Deprecated
    public void setReadAheadDisable()

Deprecated.
Deprecated.

#### setDurabilityDevNullIsWebScale

    @Deprecated
    public void setDurabilityDevNullIsWebScale()

Deprecated.
Deprecated.

#### setPrioritySystemImmediate

    public void setPrioritySystemImmediate()

Specifies that this transaction should be treated as highest priority and that lower priority transactions should block behind this one. Use is discouraged outside of low-level tools.

#### setPriorityBatch

    public void setPriorityBatch()

Specifies that this transaction should be treated as low priority and that default priority transactions will be processed first. Batch priority transactions will also be throttled at load levels smaller than for other types of transactions and may be fully cut off in the event of machine failures. Useful for doing batch work simultaneously with latency-sensitive work.

#### setInitializeNewDatabase

    public void setInitializeNewDatabase()

This is a write-only transaction which sets the initial configuration. This option is designed for use by database system tools only.

#### setAccessSystemKeys

    public void setAccessSystemKeys()

Allows this transaction to read and modify system keys (those that start with the byte 0xFF). Implies raw_access.

#### setReadSystemKeys

    public void setReadSystemKeys()

Allows this transaction to read system keys (those that start with the byte 0xFF). Implies raw_access.

#### setRawAccess

    public void setRawAccess()

Allows this transaction to access the raw key-space when tenant mode is on.

#### setTransactionLoggingEnable

    @Deprecated
    public void setTransactionLoggingEnable​(java.lang.String value)

Deprecated.
Deprecated.

Parameters:
  `value` - String identifier to be used in the logs when tracing this transaction. The identifier must not exceed 100 characters.

#### setDebugTransactionIdentifier

    public void setDebugTransactionIdentifier​(java.lang.String value)

Sets a client provided identifier for the transaction that will be used in scenarios like tracing or profiling. Client trace logging or transaction profiling must be separately enabled.

Parameters:
  `value` - String identifier to be used when tracing or profiling this transaction. The identifier must not exceed 100 characters.

#### setLogTransaction

    public void setLogTransaction()

Enables tracing for this transaction and logs results to the client trace logs. The DEBUG_TRANSACTION_IDENTIFIER option must be set before using this option, and client trace logging must be enabled to get log output.

#### setTransactionLoggingMaxFieldLength

    public void setTransactionLoggingMaxFieldLength​(long value)

Sets the maximum escaped length of key and value fields to be logged to the trace file via the LOG_TRANSACTION option, after which the field will be truncated. A negative value disables truncation.

Parameters:
  `value` - Maximum length of escaped key and value fields.

#### setServerRequestTracing

    public void setServerRequestTracing()

Sets an identifier for server tracing of this transaction. When committed, this identifier triggers logging when each part of the transaction authority encounters it, which is helpful in diagnosing slowness in misbehaving clusters. The identifier is randomly generated. When there is also a debug_transaction_identifier, both IDs are logged together.

#### setTimeout

    public void setTimeout​(long value)

Set a timeout in milliseconds which, when elapsed, will cause the transaction automatically to be cancelled. Valid parameter values are `[0, INT_MAX]`. If set to 0, will disable all timeouts. All pending and any future uses of the transaction will throw an exception. The transaction can be used again after it is reset. Prior to API version 610, like all other transaction options, the timeout must be reset after a call to `onError`. If the API version is 610 or greater, the timeout is not reset after an `onError` call. This allows the user to specify a longer timeout on specific transactions than the default timeout specified through the `transaction_timeout` database option without the shorter database timeout cancelling transactions that encounter a retryable error. Note that at all API versions, it is safe and legal to set the timeout each time the transaction begins, so most code written assuming the older behavior can be upgraded to the newer behavior without requiring any modification, and the caller is not required to implement special logic in retry loops to only conditionally set this option.

Parameters:
  `value` - value in milliseconds of timeout

#### setRetryLimit

    public void setRetryLimit​(long value)

Set a maximum number of retries after which additional calls to `onError` will throw the most recently seen error code. Valid parameter values are `[-1, INT_MAX]`. If set to -1, will disable the retry limit. Prior to API version 610, like all other transaction options, the retry limit must be reset after a call to `onError`. If the API version is 610 or greater, the retry limit is not reset after an `onError` call. Note that at all API versions, it is safe and legal to set the retry limit each time the transaction begins, so most code written assuming the older behavior can be upgraded to the newer behavior without requiring any modification, and the caller is not required to implement special logic in retry loops to only conditionally set this option.

Parameters:
  `value` - number of times to retry

#### setMaxRetryDelay

    public void setMaxRetryDelay​(long value)

Set the maximum amount of backoff delay incurred in the call to `onError` if the error is retryable. Defaults to 1000 ms. Valid parameter values are `[0, INT_MAX]`. If the maximum retry delay is less than the current retry delay of the transaction, then the current retry delay will be clamped to the maximum retry delay. Prior to API version 610, like all other transaction options, the maximum retry delay must be reset after a call to `onError`. If the API version is 610 or greater, the retry limit is not reset after an `onError` call. Note that at all API versions, it is safe and legal to set the maximum retry delay each time the transaction begins, so most code written assuming the older behavior can be upgraded to the newer behavior without requiring any modification, and the caller is not required to implement special logic in retry loops to only conditionally set this option.

Parameters:
  `value` - value in milliseconds of maximum delay

#### setSizeLimit

    public void setSizeLimit​(long value)

Set the transaction size limit in bytes. The size is calculated by combining the sizes of all keys and values written or mutated, all key ranges cleared, and all read and write conflict ranges. (In other words, it includes the total size of all data included in the request to the cluster to commit the transaction.) Large transactions can cause performance problems on FoundationDB clusters, so setting this limit to a smaller value than the default can help prevent the client from accidentally degrading the cluster's performance. This value must be at least 32 and cannot be set to higher than 10,000,000, the default transaction size limit.

Parameters:
  `value` - value in bytes

#### setSnapshotRywEnable

    public void setSnapshotRywEnable()

Snapshot read operations will see the results of writes done in the same transaction. This is the default behavior.

#### setSnapshotRywDisable

    public void setSnapshotRywDisable()

Snapshot read operations will not see the results of writes done in the same transaction. This was the default behavior prior to API version 300.

#### setLockAware

    public void setLockAware()

The transaction can read and write to locked databases, and is responsible for checking that it took the lock.

#### setUsedDuringCommitProtectionDisable

    public void setUsedDuringCommitProtectionDisable()

By default, operations that are performed on a transaction while it is being committed will not only fail themselves, but they will attempt to fail other in-flight operations (such as the commit) as well. This behavior is intended to help developers discover situations where operations could be unintentionally executed after the transaction has been reset. Setting this option removes that protection, causing only the offending operation to fail.

#### setReadLockAware

    public void setReadLockAware()

The transaction can read from locked databases.

#### setUseProvisionalProxies

    public void setUseProvisionalProxies()

This option should only be used by tools which change the database configuration.

#### setReportConflictingKeys

    public void setReportConflictingKeys()

The transaction can retrieve keys that are conflicting with other transactions.

#### setSpecialKeySpaceRelaxed

    public void setSpecialKeySpaceRelaxed()

By default, the special key space will only allow users to read from exactly one module (a subspace in the special key space). Use this option to allow reading from zero or more modules. Users who set this option should be prepared for new modules, which may have different behaviors than the modules they're currently reading. For example, a new module might block or return an error.

#### setSpecialKeySpaceEnableWrites

    public void setSpecialKeySpaceEnableWrites()

By default, users are not allowed to write to special keys. Enable this option will implicitly enable all options required to achieve the configuration change.

#### setTag

    public void setTag​(java.lang.String value)

Adds a tag to the transaction that can be used to apply manual targeted throttling. At most 5 tags can be set on a transaction.

Parameters:
  `value` - String identifier used to associated this transaction with a throttling group. Must not exceed 16 characters.

#### setAutoThrottleTag

    public void setAutoThrottleTag​(java.lang.String value)

Adds a tag to the transaction that can be used to apply manual or automatic targeted throttling. At most 5 tags can be set on a transaction.

Parameters:
  `value` - String identifier used to associated this transaction with a throttling group. Must not exceed 16 characters.

#### setSpanParent

    public void setSpanParent​(byte[] value)

Adds a parent to the Span of this transaction. Used for transaction tracing. A span can be identified with any 16 bytes.

Parameters:
  `value` - A byte string of length 16 used to associate the span of this transaction with a parent

#### setExpensiveClearCostEstimationEnable

    public void setExpensiveClearCostEstimationEnable()

Asks storage servers for how many bytes a clear key range contains. Otherwise uses the location cache to roughly estimate this.

#### setBypassUnreadable

    public void setBypassUnreadable()

Allows `get` operations to read from sections of keyspace that have become unreadable because of versionstamp operations. These reads will view versionstamp operations as if they were set operations that did not fill in the versionstamp.

#### setUseGrvCache

    public void setUseGrvCache()

Allows this transaction to use cached GRV from the database context. Defaults to off. Upon first usage, starts a background updater to periodically update the cache to avoid stale read versions.

#### setCausalReadDisable

    public void setCausalReadDisable()

#### setDurabilityDatacenter

    public void setDurabilityDatacenter()

#### setDurabilityRisky

    public void setDurabilityRisky()

#### setDebugRetryLogging

    public void setDebugRetryLogging​(java.lang.String value)

#### getOptionConsumer

    public OptionConsumer getOptionConsumer()

Returns the object on which these options are being set. Rarely used by client code, since all options should be top-level methods on extending classes.

Returns:
  target of option set calls