Struct oas_core::index::Index

pub struct Index { /* private fields */ }

ElasticSearch client.

The client is stateless. It only contains a HTTP client, the index name and the config on how to connect to ElasticSearch.

We use elasticsearch-rs, you can find the documentation on docs.rs.

Implementations

impl Index

pub fn new(
    client: Arc<Elasticsearch>,
    name: impl ToString,
    mapping: Value
) -> Self

Create a new Index client from an Elasticsearch client and index name.

pub fn index(&self) -> &str

Get the index name.

pub fn name(&self) -> &str

Get the index name.

pub fn client(&self) -> &Elasticsearch

Get the reference to the client.

pub async fn ensure_index(&self, delete: bool) -> Result<(), IndexError>

Inititialize ElasticSearch.

This creates the elasticsearch index with the default index mapping if it does not exists. It should be called before calling other methods on the client.

pub async fn put_typed_records<T: TypedValue>(
    &self,
    docs: &[Record<T>]
) -> Result<BulkPutResponse, IndexError>

Put a list of Records to the index.

Internally the Records are transformed to UntypedRecords, serialized and saved in a single bulk operation.

pub async fn put_untyped_records(
    &self,
    docs: &[UntypedRecord]
) -> Result<BulkPutResponse, IndexError>

Put a list of UntypedRecords to the index

pub async fn update_nested_record(
    &self,
    field: &str,
    record: &UntypedRecord
) -> Result<(), Error>

Update all nested documents on a top-level field with the value from an UntypedRecord.

We have a relation from [Post] to Media Because of this data model we have a nested field on the elasticsearch level which we have to update as soon as the data arrives. This function will usually be called with update from a ChangesStream.

See this Article for details on working with nested documents in ElasticSearch.

pub async fn query_records<Q: Serialize + Debug>(
    &self,
    query: Q
) -> Result<Vec<UntypedRecord>, Error>

pub async fn find_records_with_text_query(
    &self,
    query: &str
) -> Result<Vec<UntypedRecord>, Error>

Simple string query on the index.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.