Skip to main content

Module rules

Module rules 

Source
Expand description

Declarative tenancy rules an implementer provides through TenancySpi.

These types are pure data: how to find the partition id, how to build the document _id, which fields to inject, and which to treat as sensitive. The crate::TenancySpi returns them; osproxy-tenancy interprets them. The interpretation is symmetric, a field injected on ingest is stripped on read (docs/02 §2, docs/03).

Structs§

DocIdRule
Rule to construct a document _id.
IdTemplate
A document-_id template with {partition} and {body.<path>} placeholders.
InjectedField
A field the proxy injects into every ingested document (and strips on read).
JsonPath
A dotted path into a JSON document, e.g. tenant_id or meta.tenant.
SensitivitySpec
Declares which document field values observability may capture.

Enums§

InjectedValue
How an InjectedField’s value is computed for a document.
PartitionKeySpec
How to find the partition id in a request.
PartitionKeySpecKind
The kind tag of a PartitionKeySpec, without its payload.