Struct RelevanceOrder 

pub struct RelevanceOrder {
    pub fields: Vec<String>,
    pub query: String,
}

The full-text operand of an ORDER BY clause (#1284).

Carries the search text as a value, not as SQL: unlike VectorDistanceOrder, whose literal is built from parsed numbers and is therefore safe to interpolate, this is arbitrary client input and is bound as a parameter by the renderer.

Why the fields are storage keys

The rank has to be computed over the same expression the search predicate matched on, or the ordering describes a different document from the one that was searched. build_fts_where_clause emits a WhereClause::Field, whose path WhereClause::from_graphql_json lowers to the snake_case storage key and the generator renders as data->>'key' — so these are storage keys and the renderer extracts them the same way.

Fields

fields: Vec<String>

The snake_case storage keys of the searchable fields the rank is computed over, in the order the predicate ORs them. Never empty — a rank over no document is refused at render time.

query: String

The raw websearch_to_tsquery text, exactly as the client sent it.

Trait Implementations

impl Clone for RelevanceOrder

fn clone(&self) -> RelevanceOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelevanceOrder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelevanceOrder

fn deserialize<__D>( __deserializer: __D, ) -> Result<RelevanceOrder, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RelevanceOrder

impl PartialEq for RelevanceOrder

fn eq(&self, other: &RelevanceOrder) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RelevanceOrder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RelevanceOrder