JetBrains Rider 2023.3 Help

Amazon Redshift

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in JetBrains Rider by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

  1. Press Ctrl+Alt+S to open the IDE settings and then select Plugins.

  2. Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

Official documentation

This topic presents a general procedure on how you can create a data source for the connection to your Amazon Redshift database in JetBrains Rider, and run a test connection. It is assumed that you already have the necessary prerequisites and the database is up and running.

In case you want to access a private Amazon Redshift cluster from your local machine, consider using an Amazon Elastic Compute Cloud (Amazon EC2) instance and then creating an SSH tunnel from JetBrains Rider to this instance. For more information about configuring Amazon EC2, refer to this tutorial at aws.amazon.com.

In JetBrains Rider, you can work with shared databases:

  • Shared databases, and the datashares that these databases are created on, can be introspected and displayed in Database tool window.

  • You can modify both datashares and shared databases. To do that, right-click the corresponding object in Database tool window and select Modify <object>. Alternatively, select the object and press Ctrl+F6.

  • Code editor supports all the related statements.

Prerequisites

Your Amazon Redshift dashboard must have a Amazon Redshift cluster in it. For more information about the Amazon Redshift cluster, refer to Getting Started with Amazon Redshift.

Connect to an Amazon Redshift database

  1. In the Database tool window ( View | Tool Windows | Database) , click the New icon New and select Connect to Database.

  2. If you have a connection string for the database defined in your solution or elsewhere, leave the Use connection string option selected and choose Amazon Redshift in the Database type selector.

    Use the String selector to choose the desired connection string from your solution or type it in manually, then click Connect.

  3. You can also choose Add data source manually, click Next and select Amazon Redshift in the Database source selector. Follow the wizard steps to form the connection string by configuring individual options.

  4. To access all available options for the new database connection, click in the Database window, then click the New icon New and select Amazon Redshift.

  5. In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.

    1. In the Driver list, leave the default driver option, unless another driver is required for your connection.

    2. From the Connection type list, select the connection type depending on the connection details that you have:

      • default: connect by using Host, Port, Database, and URL.

      • IAM cluster/region: connect by using Database, Region, Cluster, and URL.

      • URL only: connect by using only the URL.

      For the URL only connection type, the JDBC URL that you enter is used as is.

      For the other connection types, the JDBC URL is broken down into connection details. You can either specify them separately and use the automatically generated URL, or you can enter the URL directly in the corresponding field.

    General tab of the Data Sources and Drivers dialog
  6. Check if there is a Download missing driver files link at the bottom of the connection settings area. Click this link to download drivers that are required to interact with a database. For a direct download link, refer to the JetBrains JDBC drivers page.

    Location for the downloaded JDBC drivers is the JetBrains Rider configuration directory.

    The Download missing driver files link

    You can also use your drivers for the database instead of the provided ones. For more information about connecting to a database with your driver, refer to Add a user driver to an existing connection.

    If there is no Download missing driver files link, then you already have the required drivers.

  7. Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.

    1. In the Host field, type your server address.

    2. In the Port field, type the port of Amazon Redshift. The default port is 5439.

    3. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • pgpass: by using the pgpass file. You can store this file in the user's home directory. You can read more about the password file and its location in The Password File at postgresql.org.

      • User & Password: by using your login and password.

      • AWS Profile: by using a named profile. A named profile is a collection of settings and credentials that you can use for authentication. Named profiles are stored in CREDENTIALS files. Default directories for these files are ~/.aws/credentials (Linux and macOS) and %\USERPROFILE%\.aws\credentials (Windows).

      • No auth: authentication is not required.

    4. In the Database field, type the database name to which you want to connect.

    5. In settings of the Redshift cluster, copy the JDBC URL.

    6. In the URL field, JetBrains Rider generates the JDBC URL automatically using the values of other connection settings.

      Paste the JDBC URL from the Redshift cluster settings to the URL field in JetBrains Rider.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:redshift://<connection_url><port_number>/<database_name>

      • Example: jdbc:redshift://server.redshift.amazonaws.com:5439/myDatabase

      For more information about the URL format, refer to the Amazon Redshift official documentation.

    Database connection details
    1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • pgpass: by using the pgpass file. You can store this file in the user's home directory. You can read more about the password file and its location in The Password File at postgresql.org.

      • User & Password: by using your login and password.

      • AWS Profile: by using a named profile. A named profile is a collection of settings and credentials that you can use for authentication. Named profiles are stored in CREDENTIALS files. Default directories for these files are ~/.aws/credentials (Linux and macOS) and %\USERPROFILE%\.aws\credentials (Windows).

      • No auth: authentication is not required.

    2. In the Database field, type the database name to which you want to connect.

    3. In the Region field, enter the AWS Region of the database that you are connecting to.

    4. In the Cluster field, enter the name of Amazon Redshift cluster that contains your database.

    5. In settings of the Redshift cluster, copy the JDBC URL.

    6. In the URL field, JetBrains Rider generates the JDBC URL automatically using the values of other connection settings.

      Paste the JDBC URL from the Redshift cluster settings to the URL field in JetBrains Rider.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:redshift:iam://<cluster_name>:<region>/<database_name>

      • Example: jdbc:redshift:iam://democluster:eu-south-2/demodb

      For more information about the URL format, refer to the Amazon Redshift official documentation.

    Database connection details
    1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • pgpass: by using the pgpass file. You can store this file in the user's home directory. You can read more about the password file and its location in The Password File at postgresql.org.

      • User & Password: by using your login and password.

      • AWS Profile: by using a named profile. A named profile is a collection of settings and credentials that you can use for authentication. Named profiles are stored in CREDENTIALS files. Default directories for these files are ~/.aws/credentials (Linux and macOS) and %\USERPROFILE%\.aws\credentials (Windows).

      • No auth: authentication is not required.

    2. In settings of the Redshift cluster, copy the JDBC URL.

    3. In the URL field, JetBrains Rider generates the JDBC URL automatically using the values of other connection settings.

      Paste the JDBC URL from the Redshift cluster settings to the URL field in JetBrains Rider.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:redshift://<connection_url><port_number>/<database_name>

      • Example: jdbc:redshift://server.redshift.amazonaws.com:5439

      For more information about the URL format, refer to the Amazon Redshift official documentation.

    Database connection details

    For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Shift+Enter) , see Connection settings and DBMS-specific properties.

  8. In User and Password fields, specify your Redshift credentials.

  9. Ensure that the connection to the database can be established using the provided details. To do that, click the Test Connection link at the bottom of the connection details area.

    Test Connection link

    In case of any connection issues, refer to the Cannot connect to a database page.

  10. (Optional) By default, only the default introspected and available to work with. If you also want to work with other databases, schemas, and shared databases, in the Schemas tab, select them for the introspection.

    Schemas tab of the Data Sources and Drivers dialog
  11. Click OK to create the data source.

  12. Find your new data source in the Database tool window (⌘ 1) .

    • For more information about the Database tool window, see the corresponding reference topic.

    • For more information about working with database objects in JetBrains Rider, refer to Database objects.

    • To write and run queries, open the default query console by clicking the data source and pressing F4.

    • To view and edit data of a database object, open Data editor and viewer by double-clicking the object.

Connection settings and DBMS-specific properties

Connection settings

For the reference information about connection settings (for example, Host, Port, and so on) on the General and other tabs of Data Sources and Drivers dialog (Shift+Enter) , see Data source settings.

DBMS-specific properties

General tab

Item

Description

Connection type

Region

The AWS Region that is available for the Amazon Redshift.

IAM cluster/region

Cluster

Amazon Redshift cluster is a group of computing resources. For more information, refer to the Amazon Redshift official documentation.

Profile

Your named profile. A named profile is a collection of settings and credentials that you can use for authentication. Named profiles are stored in CREDENTIALS files. Default directories for these files are ~/.aws/credentials (Linux and macOS) and %\USERPROFILE%\.aws\credentials (Windows).

all types (AWS Profile authentication method)

Schemas tab

Item

Description

Show internal system schemas

Show internal system schemas like pg_temp or p_toast.

Show template databases

Show template databases.

Last modified: 27 February 2024