Contributing

Connect to the manage database in DataGrip

Copy page

This guide explains how to connect DataGrip to the local Inkeep manage database and run branch-scoped queries on a project branch.

Download DataGrip

Install the latest version of DataGrip from JetBrains: DataGrip download.

Create a PostgreSQL data source

In DataGrip, go to: File -> New -> Data Source -> PostgreSQL -> PostgreSQL.

Create a PostgreSQL data source
Create a PostgreSQL data source

Fill data source details

Use this URL:

jdbc:postgresql://localhost:5432/inkeep_agents?user=appuser&password=password

Or fill the fields with these values:

  • Name: Inkeep Manage API
  • User: appuser
  • Password: password
  • Database: inkeep_agents
Fill data source details
Fill data source details

Test the connection

Click Test Connection and confirm it succeeds.

Test connection
Test connection

Select databases

In Database Explorer, click the 3 dots next to No databases selected and select all databases.

Select databases
Select databases

Go to DDL

Select the inkeep_agents database and click Go to DDL.

Click go to DDL
Click go to DDL

Check out a Dolt branch and run a query

In the query console, check out the project branch first, then run your SQL.

Example for the default sample project:

SELECT DOLT_CHECKOUT('default_activities-planner_main');
SELECT * FROM skills;

General branch pattern:

SELECT DOLT_CHECKOUT('{tenant_id}_{project_id}_{branch}');

Run queries with Cmd/Ctrl + Enter, then choose the statement to execute.

Run checkout and query
Run checkout and query

View results

Query results appear in the bottom panel of the IDE.

Query results
Query results