Struct ProjectionBuilder 

pub struct ProjectionBuilder { /* private fields */ }

Fluent builder for a Projection.

Implementations

impl ProjectionBuilder

pub fn name(self, value: impl Into<String>) -> Self

Set the human-readable projection name.

pub fn version(self, value: u32) -> Self

Set the projection version.

pub fn content_type(self, value: ContentType) -> Self

Set the wire codec the projector decodes records with.

pub fn extraction(self, value: IndexSchema) -> Self

Set the full index schema (instead of field/vector_field).

pub fn graph(self, schema: EntitySchema) -> Self

Make this a graph projection with the given node/edge extraction plan.

pub fn field(self, name: impl Into<String>) -> Self

Index a field by name (extracted at its matching JSON pointer).

pub fn fields<I, S>(self, names: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Bulk version of field: declare many top-level indexed fields in one call. Each name n lands at JSON pointer /n. For nested pointers use field_at instead.

pub fn field_at( self, name: impl Into<String>, pointer: impl Into<String>, ) -> Self

Index a field name from an explicit JSON pointer.

pub fn field_typed(self, name: impl Into<String>, field_type: FieldType) -> Self

Like field but with a storage-type hint for columnar backends (FieldType::Int, Float, Bool, Text). The embedded engine ignores the hint.

pub fn field_at_typed( self, name: impl Into<String>, pointer: impl Into<String>, field_type: FieldType, ) -> Self

Like field_at but with a storage-type hint.

pub fn vector_field(self, pointer: impl Into<String>) -> Self

Extract the embedding vector from this JSON pointer.

pub fn inline_payload(self) -> Self

Inline the original payload alongside the materialized row. This is the default for projections built through Projection::builder, so calling it is redundant. It stays in the API for callers who want to be explicit. To opt out, use index_only.

pub fn index_only(self) -> Self

Opt out of inlining the body. The materialized row keeps only the indexed scalars declared via field / field_at (and any vector extracted via vector_field). The full payload is not duplicated into the index. Use this when:

• the body is large and you already store it elsewhere (object store, OLAP table) and only need a fast queryable secondary index, or
• you are pushing extreme throughput and the index DB cost of a body copy is not worth it.

The Iggy log retains the original bytes either way, so a future projector rebuild can re-inline. With index_only, typed fetches return rows whose payload is None. Callers either decode from the indexed columns or replay from the log.

pub fn build(self) -> Projection

Finish the projection.