gohbase

README

Golang HBase client

This is a pure-Go client for HBase.

Current status: prototype.

Supported Versions

HBase >= 1.0

Installation

go get github.com/tsuna/gohbase

Example Usage

Create a client

client := gohbase.NewClient("localhost")

Insert a cell

// Values maps a ColumnFamily -> Qualifiers -> Values.
values := map[string]map[string][]byte{"cf": map[string][]byte{"a": []byte{0}}}
putRequest, err := hrpc.NewPutStr(context.Background(), "table", "key", values)
rsp, err := client.Put(putRequest)

Get an entire row

getRequest, err := hrpc.NewGetStr(context.Background(), "table", "row")
getRsp, err := client.Get(getRequest)

Get a specific cell

// Perform a get for the cell with key "15", column family "cf" and qualifier "a"
family := map[string][]string{"cf": []string{"a"}}
getRequest, err := hrpc.NewGetStr(context.Background(), "table", "15",
    hrpc.Families(family))
getRsp, err := client.Get(getRequest)

Get a specific cell with a filter

pFilter := filter.NewKeyOnlyFilter(true)
family := map[string][]string{"cf": []string{"a"}}
getRequest, err := hrpc.NewGetStr(context.Background(), "table", "15",
    hrpc.Families(family), hrpc.Filters(pFilter))
getRsp, err := client.Get(getRequest)

Scan with a filter

pFilter := filter.NewPrefixFilter([]byte("7"))
scanRequest, err := hrpc.NewScanStr(context.Background(), "table",
		hrpc.Filters(pFilter))
scanRsp, err := client.Scan(scanRequest)

Contributing

Any help would be appreciated. Please use GerritHub to send changes for review, instead of GitHub pull requests. Please sign the Contributor License Agreement when you send your first change for review.

License

Copyright © 2015 The GoHBase Authors. All rights reserved. Use of this source code is governed by the Apache License 2.0 that can be found in the COPYING file.

Documentation

Index

• Variables
• type Client
  • func NewClient(zkquorum string, options ...Option) *Client
  • func (c *Client) Append(mutate *hrpc.Mutate) (*pb.MutateResponse, error)
  • func (c *Client) CheckTable(ctx context.Context, table string) (*pb.GetResponse, error)
  • func (c *Client) Delete(mutate *hrpc.Mutate) (*pb.MutateResponse, error)
  • func (c *Client) Get(get *hrpc.Get) (*pb.GetResponse, error)
  • func (c *Client) Increment(mutate *hrpc.Mutate) (*pb.MutateResponse, error)
  • func (c *Client) Put(mutate *hrpc.Mutate) (*pb.MutateResponse, error)
  • func (c *Client) Scan(s *hrpc.Scan) ([]*pb.Result, error)
• type Option
  • func FlushInterval(interval time.Duration) Option
  • func RpcQueueSize(size int) Option

Variables

var (

	// ErrDeadline is returned when the deadline of a request has been exceeded
	ErrDeadline = errors.New("deadline exceeded")
)

Constants

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

A Client provides access to an HBase cluster.

func NewClient

func NewClient(zkquorum string, options ...Option) *Client

NewClient creates a new HBase client.

func (*Client) Append

func (c *Client) Append(mutate *hrpc.Mutate) (*pb.MutateResponse, error)

Append atomically appends all the given values to their current values in HBase.

func (*Client) CheckTable

func (c *Client) CheckTable(ctx context.Context, table string) (*pb.GetResponse, error)

CheckTable returns an error if the given table name doesn't exist.

func (*Client) Delete

func (c *Client) Delete(mutate *hrpc.Mutate) (*pb.MutateResponse, error)

Delete removes values from the given row of the table.

func (*Client) Get

func (c *Client) Get(get *hrpc.Get) (*pb.GetResponse, error)

Get returns a single row fetched from HBase.

func (*Client) Increment

func (c *Client) Increment(mutate *hrpc.Mutate) (*pb.MutateResponse, error)

Increment atomically increments the given values in HBase.

func (*Client) Put

func (c *Client) Put(mutate *hrpc.Mutate) (*pb.MutateResponse, error)

Put inserts or updates the values into the given row of the table. TODO: Do we want to combine the following four functions into a single function -

func (c *Client) Mutate(mutate *hrpc.Mutate) {  ?

func (*Client) Scan

func (c *Client) Scan(s *hrpc.Scan) ([]*pb.Result, error)

Scan retrieves the values specified in families from the given range.

type Option

type Option func(*Client)

func FlushInterval

func FlushInterval(interval time.Duration) Option

FlushInterval will return an option that will set the timeout for flushing the RPC queues used in a given client

func RpcQueueSize

func RpcQueueSize(size int) Option

RpcQueueSize will return an option that will set the size of the RPC queues used in a given client