nu_plugin_bigquery 0.1.2

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

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

use crate::plugin::BigQueryPlugin;

// ---------------------------------------------------------------------------
// bq (parent command — shows help)
// ---------------------------------------------------------------------------

pub struct Bq;

impl SimplePluginCommand for Bq {
    type Plugin = BigQueryPlugin;

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

    fn signature(&self) -> Signature {
        Signature::build("bq")
            .input_output_type(Type::Nothing, Type::Nothing)
            .category(Category::Database)
    }

    fn description(&self) -> &str {
        "Query Google BigQuery from Nushell"
    }

    fn extra_description(&self) -> &str {
        HELP_TEXT
    }

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

    fn run(
        &self,
        _plugin: &BigQueryPlugin,
        _engine: &EngineInterface,
        _call: &EvaluatedCall,
        _input: &Value,
    ) -> Result<Value, LabeledError> {
        Err(LabeledError::new("Missing subcommand")
            .with_help(format!("Usage: bq <subcommand>\n\n{HELP_TEXT}")))
    }
}

// ---------------------------------------------------------------------------
// bigquery (parent command — shows help)
// ---------------------------------------------------------------------------

pub struct Bigquery;

impl SimplePluginCommand for Bigquery {
    type Plugin = BigQueryPlugin;

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

    fn signature(&self) -> Signature {
        Signature::build("bigquery")
            .input_output_type(Type::Nothing, Type::Nothing)
            .category(Category::Database)
    }

    fn description(&self) -> &str {
        "Query Google BigQuery from Nushell"
    }

    fn extra_description(&self) -> &str {
        HELP_TEXT
    }

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

    fn run(
        &self,
        _plugin: &BigQueryPlugin,
        _engine: &EngineInterface,
        _call: &EvaluatedCall,
        _input: &Value,
    ) -> Result<Value, LabeledError> {
        Err(LabeledError::new("Missing subcommand")
            .with_help(format!("Usage: bigquery <subcommand>\n\n{HELP_TEXT}")))
    }
}

const HELP_TEXT: &str = "\
Available subcommands:
  query      Execute a SQL query against BigQuery
  read       Read rows directly from a BigQuery table
  datasets   List datasets in the project
  tables     List tables in a dataset
  schema     Inspect the schema of a table

Authentication (zero-config by default):
  # Just works if `gcloud auth application-default login` was run
  bq query \"SELECT 1\"

  # Explicit service account
  bq query --credentials /path/to/sa-key.json \"SELECT 1\"

  # Project override
  bq query --project my-project \"SELECT 1\"

Run `bq <subcommand> --help` for details on each command.";