docs: add Apache Wayang GSoC 2026 JDBC driver blog by makarandhinge · Pull Request #128 · apache/wayang-website

makarandhinge · 2026-08-08T07:50:51Z

No description provided.

kbeedkar

Pls see one comment regarding Before and After

kbeedkar · 2026-08-08T13:02:46Z

This before and after could be a bit misleading. The before architecture is still relevant so the JDBC driver is not replacing the "Before" architecture.

zkaoudi

Hi @makarandhinge, thank you for the detailed blog post. I enjoyed reading it and especially I liked the figures.
I have marked some minor issues inline.

One main thing that was confusing to me was the terminology used. Terms such as JDBC driver, JDBC client, JDBC server were used without clear separation. In fact, I think most of the text uses the term JDBC driver to mean JDBC client, if I'm not mistaken. JDBC driver should be the entire implementation that consists of a client, a server and a protocol to communicate. @kbeedkar Any thoughts on that?

zkaoudi · 2026-08-14T11:29:26Z

+As part of Google Summer of Code 2026, I implemented a JDBC driver for Apache Wayang, enabling Java applications to interact with Wayang through the standard JDBC API.
+
+<div style={{textAlign: 'center'}}>
+  <img width="90%" alt="Apache Wayang JDBC driver project hero image" src="/img/blog/wayang-jdbc/hero-image.png" />


in this file, why "JDBC server" is a separate box? Shouldn't it be part of the Wayang JDBC driver? Maybe at this stage you don't need this box at all.

zkaoudi · 2026-08-14T11:33:21Z

+  <img width="90%" alt="Apache Wayang JDBC driver project hero image" src="/img/blog/wayang-jdbc/hero-image.png" />
+</div>
+
+Apache Wayang provides a unified way to express and execute data processing workloads across different execution platforms. This project introduces a JDBC interface around Wayang's SQL capabilities, separating the standard JDBC client experience from the underlying Wayang execution system.


I would replace "SQL capabilities" with "SQL API", as capabilities can also be seen as the SQL platforms we support.

Also JDBC client is unclear what it means here. So either you change it or introduce the term or visualize it in the figure before.

zkaoudi · 2026-08-14T11:34:17Z

+
+JDBC is the standard database interface for Java applications. It provides familiar concepts such as connections, statements, result sets, and metadata, which many Java developers already understand.
+
+Apache Wayang already provides SQL capabilities, but the missing piece was a standard JDBC interface for external applications. This project addresses that gap by making Wayang accessible through the JDBC API without requiring applications to depend directly on Wayang-specific APIs.


"SQL capabilities" --> "an SQL API"

zkaoudi · 2026-08-14T11:36:20Z

+
+The JDBC layer therefore acts as an integration boundary: applications interact through a standard database interface, while Wayang remains responsible for SQL processing, optimization, and execution across its supported platforms.
+
+To make this possible, the project separates the JDBC client from the Wayang execution environment through a set of components that work together.


Again it's not clear what is JDBC server and what is JDBC client here. This needs to be clarified above or in the first figure.

zkaoudi · 2026-08-14T11:37:32Z

+
+## Architecture
+
+The JDBC implementation is organized into separate components so that the JDBC-facing API, communication protocol, server-side request handling, and Wayang execution remain independently manageable.


"The JDBC implementation" --> "The JDBC driver implementation"

It's important this detail, because we also have the JDBC template as platforms and it can be confusing what we mean.

zkaoudi · 2026-08-14T11:44:20Z

+
+Apache Wayang remains responsible for the actual SQL processing. The JDBC layer does not replace Wayang's SQL execution system; it provides a standard entry point into it. Once the server passes a query into Wayang's SQL API, Wayang handles planning, optimization, and execution.
+
+The key communication boundary is between the JDBC driver and the JDBC server:


by "JDBC driver" you mean "JDBC client"?

I would say that driver is the entire implementation which consists of the client, the protocol, and the server

zkaoudi · 2026-08-14T11:54:14Z

+
+The JDBC implementation was validated across the client, protocol, server, and Wayang integration layers. Testing focused on JDBC behavior, request and response handling, query execution, result and metadata processing, error handling, and resource lifecycle to ensure that the complete flow works consistently from the application to Wayang and back.
+
+<div style={{textAlign: 'center'}}>


Maybe this figure is not required. It doesn't add much to the text.

zkaoudi · 2026-08-14T11:55:41Z

+
+### 3. What the demo shows
+
+This demo helps demonstrate the idea that Wayang is not a database and does not store the data itself. The CSV files remain in the data folder, while the demo shows how they can be treated as logical SQL-style tables such as `fs.heart_disease_risk_2026`.


Can't the demo actually execute an SQL query against these datasets?

zkaoudi · 2026-08-14T11:58:21Z

+
+This provides a foundation for making Apache Wayang easier to integrate with Java applications and future JDBC-compatible tooling.
+
+Future work can continue in a few areas:


This part felt repetitive as there is a "future improvements" part above

makarandhinge · 2026-08-14T15:47:47Z

