Amazon Redshift
Official documentation
For full information about Amazon Redshift, refer to the official documentation.
For more versions of Amazon Redshift JDBC driver, refer to the official JDBC driver downloads.
This topic presents a general procedure on how you can connect to Amazon Redshift from RubyMine. 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 RubyMine to this instance. For more information about configuring Amazon EC2, see this tutorial at aws.amazon.com.
In RubyMine, 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 Control+F6.
Code editor supports all the related statements.
Prerequisites
Your Amazon Redshift dashboard must have an Amazon Redshift cluster in it. For more information about the Amazon Redshift cluster, read Getting Started with Amazon Redshift.
Connect to an Amazon Redshift database
To connect to the database, create a data source that will store your connection details. You can do this using one of the following ways:
From the main menu, navigate to and select Amazon Redshift.
In the Database tool window ( ) , click the New icon (
) in the toolbar. Navigate to Data Source and select Amazon Redshift.
In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.
In the Driver list, leave the default driver option, unless another driver is required for your connection.
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.
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.
You can find the downloaded JDBC drivers in the RubyMine configuration directory.
The IDE does not include bundled drivers in order to have a smaller size of the installation package and to keep driver versions up-to-date for each IDE version.
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, see Add a user driver to an existing connection.
If there is no Download missing driver files link, then you already have the required drivers.
Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.
In the Host field, type your server address.
In the Port field, type the port of Amazon Redshift. The default port is 5439.
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.
In the Database field, type the database name to which you want to connect.
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.
In the Database field, type the database name to which you want to connect.
In the Region field, enter the AWS Region of the database that you are connecting to.
In the Cluster field, enter the name of Amazon Redshift cluster that contains your database.
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.
For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Command I), see Connection settings and DBMS-specific properties.
In settings of the Redshift cluster, copy the JDBC URL.
Paste the JDBC URL from the Redshift cluster settings to the URL field in RubyMine.
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 full information about the JDBC URL format, refer to the Amazon Redshift official documentation.
In User and Password fields, specify your Redshift credentials.
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.
In case of any connection issues, refer to the Cannot connect to a database page.
(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.
Click OK to create the data source.
Find your new data source in the Database tool window (Alt+1) .
To learn more about the Database tool window, see the corresponding reference topic.
To learn how to work with database objects in RubyMine, see 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 (Command I), 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. |
Schemas tab
Item | Description |
|---|---|
Show internal system schemas | Show internal system schemas like pg_temp or p_toast. |
Show template databases | Show template databases. |