alibaba · longbinlai · Mar 20, 2026 · Mar 11, 2026 · Mar 12, 2026 · Mar 12, 2026
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -6,6 +6,7 @@ on:
         - main
       paths:
         - 'doc/**'
+        - 'tools/java_driver/**'
         - '.github/workflows/docs.yml'
 
 
@@ -32,16 +33,24 @@ jobs:
       with:
         python-version: '3.10'
 
+    - name: Setup Java and Maven
+      uses: s4u/setup-maven-action@v1.19.0
+      with:
+        java-version: '17'
+        maven-version: '3.9.6'
 
     - name: Build Documentation
       run: |
         sudo apt update
         sudo apt install -y doxygen graphviz
+        cd ${GITHUB_WORKSPACE}/tools/java_driver
+        mvn -DskipTests javadoc:javadoc
         cd ${GITHUB_WORKSPACE}/tools/python_bind
         python3 -m pip  install -r requirements.txt
         python3 -m pip  install -r requirements_dev.txt
         cd ${GITHUB_WORKSPACE}/doc
         . /home/neug/.neug_env
         make dependencies
         make html
-
+        mkdir -p ${GITHUB_WORKSPACE}/doc/build/html/reference/java_api
+        cp -r ${GITHUB_WORKSPACE}/tools/java_driver/target/site/apidocs ${GITHUB_WORKSPACE}/doc/build/html/reference/java_api/
diff --git a/.github/workflows/format-check.yml b/.github/workflows/format-check.yml
@@ -90,6 +90,12 @@ jobs:
       with:
         python-version: '3.10'
 
+    - name: Setup Java and Maven
+      uses: s4u/setup-maven-action@v1.19.0
+      with:
+        java-version: '17'
+        maven-version: '3.9.6'
+
     - name: Get PR Changes
       uses: dorny/paths-filter@v3
       id: changes
@@ -157,4 +163,10 @@ jobs:
         (python3 -m flake8 .) || (print_error "flake8 check failed" "tests/e2e" "flake8" && exit 1)
         popd
 
+    - name: Java Format Check
+      run: |
+        pushd ${GITHUB_WORKSPACE}/tools/java_driver
+        mvn spotless:check
+        popd
+
 
diff --git a/.github/workflows/neug-test.yml b/.github/workflows/neug-test.yml
@@ -13,6 +13,7 @@ on:
       - 'proto/**'
       - 'third_party/**'
       - 'tools/python_bind/**'
+      - 'tools/java_driver/**'
       - 'tests/**'
       - '.github/workflows/neug-test.yml'
       - 'scripts/install_deps.sh'
@@ -28,6 +29,7 @@ on:
       - 'proto/**'
       - 'third_party/**'
       - 'tools/python_bind/**'
+      - 'tools/java_driver/**'
       - 'tests/**'
       - '.github/workflows/neug-test.yml'
       - 'scripts/install_deps.sh'
@@ -78,6 +80,7 @@ jobs:
             - 'proto/**'
             - 'third_party/**'
             - 'tools/python_bind/**'
+            - 'tools/java_driver/**'
             - 'tests/**'
             - '!tests/extension/**'
             - '!tests/extensions/**'
@@ -102,7 +105,7 @@ jobs:
       uses: actions/cache@v4
       with:
         path: ~/.cache/ccache
-        key: ${{ runner.os }}-ccache-${{ github.ref_name }}-${{ hashFiles('CMakeLists.txt', 'cmake/**', 'src/**', 'include/**', 'proto/**', 'tools/python_bind/**', '.github/workflows/neug-test.yml') }}
+        key: ${{ runner.os }}-ccache-${{ github.ref_name }}-${{ hashFiles('CMakeLists.txt', 'cmake/**', 'src/**', 'include/**', 'proto/**', 'tools/python_bind/**', 'tools/java_driver/**', '.github/workflows/neug-test.yml') }}
         restore-keys: |
           ${{ runner.os }}-ccache-${{ github.ref_name }}-
           ${{ runner.os }}-ccache-main-
@@ -140,6 +143,12 @@ jobs:
       with:
         python-version: '3.13'
 
