home.vagrant.kiji.README.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jackson Show documentation

Kiji allows the imposition of schema and much else upon HBase.

The newest version!

# Kiji

This workspace contains the collection of Kiji projects.

## Prerequisites

Make sure you have the following installed:

 - Python 3.4.2 or greater.
 - Oracle JDK 7 or greater.

## Build instructions

 1. Download and extract the workspace into a directory `$wkspc`:  
    ```git clone https://github.com/kijiproject/kiji $wkspc```

 2. Make sure the workspace settings are correct in:
    [`$wkspc/.workspace_config/conf.py`](https://github.com/kijiproject/kiji/tree/master/.workspace_config/conf.py)

 3. From the workspace root directory, the Kiji artifacts (Maven artifacts and CLI executables) can be build by running:
    ```./bin/kiji-build build```

    The build process fetches and produces Maven artifacts into the local repository: `$wkspc/output/maven_repository/`.
    Executables are generated into `$wkspc/output/bin/`.


## Kiji CLI

Upon successful build, the Kiji CLI may be found at `$wkspc/output/bin/org/kiji/schema/kiji`.
Different versions of the CLI may be found at `$wkspc/output/bin/org/kiji/schema/kiji-cdh5.x`.

In order to (re)build a specific version of the CLI, you may use:
```./bin/kiji-build build //org/kiji/schema:kiji-cdh5.x```.

The definition of the Kiji artifacts can be found in the BUILD descriptor in the root directory: [`$wkspc/BUILD`](https://github.com/kijiproject/kiji/tree/master/BUILD).


## Running tests

In order to run tests, you can use:
```./bin/kiji-build test```

Tests involving the Hadoop Map/Reduce framework may run very slowly unless the appropriate version of the Hadoop native libraries are installed on the system.