Struct Mongodb 

pub struct Mongodb { /* private fields */ }

Available on crate feature services-mongodb only.

Capabilities

Depending on its configuration and the backing system, this service can expose:

• create_dir
• stat
• read
• write
• delete
• list
• copy
• rename
• presign

Inspect the effective capability set with opendal_core::Operator::info and opendal_core::OperatorInfo::capability after building an operator.

Configuration

Use crate::MongodbConfig for serializable configuration and this builder’s methods for direct construction. The field and method documentation defines accepted values, defaults, and environment interaction.

Example

Via Builder

use anyhow::Result;
use opendal_service_mongodb::Mongodb;
use opendal_core::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Mongodb::default()
        .root("/")
        .connection_string("mongodb://myUser:myPassword@localhost:27017/myAuthDB")
        .database("your_database")
        .collection("your_collection")
        // key field type in the table should be compatible with Rust's &str like text
        .key_field("key")
        // value field type in the table should be compatible with Rust's Vec<u8> like bytea
        .value_field("value");

    let op = Operator::new(builder)?;
    Ok(())
}

Implementations

impl MongodbBuilder

pub fn connection_string(self, v: &str) -> MongodbBuilder

Set the connection_string of the MongoDB service.

This connection string is used to connect to the MongoDB service. It typically follows the format:

Format

mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]

Examples:

• Connecting to a local MongoDB instance: mongodb://localhost:27017
• Using authentication: mongodb://myUser:myPassword@localhost:27017/myAuthDB
• Specifying authentication mechanism: mongodb://myUser:myPassword@localhost:27017/myAuthDB?authMechanism=SCRAM-SHA-256

Options

• authMechanism: Specifies the authentication method to use. Examples include SCRAM-SHA-1, SCRAM-SHA-256, and MONGODB-AWS.
• … (any other options you wish to highlight)

For more information, please refer to MongoDB Connection String URI Format.

pub fn root(self, root: &str) -> MongodbBuilder

Set the working directory, all operations will be performed under it.

default: “/”

pub fn database(self, database: &str) -> MongodbBuilder

Set the database name of the MongoDB service to read/write.

pub fn collection(self, collection: &str) -> MongodbBuilder

Set the collection name of the MongoDB service to read/write.

pub fn key_field(self, key_field: &str) -> MongodbBuilder

Set the key field name of the MongoDB service to read/write.

Default to key if not specified.

pub fn value_field(self, value_field: &str) -> MongodbBuilder

Set the value field name of the MongoDB service to read/write.

Default to value if not specified.

Trait Implementations

impl Builder for MongodbBuilder

type Config = MongodbConfig

Associated configuration.

fn build(self) -> Result<impl Service, Error>

Consume the builder to build a service.

impl Debug for MongodbBuilder

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

Formats the value using the given formatter.

impl Default for MongodbBuilder

fn default() -> MongodbBuilder

Returns the “default value” for a type.