+    - name: Setup Java and Maven
+      uses: s4u/setup-maven-action@v1.19.0
+      with:
+        java-version: '17'
+        maven-version: '3.9.6'
+
     - name: Set ENABLE_GCOV for main branch
       if: steps.scope.outputs.extension_only != 'true' && (github.ref == 'refs/heads/main' && github.repository == 'alibaba/neug' && github.event_name == 'push')
       run: |
@@ -347,6 +356,14 @@ jobs:
         python3 -m pytest --cov=neug --cov-report=term --exitfirst --cov-append --cov-config=.coveragerc -sv tests/test_ngcli_commands.py
         python3 -m pytest --cov=neug --cov-report=term --exitfirst --cov-append --cov-config=.coveragerc -sv tests/test_ngcli_basics.py
 
+    - name: Run Java Driver Test
+      if: steps.scope.outputs.extension_only != 'true'
+      run: |
+        cd ${GITHUB_WORKSPACE}/tools/java_driver/
+        mvn test
+        cd ${GITHUB_WORKSPACE}/tools/python_bind/
+        python3 -m pytest -sv tests/test_java_driver.py
+
     # ========================================
     # Phase 4: E2E Tests
     # ========================================

diff --git a/bin/benchmark.cc b/bin/benchmark.cc
@@ -233,7 +233,7 @@ void benchmark_iteration(
 }
 
 int main(int argc, char** argv) {
-  cxxopts::Options options("rt_server", "Real-time graph server for NeuG");
+  cxxopts::Options options("benchmark", "Benchmarking tool for NeuG");
   options.add_options()("help", "Display help message")(
       "data-path,d", "", cxxopts::value<std::string>())(
       "memory-level,m", "", cxxopts::value<int>()->default_value("1"))(

diff --git a/doc/source/_scripts/generate_cpp_docs.py b/doc/source/_scripts/generate_cpp_docs.py
@@ -1890,6 +1890,7 @@ def _generate_reference_meta_file(self):
         content = """export default {
   cpp_api: "C++ API",
   python_api: "Python API",
+  java_api: "Java API",
 };
 """
 

diff --git a/doc/source/_scripts/generate_python_docs.py b/doc/source/_scripts/generate_python_docs.py
@@ -96,7 +96,7 @@ def clean_generated_docs(output_dir: Path, scripts_dir: Path):
 def generate_docs():
     """Generate documentation for all modules using pydoc-markdown."""
     # Script is now in source/_scripts/
-    scripts_dir = Path(__file__).parent
+    scripts_dir = Path(__file__).resolve().parent
     doc_dir = scripts_dir.parent.parent  # from source/_scripts/ -> source/ -> doc/
     output_dir = scripts_dir.parent / 'reference' / 'python_api'  # source/reference/python_api
     output_dir.mkdir(parents=True, exist_ok=True)
@@ -435,7 +435,7 @@ def main():
 def generate_docs_no_clean():
     """Generate documentation without cleaning first."""
     # Script is now in source/_scripts/
-    scripts_dir = Path(__file__).parent
+    scripts_dir = Path(__file__).resolve().parent
     doc_dir = scripts_dir.parent.parent  # from source/_scripts/ -> source/ -> doc/
     output_dir = scripts_dir.parent / 'reference' / 'python_api'  # source/reference/python_api
     output_dir.mkdir(parents=True, exist_ok=True)

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -85,7 +85,9 @@
 ]
 
 # Source file suffixes
-source_suffix = ['.rst', '.md']
+# Keep .md before .rst so duplicated docnames (e.g. index.md + index.rst)
+# resolve to Markdown, which is where the Java API landing content lives.
+source_suffix = ['.md', '.rst']
 
 # API documentation settings
 # Templates for API documentation
@@ -100,6 +102,7 @@
 exclude_patterns = [
     '_build',
     '.ipynb_checkpoints',
+    'reference/java_api/index.rst',
 ]
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/doc/source/development/code_style_guide.md b/doc/source/development/code_style_guide.md
@@ -11,12 +11,20 @@ We follow the [Google C++ Style Guide](https://google.github.io/styleguide/cppgu
 
 We follow the [black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) code style for Python coding standards.
 
+## Java Style
+
+Java code in NeuG follows [Google Java Style](https://google.github.io/styleguide/javaguide.html),
+enforced by the Maven Spotless plugin (with `google-java-format`).
+
+Java source is located at [tools/java_driver](../../tools/java_driver).
+
 ## Style Linter and Checker
 
 GraphScope uses different linters and checkers for each language to enforce code style rules:
 
 - C++: [clang-format-8](https://releases.llvm.org/8.0.0/tools/clang/docs/ClangFormat.html) and [cpplint](https://github.com/cpplint/cpplint)
 - Python: [Flake8](https://flake8.pycqa.org/en/latest/)
+- Java: [Spotless Maven Plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven)
 
 Each linter can be included in the build process to ensure that the code adheres to the style guide.
 Below are the commands to check the code style in each language:
@@ -51,4 +59,22 @@ $ python3 -m isort --check --diff .
 $ python3 -m black --check --diff .
 $ python3 -m flake8 .
 $ popd
+```
+
+For Java:
+
+- Check style only:
+
+```bash
+$ pushd tools/java_driver
+$ mvn spotless:check
+$ popd
+```
+
+- Auto-format Java files:
+
+```bash
+$ pushd tools/java_driver
+$ mvn spotless:apply
+$ popd
 ```
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -81,6 +81,7 @@ NeuG documentation
 
    Python API <reference/python_api/index>
    C++ API <reference/cpp_api/index>
+   Java API <reference/java_api/index>
 
 .. toctree::
    :maxdepth: 1

diff --git a/doc/source/reference/_meta.ts b/doc/source/reference/_meta.ts
@@ -1,4 +1,5 @@
 export default {
   cpp_api: "C++ API",
   python_api: "Python API",
+  java_api: "Java API",
 };
diff --git a/doc/source/reference/cpp_api/connection.md b/doc/source/reference/cpp_api/connection.md
@@ -61,8 +61,8 @@ result = conn->Query("MATCH (p:Person) WHERE p.age > $min_age RETURN p",
 "read", params);
 // Process results
 if (result.has_value()) {
-  for (auto& record : result.value()) {
-    // Access columns via record.entries()
+  for (const auto& record : result.value()) {
+
   }
 } else {
   std::cerr << "Query failed: " << result.error().message() << std::endl;
@@ -83,7 +83,7 @@ if (result.has_value()) {
   - Use parameterized queries for dynamic values to prevent injection.
   - Specifying correct access_mode ensures proper transaction handling.
 
-- **Returns:** `result<QueryResult>` containing either:
+- **Returns:** result<QueryResult> containing either:
 
 - `QueryResult` with query results on success
 - Error status with message on failure

diff --git a/doc/source/reference/cpp_api/index.md b/doc/source/reference/cpp_api/index.md
@@ -43,7 +43,7 @@ int main() {
 
   // Process results
   if (result.has_value()) {
-    for (auto& record : result.value()) {
+    for (const auto& record : result.value()) {
       std::cout << record.ToString() << std::endl;
     }
   }

diff --git a/doc/source/reference/cpp_api/neug_db.md b/doc/source/reference/cpp_api/neug_db.md
@@ -15,7 +15,7 @@ db.Open("/path/to/data", 4);  // 4 threads
 auto conn = db.Connect();
 auto result = conn->Query("MATCH (n:Person) RETURN n LIMIT 10");
 // Process results
-for (auto& record : result.value()) {
+for (const auto& record : result.value()) {
   std::cout << record.ToString() << std::endl;
 }
 // Close database (persists data)
@@ -188,3 +188,10 @@ Remove a connection from the database.
   - This method is used to remove a connection when it is closed, to remove the handle from the database.
   - This method is not thread-safe, so it should be called only when the connection is closed. And should be only called internally.
 
+#### `CloseAllConnection()`
+
+Remove all connection from the database.
+
+- **Notes:**
+  - This method is used to remove all connection when tp svc created, to remove the handle from the database.
+