Class: ScanQuery

ScanQuery()

Class representing a Scan query which returns the whole cache entries (key-value pairs).

This version of the class does not support a possibility to specify a Filter object for the query. The query returns all entries from the entire cache or from the specified partition.

Constructor

new ScanQuery()

Public constructor.

Scan query settings have the following defaults:

    Scan Query setting        :    Default value
    Local query flag          :    false
    Cursor page size          :    1024
    Partition number          :    -1 (entire cache)
    Filter object             :    null (not supported)
Every setting (except Filter object) may be changed using set methods.

Source:

Extends

Methods

setLocal(local) → {Query}

Set local query flag.

Parameters:
Name Type Description
local boolean

local query flag: true or false.
Inherited From:
Source:
Returns:
  • the same instance of the Query.
Type
Query

setPageSize(pageSize) → {Query}

Set Cursor page size.

Parameters:
Name Type Description
pageSize number

cursor page size.
Inherited From:
Source:
Returns:
  • the same instance of the Query.
Type
Query

setPartitionNumber(partitionNumber) → {ScanQuery}

Sets a partition number over which this query should iterate.

If negative, the query will iterate over all partitions in the cache.

Parameters:
Name Type Description
partitionNumber number

partition number over which this query should iterate.
Source:
Returns:
  • the same instance of the ScanQuery.
Type
ScanQuery