DataGrip is an integrated development environment (IDE) designed by JetBrains specifically for database development personnel and administrators. It supports various database management systems, provides intelligent code completion, and facilitates version control integration.
This article will introduce how DataGrip connects to ByteHouse Cloud Data Warehouse Edition via JDBC driver using the TCP method.

Background information #

ByteHouse supports connecting DataGrip via IAM user or database user. The differences between IAM users and database users are described as follows; you can select as needed.

• IAM user is a user created in BytePlus access control (IAM), whose privileges are determined by the IAM privilege policy and the ByteHouse resources and data privileges you grant. IAM users can access the ByteHouse Console and can also access ByteHouse via CLI, connection drivers, tools, API, and others.
• Database user is a database-level user created in ByteHouse, to whom you can grant environment, resources, and data privileges. Database users cannot access the ByteHouse Console, but can access ByteHouse via CLI, connection drivers, tools, API, and others.

For more information on IAM users and database users, please refer to the following documents:

• Overview
• User Management
• Manage Database Accounts

Prerequisites #

1. Please install DataGrip in advance and acquire the corresponding commercial authorization.
2. You can set the default virtual warehouse/database for connection on the Tenant Management - Parameter Setting page.
   

Use DataGrip to connect to ByteHouse #

1. Launch DataGrip, click the + icon on the Database Explorer tab, and select Data Source -> MySQL.
   

   warning

   If the interface prompts for driver download, click "Download" to complete the driver download.
   

2. Configure Data Source information.
   

   Parameters	Connect using IAM user	Connect using database user
   Name	Customize the connection name.
   Host	Configure as the ByteHouse network domain name, which can be obtained in ByteHouse Console at Tenant Management > basic information > Network Information. For details, see Step 2: Set network information.
   Port	Database port number; configure as the fixed value: 3306.
   User & Password	Username and password for logging in to the ByteHouse database. User Name defaults to bytehouse. Password is <API_Key>, which can be obtained in ByteHouse Console > Tenant Management > Connection Information, where you can obtain the API Key. For details, see Obtain API key.	User Name is configured as {accountID_or_accountName}::{username}[::{envID}]. For details, see Step 3: Obtain ByteHouse connection string information: {accountID_or_accountName}: Refers to the BytePlus user account ID or name. Log in to the ByteHouse Console, click Profile in the upper right corner to view and copy the Account ID or name. {username}: The username of the database user account used to log in to ByteHouse. Go to ByteHouse Console > access control > User > View database username. {envID}: Optional configuration, the name of the environment where the database is located. If using the default environment, configuration is not required. To use another environment, specify the environment name. Do not add [] during configuration. You can log in to ByteHouse Console, and obtain it in Tenant management > Basic information > Current environment. Examples are as follows: Configure environment ID: 21xxxxxxxx::demouser::demoenv Without configuring environment ID: 21xxxxxxxx::demouser password: The password of the database user account is set by the administrator during custom configuration when creating the database user account. You can contact the administrator to obtain the password. If the password is lost or forgotten, contact the administrator to reset the password. For details, refer to Reset Password.
   URL	The field format is as follows: jdbc:bytehouse://{HOST}:{PORT}/?secure=true&user=bytehouse&password={API_KEY}	The field format is as follows: jdbc:bytehouse://{HOST}:{PORT}/?secure=true&user={accountID_or_accountName}::{username}[::{envID}]&password={password}

3. Switch to the SSH/SSL tab and check Use SSL.
   

4. Click Test Connection; if Succeeded is displayed, the connection is successful.

   tip

   Due to differences in how third-party software recognizes special characters contained in the password field of the URL, if you have set it correctly as above but still cannot connect, try manually entering the password in the password input box and test the connection again.

Reference #

To learn more details about DataGrip, visit the DataGrip official documentation.