Skip to content

Commit

Permalink
Version 1.19; Renamed 'master' to 'main';
Browse files Browse the repository at this point in the history
  • Loading branch information
m-manu committed Feb 13, 2021
1 parent 33c2e60 commit ec9d387
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# HBase ORM

[![Build Status](https://api.travis-ci.org/flipkart-incubator/hbase-orm.svg?branch=master&status=passed)](https://travis-ci.org/github/flipkart-incubator/hbase-orm)
[![Build Status](https://api.travis-ci.org/flipkart-incubator/hbase-orm.svg?branch=main&status=passed)](https://travis-ci.org/github/flipkart-incubator/hbase-orm)
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/flipkart-incubator/hbase-orm.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/flipkart-incubator/hbase-orm/context:java)
[![Coverage Status](https://coveralls.io/repos/github/flipkart-incubator/hbase-orm/badge.svg?branch=master)](https://coveralls.io/github/flipkart-incubator/hbase-orm?branch=master)
[![Maven Central](https://img.shields.io/badge/sonatype-1.18-blue.svg)](https://oss.sonatype.org/content/repositories/releases/com/flipkart/hbase-object-mapper/1.18/)
[![Coverage Status](https://coveralls.io/repos/github/flipkart-incubator/hbase-orm/badge.svg?branch=main)](https://coveralls.io/github/flipkart-incubator/hbase-orm?branch=master)
[![Maven Central](https://img.shields.io/badge/sonatype-1.19-blue.svg)](https://oss.sonatype.org/content/repositories/releases/com/flipkart/hbase-object-mapper/1.19/)
[![License](https://img.shields.io/badge/License-Apache%202-blue.svg)](./LICENSE.txt)

## Introduction
Expand Down Expand Up @@ -401,27 +401,27 @@ If you are using Maven, add below entry within the `dependencies` section of you
<dependency>
<groupId>com.flipkart</groupId>
<artifactId>hbase-object-mapper</artifactId>
<version>1.18</version>
<version>1.19</version>
</dependency>
```

See artifact details: [com.flipkart:hbase-object-mapper on **Maven Central**](https://search.maven.org/search?q=g:com.flipkart%20AND%20a:hbase-object-mapper&core=gav).

If you're using Gradle or Ivy or SBT, see how to include this library in your build:
[com.flipkart:hbase-object-mapper:1.18](https://mvnrepository.com/artifact/com.flipkart/hbase-object-mapper/1.18).
[com.flipkart:hbase-object-mapper:1.19](https://mvnrepository.com/artifact/com.flipkart/hbase-object-mapper/1.19).

## How to build?
To build this project, follow below simple steps:

1. Do a `git clone` of this repository
2. Checkout latest stable version `git checkout v1.18`
2. Checkout latest stable version `git checkout v1.19`
3. Execute `mvn clean install` from shell

### Please note:

* Currently, systems that use this library are running on HBase 2.0. However, if you are using a different version, just change the version in [pom.xml](./pom.xml) to the desired one and build the project.
* Test cases are **very comprehensive**. So, `mvn` build times can sometimes be longer, depending on your machine configuration.
* By default, test cases spin an [in-memory HBase test cluster](https://github.com/apache/hbase/blob/master/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtility.java) to run data access related test cases (near-realworld scenario).
* By default, test cases spin an [in-memory HBase test cluster](https://github.com/apache/hbase/blob/main/hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtility.java) to run data access related test cases (near-realworld scenario).
* If test cases are failing with time out errors, you may increase the timeout by setting environment variable `INMEMORY_CLUSTER_START_TIMEOUT` (seconds). For example, on Linux you may run the command `export INMEMORY_CLUSTER_START_TIMEOUT=8` on terminal, before running the aforementioned `mvn` command.
* You may direct test cases to use an actual HBase cluster (instead of default in-memory one) by setting `USE_REAL_HBASE` environmental variable to `true`.
* If you're using this option, ensure you've correct settings in your `hbase-site.xml`.
Expand Down

0 comments on commit ec9d387

Please sign in to comment.