nu_plugin_mongo 0.1.11

A nushell plugin to interactive with mongodb
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use crate::MongoPlugin;
use mongodb::bson::Document;
use nu_plugin::{DynamicCompletionCall, EngineInterface, SimplePluginCommand};
use nu_protocol::{
    Category, DynamicSuggestion, Example, LabeledError, Signature, Spanned, SyntaxShape, Type,
    Value, engine::ArgType,
};

pub struct Estimated;

impl SimplePluginCommand for Estimated {
    type Plugin = MongoPlugin;

    fn name(&self) -> &str {
        "mongoc estimated"
    }

    fn description(&self) -> &str {
        "estimated mongodb documents count"
    }

    fn signature(&self) -> nu_protocol::Signature {
        Signature::build("mongoc estimated")
            .required_named(
                "collection",
                SyntaxShape::String,
                "collection name",
                Some('c'),
            )
            .named(
                "db-handle",
                SyntaxShape::Int,
                "database handle, can get from `mongoc list`",
                Some('d'),
            )
            .input_output_type(Type::Nothing, Type::record())
            .category(Category::Database)
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "estimated students count with age `19`, in a `students` collection",
                example: "mongoc estimated {age: 19} -d 0 -c students",
                result: None,
            },
            Example {
                description: "estimated teachers count with name `John`, in a `teachers` collection",
                example: "mongoc estimated {name: John} -d 0 -c teachers",
                result: None,
            },
            Example {
                description: "estimated teachers count with name `John`",
                example: "mongoc estimated {name: John} -d 0 -c teachers -s {\"age\": -1}",
                result: None,
            },
        ]
    }

    fn run(
        &self,
        plugin: &MongoPlugin,
        _engine: &nu_plugin::EngineInterface,
        call: &nu_plugin::EvaluatedCall,
        _input: &Value,
    ) -> Result<Value, LabeledError> {
        let db_handle: Option<Spanned<i64>> = call.get_flag("db-handle")?;
        let db = match db_handle {
            None => plugin.get_handle(plugin.get_current()?, call.head)?,
            Some(db_handle) => plugin.get_handle(db_handle.item as u8, db_handle.span)?,
        };
        let coll: String = call
            .get_flag("collection")?
            .expect("already check existed.");
        let coll = db.collection::<Document>(&coll);
        let estimated = coll.estimated_document_count();
        let result = estimated
            .run()
            .map_err(|e| LabeledError::new(format!("{e}")))?;
        Ok(Value::int(result as i64, call.head))
    }

    fn get_dynamic_completion(
        &self,
        plugin: &Self::Plugin,
        _engine: &EngineInterface,
        _call: DynamicCompletionCall,
        arg_type: ArgType,
        _experimental: nu_protocol::engine::ExperimentalMarker,
    ) -> Option<Vec<DynamicSuggestion>> {
        match arg_type {
            ArgType::Flag(name) if name == "collection" => {
                super::get_collection_names_at_current_handle(plugin)
            }
            _ => None,
        }
    }
}