com.apple.foundationdb.record

Class ExecuteProperties.Builder

java.lang.Object

com.apple.foundationdb.record.ExecuteProperties.Builder

Enclosing class:

ExecuteProperties

public static class ExecuteProperties.Builder
extends Object

A builder for ExecuteProperties.

 ExecuteProperties.newBuilder().setSkip(s).setReturnedRowLimit(l).build()
 

Method Summary

Modifier and Type	Method and Description
ExecuteProperties	build()
ExecuteProperties.Builder	clearScannedBytesLimit()
ExecuteProperties.Builder	clearScannedRecordsLimit()
ExecuteProperties.Builder	clearState()
CursorStreamingMode	getDefaultCursorStreamingMode() Get the default CursorStreamingMode for new ScanProperties.
ExecuteProperties.Builder	setDefaultCursorStreamingMode(CursorStreamingMode defaultCursorStreamingMode) Set the default CursorStreamingMode for new ScanProperties.
ExecuteProperties.Builder	setFailOnScanLimitReached(boolean failOnScanLimitReached) Set how scan limit reached is handled.
ExecuteProperties.Builder	setIsolationLevel(IsolationLevel isolationLevel)
ExecuteProperties.Builder	setReturnedRowLimit(int rowLimit)
ExecuteProperties.Builder	setScannedBytesLimit(long limit)
ExecuteProperties.Builder	setScannedRecordsLimit(int limit) Set the limit on the number of records that may be scanned.
ExecuteProperties.Builder	setSkip(int skip)
ExecuteProperties.Builder	setState(ExecuteState state)
ExecuteProperties.Builder	setTimeLimit(long timeLimit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setIsolationLevel

@Nonnull
public ExecuteProperties.Builder setIsolationLevel(@Nonnull
                                                            IsolationLevel isolationLevel)

setSkip

@Nonnull
public ExecuteProperties.Builder setSkip(int skip)

setReturnedRowLimit

@Nonnull
public ExecuteProperties.Builder setReturnedRowLimit(int rowLimit)

setTimeLimit

@Nonnull
public ExecuteProperties.Builder setTimeLimit(long timeLimit)

setScannedRecordsLimit

@Nonnull
public ExecuteProperties.Builder setScannedRecordsLimit(int limit)

Set the limit on the number of records that may be scanned. Note that at most one of scannedRecordsLimit and executeState may be set at the same time, since the ExecuteState contains a shared RecordScanLimiter.

Parameters:

limit - the maximum number of records to scan

Returns:

an updated builder

clearScannedRecordsLimit

@Nonnull
public ExecuteProperties.Builder clearScannedRecordsLimit()

setScannedBytesLimit

@Nonnull
public ExecuteProperties.Builder setScannedBytesLimit(long limit)

clearScannedBytesLimit

@Nonnull
public ExecuteProperties.Builder clearScannedBytesLimit()

setState

@Nonnull
public ExecuteProperties.Builder setState(@Nullable
                                                   ExecuteState state)

clearState

@Nonnull
public ExecuteProperties.Builder clearState()

setFailOnScanLimitReached

public ExecuteProperties.Builder setFailOnScanLimitReached(boolean failOnScanLimitReached)

Set how scan limit reached is handled. This setting has no effect if setScannedRecordsLimit(int) is not also set.

Parameters:

failOnScanLimitReached - true to throw an exception, false to return early

Returns:

an updated builder

getDefaultCursorStreamingMode

public CursorStreamingMode getDefaultCursorStreamingMode()

Get the default CursorStreamingMode for new ScanProperties.

Returns:

the default streaming mode

setDefaultCursorStreamingMode

public ExecuteProperties.Builder setDefaultCursorStreamingMode(CursorStreamingMode defaultCursorStreamingMode)

Set the default CursorStreamingMode for new ScanProperties.

Parameters:

defaultCursorStreamingMode - default streaming mode

Returns:

an updated builder

build

@Nonnull
public ExecuteProperties build()