Struct polodb_core::db::Collection

pub struct Collection<'a, T> { /* private fields */ }

A wrapper of collection in struct.

All CURD methods can be done through this structure.

It can be used to perform collection-level operations such as CRUD operations.

Implementations

impl<'a, T> Collection<'a, T>

pub fn name(&self) -> &str

pub fn count_documents(&self) -> DbResult<u64>

Return the size of all data in the collection.

pub fn update_one(
    &self,
    query: Document,
    update: Document
) -> DbResult<UpdateResult>

Updates up to one document matching query in the collection. documentation for more information on specifying updates.

pub fn update_many(
    &self,
    query: Document,
    update: Document
) -> DbResult<UpdateResult>

Updates all documents matching query in the collection. documentation for more information on specifying updates.

pub fn delete_one(&self, query: Document) -> DbResult<DeleteResult>

Deletes up to one document found matching query.

pub fn delete_many(&self, query: Document) -> DbResult<DeleteResult>

When query is None, all the data in the collection will be deleted.

The size of data deleted returns.

pub fn drop(&self) -> DbResult<()>

impl<'a, T> Collection<'a, T>where
    T: Serialize,

pub fn insert_one(&self, doc: impl Borrow<T>) -> DbResult<InsertOneResult>

Inserts doc into the collection.

pub fn insert_many(
    &self,
    docs: impl IntoIterator<Item = impl Borrow<T>>
) -> DbResult<InsertManyResult>

Inserts the data in docs into the collection.

impl<'a, T> Collection<'a, T>where
    T: DeserializeOwned,

pub fn find_many(&self, filter: impl Into<Option<Document>>) -> DbResult<Vec<T>>

When query document is passed to the function. The result satisfies the query document.

pub fn find_one(
    &self,
    filter: impl Into<Option<Document>>
) -> DbResult<Option<T>>

Return the first element in the collection satisfies the query.