nu_plugin_bigquery 0.2.0

A Nushell plugin for querying Google BigQuery
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
use nu_protocol::{Category, LabeledError, Record, Signature, SyntaxShape, Type, Value};

use crate::plugin::BigQueryPlugin;

use super::create_client;

// ---------------------------------------------------------------------------
// bq datasets
// ---------------------------------------------------------------------------

pub struct BqDatasets;

impl SimplePluginCommand for BqDatasets {
    type Plugin = BigQueryPlugin;

    fn name(&self) -> &str {
        "bq datasets"
    }

    fn signature(&self) -> Signature {
        datasets_signature("bq datasets")
    }

    fn description(&self) -> &str {
        "List BigQuery datasets in the project"
    }

    fn search_terms(&self) -> Vec<&str> {
        vec!["bigquery", "gcp", "google", "list"]
    }

    fn run(
        &self,
        plugin: &BigQueryPlugin,
        engine: &EngineInterface,
        call: &EvaluatedCall,
        _input: &Value,
    ) -> Result<Value, LabeledError> {
        run_datasets(plugin, engine, call)
    }
}

// ---------------------------------------------------------------------------
// bigquery datasets (alias)
// ---------------------------------------------------------------------------

pub struct BigqueryDatasets;

impl SimplePluginCommand for BigqueryDatasets {
    type Plugin = BigQueryPlugin;

    fn name(&self) -> &str {
        "bigquery datasets"
    }

    fn signature(&self) -> Signature {
        datasets_signature("bigquery datasets")
    }

    fn description(&self) -> &str {
        "List BigQuery datasets in the project"
    }

    fn search_terms(&self) -> Vec<&str> {
        vec!["bq", "gcp", "google", "list"]
    }

    fn run(
        &self,
        plugin: &BigQueryPlugin,
        engine: &EngineInterface,
        call: &EvaluatedCall,
        _input: &Value,
    ) -> Result<Value, LabeledError> {
        run_datasets(plugin, engine, call)
    }
}

// ---------------------------------------------------------------------------
// Shared implementation
// ---------------------------------------------------------------------------

fn datasets_signature(name: &str) -> Signature {
    Signature::build(name)
        .named("project", SyntaxShape::String, "GCP project ID", Some('p'))
        .named(
            "credentials",
            SyntaxShape::Filepath,
            "Path to service account key JSON file",
            Some('c'),
        )
        .input_output_type(Type::Nothing, Type::table())
        .category(Category::Database)
}

fn run_datasets(
    plugin: &BigQueryPlugin,
    engine: &EngineInterface,
    call: &EvaluatedCall,
) -> Result<Value, LabeledError> {
    let project: Option<String> = call.get_flag("project")?;
    let credentials: Option<String> = call.get_flag("credentials")?;
    let span = call.head;

    let client = create_client(plugin, engine, credentials, project, span)?;

    plugin.runtime.block_on(async {
        let response = client.list_datasets().await?;

        let rows: Vec<Value> = response
            .datasets
            .unwrap_or_default()
            .iter()
            .map(|ds| {
                let dataset_id = ds
                    .dataset_reference
                    .as_ref()
                    .and_then(|r| r.dataset_id.clone())
                    .unwrap_or_default();
                let id = ds.id.clone().unwrap_or_default();
                let location = ds.location.clone().unwrap_or_default();
                let friendly_name = ds.friendly_name.clone().unwrap_or_default();

                let mut record = Record::new();
                record.push("name", Value::string(&dataset_id, span));
                record.push("id", Value::string(&id, span));
                record.push("location", Value::string(&location, span));
                record.push("friendly_name", Value::string(&friendly_name, span));
                Value::record(record, span)
            })
            .collect();

        Ok(Value::list(rows, span))
    })
}