Struct SearchQuery 

pub struct SearchQuery {
    pub search_term: NormalizedTermValue,
    pub search_terms: Option<Vec<NormalizedTermValue>>,
    pub operator: Option<LogicalOperator>,
    pub skip: Option<usize>,
    pub limit: Option<usize>,
    pub role: Option<RoleName>,
    pub layer: Layer,
    pub include_pinned: bool,
}

A search query for finding documents in the knowledge graph.

Supports both single-term and multi-term queries with logical operators (AND/OR). Results can be paginated using skip and limit, and scoped to specific roles.

Examples

Single-term query

use terraphim_types::{SearchQuery, NormalizedTermValue, Layer, RoleName};

let query = SearchQuery {
    search_term: NormalizedTermValue::from("machine learning"),
    search_terms: None,
    operator: None,
    skip: None,
    limit: Some(10),
    role: Some(RoleName::new("data_scientist")),
    layer: Layer::default(),
    include_pinned: false,
};

Multi-term AND query

use terraphim_types::{SearchQuery, NormalizedTermValue, LogicalOperator, RoleName};

let query = SearchQuery::with_terms_and_operator(
    NormalizedTermValue::from("rust"),
    vec![NormalizedTermValue::from("async"), NormalizedTermValue::from("tokio")],
    LogicalOperator::And,
    Some(RoleName::new("engineer")),
);
assert!(query.is_multi_term_query());
assert_eq!(query.get_all_terms().len(), 3);

Fields

search_term: NormalizedTermValue

Primary search term for backward compatibility

search_terms: Option<Vec<NormalizedTermValue>>

Multiple search terms for logical operations

operator: Option<LogicalOperator>

Logical operator for combining multiple terms (defaults to OR if not specified)

skip: Option<usize>

Number of results to skip (for pagination)

limit: Option<usize>

Maximum number of results to return

role: Option<RoleName>

Role context for this search

layer: Layer

Output layer for controlling result detail (1=minimal, 2=summary, 3=full)

include_pinned: bool

Include pinned KG entries in results even if they don’t match the query

Implementations

impl SearchQuery

pub fn get_all_terms(&self) -> Vec<&NormalizedTermValue>

Get all search terms (both single and multiple)

pub fn is_multi_term_query(&self) -> bool

Check if this is a multi-term query with logical operators

pub fn get_operator(&self) -> LogicalOperator

Get the effective logical operator (defaults to Or for multi-term queries)

pub fn with_terms_and_operator( primary_term: NormalizedTermValue, additional_terms: Vec<NormalizedTermValue>, operator: LogicalOperator, role: Option<RoleName>, ) -> Self

Create a new SearchQuery with multiple terms and an operator

Trait Implementations

impl Clone for SearchQuery

fn clone(&self) -> SearchQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchQuery

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

Formats the value using the given formatter.

impl Default for SearchQuery

fn default() -> SearchQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SearchQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.