GridH2QueryRequest (Ignite 8.9.17-p1)

java.lang.Object
- org.apache.ignite.internal.processors.query.h2.twostep.msg.GridH2QueryRequest

All Implemented Interfaces:

Serializable, GridCacheQueryMarshallable, Message
```
public class GridH2QueryRequest
extends Object
implements Message, GridCacheQueryMarshallable
```
Query request.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FLAG_DISTRIBUTED_JOINS` Map query will not destroy context until explicit query cancel request will be received because distributed join requests can be received.
`static int`	`FLAG_ENFORCE_JOIN_ORDER` Remote map query executor will enforce join order for the received map queries.
`static int`	`FLAG_EXPLAIN` If it is an EXPLAIN command.
`static int`	`FLAG_LAZY` If lazy execution is enabled.
`static int`	`FLAG_REPLICATED` If it is a REPLICATED query.
`static int`	`FLAG_REPLICATED_AS_PARTITIONED` Whether to treat replicated as partitioned (for outer joins).

Fields inherited from interface org.apache.ignite.plugin.extensions.communication.Message
DIRECT_TYPE_SIZE

Constructor Summary

Constructors
Constructor and Description

GridH2QueryRequest()
Required by Externalizable

GridH2QueryRequest(GridH2QueryRequest req)

Constructors
Constructor and Description
`GridH2QueryRequest()` Required by `Externalizable`
`GridH2QueryRequest(GridH2QueryRequest req)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Integer>`	`caches()`
`GridH2QueryRequest`	`caches(List<Integer> caches)`
`short`	`directType()`
`boolean`	`explicitTimeout()`
`GridH2QueryRequest`	`explicitTimeout(boolean explicitTimeout)`
`byte`	`fieldsCount()`
`GridH2QueryRequest`	`flags(int flags)`
`Boolean`	`isDataPageScanEnabled()` Checks if data page scan enabled.
`static Boolean`	`isDataPageScanEnabled(int flags)` Checks if data page scan enabled.
`boolean`	`isFlagSet(int flags)`
`@Nullable String`	`label()`
`GridH2QueryRequest`	`label(@Nullable String label)` Sets query label.
`void`	`marshall(Marshaller m)`
`long`	`maxMemory()` Return memory limit for query.
`GridH2QueryRequest`	`maxMemory(long maxMem)` Sets memory limit for query.
`@Nullable MvccSnapshot`	`mvccSnapshot()`
`GridH2QueryRequest`	`mvccSnapshot(MvccSnapshot mvccSnapshot)`
`void`	`onAckReceived()`
`int`	`pageSize()`
`GridH2QueryRequest`	`pageSize(int pageSize)`
`Object[]`	`parameters()`
`GridH2QueryRequest`	`parameters(Object[] params)`
`Map<UUID,int[]>`	`partitions()`
`GridH2QueryRequest`	`partitions(Map<UUID,int[]> parts)`
`List<GridCacheSqlQuery>`	`queries()`
`GridH2QueryRequest`	`queries(List<GridCacheSqlQuery> qrys)`
`static int`	`queryFlags(boolean distributedJoins, boolean enforceJoinOrder, boolean lazy, boolean replicatedOnly, boolean explain, Boolean dataPageScanEnabled, boolean treatReplicatedAsPartitioned)` Build query flags.
`int[]`	`queryPartitions()`
`GridH2QueryRequest`	`queryPartitions(int[] qryParts)`
`boolean`	`readFrom(ByteBuffer buf, MessageReader reader)`
`long`	`requestId()`
`GridH2QueryRequest`	`requestId(long reqId)`
`Long`	`runningQryId()` Id of the query assigned by `RunningQueryManager`.
`GridH2QueryRequest`	`runningQryId(Long runningQryId)` Sets id of the query assigned by `RunningQueryManager`.
`String`	`schemaName()`
`GridH2QueryRequest`	`schemaName(String schemaName)`
`static int`	`setDataPageScanEnabled(int flags, Boolean dataPageScanEnabled)`
`Collection<QueryTable>`	`tables()` Get tables.
`GridH2QueryRequest`	`tables(Collection<QueryTable> tbls)`
`int`	`timeout()`
`GridH2QueryRequest`	`timeout(int timeout)`
`AffinityTopologyVersion`	`topologyVersion()`
`GridH2QueryRequest`	`topologyVersion(AffinityTopologyVersion topVer)`
`String`	`toString()`
`GridH2SelectForUpdateTxDetails`	`txDetails()`
`void`	`txDetails(GridH2SelectForUpdateTxDetails txReq)`
`void`	`unmarshall(Marshaller m, GridKernalContext ctx)`
`boolean`	`writeTo(ByteBuffer buf, MessageWriter writer)`

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

Methods inherited from interface org.apache.ignite.plugin.extensions.communication.Message
policy

- Field Detail
  - FLAG_DISTRIBUTED_JOINS
```
public static final int FLAG_DISTRIBUTED_JOINS
```
    Map query will not destroy context until explicit query cancel request will be received because distributed join requests can be received.
    
    See Also:
    
    Constant Field Values
  - FLAG_ENFORCE_JOIN_ORDER
```
public static final int FLAG_ENFORCE_JOIN_ORDER
```
    Remote map query executor will enforce join order for the received map queries.
    
    See Also:
    
    Constant Field Values
  - FLAG_REPLICATED_AS_PARTITIONED
```
public static final int FLAG_REPLICATED_AS_PARTITIONED
```
    Whether to treat replicated as partitioned (for outer joins).
    
    See Also:
    
    Constant Field Values
  - FLAG_EXPLAIN
```
public static final int FLAG_EXPLAIN
```
    If it is an EXPLAIN command.
    
    See Also:
    
    Constant Field Values
  - FLAG_REPLICATED
```
public static final int FLAG_REPLICATED
```
    If it is a REPLICATED query.
    
    See Also:
    
    Constant Field Values
  - FLAG_LAZY
```
public static final int FLAG_LAZY
```
    If lazy execution is enabled.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GridH2QueryRequest
```
public GridH2QueryRequest()
```
    Required by Externalizable
  - GridH2QueryRequest
```
public GridH2QueryRequest(GridH2QueryRequest req)
```
    Parameters:
    
    req - Request.
- Method Detail
  - mvccSnapshot
```
@Nullable
public @Nullable MvccSnapshot mvccSnapshot()
```
    Returns:
    
    MVCC snapshot.
  - mvccSnapshot
```
public GridH2QueryRequest mvccSnapshot(MvccSnapshot mvccSnapshot)
```
    Parameters:
    
    mvccSnapshot - MVCC snapshot version.
    
    Returns:
    
    this.
  - parameters
```
public Object[] parameters()
```
    Returns:
    
    Parameters.
  - parameters
```
public GridH2QueryRequest parameters(Object[] params)
```
    Parameters:
    
    params - Parameters.
    
    Returns:
    
    this.
  - tables
```
public GridH2QueryRequest tables(Collection<QueryTable> tbls)
```
    Parameters:
    
    tbls - Tables.
    
    Returns:
    
    this.
  - tables
```
public Collection<QueryTable> tables()
```
    Get tables.
    N.B.: Was used in AI 1.9 for snapshots. Unused at the moment, but should be kept for compatibility reasons.
    
    Returns:
    
    Tables.
  - requestId
```
public GridH2QueryRequest requestId(long reqId)
```
    Parameters:
    
    reqId - Request ID.
    
    Returns:
    
    this.
  - requestId
```
public long requestId()
```
    Returns:
    
    Request ID.
  - caches
```
public GridH2QueryRequest caches(List<Integer> caches)
```
    Parameters:
    
    caches - Caches.
    
    Returns:
    
    this.
  - caches
```
public List<Integer> caches()
```
    Returns:
    
    Caches.
  - topologyVersion
```
public GridH2QueryRequest topologyVersion(AffinityTopologyVersion topVer)
```
    Parameters:
    
    topVer - Topology version.
    
    Returns:
    
    this.
  - topologyVersion
```
public AffinityTopologyVersion topologyVersion()
```
    Returns:
    
    Topology version.
  - partitions
```
public Map<UUID,int[]> partitions()
```
    Returns:
    
    Explicit partitions mapping.
  - partitions
```
public GridH2QueryRequest partitions(Map<UUID,int[]> parts)
```
    Parameters:
    
    parts - Explicit partitions mapping.
    
    Returns:
    
    this.
  - queryPartitions
```
public int[] queryPartitions()
```
    Returns:
    
    Query partitions.
  - queryPartitions
```
public GridH2QueryRequest queryPartitions(int[] qryParts)
```
    Parameters:
    
    qryParts - Query partitions.
    
    Returns:
    
    this.
  - pageSize
```
public GridH2QueryRequest pageSize(int pageSize)
```
    Parameters:
    
    pageSize - Page size.
    
    Returns:
    
    this.
  - pageSize
```
public int pageSize()
```
    Returns:
    
    Page size.
  - queries
```
public GridH2QueryRequest queries(List<GridCacheSqlQuery> qrys)
```
    Parameters:
    
    qrys - SQL Queries.
    
    Returns:
    
    this.
  - queries
```
public List<GridCacheSqlQuery> queries()
```
    Returns:
    
    SQL Queries.
  - flags
```
public GridH2QueryRequest flags(int flags)
```
    Parameters:
    
    flags - Flags.
    
    Returns:
    
    this.
  - isFlagSet
```
public boolean isFlagSet(int flags)
```
    Parameters:
    
    flags - Flags to check.
    
    Returns:
    
    true If all the requested flags are set to true.
  - timeout
```
public int timeout()
```
    Returns:
    
    Timeout.
  - timeout
```
public GridH2QueryRequest timeout(int timeout)
```
    Parameters:
    
    timeout - New timeout.
    
    Returns:
    
    this.
  - explicitTimeout
```
public boolean explicitTimeout()
```
    Returns:
    
    true if query timeout is set explicitly.
  - explicitTimeout
```
public GridH2QueryRequest explicitTimeout(boolean explicitTimeout)
```
    Parameters:
    
    explicitTimeout - Explicit timeout flag.
    
    Returns:
    
    this.
  - schemaName
```
public String schemaName()
```
    Returns:
    
    Schema name.
  - schemaName
```
public GridH2QueryRequest schemaName(String schemaName)
```
    Parameters:
    
    schemaName - Schema name.
    
    Returns:
    
    this.
  - txDetails
```
public GridH2SelectForUpdateTxDetails txDetails()
```
    Returns:
    
    TX details holder for SELECT FOR UPDATE, or null if not applicable.
  - txDetails
```
public void txDetails(GridH2SelectForUpdateTxDetails txReq)
```
    Parameters:
    
    txReq - TX details holder for SELECT FOR UPDATE, or null if not applicable.
  - setDataPageScanEnabled
```
public static int setDataPageScanEnabled(int flags,
                                         Boolean dataPageScanEnabled)
