laurus-server 0.3.0

gRPC server for the Laurus search engine
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# laurus-server

[![Crates.io](https://img.shields.io/crates/v/laurus-server.svg)](https://crates.io/crates/laurus-server)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

gRPC server with HTTP/JSON gateway for the [Laurus](https://github.com/mosuka/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

```bash
# Start with default settings (gRPC on port 50051)
laurus serve

# Start with HTTP Gateway
laurus serve --http-port 8080

# Start with a configuration file
laurus serve --config config.toml
```

## 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

- [Server Guide](https://mosuka.github.io/laurus/laurus-server.html)
- [Getting Started](https://mosuka.github.io/laurus/laurus-server/getting_started.html)
- [Configuration](https://mosuka.github.io/laurus/laurus-server/configuration.html)
- [gRPC API Reference](https://mosuka.github.io/laurus/laurus-server/grpc_api.html)
- [HTTP Gateway](https://mosuka.github.io/laurus/laurus-server/http_gateway.html)
- [Tutorial](https://mosuka.github.io/laurus/laurus-server/tutorial.html)

## License

This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details.