Skip to content

docs: add SQL RAG schema-context application to README - #72

Open
mingjerli wants to merge 1 commit into
mainfrom
docs/sql-rag-application
Open

docs: add SQL RAG schema-context application to README#72
mingjerli wants to merge 1 commit into
mainfrom
docs/sql-rag-application

Conversation

@mingjerli

Copy link
Copy Markdown
Owner

Summary

  • Positions clgraph as the context layer for SQL RAG (retrieval-augmented text-to-SQL) systems: clgraph does not do retrieval or embedding, but produces lineage-aware, description-rich, PII-filtered schema context that any retrieval stack can index
  • Adds SQL RAG? Schema context is graph export. to the "One graph. Many applications." list
  • Adds an SQL RAG context bullet under LLM-Powered Features
  • Adds a new README section "SQL RAG: Schema Context for Retrieval Pipelines" after the Text-to-SQL section, with two code examples:
    • Building one retrieval document per table with PII columns filtered out
    • Expanding retrieved context with trace_column_backward() at question time
  • Adds a SQL RAG bullet to the Use Cases section

Test plan

  • Both new code examples executed against the current API: the PII filter drops email from the analytics.customers document, and the backward trace resolves lifetime_value to raw.customers.lifetime_value
  • All APIs referenced (get_columns_by_table, col.pii, trace_column_backward, propagate_all_metadata, generate_all_descriptions, to_json) verified to exist in src/clgraph/pipeline.py / models.py
  • make pre-commit hooks passed (ruff format + lint clean; ty diagnostics are pre-existing and non-blocking)

Companion docs-site PR adds a matching "SQL RAG" use case page section.

Position clgraph as the context layer for retrieval-augmented
text-to-SQL systems: a new section after Text-to-SQL shows how to
build PII-filtered, description-rich retrieval documents from the
lineage graph and expand retrieved context with backward tracing.
Also adds SQL RAG to the applications list, LLM feature bullets,
and Use Cases. Both code examples verified against the current API.
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.

1 participant