Fluo Recipes 1.0.0-incubating Documentation

Fluo Recipes are common code for Apache Fluo application developers.

Fluo Recipes build on the Fluo API to offer additinal functionality to developers. They are published seperately from Fluo on their own release schedule. This allows Fluo Recipes to iterate and innovate faster than Fluo (which will maintain a more minimal API on a slower release cycle).

Documentation

Recipes are documented below and in the Recipes API docs.

  • Collision Free Map - A recipe for making many to many updates.
  • Export Queue - A recipe for exporting data from Fluo to external systems.
  • Row Hash Prefix - A recipe for spreading data evenly in a row prefix.
  • RecordingTransaction - A wrapper for a Fluo transaction that records all transaction operations to a log which can be used to export data from Fluo.
  • Testing Some code to help write Fluo Integration test.

Recipes have common needs that are broken down into the following reusable components.

Usage

The Fluo Recipes project publishes multiple jars to Maven Central for each release. The fluo-recipes-core jar is the primary jar. It is where most recipes live and where they are placed by default if they have minimal dependencies beyond the Fluo API.

Fluo Recipes with dependencies that bring in many transitive dependencies publish their own jar. For example, recipes that depend on Apache Spark are published in the fluo-recipes-spark jar. If you don’t plan on using code in the fluo-recipes-spark jar, you should avoid including it in your pom.xml to avoid a transitive dependency on Spark.

Below is a sample Maven POM containing all possible Fluo Recipes dependencies:

  <properties>
    <fluo-recipes.version>1.0.0-incubating</fluo-recipes.version>
  </properties>

  <dependencies>
    <!-- Required. Contains recipes that are only depend on the Fluo API -->
    <dependency>
      <groupId>org.apache.fluo</groupId>
      <artifactId>fluo-recipes-core</artifactId>
      <version>${fluo-recipes.version}</version>
    </dependency>
    <!-- Optional. Serialization code that depends on Kryo -->
    <dependency>
      <groupId>org.apache.fluo</groupId>
      <artifactId>fluo-recipes-kryo</artifactId>
      <version>${fluo-recipes.version}</version>
    </dependency>
    <!-- Optional. Common code for using Fluo with Accumulo -->
    <dependency>
      <groupId>org.apache.fluo</groupId>
      <artifactId>fluo-recipes-accumulo</artifactId>
      <version>${fluo-recipes.version}</version>
    </dependency>
    <!-- Optional. Common code for using Fluo with Spark -->
    <dependency>
      <groupId>org.apache.fluo</groupId>
      <artifactId>fluo-recipes-spark</artifactId>
      <version>${fluo-recipes.version}</version>
    </dependency>
    <!-- Optional. Common code for writing Fluo integration tests -->
    <dependency>
      <groupId>org.apache.fluo</groupId>
      <artifactId>fluo-recipes-test</artifactId>
      <version>${fluo-recipes.version}</version>
      <scope>test</scope>
    </dependency>
  </dependencies>