Expand description
mongreldb-client — a lightweight HTTP client for mongreldb-server.
Hardened surface:
- Every call checks the HTTP status and returns a typed
ClientErroron non-2xx (the server’sKitErrorEnvelopeis decoded into [KitError::unique_violation]/fk_violation/etc.). - Typed
KitTxnRequest/KitTxnResponsemodels mirror the server’s/kit/txnbatch endpoint. MongrelClient::kit_schemafetches table metadata (columns + constraints).- Legacy SQL read (
MongrelClient::sql) returns Arrow IPC batches.
Structs§
- AiExecution
Options - Cooperative execution limits accepted by every Kit AI endpoint.
- Async
Mongrel Client - Async counterpart for Kit and health calls.
- Async
Mongrel Client Builder - Builder for an
AsyncMongrelClient. - Column
DefJson - Column
Meta - Constraint
Meta - History
Retention - Index
Meta - KitAnn
Rerank Hit - KitAnn
Rerank Request - KitAnn
Rerank Response - KitComponent
Score - KitQuery
Request - A native typed query (
POST /kit/query).conditionsare raw JSON objects mirroring the daemon’s condition variants, e.g.{"pk": {"value": 2}},{"range": {"column_id": 2, "lo": 0, "hi": 100}},{"ann": {"column_id": 5, "query": [...], "k": 10}}. - KitQuery
Response - KitQuery
Row - KitRetrieve
Request - KitRetrieve
Response - KitRetriever
Hit - KitScore
- KitSearch
Hit - KitSearch
Request - KitSearch
Response - KitSet
Similarity Hit - KitSet
Similarity Request - KitSet
Similarity Response - KitTxn
Request - A typed atomic batch request for
/kit/txn. - KitTxn
Response - Mongrel
Client - Mongrel
Client Builder - Builder for a blocking
MongrelClient. Authorization is installed as a sensitive default header, so every route uses it and debug output redacts it. - Procedure
Call Request - Procedure
Call Response - Procedure
Request - Procedure
Response - Procedures
Response - Remote
Options - Remote
Query Error Body - Remote
Query Error Response - Remote
Query Outcome - Remote
Query Status - Remote
SqlPage - Remote
SqlPage Limits - Remote
SqlPage Metadata - Remote
SqlQuery Handle - Remote
SqlReceipt - Remote
Terminal Error - Replication
Follower - A replication follower that polls a leader’s
/wal/streamendpoint and applies WAL records to a local database directory viaSharedWal::replay. - Server
Capabilities - SqlCancellation
Capabilities - SqlClient
Options - SqlIdempotency
Capabilities - SqlPage
Options - SqlPagination
Capabilities - Table
Schema Info - Server-side schema metadata for one table (subset of the server’s descriptor).
- Trigger
Request - Trigger
Response - Triggers
Response - TxnOp
Enums§
- Client
Error - A typed client error. Network/IO failures and non-2xx HTTP responses both
surface here; constraint violations from
/kit/txnare decoded into the matching variant so callers can branch on them. - KitError
Code - Typed error codes mirrored from the server’s Kit error envelope.
- KitOp
- One operation in a
/kit/txnbatch. - KitOp
Result - A typed per-op result from
/kit/txn. - KitVector
Metric - Remote
Auth - Remote
Cancel Outcome - Remote
Query Error Code
Type Aliases§
- Client
Result - Remote
SqlControl Options - Secret
String - Secret string type.