com.twitter.storehaus.hbase.HBaseStore.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of storehaus-hbase_2.11 Show documentation
storehaus-hbase
There is a newer version: 0.15.0-RC1
/*
 * Copyright 2014 Twitter inc.
 *
 *    Licensed 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 com.twitter.storehaus.hbase

import org.apache.hadoop.hbase.client._
import org.apache.hadoop.conf.Configuration
import org.apache.hadoop.hbase.{HColumnDescriptor, HTableDescriptor, HBaseConfiguration}
import com.twitter.bijection.hbase.HBaseInjections.string2BytesInj
import com.twitter.bijection.Conversion._
import com.twitter.bijection.Injection
import com.twitter.util.{FuturePool, Future}
import scala.Some
import java.util.concurrent.Executors

/**
 * @author Mansur Ashraf
 * @since 9/8/13
 */
trait HBaseStore {

  protected val quorumNames: Seq[String]
  protected val createTable: Boolean
  protected val table: String
  protected val columnFamily: String
  protected val column: String
  protected val pool: HTablePool
  protected val conf: Configuration
  protected val threads: Int
  protected val futurePool = FuturePool(Executors.newFixedThreadPool(threads))

  def getHBaseAdmin: HBaseAdmin = {
    if (conf.get("hbase.zookeeper.quorum") == null) {
      conf.set("hbase.zookeeper.quorum", quorumNames.mkString(","))
    }
    val hbaseConf = HBaseConfiguration.create(conf)
    new HBaseAdmin(hbaseConf)
  }

  def createTableIfRequired() {
    val hbaseAdmin = getHBaseAdmin
    if (createTable && !hbaseAdmin.tableExists(table)) {
      val tableDescriptor = new HTableDescriptor(table)
      tableDescriptor.addFamily(new HColumnDescriptor(columnFamily))
      hbaseAdmin.createTable(tableDescriptor)
    }
  }

  def validateConfiguration() {
    import org.apache.commons.lang.StringUtils.isNotEmpty

    require(!quorumNames.isEmpty, "Zookeeper quorums are required")
    require(isNotEmpty(columnFamily), "column family is required")
    require(isNotEmpty(column), "column is required")
  }

  def getValue[K, V](key: K)(implicit keyInj: Injection[K, Array[Byte]], valueInj: Injection[V, Array[Byte]]): Future[Option[V]] = {
    val tbl = pool.getTable(table)
    futurePool {
      val g = new Get(keyInj(key))
      g.addColumn(string2BytesInj(columnFamily), string2BytesInj(column))

      val result = tbl.get(g)
      val value = result.getValue(string2BytesInj(columnFamily),
        string2BytesInj(column))

      Option(value).map(v => valueInj.invert(v).get)
    } ensure tbl.close
  }

  def putValue[K, V](kv: (K, Option[V]))(implicit keyInj: Injection[K, Array[Byte]], valueInj: Injection[V, Array[Byte]]): Future[Unit] = {
    val tbl = pool.getTable(table)
    kv match {
      case (k, Some(v)) => futurePool {
        val p = new Put(keyInj(k))
        p.add(string2BytesInj(columnFamily), string2BytesInj(column), valueInj(v))
        tbl.put(p)
      } ensure tbl.close

      case (k, None) => futurePool {
        val delete = new Delete(keyInj(k))
        tbl.delete(delete)
      } ensure tbl.close
    }
  }
}