Struct BulkOperation

pub struct BulkOperation<B> { /* private fields */ }

A bulk operation consists of a header that indicates the bulk action and the related metadata for the action, and an optional source document.

A collection of bulk operations can be sent to the Bulk API in the body of the API call.

For serializing a collection of bulk operations that model the source document of each bulk operation using different structs, take a look at BulkOperations.

Example

Using serde_json’s json! macro to constuct serde_json::Value from JSON literals, for the source document of each bulk operation

let mut ops: Vec<BulkOperation<Value>> = Vec::with_capacity(4);
ops.push(BulkOperation::index(json!({
        "user": "kimchy",
        "post_date": "2009-11-15T00:00:00Z",
        "message": "Trying out OpenSearch, so far so good?"
    }))
    .id("1")
    .pipeline("process_tweet")
    .into()
);
ops.push(BulkOperation::create("2", json!({
        "user": "forloop",
        "post_date": "2020-01-08T00:00:00Z",
        "message": "Indexing with the rust client, yeah!"
    }))
    .pipeline("process_tweet")
    .into()
);
ops.push(BulkOperation::update("3", json!({
        "doc": {
            "message": "Tweets are _meant_ to be immutable!"
        },
        "doc_as_upsert": true
    }))
    .into()
);
ops.push(BulkOperation::delete("4")
    .index("old_tweets")
    .into()
);

let bulk_response = client.bulk(BulkParts::Index("tweets"))
    .body(ops)
    .send()
    .await?;

Implementations

impl<B> BulkOperation<B>

where B: Serialize,

pub fn create<S>(id: S, source: B) -> BulkCreateOperation<B>

where S: Into<String>,

Creates a new instance of a bulk create operation

pub fn create_without_id(source: B) -> BulkCreateOperation<B>

Creates a new instance of bulk create operation without an explicit id

pub fn index(source: B) -> BulkIndexOperation<B>

Creates a new instance of a bulk index operation

pub fn delete<S>(id: S) -> BulkDeleteOperation<B>

where S: Into<String>,

Creates a new instance of a bulk delete operation

pub fn update<S>(id: S, source: B) -> BulkUpdateOperation<B>

where S: Into<String>,

Creates a new instance of a bulk update operation

Trait Implementations

impl<B> Body for BulkOperation<B>

where B: Serialize,

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

Write to a buffer that will be written to the request stream

fn bytes(&self) -> Option<Bytes>

An existing immutable buffer that can be used to avoid having to write to another buffer that will then be written to the request stream.

impl<B> From<BulkCreateOperation<B>> for BulkOperation<B>

fn from(b: BulkCreateOperation<B>) -> Self

Converts to this type from the input type.

impl<B> From<BulkDeleteOperation<B>> for BulkOperation<B>

fn from(b: BulkDeleteOperation<B>) -> Self

Converts to this type from the input type.

impl<B> From<BulkIndexOperation<B>> for BulkOperation<B>

fn from(b: BulkIndexOperation<B>) -> Self

Converts to this type from the input type.

impl<B> From<BulkUpdateOperation<B>> for BulkOperation<B>

fn from(b: BulkUpdateOperation<B>) -> Self

Converts to this type from the input type.