metadata

Author: retroryan

.github/workflows/deploy-antora.yml

@@ -30,17 +30,20 @@ jobs:
         with:
           node-version: '20'
           cache: 'npm'
+          cache-dependency-path: docs/package-lock.json
 
       - name: Install dependencies
         run: npm ci
+        working-directory: docs
 
       - name: Build Antora site
         run: npm run build
+        working-directory: docs
 
       - name: Upload artifact for GitHub Pages
         uses: actions/upload-pages-artifact@v3
         with:
-          path: build/site
+          path: docs/build/site
 
   deploy:
     name: Deploy to GitHub Pages

GUIDE_NEO4J_UC.md

@@ -128,7 +128,7 @@ SELECT * FROM remote_query(
 
 ## Validated Test Results
 
-The following results are from running `full_uc_tests.py` against a Neo4j Aura instance:
+The following results are from testing against a Neo4j Aura instance:
 
 | Test | Status | Result |
 |------|--------|--------|
@@ -382,43 +382,6 @@ spark.databricks.safespark.jdbcSandbox.size.default.mib 512
 
 ---
 
-## Running the Test Suite
-
-A comprehensive test suite is available to validate your UC JDBC setup:
-
-```python
-# In Databricks notebook
-%run ./full_uc_tests
-
-# Or execute directly
-exec(open("/Workspace/path/to/full_uc_tests.py").read())
-```
-
-The test suite:
-- Loads configuration from Databricks Secrets
-- Creates/recreates the UC JDBC connection
-- Runs 12 tests covering all supported and unsupported patterns
-- Wraps all tests in try/except to prevent crashes
-- Provides detailed timing and results summary
-
-**Expected output:**
-```
-============================================================
-SUMMARY
-============================================================
-
-Total Tests: 12
-  Passed: 9
-  Failed: 0
-  Expected Failures: 3
-
-Success Rate: 100% (excluding expected failures)
-
-Total Execution Time: 194.1s
-```
-
----
-
 ## References
 
 ### Documentation
@@ -428,13 +391,15 @@ Total Execution Time: 194.1s
 - [Databricks Unity Catalog JDBC](https://docs.databricks.com/aws/en/connect/jdbc-connection)
 - [Spark JDBC Data Sources](https://spark.apache.org/docs/latest/sql-data-sources-jdbc.html)
 
-### Test Suite Files
+### Notebooks
 
 | File | Description |
 |------|-------------|
-| `uc-neo4j-test-suite/full_uc_tests.py` | Standalone Python test suite for Databricks |
-| `uc-neo4j-test-suite/neo4j_databricks_sql_translation.ipynb` | Full test notebook (Sections 1-8) |
-| `uc-neo4j-test-suite/neo4j_schema_test.ipynb` | Schema testing notebook (Sections 1, 3, 8) |
+| `uc-neo4j-test-suite/neo4j_databricks_sql_translation.ipynb` | UC JDBC connection and SQL-to-Cypher translation tests |
+| `uc-neo4j-test-suite/metadata_sync_delta.ipynb` | Metadata sync via materialized Delta tables |
+| `uc-neo4j-test-suite/metadata_sync_external.ipynb` | Metadata sync via External Metadata API |
+| `uc-neo4j-test-suite/federated_lakehouse_query.ipynb` | Federated query testing |
+| `uc-neo4j-test-suite/federated_views_agent_ready.ipynb` | Agent-ready federated views |
 
 ### Additional Examples
 

NEO4J_UC_INTEGRATION_REPORT.md

@@ -201,7 +201,7 @@ This would unlock row-level data access, GROUP BY, ORDER BY, and LIMIT through t
 
 ## Prototype Validation: Query Patterns
 
-We ran a 12-test suite (`full_uc_tests.py`) against a live Neo4j Aura instance through the UC JDBC connection. Total execution time was approximately 194 seconds, with most time spent on connection initialization rather than query execution.
+We ran a 12-test suite against a live Neo4j Aura instance through the UC JDBC connection. Total execution time was approximately 194 seconds, with most time spent on connection initialization rather than query execution.
 
 ### Passing Tests (9/9 supported patterns)
 

README.md

@@ -95,10 +95,13 @@ df.show()
 ```
 neo4j-uc-integration/
 ├── GUIDE_NEO4J_UC.md              # Detailed usage guide
-├── uc-neo4j-test-suite/           # Databricks notebooks and test suite
-│   ├── full_uc_tests.py           # Standalone Python test suite
-│   ├── neo4j_databricks_sql_translation.ipynb  # Full test notebook
-│   └── neo4j_schema_test.ipynb    # Schema testing notebook
+├── METADATA.md                    # Metadata synchronization design
+├── uc-neo4j-test-suite/           # Databricks notebooks
+│   ├── neo4j_databricks_sql_translation.ipynb  # UC JDBC and SQL translation tests
+│   ├── metadata_sync_delta.ipynb              # Metadata sync via Delta tables
+│   ├── metadata_sync_external.ipynb           # Metadata sync via External Metadata API
+│   ├── federated_lakehouse_query.ipynb        # Federated query testing
+│   └── federated_views_agent_ready.ipynb      # Agent-ready federated views
 ├── pyspark-translation-example/   # Local PySpark SQL translation tests
 ├── sample-sql-translation/        # Spring Boot JDBC connectivity demo
 ├── java-metadata-demo/            # Java JDBC metadata exploration
@@ -113,15 +116,9 @@ neo4j-uc-integration/
 
 Import notebooks from `uc-neo4j-test-suite/` to your Databricks workspace:
 
-1. **neo4j_databricks_sql_translation.ipynb** - Full test suite covering network, drivers, direct JDBC, and UC JDBC
-2. **neo4j_schema_test.ipynb** - Focused schema testing
-
-Or run the standalone test suite:
-
-```python
-# In a Databricks notebook
-%run ./full_uc_tests
-```
+1. **neo4j_databricks_sql_translation.ipynb** - UC JDBC connection and SQL-to-Cypher translation tests
+2. **metadata_sync_delta.ipynb** - Metadata sync via materialized Delta tables
+3. **metadata_sync_external.ipynb** - Metadata sync via External Metadata API
 
 ### Local PySpark Tests
 

antora-playbook.yml docs/antora-playbook.ymlantora-playbook.yml renamed to docs/antora-playbook.yml

@@ -7,7 +7,7 @@ content:
   sources:
   - url: .
     branches: HEAD
-    start_path: docs
+    start_path: .
 
 ui:
   bundle:

architecture-overview.excalidraw docs/architecture-overview.excalidrawarchitecture-overview.excalidraw renamed to docs/architecture-overview.excalidraw

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "description": "Neo4j UC Integration - Federated Query Patterns Documentation",
   "scripts": {
-    "convert-diagrams": "node docs/scripts/convert-excalidraw.js",
+    "convert-diagrams": "node scripts/convert-excalidraw.js",
     "build": "antora antora-playbook.yml",
     "serve": "npx http-server build/site -p 8080 -o"
   },