ExecuteOptions (Oracle NoSQL Database API)

java.lang.Object
- oracle.kv.query.ExecuteOptions

```
public class ExecuteOptions
extends java.lang.Object
```
Class contains several options for the execution of an SQL statement (DDL or DML). SQL statements are executed via one of the KVStore.execute() methods.

Since:

4.0

See Also:

KVStore.execute(String, ExecuteOptions), KVStore.executeSync(String, ExecuteOptions), KVStore.executeSync(Statement, ExecuteOptions)

Constructor Summary

Constructors
Constructor Description

ExecuteOptions()

Constructors
Constructor	Description
`ExecuteOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Consistency`	`getConsistency()`	Gets the last set execution consistency.
`Durability`	`getDurability()`	Gets the last set execution durability.
`java.math.MathContext`	`getMathContext()`	Returns the `MathContext` used for `BigDecimal` and `BigInteger` operations.
`int`	`getMaxConcurrentRequests()`	Returns the maximum number of concurrent requests.
`long`	`getMaxMemoryConsumption()`	Get the maximum number of memory bytes that may be consumed by the statement at the client for blocking operations, such as duplicate elimination (which may be required due to the use of an index on an array or map) and sorting (sorting by distance when a query contains a geo_near() function).
`java.lang.String`	`getNamespace()`	Returns the namespace to use for the query, null if not set.
`int`	`getResultsBatchSize()`	Returns the number of results per request.
`long`	`getTimeout()`	Gets the timeout, which is an upper bound on the time interval for processing the read or write operations.
`java.util.concurrent.TimeUnit`	`getTimeoutUnit()`	Gets the unit of the timeout parameter, and may be `null` only if `getTimeout()` returns zero.
`ExecuteOptions`	`setConsistency(Consistency consistency)`	Sets the execution consistency.
`ExecuteOptions`	`setDurability(Durability durability)`	Sets the execution durability.
`ExecuteOptions`	`setMathContext(java.math.MathContext mathContext)`	Sets the `MathContext` used for `BigDecimal` and `BigInteger` operations.
`ExecuteOptions`	`setMaxConcurrentRequests(int maxConcurrentRequests)`	Sets the maximum number of concurrent requests.
`void`	`setMaxMemoryConsumption(long v)`	Set the maximum number of memory bytes that may be consumed by the statement at the client for blocking operations, such as duplicate elimination (which may be required due to the use of an index on an array or map) and sorting (sorting by distance when a query contains a geo_near() function).
`ExecuteOptions`	`setNamespace(java.lang.String namespace)`	Sets the namespace to use for the query.
`ExecuteOptions`	`setResultsBatchSize(int resultsBatchSize)`	Sets the number of results per request.
`ExecuteOptions`	`setTimeout(long timeout, java.util.concurrent.TimeUnit timeoutUnit)`	The `timeout` parameter is an upper bound on the time interval for processing the operation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExecuteOptions
```
public ExecuteOptions()
```
- Method Detail
  - setConsistency
```
public ExecuteOptions setConsistency(Consistency consistency)
```
    Sets the execution consistency.
  - getConsistency
```
public Consistency getConsistency()
```
    Gets the last set execution consistency.
  - setDurability
```
public ExecuteOptions setDurability(Durability durability)
```
    Sets the execution durability.
  - getDurability
```
public Durability getDurability()
```
    Gets the last set execution durability.
  - setTimeout
```
public ExecuteOptions setTimeout(long timeout,
                                 java.util.concurrent.TimeUnit timeoutUnit)
```
    The timeout parameter is an upper bound on the time interval for processing the operation. A best effort is made not to exceed the specified limit. If zero, the default request timeout is used.
    If timeout is not 0, the timeoutUnit parameter must not be null.
    
    Parameters:
    
    timeout - the timeout value to use
    
    timeoutUnit - the TimeUnit used by the timeout parameter or null
  - getTimeout
```
public long getTimeout()
```
    Gets the timeout, which is an upper bound on the time interval for processing the read or write operations. A best effort is made not to exceed the specified limit. If zero, the default request timeout is used.
    
    Returns:
    
    the timeout
  - getTimeoutUnit
```
public java.util.concurrent.TimeUnit getTimeoutUnit()
```
    Gets the unit of the timeout parameter, and may be null only if getTimeout() returns zero.
    
    Returns:
    
    the timeout unit or null
  - getMaxConcurrentRequests
```
public int getMaxConcurrentRequests()
```
    Returns the maximum number of concurrent requests.
  - setMaxConcurrentRequests
```
public ExecuteOptions setMaxConcurrentRequests(int maxConcurrentRequests)
```
    Sets the maximum number of concurrent requests.
  - getResultsBatchSize
```
public int getResultsBatchSize()
```
    Returns the number of results per request.
  - setResultsBatchSize
```
public ExecuteOptions setResultsBatchSize(int resultsBatchSize)
```
    Sets the number of results per request.
  - getMathContext
```
public java.math.MathContext getMathContext()
```
    Returns the MathContext used for BigDecimal and BigInteger operations. MathContext.DECIMAL32 is used by default.
  - setMathContext
```
public ExecuteOptions setMathContext(java.math.MathContext mathContext)
```
    Sets the MathContext used for BigDecimal and BigInteger operations. MathContext.DECIMAL32 is used by default.
  - setNamespace
```
public ExecuteOptions setNamespace(java.lang.String namespace)
```
    Sets the namespace to use for the query. Query specified namespace takes precedence, else this namespace value is used for unqualified table names.
    
    Since:
    
    18.3
  - getNamespace
```
public java.lang.String getNamespace()
```
    Returns the namespace to use for the query, null if not set.
    
    Since:
    
    18.3
  - setMaxMemoryConsumption
```
public void setMaxMemoryConsumption(long v)
```
    Set the maximum number of memory bytes that may be consumed by the statement at the client for blocking operations, such as duplicate elimination (which may be required due to the use of an index on an array or map) and sorting (sorting by distance when a query contains a geo_near() function). Such operations may consume a lot of memory as they need to cache the full result set at the client memory. The default value is 100MB.
    
    Since:
    
    18.3
  - getMaxMemoryConsumption
```
public long getMaxMemoryConsumption()
```
    Get the maximum number of memory bytes that may be consumed by the statement at the client for blocking operations, such as duplicate elimination (which may be required due to the use of an index on an array or map) and sorting (sorting by distance when a query contains a geo_near() function). Such operations may consume a lot of memory as they need to cache the full result set at the client memory. The default value is 100MB.

Class ExecuteOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExecuteOptions

Method Detail

setConsistency

getConsistency

setDurability

getDurability

setTimeout

getTimeout

getTimeoutUnit

getMaxConcurrentRequests

setMaxConcurrentRequests

getResultsBatchSize

setResultsBatchSize

getMathContext

setMathContext

setNamespace

getNamespace

setMaxMemoryConsumption

getMaxMemoryConsumption