Struct mongodb_schema_describer::MongoSchema

pub struct MongoSchema { /* private fields */ }

All the possible information we should scrape out from a MongoDB database.

Implementations

impl MongoSchema

pub fn push_collection( &mut self, name: String, has_schema: bool, is_capped: bool ) -> CollectionId

Add a collection to the schema.

pub fn push_index( &mut self, collection_id: CollectionId, name: String, type: IndexType, fields: Vec<IndexField> ) -> IndexId

Adds an index to the schema.

pub fn walk_collections( &self ) -> impl ExactSizeIterator<Item = CollectionWalker<'_>> + '_

An iterator over all the collections in the schema.

pub fn walk_collection(&self, id: CollectionId) -> CollectionWalker<'_>

Walk a collection.

Panics

If there is no collection with the given id.

pub fn walk_index(&self, id: IndexId) -> IndexWalker<'_>

Walk an index.

Panics

If there is no index with the given id.

pub fn remove_fulltext_indexes(&mut self)

Remove all indexes that are of fulltext type. We basically need this until the feature is GA.

Only call this if you do not hold IndexIds anywhere.

Trait Implementations

impl Clone for MongoSchema

fn clone(&self) -> MongoSchema

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MongoSchema

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

Formats the value using the given formatter.

impl Default for MongoSchema

fn default() -> MongoSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MongoSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<CollectionId> for MongoSchema

type Output = CollectionData

The returned type after indexing.

fn index(&self, index: CollectionId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<IndexId> for MongoSchema

type Output = IndexData

The returned type after indexing.

fn index(&self, index: IndexId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Serialize for MongoSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.