Field Detail

• scanMetrics

  protected ScanMetrics scanMetrics

Constructor Detail

• AbstractClientScanner

  public AbstractClientScanner()

Method Detail

• initScanMetrics

  protected void initScanMetrics(Scan scan)

  Check and initialize if application wants to collect scan metrics

• getScanMetrics

  public ScanMetrics getScanMetrics()

  Used internally accumulating metrics on scan. To enable collection of metrics on a Scanner, call Scan.setScanMetricsEnabled(boolean). These metrics are cleared at key transition points. Metrics are accumulated in the Scan object itself.

  Returns:

  Returns the running ScanMetrics instance or null if scan metrics not enabled.

  See Also:

  Scan.getScanMetrics()

• next

  public Result[] next(int nbRows)
                throws IOException

  Get nbRows rows. How many RPCs are made is determined by the Scan.setCaching(int) setting (or hbase.client.scanner.caching in hbase-site.xml).

  Specified by:

  next in interface ResultScanner

  Parameters:

  nbRows - number of rows to return

  Returns:

  Between zero and nbRows rowResults. Scan is done if returned array is of zero-length (We never return null).

  Throws:

  IOException

• iterator

  public Iterator<Result> iterator()

  Specified by:

  iterator in interface Iterable<Result>

• renewLease

  public abstract boolean renewLease()

  Allow the client to renew the scanner's lease on the server.

  Returns:

  true if the lease was successfully renewed, false otherwise.