docs.rs failed to build laurus-server-0.3.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
laurus-server-0.2.1
laurus-server
gRPC server with HTTP/JSON gateway for the Laurus search engine.
Features
- Persistent engine -- The index stays open across requests; no WAL replay on every call
- Full gRPC API -- Index management, document CRUD, commit, and search (unary + streaming)
- HTTP Gateway -- Optional HTTP/JSON gateway alongside gRPC for REST-style access
- Health checking -- Standard health check endpoint for load balancers and orchestrators
- Graceful shutdown -- Pending changes are committed automatically on Ctrl+C / SIGINT
- TOML configuration -- Optional config file with CLI and environment variable overrides
Quick Start
# Start with default settings (gRPC on port 50051)
# Start with HTTP Gateway
# Start with a configuration file
gRPC Services
| Service | RPCs |
|---|---|
HealthService |
Check |
IndexService |
CreateIndex, GetIndex, GetSchema, AddField, DeleteField |
DocumentService |
PutDocument, AddDocument, GetDocuments, DeleteDocuments, Commit |
SearchService |
Search, SearchStream |
HTTP Gateway Endpoints
| Method | Path | Description |
|---|---|---|
GET |
/v1/health |
Health check |
POST |
/v1/index |
Create index |
GET |
/v1/index |
Get index stats |
GET |
/v1/schema |
Get schema |
POST |
/v1/schema/fields |
Add field |
DELETE |
/v1/schema/fields/{name} |
Delete field |
PUT |
/v1/documents/{id} |
Put (upsert) document |
POST |
/v1/documents/{id} |
Add document (chunk) |
GET |
/v1/documents/{id} |
Get documents |
DELETE |
/v1/documents/{id} |
Delete documents |
POST |
/v1/commit |
Commit changes |
POST |
/v1/search |
Search |
POST |
/v1/search/stream |
Streaming search (SSE) |
Documentation
License
This project is licensed under the MIT License - see the LICENSE file for details.