Package org.apache.ignite.client.handler.requests.table

Class ClientIndexScanRequest

java.lang.Object
org.apache.ignite.client.handler.requests.table.ClientIndexScanRequest
public class ClientIndexScanRequest extends Object
Client request: scan rows by an index-key prefix range.

Returns a cursor of BinaryRows whose index-key values lie within the supplied bounds. Rows are ordered by the full index key (collation-aware).

Wire layout (in order):

  • int index id;
  • tx meta (nil -> server starts an explicit RO tx);
  • BitSet column bitmap for projection (null or empty = all columns);
  • lower bound: bool present, and when present bool inclusive followed by binary prefix bytes (BinaryTuplePrefix-encoded);
  • upper bound: same shape as the lower bound;
  • byte direction (0 = forward, 1 = reverse);
  • int page size (must be positive);
  • long client observable timestamp.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClientIndexScanRequest()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static CompletableFuture<ResponseWriter>
    process(org.apache.ignite.internal.client.proto.ClientMessageUnpacker in, org.apache.ignite.internal.table.IgniteTablesInternal tables, org.apache.ignite.internal.catalog.CatalogService catalogService, org.apache.ignite.internal.schema.SchemaSyncService schemaSyncService, org.apache.ignite.internal.network.ClusterService clusterService, ClientResourceRegistry resources, ClientHandlerMetricSource metrics, org.apache.ignite.internal.tx.TxManager txManager, ClientPrimaryReplicaTracker primaryReplicaTracker, org.apache.ignite.internal.hlc.ClockService clockService, org.gridgain.internal.license.LicenseFeatureChecker licenseFeatureChecker, org.apache.ignite.internal.hlc.HybridTimestampTracker tsTracker, @Nullable NotificationSender notificationSender, long requestId, Map<Long,Long> reqToTxMap)
    Processes the request.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ClientIndexScanRequest

      public ClientIndexScanRequest()

  • Method Details

    • process

      public static CompletableFuture<ResponseWriter> process(org.apache.ignite.internal.client.proto.ClientMessageUnpacker in, org.apache.ignite.internal.table.IgniteTablesInternal tables, org.apache.ignite.internal.catalog.CatalogService catalogService, org.apache.ignite.internal.schema.SchemaSyncService schemaSyncService, org.apache.ignite.internal.network.ClusterService clusterService, ClientResourceRegistry resources, ClientHandlerMetricSource metrics, org.apache.ignite.internal.tx.TxManager txManager, ClientPrimaryReplicaTracker primaryReplicaTracker, org.apache.ignite.internal.hlc.ClockService clockService, org.gridgain.internal.license.LicenseFeatureChecker licenseFeatureChecker, org.apache.ignite.internal.hlc.HybridTimestampTracker tsTracker, @Nullable @Nullable NotificationSender notificationSender, long requestId, Map<Long,Long> reqToTxMap)
      Processes the request.