Struct IndexBuilder 

pub struct IndexBuilder { /* private fields */ }

Fluent builder for index creation.

Example

use interstellar::index::IndexBuilder;

// B+ tree index on person.age
let spec = IndexBuilder::vertex()
    .label("person")
    .property("age")
    .build()?;

// Unique index on user.email
let spec = IndexBuilder::vertex()
    .label("user")
    .property("email")
    .unique()
    .build()?;

// Edge index
let spec = IndexBuilder::edge()
    .label("purchased")
    .property("amount")
    .build()?;

Implementations

impl IndexBuilder

pub fn vertex() -> Self

Start building a vertex index.

pub fn edge() -> Self

Start building an edge index.

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

Set the label filter (only index elements with this label).

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

Set the property to index (required).

pub fn unique(self) -> Self

Make this a unique index (default is B+ tree).

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

Set explicit index name (default: auto-generated).

pub fn build(self) -> Result<IndexSpec, IndexError>

Build the index specification.

Errors

Returns IndexError::MissingProperty if the property was not set.

Trait Implementations

impl Clone for IndexBuilder

fn clone(&self) -> IndexBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.