Struct GroupingComponent 

pub struct GroupingComponent { /* private fields */ }

Group documents by a field or query.

Examples

use solrstice::{GroupingComponent, SelectQuery, SolrBasicAuth, SolrSingleServerHost};
let response = SelectQuery::new()
    .fq(["age:[* TO *]"])
    .grouping(&GroupingComponent::new().fields(["age"]).limit(10))
    .execute(&context, "collection_name")
    .await?;
let groups = response.get_groups().ok_or("No groups")?;
let age_group = groups.get("age").ok_or("No age group")?;

for group in age_group.get_field_result().ok_or("No field result")? {
    println!("Group key: {}", group.get_group_value::<usize>()?);
    let docs = group.get_doc_list().get_docs::<serde_json::Value>()?;
}

Implementations

impl GroupingComponent

pub fn new() -> Self

Create a new GroupingComponentBuilder.

Examples

use solrstice::{GroupingComponent, SelectQuery, SolrBasicAuth, SolrSingleServerHost};
let response = SelectQuery::new()
    .fq(["age:[* TO *]"])
    .grouping(&GroupingComponent::new().fields(["age"]).limit(10))
    .execute(&context, "collection_name")
    .await?;
let groups = response.get_groups().ok_or("No groups")?;
let age_group = groups.get("age").ok_or("No age group")?;

for group in age_group.get_field_result().ok_or("No field result")? {
    println!("Group key: {}", group.get_group_value::<usize>()?);
    let docs = group.get_doc_list().get_docs::<serde_json::Value>()?;
}

pub fn fields<S: Into<String>, I: IntoIterator<Item = S>, O: Into<Option<I>>>( self, fields: O, ) -> Self

Fields to group by.

Examples

use solrstice::GroupingComponent;
GroupingComponent::new().fields(["age"]);

pub fn queries<S: Into<String>, I: IntoIterator<Item = S>, O: Into<Option<I>>>( self, queries: O, ) -> Self

Queries to group by.

Examples

use solrstice::GroupingComponent;
GroupingComponent::new().queries(["age:[0 TO 59]", "age:[60 TO *]"]);

pub fn limit<O: Into<Option<usize>>>(self, limit: O) -> Self

Maximum number of documents per group.

Examples

use solrstice::GroupingComponent;
GroupingComponent::new().limit(10);

pub fn offset<O: Into<Option<usize>>>(self, offset: O) -> Self

Initial offset

Examples

use solrstice::GroupingComponent;
GroupingComponent::new().limit(10).offset(10);

pub fn sort<S: Into<String>, I: IntoIterator<Item = S>, O: Into<Option<I>>>( self, sort: O, ) -> Self

How to sort the documents in the groups.

Examples

use solrstice::GroupingComponent;
GroupingComponent::new().sort(["age asc"]);

pub fn format<O: Into<Option<GroupFormatting>>>(self, format: O) -> Self

How to format the groups.

Examples

use solrstice::{GroupingComponent, GroupFormatting};
GroupingComponent::new().format(GroupFormatting::Simple);

pub fn main<O: Into<Option<bool>>>(self, main: O) -> Self

Put the results in the main result set.

Examples

use solrstice::GroupingComponent;
GroupingComponent::new().main(true);

pub fn n_groups<O: Into<Option<bool>>>(self, n_groups: O) -> Self

Include the number of groups that have matched the query.

Examples

use solrstice::GroupingComponent;
GroupingComponent::new().n_groups(true);

pub fn truncate<O: Into<Option<bool>>>(self, truncate: O) -> Self

Not really sure what this does.

pub fn facet<O: Into<Option<bool>>>(self, facet: O) -> Self

Not really sure what this does.

Trait Implementations

impl AsRef<GroupingComponent> for GroupingComponent

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for GroupingComponent

fn clone(&self) -> GroupingComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupingComponent

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

Formats the value using the given formatter.

impl Default for GroupingComponent

fn default() -> GroupingComponent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GroupingComponent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&GroupingComponent> for GroupingComponent

fn from(component: &GroupingComponent) -> Self

Converts to this type from the input type.

impl PartialEq for GroupingComponent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GroupingComponent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GroupingComponent