Struct merino_wikipedia::ElasticHelper

pub struct ElasticHelper {
    pub client: Elasticsearch,
    pub index_name: String,
}

A wrapper around an Elasticsearch client to make common operations easier and more consistent.

Fields

client: Elasticsearch

The ES client this helper users.

index_name: String

The search index this helper targets.

Implementations

impl ElasticHelper

pub fn new<S: Into<String>>(
    es_settings: &ElasticsearchSettings,
    index_name: S
) -> Result<Self>

Create a new ElasticHelper that connects to the server specified in settings and uses the index specified in [index_name].

Errors

If the settings to connect to Elasticsearch are not valid, the creation process may fail.

pub async fn index_exists(&self) -> Result<bool>

Check that the helper’s index exists.

Errors

If there is an HTTP error communication with ES.

pub async fn index_create(&self) -> Result<()>

Creates the helper’s index, assuming it doesn’t already exist.

Errors

If the index already exists, or if there is an HTTP error communication with ES.

pub async fn index_ensure_exists(&self) -> Result<()>

Ensure that the helper’s index exists, creating it if needed.

Errors

If there is an HTTP error communication with ES.

pub async fn doc_add<T>(&self, doc: T) -> Result<()> where
    T: HelperIndexable, 

Add a document to the helper’s index. The ID of the document will be set based on the HelperIndexable::doc_id method.

Errors

If there is an HTTP error communication with ES, or if there is a problem serializing the document.