Hi @zkaoudi ,

Thank you for the review. I have addressed the inline comments and clarified the JDBC driver, client, server, and protocol terminology.

I did not mention Python because it requires a JDBC bridge, and this integration has not yet been tested or officially supported.

…rminology

kbeedkar

LGTM.

zkaoudi · 2026-08-18T07:08:35Z

+```text
+wayang-jdbc/
+│
+├── wayang-jdbc-driver/


This needs to be replaced with wayang-jdbc-client

zkaoudi · 2026-08-18T07:09:59Z

+**Decision:** The client-side JDBC layer and JDBC server communicate through a defined TCP protocol using length-prefixed JSON messages.
+
+```text
+JDBC Driver


JDBC Client

zkaoudi · 2026-08-18T07:10:36Z

+```text
+Java Application
+       ↓
+JDBC Driver


JDBC Client

zkaoudi · 2026-08-18T07:11:05Z

+
+Each `ResultSet.next()` does not execute the SQL query again. The query is executed once, and later fetches retrieve additional pages from the server-side cursor.
+
+> The JDBC application only sees the standard JDBC interface. The driver, protocol, and server handle the communication and lifecycle details, while Apache Wayang remains responsible for SQL processing and execution.


"The driver, protocol, and server" --> "The client-side layer, protocol, and server"

…agrams

docs: add Apache Wayang GSoC 2026 JDBC driver blog

bbdf7f0

kbeedkar requested changes Aug 8, 2026

View reviewed changes

docs: refine Why JDBC section and update visual

8abcd90

makarandhinge requested a review from kbeedkar August 8, 2026 13:33

Update Wayang JDBC demo blog section

037ea73

zkaoudi requested changes Aug 14, 2026

View reviewed changes

makarandhinge added 2 commits August 14, 2026 20:44

Address Wayang JDBC blog review comments

b00640d

Update Wayang JDBC blog hero image

56a073e

docs: update Wayang JDBC architecture and sql journey diagrams and te…

d364101

…rminology

makarandhinge requested a review from zkaoudi August 17, 2026 19:18

kbeedkar previously approved these changes Aug 18, 2026

View reviewed changes

zkaoudi requested changes Aug 18, 2026

View reviewed changes

docs: update documentation per mentor feedback

560e64a

makarandhinge dismissed kbeedkar’s stale review via 560e64a August 18, 2026 07:24

docs: rename JDBC Driver layer to Client-side JDBC in architecture di…

ec9b038

…agrams

makarandhinge requested review from kbeedkar and zkaoudi August 18, 2026 07:56

zkaoudi approved these changes Aug 18, 2026

View reviewed changes

zkaoudi merged commit 9801fde into apache:main Aug 18, 2026
1 check passed


		JDBC is the standard database interface for Java applications. It provides familiar concepts such as connections, statements, result sets, and metadata, which many Java developers already understand.

		Apache Wayang already provides SQL capabilities, but the missing piece was a standard JDBC interface for external applications. This project addresses that gap by making Wayang accessible through the JDBC API without requiring applications to depend directly on Wayang-specific APIs.


		The JDBC layer therefore acts as an integration boundary: applications interact through a standard database interface, while Wayang remains responsible for SQL processing, optimization, and execution across its supported platforms.

		To make this possible, the project separates the JDBC client from the Wayang execution environment through a set of components that work together.


		## Architecture

		The JDBC implementation is organized into separate components so that the JDBC-facing API, communication protocol, server-side request handling, and Wayang execution remain independently manageable.


		Apache Wayang remains responsible for the actual SQL processing. The JDBC layer does not replace Wayang's SQL execution system; it provides a standard entry point into it. Once the server passes a query into Wayang's SQL API, Wayang handles planning, optimization, and execution.

		The key communication boundary is between the JDBC driver and the JDBC server:


		The JDBC implementation was validated across the client, protocol, server, and Wayang integration layers. Testing focused on JDBC behavior, request and response handling, query execution, result and metadata processing, error handling, and resource lifecycle to ensure that the complete flow works consistently from the application to Wayang and back.

		<div style={{textAlign: 'center'}}>


		### 3. What the demo shows

		This demo helps demonstrate the idea that Wayang is not a database and does not store the data itself. The CSV files remain in the data folder, while the demo shows how they can be treated as logical SQL-style tables such as `fs.heart_disease_risk_2026`.


		This provides a foundation for making Apache Wayang easier to integrate with Java applications and future JDBC-compatible tooling.

		Future work can continue in a few areas:


		Each `ResultSet.next()` does not execute the SQL query again. The query is executed once, and later fetches retrieve additional pages from the server-side cursor.

		> The JDBC application only sees the standard JDBC interface. The driver, protocol, and server handle the communication and lifecycle details, while Apache Wayang remains responsible for SQL processing and execution.

Conversation

makarandhinge commented Aug 8, 2026

Uh oh!

kbeedkar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zkaoudi left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

makarandhinge commented Aug 14, 2026

Uh oh!

kbeedkar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zkaoudi left a comment •

edited

Loading