Struct OpenSearchClient 

pub struct OpenSearchClient { /* private fields */ }

A handle to one OpenSearch cluster.

Implementations

impl OpenSearchClient

pub fn new(base_url: impl Into<String>) -> Self

base_url e.g. http://localhost:9200 (a trailing slash is tolerated).

pub fn with_client(self, http: Client) -> Self

Use a preconfigured reqwest::Client (timeouts, connection limits, TLS roots, headers).

pub fn with_basic_auth( self, user: impl Into<String>, password: impl Into<String>, ) -> Self

Send HTTP basic credentials with every request (the OpenSearch security plugin’s default).

pub fn with_bearer_token(self, token: impl Into<String>) -> Self

Send a bearer token with every request.

pub fn base_url(&self) -> &str

The cluster base URL, without a trailing slash.

pub async fn search(&self, index: &str, body: &Value) -> Result<Vec<Value>>

Run one _search against index and return each hit’s _source. A missing index (404) yields an empty result rather than an error, so a table over an index that has not been created yet simply reads as empty.

pub async fn search_page( &self, index: &str, body: &Value, keep_alive: Option<&str>, ) -> Result<SearchPage>

Run a _search, optionally opening a scroll cursor (keep_alive e.g. "1m") so the rest of the result can be paged with scroll. A missing index reads as empty.

pub async fn scroll( &self, scroll_id: &str, keep_alive: &str, ) -> Result<SearchPage>

Fetch the next page of an open scroll.

pub async fn clear_scroll(&self, scroll_id: &str)

Release a scroll cursor early (best effort — the server expires it anyway).

pub async fn mapping(&self, index: &str) -> Result<Value>

Fetch the index _mapping (the raw response, keyed by index name). A missing index is Error::IndexNotFound — unlike search, a caller asking for the schema of an index that does not exist has nothing sensible to fall back to.

pub async fn indices(&self) -> Result<Vec<String>>

The names of the cluster’s indices, sorted, excluding system indices (names starting with .). Aliases are not included.

Trait Implementations

impl Clone for OpenSearchClient

fn clone(&self) -> OpenSearchClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenSearchClient

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

Formats the value using the given formatter.