@API(value=MAINTAINED) public class ScanProperties extends Object
ExecuteProperties
, which holds the properties that pertain to an entire
execution.Modifier and Type | Field and Description |
---|---|
static ScanProperties |
FORWARD_SCAN |
static ScanProperties |
REVERSE_SCAN |
Constructor and Description |
---|
ScanProperties(ExecuteProperties executeProperties)
Creates scan properties.
|
ScanProperties(ExecuteProperties executeProperties,
boolean reverse)
Creates scan properties.
|
ScanProperties(ExecuteProperties executeProperties,
boolean reverse,
CursorStreamingMode cursorStreamingMode)
Creates scan properties.
|
Modifier and Type | Method and Description |
---|---|
CursorStreamingMode |
getCursorStreamingMode()
Get cursor streaming mode.
|
ExecuteProperties |
getExecuteProperties()
Get execute properties for this scan properties.
|
boolean |
isReverse()
Get direction of scans.
|
ScanProperties |
setReverse(boolean reverse)
Change direction of scans.
|
ScanProperties |
setStreamingMode(CursorStreamingMode cursorStreamingMode)
Set cursor streaming mode.
|
String |
toString() |
ScanProperties |
with(Function<ExecuteProperties,ExecuteProperties> modifier)
Change execute properties.
|
public static final ScanProperties FORWARD_SCAN
public static final ScanProperties REVERSE_SCAN
public ScanProperties(@Nonnull ExecuteProperties executeProperties)
executeProperties
- the execution properties (such as isolation level and row limit) associated with this scanpublic ScanProperties(@Nonnull ExecuteProperties executeProperties, boolean reverse)
executeProperties
- the execution properties (such as isolation level and row limit) associated with this scanreverse
- if true, the scan direction will be reversedpublic ScanProperties(@Nonnull ExecuteProperties executeProperties, boolean reverse, @Nonnull CursorStreamingMode cursorStreamingMode)
executeProperties
- the execution properties (such as isolation level and row limit) associated with this scanreverse
- if true, the scan direction will be reversedcursorStreamingMode
- streaming mode to use if opening an FDB cursorpublic boolean isReverse()
true
if scan is in reverse order@Nonnull public ExecuteProperties getExecuteProperties()
@Nonnull public ScanProperties with(@Nonnull Function<ExecuteProperties,ExecuteProperties> modifier)
modifier
- a function to produce a new execute properties from the current one@Nonnull public ScanProperties setReverse(boolean reverse)
reverse
- true
if scan is in reverse order@Nonnull public CursorStreamingMode getCursorStreamingMode()
@Nonnull public ScanProperties setStreamingMode(@Nonnull CursorStreamingMode cursorStreamingMode)
cursorStreamingMode
- cursor streaming mode to set