Bigquery extension for Visual Studio Code
This extension aims to bring most of the functionality of Bigquery to Visual Studio Code. At the moment is possible to: authenticate ( using the gcloud CLI); list projects, dataset and tables; view table content; and run queries.
The authentication is taken cared by the gcloud CLI. Threfore, gcloud CLI must be installed. This extension makes a visual representation of what is provided by that console application.
The three buttons "User login", "User login + GDrive" and "Service account" reflect that three possible ways of authenticate the requests. Either user personal authentication is used, where the computer browser will be opened requesting authentication to Google Cloud for the options "User login" and "User login + GDrive". Use the "GDrive" option to be able to browse and select tables based on Google Drive. Or, a service account key file (json format) must be selected when requested by pressing the button "Service account".
When there's a valid account active and with the necessary permissions to interact with bigquery, this extension is ready to be used.
Additional functionality to activate and revoke authentication accounts is also provided.
This screen is refreshed programatically every time that a change is detected. Additionaly, to refresh the authentication screen, can be done my executing the command
Projects, Dataset and Tables tree
In the Bigquery side panel, sub panel "explorer", a tree of projects, datasets, tables, views, functions and ML models is available. Compared with tree available in the Bigquery interface in the Google Cloud portal, the "saved queries" are missing. Other than that, it should be like-for-like.
To refresh the explorer screen, can be done my executing the command
Is possible to change the default project that queries will run against.
In order to influence the order of the different GCP projects on the list, is possible to pin one or more to stay on top of the list.
By using the command show in the image above, the local settings will be changed.
To make changes at user level, the settings must be modified via the settings menu and change the associated file.
Interaction with views, functions and ML models is still not implemented. Will be available in future releases of this extension. At the moment, only tables have
This extension responds to files with extension
To run only the query selected in the text, can be done by the key combination
After the query returns a response, the bottom panel of Visual Studio code will be made visible with the selected tab
As visible in the image above, syntax highlight is very poor at the moment. Intellisence has too few features. This will be the next improvements biggest area.
The query in the editor is evaluated in every change. If there's errors in the query, it will be underlined
If the query is valid, the number of bytes that will be consumed will appear in the bottom bar
After a query has run, in the result grid, there's the option of downloading that same results in CSV format. The file generated supports multiline, but not nested complex objects. There is no limit size/row number imposed in this feature, so please be aware of the effort that will be asked of your computer.
View table schema
When exploring the tree of projects, dataset and its contents, the table items have the possibility of opening a schema page in the context menu (right-click).
This command will open a page containg some information about the table and it's schema.
Sometimes, after this extension is installed, the command
Available in github: https://github.com/orgs/bstruct/projects/1/views/2.
Report a bug
Please file an issue most descriptive as possible in https://github.com/bstruct/vscode-bigquery/issues.