Struct Client

pub struct Client {
    pub application_id: String,
    pub api_token: String,
    pub api_version: ApiVersion,
    pub deployment_region: Option<String>,
}

Implements all the api calls, but doesn’t hold information about the selected collection or database

Fields

application_id: String

The application id, which is inserted into the query url

api_token: String

authentication using the apiKey header

api_version: ApiVersion

deployment_region: Option<String>

should be none, if deployed globally or .

Implementations

impl Client

pub fn new<'fn_lifetime>() -> ClientBuilder<'fn_lifetime, (), (), (), (), (), ()>

Creating a builder.

Required Fields

api_token

• Type: Into<String>

authentication using the apiKey header

application_id

• Type: Into<String>

The application id, which is inserted into the query url

Optional Fields

api_version

• Type: ApiVersion
• Default: ApiVersion :: v1

deployment_region

• Type: Into<Option < String >>
• Default: None

should be none, if deployed globally or .

impl Client

pub async fn find_one( &self, collection: Collection, filter: Option<Document>, projection: Option<Document>, http_client: &Client, ) -> Result<FindResponse, Error>

Find a Single Document

filter

A MongoDB Query Filter. The findOne action returns the first document in the collection that matches this filter. If you do not specify a filter, the action matches all document in the collection.

projection

A MongoDB Query Projection. Depending on the projection, the returned document will either omit specific fields or include only specified fields or values

pub async fn find( &self, collection: Collection, filter: Option<Document>, projection: Option<Document>, sort: Option<Document>, limit: Option<i32>, skip: Option<i32>, http_client: &Client, ) -> Result<FindResponse, Error>

Find Multiple Documents

filter

A MongoDB Query Filter. The find action returns documents in the collection that match this filter. If you do not specify a filter, the action matches all document in the collection. If the filter matches more documents than the specified limit, the action only returns a subset of them. You can use skip in subsequent queries to return later documents in the result set.

projection

A MongoDB Query Projection. Depending on the projection, the returned document will either omit specific fields or include only specified fields or values

sort

A MongoDB Sort Expression. Matched documents are returned in ascending or descending order of the fields specified in the expression.

limit

The maximum number of matched documents to include in the returned result set. Each request may return up to 50,000 documents.

skip

The number of matched documents to skip before adding matched documents to the result set.

pub async fn insert_one( &self, collection: Collection, document: Document, http_client: &Client, ) -> Result<InsertResponse, Error>

Insert a Single Document

document

An EJSON document to insert into the collection.

pub async fn insert( &self, collection: Collection, documents: Vec<Document>, http_client: &Client, ) -> Result<InsertResponse, Error>

Insert Multiple Documents

documents

An array of one or more EJSON documents to insert into the collection.

pub async fn update_one( &self, collection: Collection, filter: Document, update: Document, upsert: Option<bool>, http_client: &Client, ) -> Result<UpdateResponse, Error>

Update a Single Document

filter

A MongoDB Query Filter. The updateOne action modifies the first document in the collection that matches this filter.

update

A MongoDB Update Expression that specifies how to modify the matched document.

upsert

The upsert flag only applies if no documents match the specified filter. If true, the updateOne action inserts a new document that matches the filter with the specified update applied to it.

pub async fn update( &self, collection: Collection, filter: Document, update: Document, upsert: Option<bool>, http_client: &Client, ) -> Result<UpdateResponse, Error>

Update Multiple Documents

filter

A MongoDB Query Filter. The updateMany action modifies the first document in the collection that matches this filter.

update

A MongoDB Update Expression that specifies how to modify the matched document.

upsert

The upsert flag only applies if no documents match the specified filter. If true, the updateMany action inserts a new document that matches the filter with the specified update applied to it.

pub async fn replace_one( &self, collection: Collection, filter: Document, replacement: Document, upsert: Option<bool>, http_client: &Client, ) -> Result<ReplaceResponse, Error>

Replace a Single Document

filter

A MongoDB Query Filter. The replaceOne action overwrites the first document in the collection that matches this filter.

replacement

An EJSON document that overwrites the matched document.

upsert

The upsert flag only applies if no documents match the specified filter. If true, the replaceOne action inserts the replacement document.

pub async fn delete_one( &self, collection: Collection, filter: Document, http_client: &Client, ) -> Result<DeleteResponse, Error>

Delete a Single Document

filter

A MongoDB Query Filter. The deleteOne action deletes the first document in the collection that matches this filter.

pub async fn delete( &self, collection: Collection, filter: Document, http_client: &Client, ) -> Result<DeleteResponse, Error>

Delete Multiple Documents

filter

A MongoDB Query Filter. The deleteMany action deletes all documents in the collection that match this filter.

pub async fn aggregate( &self, collection: Collection, pipeline: Vec<Document>, http_client: &Client, ) -> Result<AggregationResponse, Error>

Run an Aggregation Pipeline

pipeline

A MongoDB Aggregation Pipeline.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.