| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.drill.exec.store.hbase; |
| |
| import java.util.Collections; |
| import java.util.Iterator; |
| import java.util.LinkedList; |
| import java.util.List; |
| |
| import org.apache.drill.common.exceptions.ExecutionSetupException; |
| import org.apache.drill.common.expression.SchemaPath; |
| import org.apache.drill.exec.physical.base.AbstractBase; |
| import org.apache.drill.exec.physical.base.PhysicalOperator; |
| import org.apache.drill.exec.physical.base.PhysicalVisitor; |
| import org.apache.drill.exec.physical.base.SubScan; |
| import org.apache.drill.exec.store.StoragePluginRegistry; |
| import org.apache.hadoop.hbase.filter.Filter; |
| import org.apache.hadoop.hbase.util.Bytes; |
| |
| import com.fasterxml.jackson.annotation.JacksonInject; |
| import com.fasterxml.jackson.annotation.JsonCreator; |
| import com.fasterxml.jackson.annotation.JsonIgnore; |
| import com.fasterxml.jackson.annotation.JsonProperty; |
| import com.fasterxml.jackson.annotation.JsonTypeName; |
| import org.apache.drill.shaded.guava.com.google.common.base.Preconditions; |
| |
| /** |
| * Information for reading a single HBase region |
| */ |
| @JsonTypeName("hbase-region-scan") |
| public class HBaseSubScan extends AbstractBase implements SubScan { |
| |
| public static final String OPERATOR_TYPE = "HBASE_SUB_SCAN"; |
| |
| private final HBaseStoragePlugin hbaseStoragePlugin; |
| private final List<HBaseSubScanSpec> regionScanSpecList; |
| private final List<SchemaPath> columns; |
| |
| @JsonCreator |
| public HBaseSubScan(@JacksonInject StoragePluginRegistry registry, |
| @JsonProperty("userName") String userName, |
| @JsonProperty("hbaseStoragePluginConfig") HBaseStoragePluginConfig hbaseStoragePluginConfig, |
| @JsonProperty("regionScanSpecList") LinkedList<HBaseSubScanSpec> regionScanSpecList, |
| @JsonProperty("columns") List<SchemaPath> columns) throws ExecutionSetupException { |
| this(userName, |
| registry.resolve(hbaseStoragePluginConfig, HBaseStoragePlugin.class), |
| regionScanSpecList, |
| columns); |
| } |
| |
| public HBaseSubScan(String userName, |
| HBaseStoragePlugin hbaseStoragePlugin, |
| List<HBaseSubScanSpec> regionInfoList, |
| List<SchemaPath> columns) { |
| super(userName); |
| this.hbaseStoragePlugin = hbaseStoragePlugin; |
| this.regionScanSpecList = regionInfoList; |
| this.columns = columns; |
| } |
| |
| @JsonProperty |
| public HBaseStoragePluginConfig getHbaseStoragePluginConfig() { |
| return hbaseStoragePlugin.getConfig(); |
| } |
| |
| @JsonProperty |
| public List<HBaseSubScanSpec> getRegionScanSpecList() { |
| return regionScanSpecList; |
| } |
| |
| @JsonProperty |
| public List<SchemaPath> getColumns() { |
| return columns; |
| } |
| |
| @Override |
| public boolean isExecutable() { |
| return false; |
| } |
| |
| @JsonIgnore |
| public HBaseStoragePlugin getStorageEngine(){ |
| return hbaseStoragePlugin; |
| } |
| |
| @Override |
| public <T, X, E extends Throwable> T accept(PhysicalVisitor<T, X, E> physicalVisitor, X value) throws E { |
| return physicalVisitor.visitSubScan(this, value); |
| } |
| |
| @Override |
| public PhysicalOperator getNewWithChildren(List<PhysicalOperator> children) { |
| Preconditions.checkArgument(children.isEmpty()); |
| return new HBaseSubScan(getUserName(), hbaseStoragePlugin, regionScanSpecList, columns); |
| } |
| |
| @Override |
| public Iterator<PhysicalOperator> iterator() { |
| return Collections.emptyIterator(); |
| } |
| |
| public static class HBaseSubScanSpec { |
| |
| protected String tableName; |
| protected String regionServer; |
| protected byte[] startRow; |
| protected byte[] stopRow; |
| protected byte[] serializedFilter; |
| |
| @JsonCreator |
| public HBaseSubScanSpec(@JsonProperty("tableName") String tableName, |
| @JsonProperty("regionServer") String regionServer, |
| @JsonProperty("startRow") byte[] startRow, |
| @JsonProperty("stopRow") byte[] stopRow, |
| @JsonProperty("serializedFilter") byte[] serializedFilter, |
| @JsonProperty("filterString") String filterString) { |
| if (serializedFilter != null && filterString != null) { |
| throw new IllegalArgumentException("The parameters 'serializedFilter' or 'filterString' cannot be specified at the same time."); |
| } |
| this.tableName = tableName; |
| this.regionServer = regionServer; |
| this.startRow = startRow; |
| this.stopRow = stopRow; |
| if (serializedFilter != null) { |
| this.serializedFilter = serializedFilter; |
| } else { |
| this.serializedFilter = HBaseUtils.serializeFilter(HBaseUtils.parseFilterString(filterString)); |
| } |
| } |
| |
| /* package */ HBaseSubScanSpec() { |
| // empty constructor, to be used with builder pattern; |
| } |
| |
| @JsonIgnore |
| private Filter scanFilter; |
| public Filter getScanFilter() { |
| if (scanFilter == null && serializedFilter != null) { |
| scanFilter = HBaseUtils.deserializeFilter(serializedFilter); |
| } |
| return scanFilter; |
| } |
| |
| public String getTableName() { |
| return tableName; |
| } |
| |
| public HBaseSubScanSpec setTableName(String tableName) { |
| this.tableName = tableName; |
| return this; |
| } |
| |
| public String getRegionServer() { |
| return regionServer; |
| } |
| |
| public HBaseSubScanSpec setRegionServer(String regionServer) { |
| this.regionServer = regionServer; |
| return this; |
| } |
| |
| public byte[] getStartRow() { |
| return startRow; |
| } |
| |
| public HBaseSubScanSpec setStartRow(byte[] startRow) { |
| this.startRow = startRow; |
| return this; |
| } |
| |
| public byte[] getStopRow() { |
| return stopRow; |
| } |
| |
| public HBaseSubScanSpec setStopRow(byte[] stopRow) { |
| this.stopRow = stopRow; |
| return this; |
| } |
| |
| public byte[] getSerializedFilter() { |
| return serializedFilter; |
| } |
| |
| public HBaseSubScanSpec setSerializedFilter(byte[] serializedFilter) { |
| this.serializedFilter = serializedFilter; |
| this.scanFilter = null; |
| return this; |
| } |
| |
| @Override |
| public String toString() { |
| return "HBaseScanSpec [tableName=" + tableName |
| + ", startRow=" + (startRow == null ? null : Bytes.toStringBinary(startRow)) |
| + ", stopRow=" + (stopRow == null ? null : Bytes.toStringBinary(stopRow)) |
| + ", filter=" + (getScanFilter() == null ? null : getScanFilter().toString()) |
| + ", regionServer=" + regionServer + "]"; |
| } |
| } |
| |
| @Override |
| public String getOperatorType() { |
| return OPERATOR_TYPE; |
| } |
| } |