How to run PostgreSQL queries from GoLand

Last modified: 04 December 2024

note

Prerequisites

To complete this tutorial, ensure that you have installed the following software:

Step 1. Clone files from repositories

For example purposes, we are going to use the following two repositories: Sakila dump files (https://github.com/DataGrip/dumps) and Docker-compose files (https://github.com/DataGrip/datagrip-documentation). Sakila repository includes scripts that generate the structure of the Sakila database and scripts that add data to database objects. Docker repository includes YAML files that define services, networks, and volumes.

Enable version control integration

  1. Click VCS | Enable Version Control Integration in the menu.

  2. In the Enable Version Control Integration dialog, ensure that Git is selected in the dropdown list and click OK.

    Enable version control integration

Clone repositories

  1. Click Git | Clone.

  2. In the URL field, copy and paste the following web URL:

    • Sakila dump files: 

      https://github.com/DataGrip/dumps.git

    • Docker-compose files: 

      https://github.com/DataGrip/datagrip-documentation.git

  3. In the Directory field, click the folder icon (The folder icon) and specify a directory for the repository files.

    Clone repositories

Step 2. Run a Docker container

For this tutorial, we are going to run a PostgreSQL container for Docker (from the datagrip-documentation repository). In the Docker directory of the repository, you can find .env and docker-compose.yml files. .env includes credentials for the PostgreSQL service. docker-compose.yml defines how the service is created and configured.

The service name is the first line of the service definition (before the JDBC URL). In our example, the service name is postgresql_12, the JDBC URL is jdbc:postgresql://localhost:54333/guest?user=guest&password=guest.

postgresql_12:
            # jdbc:postgresql://localhost:54333/guest?user=guest&password=guest
            container_name: postgresql_12
            ports:
            - "54333:5432"
            image: postgres:12-alpine
            env_file: .env
            healthcheck:
            test: "exit 0"

You can run the container from a command line by running:

docker-compose up -d postgresql_12

Note that you have to navigate to the directory of the docker-compose.yml file first.

Alternatively, you can enable and use the Docker plugin in GoLand.

Connect to the Docker daemon

  1. Press to open settings and then select Build, Execution, Deployment | Docker.

  2. Click The Add button to add a Docker configuration and specify how to connect to the Docker daemon.

    The connection settings depend on your Docker version and operating system.

    The Connection successful message should appear at the bottom of the dialog.

    The Docker connection settings

    For more information about mapping local paths to the virtual machine running the Docker daemon when using Docker on Windows or macOS, refer to Virtual machine path mappings for Windows and macOS hosts. You will not be able to use volumes and bind mounts for directories outside of the mapped local path.

    This table is not available on a Linux host, where Docker runs natively and you can mount any directory to the container.

  3. Open the Services tool window (View | Tool Windows | Services or ), select the configured Docker connection node Docker node and click The Connect button, or select Connect from the context menu.

    The Docker tool window, connected to Docker

    To edit the Docker connection settings, select the Docker node and click The Edit Configuration button on the toolbar, or select Edit Configuration from the context menu.

    You can also click the Add Service menu and select Docker Connection to add a Docker connection directly from the Services tool window. If you have Docker contexts configured, you can select Docker Connections from Docker Contexts to add the corresponding connections.

Create the Docker-compose deployment configuration

  1. In the Services tool window (View | Tool Windows | Services), right-click the Docker node and select Deploy.

  2. In the popup window, select Create Docker-compose Deployment.

  3. In the Create Deployment Configuration dialog, click the Browse icon of the Compose file(s) field.

  4. In the Docker Compose Configuration Files dialog, click the Add button and navigate to the compose file. The Compose YAML file defines services, networks, and volumes. In our case, it is docker-compose.yml

  5. In the Docker Compose Configuration Files dialog, click OK.

  6. In the Service(s) field, type postgresql_12.

  7. Click Run.

    As a result, you can see the postgresql_12 running container in the Services tool window.

    https://resources.jetbrains.com.cn/help/img/idea/2024.3/db_create_the_docker_compose_deployment_configuration.png
    Gif

tip

To view all running images, use the docker ps command in the command line. Otherwise, use the Docker tool window (View | Tool Windows | Docker) to view and manage Docker containers.

Step 3. Connect to a data source

Depending on a database vendor (MySQL, PostgreSQL, Oracle), you need to create a corresponding data source connection. In this tutorial, we will create a PostgreSQL connection. If you want to connect to other database management systems (DBMS), refer to Create a data source.

tip

If you see the Connecting to <JDBC URL> dialog when you click the Test connection button, specify guest as a password and click OK.

Step 4. Attach a directory to the project

To run dump files from the project in GoLand, attach a directory with dump files.

  1. Click File | Open.

  2. Navigate to the folder that you want to attach. In this tutorial, this folder is dumps that you cloned on Step 1 (Sakila dump files).

  3. Click Open.

  4. In the Open Project dialog, click Attach.

Attach a directory to the project

Step 5. Run the dump files

Create the database structure

  1. In the Project (View | Tool Windows | Project) tool window, navigate to the postgres-sakila-db tree node.

  2. Expand postgres-sakila-db tree node.

  3. Right-click the postgres-sakila-schema.sql and select Run postgres-sakila-schema .sql. Alternatively, click the postgres-sakila-schema.sql file and press .

  4. In the Edit Configuration dialog, click the Add button and select PostgreSQL.

  5. Press Run.

    https://resources.jetbrains.com.cn/help/img/idea/2024.3/go_tutorial_run_dump_files.png
    Gif

Load sample data to the database

  1. In the Project (View | Tool Windows | Project) tool window, navigate to the postgres-sakila-db tree node.

  2. Expand postgres-sakila-db tree node.

  3. Right-click the postgres-sakila-insert-data.sql and select Run postgres-sakila-insert-data.sql. Alternatively, click the postgres-sakila-insert-data.sql file and press .

  4. In the Edit Configuration dialog, click the Add button and select PostgreSQL.

  5. Press Run.

Step 6. Fetch dependencies from the Go code

To issue a query to PostgreSQL, we are going to use the sqlx library that provides a set of extensions for the Go standard database/sql library. For more information about the library, refer to sqlx on GitHub.

main.go at GitHub: click the link to get the code from the GiHub repository.

  1. Create a Go project in GoLand.

  2. Right-click the root folder in the project and navigate to New | Go File.

  3. In the New Go File dialog, type main in the Name field and click OK.

  4. Copy the attached code snippet and paste it to the main.go file.

  5. Place the caret at the "github.com/jmoiron/sqlx" import line, press and click go get -t github.com/jmoiron/sqlx.

tip

Inject a correct SQL dialect to have a correct syntax highlighting and code completion in your query. For our example, it is PostgreSQL. To apply the PostgreSQL dialect, press and select Inject language or reference. In the list of languages, select PostgreSQL (SQL).

tip

To run just the SQL code, click the SQL part in the code, press , and select Run query in console.

Step 7. Run the configuration

  • To run the configuration, click the Run icon (The Run icon) in the gutter near the main function and select Run 'go build main.go'.

    Run the configuration