hbase-shims/hbase-1/src/main/java/org/apache/omid/HBaseShims.java

/*
 * 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.omid;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.CellComparator;
import org.apache.hadoop.hbase.HColumnDescriptor;
import org.apache.hadoop.hbase.HTableDescriptor;
import org.apache.hadoop.hbase.KeyValue;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.client.Admin;
import org.apache.hadoop.hbase.client.Connection;
import org.apache.hadoop.hbase.client.CoprocessorHConnection;
import org.apache.hadoop.hbase.coprocessor.ObserverContext;
import org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment;
import org.apache.hadoop.hbase.regionserver.HRegionServer;
import org.apache.hadoop.hbase.regionserver.Region;
import org.apache.hadoop.hbase.regionserver.Store;
import org.apache.hadoop.hbase.util.Bytes;

import java.io.IOException;

public class HBaseShims {

    static public void setKeyValueSequenceId(KeyValue kv, int sequenceId) {

        kv.setSequenceId(sequenceId);

    }

    static public Region getRegionCoprocessorRegion(RegionCoprocessorEnvironment env) {

        return env.getRegion();

    }

    static public void flushAllOnlineRegions(HRegionServer regionServer, TableName tableName) throws IOException {

        for (Region r : regionServer.getOnlineRegions(tableName)) {
            r.flush(true);
        }

    }

    static public void addFamilyToHTableDescriptor(HTableDescriptor tableDesc, HColumnDescriptor columnDesc) {

        tableDesc.addFamily(columnDesc);

    }

    public static CellComparator cellComparatorInstance() {
        return new CellComparator();
    }

    public static boolean OmidCompactionEnabled(ObserverContext<RegionCoprocessorEnvironment> env,
                                  Store store,
                                  String cfFlagValue) {
        HTableDescriptor desc = env.getEnvironment().getRegion().getTableDesc();
        HColumnDescriptor famDesc
                = desc.getFamily(Bytes.toBytes(store.getColumnFamilyName()));
        return Boolean.valueOf(famDesc.getValue(cfFlagValue));
    }


    public static void setCompaction(Connection conn, TableName table, byte[] columnFamily, String key, String value)
            throws IOException {
        try(Admin admin = conn.getAdmin()) {
            HTableDescriptor desc = admin.getTableDescriptor(table);
            HColumnDescriptor cfDesc = desc.getFamily(columnFamily);
            cfDesc.setValue(key, value);
            admin.modifyColumn(table, cfDesc);
        }
    }
    
    /**
     * For HBase 1.x, an HConstants.HBASE_CLIENT_RETRIES_NUMBER value of 0
     * means no retries, while for 2.x a value of 1 means no retries. 
     * @return
     */
    public static int getNoRetriesNumber() {
        return 0;
    }
    
    /**
     * Create an HBase Connection from the region server
     */
    public static Connection newServerConnection(Configuration config, RegionCoprocessorEnvironment env) throws IOException {
        return new CoprocessorHConnection(config, (HRegionServer)env.getRegionServerServices());
    }

}