From 8cf508da8fc30bdaf1998b85c61f8bb66598e1d8 Mon Sep 17 00:00:00 2001 From: lamber-ken Date: Thu, 28 Nov 2019 15:53:04 +0800 Subject: [PATCH 1/8] update readme --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4f0d72dcf4786..00d5836e96b12 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,17 @@ limitations under the License. --> -# Hudi +# Apache Hudi (Incubating) Apache Hudi (Incubating) (pronounced Hoodie) stands for `Hadoop Upserts Deletes and Incrementals`. Hudi manages the storage of large analytical datasets on DFS (Cloud stores, HDFS or any Hadoop FileSystem compatible storage). -### Features + + +[![Build Status](https://travis-ci.org/apache/incubator-hudi.svg?branch=master)](https://travis-ci.org/apache/incubator-hudi) +[![GitHub release](https://img.shields.io/github/release/apache/incubator-hudi.svg)](https://github.com/apache/incubator-hudi/releases) +[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) + +## Features * Upsert support with fast, pluggable indexing * Atomically publish data with rollback support * Snapshot isolation between writer & queries @@ -35,17 +41,22 @@ Hudi provides the ability to query via three types of views: Learn more about Hudi at [https://hudi.apache.org](https://hudi.apache.org) -### Building Apache Hudi from source {#building-hudi} +## Building Apache Hudi from source + +Prerequisites for building Hudi: -Hudi requires Java 8 to be installed on a *nix system. Check out [code](https://github.com/apache/incubator-hudi) and -normally build the maven project, from command line: +* Unix-like system (like Linux, Mac OS X) +* Java 8 (Java 9 or 10 may work) +* Git +* Maven (recommend version 3.2.5) ``` # Checkout code and build -git clone https://github.com/apache/incubator-hudi.git && cd incubator-hudi +git clone https://github.com/apache/incubator-hudi.git +cd incubator-hudi mvn clean package -DskipTests -DskipITs ``` -### Quickstart +## Quickstart -Try [https://hudi.apache.org/quickstart.html](https://hudi.apache.org/quickstart.html) to quickly explore Hudi's capabilities using spark-shell. +Please visit [https://hudi.apache.org/quickstart.html](https://hudi.apache.org/quickstart.html) to quickly explore Hudi's capabilities using spark-shell. From 9d2a1813d7d1c9cdd6223d9a92dcaa67f2e853d5 Mon Sep 17 00:00:00 2001 From: lamber-ken Date: Thu, 28 Nov 2019 15:54:31 +0800 Subject: [PATCH 2/8] update readme --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 00d5836e96b12..0123df73c6d02 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,7 @@ Prerequisites for building Hudi: ``` # Checkout code and build -git clone https://github.com/apache/incubator-hudi.git -cd incubator-hudi +git clone https://github.com/apache/incubator-hudi.git && cd incubator-hudi mvn clean package -DskipTests -DskipITs ``` From 5dd8b7141dc71167b453171725d0d28f30eed45d Mon Sep 17 00:00:00 2001 From: lamber-ken Date: Thu, 28 Nov 2019 15:55:50 +0800 Subject: [PATCH 3/8] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0123df73c6d02..41d64fbad7b20 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Hudi manages the storage of large analytical datasets on DFS (Cloud stores, HDFS Hudi provides the ability to query via three types of views: * **Read Optimized View** - Provides excellent snapshot query performance via purely columnar storage (e.g. [Parquet](https://parquet.apache.org/)) * **Incremental View** - Provides a change stream with records inserted or updated after a point in time. - * **Real-time View** - Provides snapshot queries on real-time data, using a combination of columnar & row-based storage (e.g Parquet + [Avro](http://avro.apache.org/docs/current/mr.html)) + * **Real-time View** - Provides snapshot queries on real-time data, using a combination of columnar & row-based storage (e.g [Parquet](https://parquet.apache.org/) + [Avro](http://avro.apache.org/docs/current/mr.html)) Learn more about Hudi at [https://hudi.apache.org](https://hudi.apache.org) From 02483b38e0a787422327e59cfc5e37d25c1790fd Mon Sep 17 00:00:00 2001 From: lamber-ken Date: Thu, 28 Nov 2019 16:16:26 +0800 Subject: [PATCH 4/8] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 41d64fbad7b20..a3390869fe8f7 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Prerequisites for building Hudi: * Unix-like system (like Linux, Mac OS X) * Java 8 (Java 9 or 10 may work) * Git -* Maven (recommend version 3.2.5) +* Maven ``` # Checkout code and build From 2ed060890ef7094270c0c24993fa09e73a7d5e70 Mon Sep 17 00:00:00 2001 From: lamber-ken Date: Sun, 1 Dec 2019 02:30:43 +0800 Subject: [PATCH 5/8] standardize buid name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a3390869fe8f7..04484a300cd09 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Learn more about Hudi at [https://hudi.apache.org](https://hudi.apache.org) ## Building Apache Hudi from source -Prerequisites for building Hudi: +Prerequisites for building Apache Hudi: * Unix-like system (like Linux, Mac OS X) * Java 8 (Java 9 or 10 may work) From fc99bc1f9535e1a99ed06f71a962424eaad29cc4 Mon Sep 17 00:00:00 2001 From: lamber-ken Date: Sun, 1 Dec 2019 02:58:03 +0800 Subject: [PATCH 6/8] replace release --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04484a300cd09..bab12f33d79ae 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,8 @@ Hudi manages the storage of large analytical datasets on DFS (Cloud stores, HDFS [![Build Status](https://travis-ci.org/apache/incubator-hudi.svg?branch=master)](https://travis-ci.org/apache/incubator-hudi) -[![GitHub release](https://img.shields.io/github/release/apache/incubator-hudi.svg)](https://github.com/apache/incubator-hudi/releases) [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.hudi/hudi/badge.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.hudi%22) ## Features * Upsert support with fast, pluggable indexing From 40e4bfc88ebf3731f43113fe4f2e04a50a754a1b Mon Sep 17 00:00:00 2001 From: lamber-ken Date: Sun, 1 Dec 2019 08:34:38 +0800 Subject: [PATCH 7/8] revert building-hudi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bab12f33d79ae..5efbb71a8d4e2 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ Hudi provides the ability to query via three types of views: Learn more about Hudi at [https://hudi.apache.org](https://hudi.apache.org) -## Building Apache Hudi from source +## Building Apache Hudi from source {#building-hudi} Prerequisites for building Apache Hudi: From fb5ff5dd9192cfb891ac2465b40248a1b8f091de Mon Sep 17 00:00:00 2001 From: lamber-ken Date: Sun, 1 Dec 2019 09:56:56 +0800 Subject: [PATCH 8/8] add periods --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5efbb71a8d4e2..c25454864aa9b 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,9 @@ Hudi manages the storage of large analytical datasets on DFS (Cloud stores, HDFS * Timeline metadata to track lineage Hudi provides the ability to query via three types of views: - * **Read Optimized View** - Provides excellent snapshot query performance via purely columnar storage (e.g. [Parquet](https://parquet.apache.org/)) + * **Read Optimized View** - Provides excellent snapshot query performance via purely columnar storage (e.g. [Parquet](https://parquet.apache.org/)). * **Incremental View** - Provides a change stream with records inserted or updated after a point in time. - * **Real-time View** - Provides snapshot queries on real-time data, using a combination of columnar & row-based storage (e.g [Parquet](https://parquet.apache.org/) + [Avro](http://avro.apache.org/docs/current/mr.html)) + * **Real-time View** - Provides snapshot queries on real-time data, using a combination of columnar & row-based storage (e.g [Parquet](https://parquet.apache.org/) + [Avro](http://avro.apache.org/docs/current/mr.html)). Learn more about Hudi at [https://hudi.apache.org](https://hudi.apache.org)