pub struct MongoClient { /* private fields */ }Expand description
A MongoDB client with connection pooling.
The MongoDB driver handles connection pooling internally, so this client wraps the driver’s Client with additional Prax-specific functionality.
Implementations§
Source§impl MongoClient
impl MongoClient
Sourcepub async fn new(config: MongoConfig) -> MongoResult<Self>
pub async fn new(config: MongoConfig) -> MongoResult<Self>
Create a new client from configuration.
Sourcepub fn builder() -> MongoClientBuilder
pub fn builder() -> MongoClientBuilder
Create a builder for the client.
Sourcepub fn collection<T>(&self, name: &str) -> Collection<T>
pub fn collection<T>(&self, name: &str) -> Collection<T>
Get a typed collection.
Sourcepub fn collection_doc(&self, name: &str) -> Collection<Document>
pub fn collection_doc(&self, name: &str) -> Collection<Document>
Get a collection with BSON documents.
Sourcepub fn get_database(&self, name: &str) -> Database
pub fn get_database(&self, name: &str) -> Database
Get a different database from the same client.
Sourcepub fn config(&self) -> &MongoConfig
pub fn config(&self) -> &MongoConfig
Get the configuration.
Sourcepub async fn is_healthy(&self) -> bool
pub async fn is_healthy(&self) -> bool
Check if the client is healthy by pinging the server.
Sourcepub async fn list_collections(&self) -> MongoResult<Vec<String>>
pub async fn list_collections(&self) -> MongoResult<Vec<String>>
List all collection names in the database.
Sourcepub async fn drop_collection(&self, name: &str) -> MongoResult<()>
pub async fn drop_collection(&self, name: &str) -> MongoResult<()>
Drop a collection.
Sourcepub async fn create_index(
&self,
collection: &str,
keys: Document,
unique: bool,
) -> MongoResult<String>
pub async fn create_index( &self, collection: &str, keys: Document, unique: bool, ) -> MongoResult<String>
Create an index on a collection.
Sourcepub async fn run_command(&self, command: Document) -> MongoResult<Document>
pub async fn run_command(&self, command: Document) -> MongoResult<Document>
Run a database command.
Sourcepub async fn start_session(&self) -> MongoResult<ClientSession>
pub async fn start_session(&self) -> MongoResult<ClientSession>
Start a client session for transactions.
Source§impl MongoClient
impl MongoClient
Sourcepub async fn create_view(&self, view: &AggregationView) -> MongoResult<()>
pub async fn create_view(&self, view: &AggregationView) -> MongoResult<()>
Create a view in the database.
Sourcepub async fn drop_view(&self, name: &str) -> MongoResult<()>
pub async fn drop_view(&self, name: &str) -> MongoResult<()>
Drop a view from the database.
Sourcepub async fn list_views(&self) -> MongoResult<Vec<String>>
pub async fn list_views(&self) -> MongoResult<Vec<String>>
List all views in the database.
Sourcepub async fn get_view_definition(
&self,
name: &str,
) -> MongoResult<Option<AggregationView>>
pub async fn get_view_definition( &self, name: &str, ) -> MongoResult<Option<AggregationView>>
Get the definition of a view.
Sourcepub async fn refresh_materialized_view(
&self,
view: &MaterializedAggregationView,
) -> MongoResult<u64>
pub async fn refresh_materialized_view( &self, view: &MaterializedAggregationView, ) -> MongoResult<u64>
Refresh a materialized view.
This runs the aggregation pipeline and outputs results to the target collection.
Trait Implementations§
Source§impl Clone for MongoClient
impl Clone for MongoClient
Source§fn clone(&self) -> MongoClient
fn clone(&self) -> MongoClient
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for MongoClient
impl !RefUnwindSafe for MongoClient
impl Send for MongoClient
impl Sync for MongoClient
impl Unpin for MongoClient
impl UnsafeUnpin for MongoClient
impl !UnwindSafe for MongoClient
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
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,
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,
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,
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,
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,
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,
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,
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,
self to use its UpperHex implementation when
Debug-formatted.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> 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,
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,
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,
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
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
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
self, then passes self.deref() into the pipe function.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
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
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
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
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
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
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
.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
.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
.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
.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
.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
.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
.tap_deref() only in debug builds, and is erased in release
builds.