```
    Parameters:
    
    flags - Flags.
    
    dataPageScanEnabled - true If data page scan enabled, false if not, and null if not set.
    
    Returns:
    
    Updated flags.
  - queryFlags
```
public static int queryFlags(boolean distributedJoins,
                             boolean enforceJoinOrder,
                             boolean lazy,
                             boolean replicatedOnly,
                             boolean explain,
                             Boolean dataPageScanEnabled,
                             boolean treatReplicatedAsPartitioned)
```
    Build query flags.
    
    Returns:
    
    Query flags.
  - maxMemory
```
public long maxMemory()
```
    Return memory limit for query.
    
    Returns:
    
    Memory size in bytes.
  - maxMemory
```
public GridH2QueryRequest maxMemory(long maxMem)
```
    Sets memory limit for query.
    
    Parameters:
    
    maxMem - Memory size in bytes.
    
    Returns:
    
    this for chaining.
  - runningQryId
```
public Long runningQryId()
```
    Id of the query assigned by RunningQueryManager.
    
    Returns:
    
    Running query id.
  - runningQryId
```
public GridH2QueryRequest runningQryId(Long runningQryId)
```
    Sets id of the query assigned by RunningQueryManager.
    
    Parameters:
    
    runningQryId - Running query id.
    
    Returns:
    
    this for chaining.
  - label
```
@Nullable
public @Nullable String label()
```
    Returns:
    
    Query label, or null if not set.
  - label
```
public GridH2QueryRequest label(@Nullable
                                @Nullable String label)
