Local Dev Database Connection Setup

While not required for basic use of the Caliper SDK, it can be convenient to run raw sql commands to learn more about the database.

Warning

Running raw sql queries can break your environment. We can reset your database to it’s default state though just create a General ticket

How the connection works

To login to your database, your Database Name, Database User, Database Password, and Database Host can be found on your Developer Portal Dashboard.

While any database editor will work, we’ve provided a guide for VSCode setup below.

Visual Studio Code

Note

The below steps assume you have already setup vscode using the Local Dev IDE Setup Guide. If you haven’t done that, download VSCode and install the Q2 SDK Extension Pack.

  1. Open the SQL Server extension. And follow the following steps:

    • Click the + button to the right of CONNECTIONS

    • for hostname <Database Host>

    • for Database to connect <Database Name>

    • Authentication Type: Sql Login

    • Username: <Database User>

    • Password: <Database Password>

    • Save Password is your choice

    • The display name is optional, this is what the view will be for VSCode though, so feel free to enter whatever.

    • On the popup select the Enable Trust Server Certificate option

  2. Your Visual Studio code is now setup to do manual SQL commands! To explore the database, the new connection should appear under CONNECTIONS and you can click into it to see structures. Right click on any table to see what is inside the table.