Struct opendal::services::Mongodb

pub struct Mongodb { /* private fields */ }

Available on crate feature services-mongodb only.

Capabilities

This service can be used to:

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

Configuration

• root: Set the working directory of OpenDAL
• connection_string: Set the connection string of mongodb server
• database: Set the database of mongodb
• collection: Set the collection of mongodb
• key_field: Set the key field of mongodb
• value_field: Set the value field of mongodb

Example

Via Builder

use anyhow::Result;
use opendal::services::Mongodb;
use opendal::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)?.finish();
    Ok(())
}

Implementations

impl MongodbBuilder

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

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) -> Self

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

default: “/”

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

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

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

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

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

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) -> Self

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

Default to value if not specified.

Trait Implementations

impl Builder for MongodbBuilder

const SCHEME: Scheme = Scheme::Mongodb

Associated scheme for this builder. It indicates what underlying service is.

type Config = MongodbConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access>

Consume the accessor builder to build a service.

impl Debug for MongodbBuilder

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

Formats the value using the given formatter.

impl Default for MongodbBuilder

fn default() -> MongodbBuilder

Returns the “default value” for a type.