```
    Sets query label.
    
    Parameters:
    
    label - Query label.
    
    Returns:
    
    this for chaining.
  - isDataPageScanEnabled
```
public Boolean isDataPageScanEnabled()
```
    Checks if data page scan enabled.
    
    Returns:
    
    true If data page scan enabled, false if not, and null if not set.
  - isDataPageScanEnabled
```
public static Boolean isDataPageScanEnabled(int flags)
```
    Checks if data page scan enabled.
    
    Parameters:
    
    flags - Flags.
    
    Returns:
    
    true If data page scan enabled, false if not, and null if not set.
  - marshall
```
public void marshall(Marshaller m)
```
    Specified by:
    
    marshall in interface GridCacheQueryMarshallable
  - unmarshall
```
public void unmarshall(Marshaller m,
                       GridKernalContext ctx)
```
    Specified by:
    
    unmarshall in interface GridCacheQueryMarshallable
  - writeTo
```
public boolean writeTo(ByteBuffer buf,
                       MessageWriter writer)
```
    Specified by:
    
    writeTo in interface Message
  - readFrom
```
public boolean readFrom(ByteBuffer buf,
                        MessageReader reader)
```
    Specified by:
    
    readFrom in interface Message
  - directType
```
public short directType()
```
    Specified by:
    
    directType in interface Message
  - fieldsCount
```
public byte fieldsCount()
```
    Specified by:
    
    fieldsCount in interface Message
  - onAckReceived
```
public void onAckReceived()
```
    Specified by:
    
    onAckReceived in interface Message
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GridH2QueryRequest

Field Summary

Fields inherited from interface org.apache.ignite.plugin.extensions.communication.Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.ignite.plugin.extensions.communication.Message

Field Detail

FLAG_DISTRIBUTED_JOINS

FLAG_ENFORCE_JOIN_ORDER

FLAG_REPLICATED_AS_PARTITIONED

FLAG_EXPLAIN

FLAG_REPLICATED

FLAG_LAZY

Constructor Detail

GridH2QueryRequest

GridH2QueryRequest

Method Detail

mvccSnapshot

mvccSnapshot

parameters

parameters

tables

tables

requestId

requestId

caches

caches

topologyVersion

topologyVersion

partitions

partitions

queryPartitions

queryPartitions

pageSize

pageSize

queries

queries

flags

isFlagSet

timeout

timeout

explicitTimeout

explicitTimeout

schemaName

schemaName

txDetails

txDetails

setDataPageScanEnabled

queryFlags

maxMemory

maxMemory

runningQryId

runningQryId

label

label

isDataPageScanEnabled

isDataPageScanEnabled

marshall

unmarshall

writeTo

readFrom

directType

fieldsCount

onAckReceived

toString