Skip to content

README.md

Latest commit

 

History

History
42 lines (35 loc) · 2.61 KB

README.md

File metadata and controls

42 lines (35 loc) · 2.61 KB

SQLRite Documentation

SQLRite is an embedded retrieval engine first. Start here if you want one current documentation set without the older sprint-era material.

Read This First

Goal Document
Understand the whole project /Users/jameskaranja/Developer/projects/SQLRight/PROJECT_README.md
Install and verify SQLRite /Users/jameskaranja/Developer/projects/SQLRight/docs/getting-started.md
Build an embedded app /Users/jameskaranja/Developer/projects/SQLRight/docs/embedded.md
Run CLI retrieval queries /Users/jameskaranja/Developer/projects/SQLRight/docs/querying.md
Use SQL-native retrieval /Users/jameskaranja/Developer/projects/SQLRight/docs/sql.md
Expose HTTP, gRPC, or MCP /Users/jameskaranja/Developer/projects/SQLRight/docs/server-api.md
Operate, benchmark, and package /Users/jameskaranja/Developer/projects/SQLRight/docs/operations.md, /Users/jameskaranja/Developer/projects/SQLRight/docs/distribution.md

Recommended Reading Order

  1. /Users/jameskaranja/Developer/projects/SQLRight/docs/getting-started.md
  2. /Users/jameskaranja/Developer/projects/SQLRight/docs/embedded.md
  3. /Users/jameskaranja/Developer/projects/SQLRight/docs/querying.md
  4. /Users/jameskaranja/Developer/projects/SQLRight/docs/sql.md
  5. /Users/jameskaranja/Developer/projects/SQLRight/docs/examples.md

Full Index

Topic Path
Detailed project guide /Users/jameskaranja/Developer/projects/SQLRight/PROJECT_README.md
Getting started /Users/jameskaranja/Developer/projects/SQLRight/docs/getting-started.md
Embedded Rust usage /Users/jameskaranja/Developer/projects/SQLRight/docs/embedded.md
CLI query patterns /Users/jameskaranja/Developer/projects/SQLRight/docs/querying.md
SQL retrieval /Users/jameskaranja/Developer/projects/SQLRight/docs/sql.md
Ingestion and reindexing /Users/jameskaranja/Developer/projects/SQLRight/docs/ingestion.md
HTTP, gRPC, MCP /Users/jameskaranja/Developer/projects/SQLRight/docs/server-api.md
Security /Users/jameskaranja/Developer/projects/SQLRight/docs/security.md
Migrations /Users/jameskaranja/Developer/projects/SQLRight/docs/migrations.md
Operations /Users/jameskaranja/Developer/projects/SQLRight/docs/operations.md
Performance /Users/jameskaranja/Developer/projects/SQLRight/docs/performance.md
Examples /Users/jameskaranja/Developer/projects/SQLRight/docs/examples.md
Distribution /Users/jameskaranja/Developer/projects/SQLRight/docs/distribution.md
Release policy /Users/jameskaranja/Developer/projects/SQLRight/docs/release_policy.md