This is an automated email from the ASF dual-hosted git repository.
xushiyan pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hudi.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 0d00aa2e64b1 docs: add notebooks instructions page to Hudi website
(#14034)
0d00aa2e64b1 is described below
commit 0d00aa2e64b1911f0acf12a0bfe4d5504c323217
Author: deepakpanda93 <[email protected]>
AuthorDate: Wed Oct 8 22:43:05 2025 +0530
docs: add notebooks instructions page to Hudi website (#14034)
---
website/docs/notebooks.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++
website/sidebars.js | 1 +
2 files changed, 79 insertions(+)
diff --git a/website/docs/notebooks.md b/website/docs/notebooks.md
new file mode 100644
index 000000000000..2c73f9c343b9
--- /dev/null
+++ b/website/docs/notebooks.md
@@ -0,0 +1,78 @@
+---
+title: "Notebooks"
+keywords: [ hudi, notebooks]
+toc: true
+last_modified_at: 2025-10-09T19:13:57+08:00
+---
+
+Get hands-on with Apache Hudi using interactive notebooks!
+
+This demo environment is designed to help you explore Hudi's capabilities
end-to-end using real-world scenarios. It runs entirely within a local
Docker-based infrastructure, making it easy to get started without any external
dependencies. The setup includes all required services, such as Spark, Hive,
and a local S3-compatible store, bundled and orchestrated via Docker Compose.
+
+All you need is a cloned copy of the Hudi repository and Docker installed on
your system. These notebooks have been tested on macOS.
+
+### Setup
+
+ * Clone the [Hudi repository](https://github.com/apache/hudi) to your local
machine.
+ * Docker Setup : For Mac, Please follow the steps as defined in [Install
Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/).
For running Spark-SQL queries, please ensure atleast 6 GB and 4 CPUs are
allocated to Docker (See Docker -> Preferences -> Advanced).
+ * This setup also needs JDK 8 and maven installed on your system.
+ * Build Docker Images
+ ```sh
+ cd hudi-notebooks
+ ./build.sh
+ ```
+ * Start the Environment
+ ```sh
+ ./run_spark_hudi.sh start
+ ```
+
+### Meet Your Notebooks
+#### 1 - Getting Started with Apache Hudi: A Hands-On Guide to CRUD Operations
+This notebook is a beginner friendly, practical guide to working with Apache
Hudi using PySpark. It walks you through the essential CRUD operations (Create,
Read, Update, Delete) on Hudi tables, while also helping you understand key
table types such as Copy-On-Write (COW) and Merge-On-Read (MOR).
+
+For storage, we use MinIO as an S3-compatible backend, simulating a modern
datalake setup.
+
+**What you will learn:**
+- How to create and update Hudi tables using PySpark
+- The difference between COW and MOR tables
+- Reading data using snapshot and incremental queries
+- How Hudi handles upserts and deletes
+
+#### 2 - Deep Dive into Apache Hudi Table & Query Types: Snapshot, RO,
Incremental, Time Travel, CDC
+This notebook is your hands-on guide to mastering Apache Hudi's advanced query
capabilities. You will explore practical examples of various read modes such as
Snapshot, Read-Optimized (RO), Incremental, Time Travel, and Change Data
Capture (CDC) so you can understand when and how to use each for building
efficient, real-world data pipelines.
+
+**What you will learn:**
+- How to perform Snapshot and Read-Optimized queries
+- Using Incremental pulls for near real-time data processing
+- Querying historical data with Time Travel
+- Capturing changes with CDC for downstream consumption
+
+#### 3 - Implementing Slowly Changing Dimensions (SCD Type 2 & 4) with Apache
Hudi
+Dive into this practical guide on implementing two key data warehousing
patterns - Slowly Changing Dimensions (SCD) Type 2 and Type 4 using Apache Hudi.
+
+SCDs help track changes in dimension data over time without losing historical
context. Instead of overwriting records, these patterns let you maintain a full
history of data changes. Leveraging Hudi's upsert capabilities and rich
metadata, this notebook simplifies what's traditionally a complex process.
+
+**What you will learn:**
+- SCD Type 2: How to track changes by adding new rows to your dimension tables
+- SCD Type 4: How to manage historical data in a separate history table
+
+#### 4 - Schema Evolution with Apache Hudi: Concepts and Practical Use
+In real-world data lake environments, schema changes are not just common but
they are expected. Whether you are adding new data attributes, adjusting
existing types, or refactoring nested structures, it's essential that your
pipelines adapt without introducing instability.
+
+Apache Hudi supports powerful schema evolution capabilities that help you
maintain schema flexibility while ensuring data consistency. In this notebook,
we will explore how Hudi enables safe and efficient schema changes, both at
write time and read time.
+
+**What you will learn:**
+- Schema Evolution on Write:
+Apache Hudi allows safe, backward-compatible schema changes during write
operations. This ensures that you can evolve your schema without rewriting
existing data or breaking your ingestion pipelines.
+
+- Schema Evolution on Read:
+Hudi also supports schema evolution during reads, enabling more flexible
transformations that don't require rewriting the dataset.
+
+#### 5 - A Hands-on Guide to Hudi SQL Procedures
+Apache Hudi provides a suite of powerful built-in procedures that can be
executed directly from Spark SQL using the familiar CALL syntax.
+
+These procedures enable you to perform advanced table maintenance, auditing,
and data management tasks without writing any custom code or scripts. Whether
you are compacting data, cleaning old versions, or retrieving metadata, Hudi
SQL procedures make it easy and SQL-friendly.
+
+**What you will learn:**
+
+In this guide, we will explore how to use various Hudi SQL procedures through
practical, real-world examples. You will learn how to invoke these operations
using Spark SQL and understand when and why to use each one.
diff --git a/website/sidebars.js b/website/sidebars.js
index 54e5ea3ee094..71c209ebdcaa 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -17,6 +17,7 @@ module.exports = {
'flink-quick-start-guide',
'python-rust-quick-start-guide',
'docker_demo',
+ "notebooks",
'use_cases',
],
},
