Visible Studio Code is likely one of the most widely-used IDEs, due partially to the number of extensions which might be obtainable to builders. For builders who’re constructing purposes that work together with Cloud Spanner, we’re excited to announce the Google Cloud Spanner driver for the favored SQLTools extension for VS Code.
The SQLTools extension works with quite a lot of SQL drivers and permits builders to handle database connections, execute and generate queries, and extra from inside VS Code. Through the use of the Cloud Spanner driver with SQLTools, builders can browse tables and execute queries, DDL statements, and DML statements on Cloud Spanner databases with out having to go away the IDE.
On this put up, we’ll stroll via the method of putting in the extension, connecting to a Cloud Spanner database, and utilizing SQLTools with the database.
Earlier than you get began, you may have to have a Google Cloud Platform mission with a Cloud Spanner occasion and a database. This codelab will stroll you thru the method if you have not used Cloud Spanner earlier than. Alternatively, you should use the emulator. You may additionally have to have VS Code put in in your pc.
To put in the Cloud Spanner driver for SQLTools, click on on the Extensions icon in VS Code, seek for “cloud spanner driver”, and set up the extension referred to as Google Cloud Spanner Driver. Alternatively, you’ll be able to set up the Cloud Spanner driver for SQLTools from the Visible Studio Market.
As soon as the extension is put in, you may see a database icon for SQLTools, as highlighted by the pink rectangle within the picture beneath, present up in VS Code. Click on this database icon to entry the extension.
Connecting to a Cloud Spanner database
With the extension put in, click on the Add New Connection icon in SQLTools to open the Connection Assistant and select Google Cloud Spanner Driver. You possibly can join both to a Spanner occasion on Google Cloud or to an emulator occasion.
Configuring a connection utilizing the emulator
The Cloud SDK presents an area, in-memory emulator that you should use whereas creating and testing. To make use of the SQLTools extension with the emulator, you have to first begin the emulator. Then, within the Connection Settings step, enter values for Connection title, Google Cloud Mission ID, Spanner Occasion ID, andSpanner Database ID. Choose the checkbox subsequent to Connect with emulator. Once you use this setting, the occasion and database you specified will probably be robotically created for you within the emulator if they don’t exist already.
Configuring a connection to a Cloud Spanner database on Google Cloud
In case you are connecting to a Cloud Spanner database operating on Google Cloud, you may want to offer the Google Cloud Mission ID, Spanner Occasion ID, and Spanner Database ID. You possibly can enter any worth you want for theConnection title. You may additionally have to specify your credentials in considered one of two methods: enter absolutely the path to your credential key file within the Connection Assistant or set the
GOOGLE_ACCOUNT_CREDENTIALS atmosphere variable to the trail to your credential key file. In case you are utilizing the
GOOGLE_ACCOUNT_CREDENTIALS atmosphere variable, word that if VS Code was already operating earlier than you set the atmosphere variable, then you have to to restart VS Code. Your service account will have to be granted applicable permissions for interacting with Cloud Spanner. For extra details about credentials, see the documentation on creating service accounts and repair account keys. You’ll find an inventory of Cloud Spanner roles on this desk.
Testing and establishing connections
As soon as you have entered the connection settings info, you’ll be able to click on TEST CONNECTION to ensure the connection is profitable, after which click on SAVE CONNECTION.
On the ultimate step of the Connection Assistant, click on CONNECT NOW.
Looking database tables
Within the Connections part of SQLTools, you’ll be able to view the tables in your database. Within the screenshot beneath, you’ll be able to see the columns within the feedback desk.
Proper-clicking on a desk title supplies choices akin to exhibiting desk information or producing an insert question.
Executing queries and statements
The Cloud Spanner driver helps executing queries, DDL statements, and DML statements. Should you execute a number of statements in a single script, every assertion will probably be executed in a separate transaction. Be aware that the extension is meant to be used throughout improvement and testing, not for administration of manufacturing database environments.
Queries use single-use read-only transactions, whereas DML statements use read-write transactions. Make it possible for the service account you are utilizing has the mandatory permissions to execute the queries or statements. For extra info on sorts of transactions, see the documentation.
Interacting along with your Cloud Spanner databases from inside your IDE could make your improvement course of extra environment friendly and cut back the necessity to change between a number of instruments and interfaces. Able to strive it your self? Set up the Cloud Spanner driver for SQLTools and begin exploring and interacting along with your Cloud Spanner databases from inside VS Code. When you have recommendations or points, you’ll be able to elevate them within the difficulty tracker or for questions or feedback, be at liberty to succeed in out to me on Twitter. We might love to listen to your suggestions.