View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.hadoop.hbase.client;
20  
21  import java.io.IOException;
22  import java.util.ArrayList;
23  import java.util.List;
24  
25  import org.apache.hadoop.hbase.classification.InterfaceAudience;
26  import org.apache.hadoop.conf.Configuration;
27  import org.apache.hadoop.fs.FileSystem;
28  import org.apache.hadoop.fs.Path;
29  import org.apache.hadoop.hbase.Cell;
30  import org.apache.hadoop.hbase.HRegionInfo;
31  import org.apache.hadoop.hbase.HTableDescriptor;
32  import org.apache.hadoop.hbase.KeyValueUtil;
33  import org.apache.hadoop.hbase.client.metrics.ScanMetrics;
34  import org.apache.hadoop.hbase.regionserver.HRegion;
35  import org.apache.hadoop.hbase.regionserver.RegionScanner;
36  import org.mortbay.log.Log;
37  
38  /**
39   * A client scanner for a region opened for read-only on the client side. Assumes region data
40   * is not changing.
41   */
42  @InterfaceAudience.Private
43  public class ClientSideRegionScanner extends AbstractClientScanner {
44  
45    private HRegion region;
46    private Scan scan;
47    RegionScanner scanner;
48    List<Cell> values;
49  
50    public ClientSideRegionScanner(Configuration conf, FileSystem fs,
51        Path rootDir, HTableDescriptor htd, HRegionInfo hri, Scan scan, ScanMetrics scanMetrics) throws IOException {
52  
53      this.scan = scan;
54  
55      // region is immutable, set isolation level
56      scan.setIsolationLevel(IsolationLevel.READ_UNCOMMITTED);
57  
58      // open region from the snapshot directory
59      this.region = HRegion.openHRegion(conf, fs, rootDir, hri, htd, null, null, null);
60  
61      // create an internal region scanner
62      this.scanner = region.getScanner(scan);
63      values = new ArrayList<Cell>();
64  
65      if (scanMetrics == null) {
66        initScanMetrics(scan);
67      } else {
68        this.scanMetrics = scanMetrics;
69      }
70      region.startRegionOperation();
71    }
72  
73    @Override
74    public Result next() throws IOException {
75      values.clear();
76  
77      scanner.nextRaw(values, -1); // pass -1 as limit so that we see the whole row.
78      if (values == null || values.isEmpty()) {
79        //we are done
80        return null;
81      }
82  
83      Result result = Result.create(values);
84      if (this.scanMetrics != null) {
85        long resultSize = 0;
86        for (Cell kv : values) {
87          // TODO add getLength to Cell/use CellUtil#estimatedSizeOf
88          resultSize += KeyValueUtil.ensureKeyValue(kv).getLength();
89        }
90        this.scanMetrics.countOfBytesInResults.addAndGet(resultSize);
91      }
92  
93      return result;
94    }
95  
96    @Override
97    public void close() {
98      if (this.scanner != null) {
99        try {
100         this.scanner.close();
101         this.scanner = null;
102       } catch (IOException ex) {
103         Log.warn("Exception while closing scanner", ex);
104       }
105     }
106     if (this.region != null) {
107       try {
108         this.region.closeRegionOperation();
109         this.region.close(true);
110         this.region = null;
111       } catch (IOException ex) {
112         Log.warn("Exception while closing region", ex);
113       }
114     }
115   }
116 }