Skip to content

docs(readme): add DeltaGraph / Databricks mention#341

Merged
genezhang merged 2 commits into
mainfrom
docs/readme-deltagraph-mention
May 17, 2026
Merged

docs(readme): add DeltaGraph / Databricks mention#341
genezhang merged 2 commits into
mainfrom
docs/readme-deltagraph-mention

Conversation

@genezhang
Copy link
Copy Markdown
Owner

Summary

  • DeltaGraph is the headline 0.6.7-dev feature but had zero README mention. Visitors hitting the repo landing page had no signal it existed.
  • Adds two anchors:
    • What's New in v0.6.7-dev: full DeltaGraph bullet covering dialect routing, executor, embedded/FFI/cg surfaces, deltagraph server binary, YAML catalog: field, and the pending items (MERGE, OAuth M2M, full LDBC, external-link result chunks).
    • Features → Core Capabilities: a top-level entry alongside Embedded Mode and Remote Mode, with a link to docs/deltagraph/QUICKSTART.md.
  • No code changes; CHANGELOG / STATUS / QUICKSTART already covered the feature — this just makes the README a complete source of truth.

Test plan

  • No code changes; nothing to test beyond rendering. Verified the markdown links resolve.

🤖 Generated with Claude Code

DeltaGraph (Databricks SQL Warehouse support) is the headline 0.6.7-dev
feature but had zero README coverage — visitors hitting the repo
landing page had no signal it exists, and the "What's New" section for
0.6.7-dev only mentioned the embedded writes work.

Adds:
- "What's New in v0.6.7-dev" bullet covering the full scope (dialect
  routing, executor, embedded/FFI/`cg` surfaces, `deltagraph` server
  binary, YAML catalog field) and the pending items.
- A top-level Features entry alongside Embedded Mode and Remote Mode,
  pointing at the QUICKSTART for the manual walkthrough.

No code changes; CHANGELOG / STATUS / QUICKSTART already covered this
feature — this just makes the README the same source of truth.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 17, 2026 04:33
github-actions[bot]
github-actions Bot previously approved these changes May 17, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the README to surface DeltaGraph / Databricks SQL Warehouse support as a v0.6.7-dev feature and core capability.

Changes:

  • Adds a detailed DeltaGraph bullet under “What’s New in v0.6.7-dev”.
  • Adds DeltaGraph to the “Core Capabilities” feature list with a quickstart link.

Comment thread README.md Outdated
- **Stateless Architecture** - Offloads all query execution to ClickHouse; no extra datastore required
- **Embedded Mode** - In-process graph queries over Parquet/Iceberg/Delta/S3 via chdb; no ClickHouse server needed (`--features embedded`)
- **Remote Mode** - Cypher translated locally, executed against external ClickHouse — no chdb required (`Database::new_remote`)
- **DeltaGraph (Databricks SQL Warehouse)** - Cypher translated to Spark SQL locally and executed against a Databricks SQL Warehouse via the Statement Execution API. Opt-in `--features databricks`; ships the `deltagraph` server binary, `cg --dialect databricks`, and `Database::new_databricks` for embedded/FFI callers. See [docs/deltagraph/QUICKSTART.md](docs/deltagraph/QUICKSTART.md).
Address PR #341 Copilot review: the feature-list entry said
`Database::new_databricks` for both embedded and FFI callers, but
the FFI surface is `Database::open_databricks` (see clickgraph-ffi/
src/lib.rs). Conflating them would send Go/Python users to a
nonexistent constructor.

Now matches the split already used in the "What's New" bullet on
line 21.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@genezhang genezhang merged commit 37311a3 into main May 17, 2026
4 checks passed
@genezhang genezhang deleted the docs/readme-deltagraph-mention branch May 17, 2026 04:44
genezhang added a commit that referenced this pull request May 17, 2026
- PR provenance: align with CHANGELOG (engineering PRs #316#338,
  follow-ups #339/#340/#341 noted separately) instead of claiming the
  full range was all engineering work
- Correctness gate + exit criterion: exclude bi-16 explicitly (blocked
  on CALL subqueries; was an impossible gate as written)
- MERGE: move out of "explicitly out of scope" into a should-land-before-GA
  bullet, matching STATUS.md / CHANGELOG.md which both list MERGE as
  pending before Databricks GA. Flag the QUICKSTART wording mismatch
  for reconciliation when MERGE lands.
- Local-dataset seeding: point at benchmarks/ldbc_snb/schemas/ for the
  actual LDBC label set; clarify that social_benchmark.yaml is dev-only
  sanity coverage, not LDBC

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants