pub struct MongoStore { /* private fields */ }Expand description
A reusable MongoDB client and selected database.
Implementations§
Source§impl MongoStore
impl MongoStore
Sourcepub async fn connect(config: MongoStoreConfig) -> Result<Self, MongoStoreError>
pub async fn connect(config: MongoStoreConfig) -> Result<Self, MongoStoreError>
Examples found in repository?
examples/external_stores.rs (line 15)
7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8 let redis_url = env::var("REDIS_URL").unwrap_or_else(|_| "redis://127.0.0.1/".to_owned());
9 let mongo_url =
10 env::var("MONGODB_URI").unwrap_or_else(|_| "mongodb://127.0.0.1:27017".to_owned());
11 let sqlite_url = env::var("DATABASE_URL").unwrap_or_else(|_| "sqlite::memory:".to_owned());
12
13 let redis = RedisStore::new(RedisStoreConfig::new(redis_url))?;
14 let sql = SqliteStore::connect_sqlite(SqlStoreConfig::new(sqlite_url)).await?;
15 let mongo = MongoStore::connect(MongoStoreConfig::new(mongo_url, "rust_zero_example")).await?;
16
17 redis.ping().await?;
18 sql.health_check().await?;
19 mongo.health_check().await?;
20 println!("Redis, SQLite, and MongoDB are ready");
21 Ok(())
22}pub fn from_client( client: Client, database: impl AsRef<str>, ) -> Result<Self, MongoStoreError>
Sourcepub fn with_metrics(self, metrics: MongoStoreMetrics) -> Self
pub fn with_metrics(self, metrics: MongoStoreMetrics) -> Self
Installs metrics for operations run through the typed helper methods.
pub fn client(&self) -> &Client
pub fn database(&self) -> &Database
pub fn collection<T>(&self, name: impl AsRef<str>) -> Collection<T>
pub fn cached_collection<K, T>( &self, name: impl AsRef<str>, config: MongoCacheConfig, ) -> CachedMongoCollection<K, T>
Sourcepub fn cached_indexed_collection<K, I, T>(
&self,
name: impl AsRef<str>,
config: MongoCacheConfig,
) -> CachedMongoCollection<K, T, I>
pub fn cached_indexed_collection<K, I, T>( &self, name: impl AsRef<str>, config: MongoCacheConfig, ) -> CachedMongoCollection<K, T, I>
Creates a cached collection with distinct primary- and secondary-key types.
Sourcepub async fn health_check(&self) -> Result<(), MongoStoreError>
pub async fn health_check(&self) -> Result<(), MongoStoreError>
Examples found in repository?
examples/external_stores.rs (line 19)
7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8 let redis_url = env::var("REDIS_URL").unwrap_or_else(|_| "redis://127.0.0.1/".to_owned());
9 let mongo_url =
10 env::var("MONGODB_URI").unwrap_or_else(|_| "mongodb://127.0.0.1:27017".to_owned());
11 let sqlite_url = env::var("DATABASE_URL").unwrap_or_else(|_| "sqlite::memory:".to_owned());
12
13 let redis = RedisStore::new(RedisStoreConfig::new(redis_url))?;
14 let sql = SqliteStore::connect_sqlite(SqlStoreConfig::new(sqlite_url)).await?;
15 let mongo = MongoStore::connect(MongoStoreConfig::new(mongo_url, "rust_zero_example")).await?;
16
17 redis.ping().await?;
18 sql.health_check().await?;
19 mongo.health_check().await?;
20 println!("Redis, SQLite, and MongoDB are ready");
21 Ok(())
22}Sourcepub async fn query<T, R, F, Fut>(
&self,
operation: &'static str,
collection: impl AsRef<str>,
query: F,
) -> Result<R, MongoStoreError>where
T: Send + Sync,
F: FnOnce(Collection<T>) -> Fut,
Fut: Future<Output = Result<R, DriverError>>,
pub async fn query<T, R, F, Fut>(
&self,
operation: &'static str,
collection: impl AsRef<str>,
query: F,
) -> Result<R, MongoStoreError>where
T: Send + Sync,
F: FnOnce(Collection<T>) -> Fut,
Fut: Future<Output = Result<R, DriverError>>,
Runs a typed collection query with consistent metrics, tracing, and error conversion.
Sourcepub async fn query_one<T, F, Fut>(
&self,
operation: &'static str,
collection: impl AsRef<str>,
entity: impl Into<String>,
query: F,
) -> Result<T, MongoStoreError>where
T: Send + Sync,
F: FnOnce(Collection<T>) -> Fut,
Fut: Future<Output = Result<Option<T>, DriverError>>,
pub async fn query_one<T, F, Fut>(
&self,
operation: &'static str,
collection: impl AsRef<str>,
entity: impl Into<String>,
query: F,
) -> Result<T, MongoStoreError>where
T: Send + Sync,
F: FnOnce(Collection<T>) -> Fut,
Fut: Future<Output = Result<Option<T>, DriverError>>,
Runs an optional query and converts an absent document into a stable not-found error.
Sourcepub async fn execute<T, R, F, Fut>(
&self,
operation: &'static str,
collection: impl AsRef<str>,
execute: F,
) -> Result<R, MongoStoreError>where
T: Send + Sync,
F: FnOnce(Collection<T>) -> Fut,
Fut: Future<Output = Result<R, DriverError>>,
pub async fn execute<T, R, F, Fut>(
&self,
operation: &'static str,
collection: impl AsRef<str>,
execute: F,
) -> Result<R, MongoStoreError>where
T: Send + Sync,
F: FnOnce(Collection<T>) -> Fut,
Fut: Future<Output = Result<R, DriverError>>,
Runs a typed collection mutation with consistent metrics and tracing.
Sourcepub async fn bulk_insert<T>(
&self,
operation: &'static str,
collection: impl AsRef<str>,
items: impl IntoIterator<Item = T>,
batch_size: usize,
) -> Result<Vec<InsertManyResult>, MongoStoreError>
pub async fn bulk_insert<T>( &self, operation: &'static str, collection: impl AsRef<str>, items: impl IntoIterator<Item = T>, batch_size: usize, ) -> Result<Vec<InsertManyResult>, MongoStoreError>
Inserts documents with MongoDB’s native insert_many in bounded batches.
Sourcepub async fn begin(&self) -> Result<ClientSession, MongoStoreError>
pub async fn begin(&self) -> Result<ClientSession, MongoStoreError>
Starts a client session and transaction. Pass the returned session to each operation.
Trait Implementations§
Source§impl Clone for MongoStore
impl Clone for MongoStore
Source§fn clone(&self) -> MongoStore
fn clone(&self) -> MongoStore
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl !RefUnwindSafe for MongoStore
impl !UnwindSafe for MongoStore
impl Freeze for MongoStore
impl Send for MongoStore
impl Sync for MongoStore
impl Unpin for MongoStore
impl UnsafeUnpin for MongoStore
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
Source§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> ServiceExt for T
impl<T> ServiceExt for T
Source§fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
Apply a transformation to the response body. Read more
Source§fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
High level tracing that classifies responses using HTTP status codes. Read more
Source§fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
High level tracing that classifies responses using gRPC headers. Read more
Source§fn follow_redirects(self) -> FollowRedirect<Self>where
Self: Sized,
fn follow_redirects(self) -> FollowRedirect<Self>where
Self: Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.