This page describes how to connect to a Spanner database in IntelliJ and other JetBrains products.
IntelliJ IDEA is an integrated development environment for developing software in Java, Kotlin, Groovy, and other JVM-based languages.
This page assumes that you already have IntelliJ or another JetBrains IDE installed on your computer.
Connect to Spanner
Connecting IntelliJ to your Spanner database lets you execute queries and other SQL statements on your Spanner database directly from IntelliJ. It also enables code completion and validation for table and column names in your code.
You can connect to both GoogleSQL-dialect databases and PostgreSQL-dialect databases by following these steps:
In IntelliJ, click the menu option
File > New > Datasource > Google Spanner
. TheGoogle Spanner
driver is under theOther
sub-menu if you have not used this driver before.In the Data Sources window, enter your project, instance, and database ID.
Optional: Select a service account key file if you want to authenticate using a service account. Select
No Auth
in the Credentials drop-down if you want to use your default credentials.Click OK to create the data source. The Spanner database is added to the Database window in IntelliJ.
In the Databases window, expand the data source that you just added. Then click the
...
button next to the textNo schemas selected
.Select the option
All schemas
to instruct IntelliJ to introspect all schemas in the database. IntelliJ will then populate the database view with all tables and views in your database.
Connect to the Spanner Emulator
You can also connect IntelliJ to a database in the Spanner Emulator:
First start the emulator with one of the following commands:
gcloud emulators spanner start
docker run -p 9010:9010 -p 9020:9020 gcr.io/cloud-spanner-emulator/emulator
Click the menu option
File > New > Datasource > Google Spanner
. TheGoogle Spanner
driver is under theOther
sub-menu if you have not used this driver before.Enter the project, instance, and database ID. NOTE: The project, instance and database do not need to exist in the emulator.
Select
No Auth
in the Credentials drop-down.Click the
Advanced
tab in the Data Sources window.Modify the value of
autoConfigEmulator
totrue
.Click OK to accept all changes. The project, instance, and database will be created on the emulator automatically if these do not exist already.
In the Databases window, expand the data source that you just added. Click the
...
button next to the textNo schemas selected
.Select the option
All schemas
to instruct IntelliJ to introspect all schemas in the database. IntelliJ will then populate the database view with all tables and views in your database.
What's next
- For more documentation on how to add and work with data sources in IntelliJ, visit IntelliJ Data sources.
- Learn more about the Spanner Emulator.