Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ GaussDB/ User Guide/ GaussDB Instance Connection/ Using DBeaver to Connect to an Instance

Using DBeaver to Connect to an Instance

Updated on 2025-01-09 GMT+08:00

DBeaver is a multi-platform database client for you to connect to different databases using particular drivers. This section describes how to use DBeaver to connect to a GaussDB instance.

NOTE:

This section uses DBeaver 24.1.4 as an example. DBeaver's GUIs differ depending on the version you are using. To learn more about how to perform operations in different versions, refer to the product documentation specific to that version.

Step 1: Obtain the DBeaver Client Installation Package

The DBeaver official website provides client installation packages for different OSs. Download the required DBeaver client installation package, and install it on the local PC.

Step 2: Connect to the Database

  1. On the DBeaver client, choose to create a connection.
  2. On the SQL tab, select GaussDB and click Next.
    Figure 1 Selecting a database

  3. Enter the host IP address, port number, database name, username, and password.
    Figure 2 Configuring the connection

    Table 1 Parameters

    Parameter

    Description

    Host

    Private IP address of the DB instance to be connected. To obtain the IP address, perform the following steps:
    1. Log in to the GaussDB management console.
    2. Select the region in which the target instance is located.
    3. Click the name of the target instance to enter the Basic Information page.
    4. In the Node List area, view the EIP of the instance.

      If no EIP is bound to the instance, bind one to the instance first. For details, see Binding an EIP.

    Port

    Port of your DB instance specified during instance creation. The default port of a GaussDB instance is 8000.

    Database

    Name of the database to be connected. After a DB instance is created, a database named postgres is generated by default.

    Username

    Name of the user who will access the GaussDB instance. The default user is root.

    Password

    Password of the user who will access the GaussDB instance.

  4. Click Test Connection. In the Driver settings dialog box, click Download to enable the server to automatically download driver files. If Connected is displayed in the dialog box, the connection is successful. Click OK.

    Alternatively, obtain driver files by yourself and click Edit Driver. Then, click the Libraries tab and add the local driver files to the driver editor.

    Figure 3 Automatically downloading driver files

    Figure 4 Manually adding local driver files

  5. Click Finish to connect to the database. You can view information about the connected database in the Database Navigator area.

Related Operations

  1. Obtain the driver package and its verification package.

    Download the driver package and its verification package of the relevant version to any local directory. Table 2 lists the download list.

  2. Verify the driver package.

    To prevent the driver package from being maliciously tampered during transfer or storage, perform the following steps to verify the driver package:

    1. Press Win+R to open the Run text box. Type cmd in the Open field and press Enter to open the Command Prompt window.
    2. Run the following command to obtain the hash value of the driver package:

      certutil -hashfile {Local directory of the driver package}\{Driver package name} sha256

      • Replace {Local directory of the driver package} with the actual download path, for example, C:\Users.
      • Replace {Driver package name} with the name of the downloaded driver package, for example, GaussDB_driver.zip.

      Example: certutil -hashfile C:\Users\GaussDB_driver.zip sha256

    3. Compare the hash value obtained in 2.b with the hash value of the verification package obtained in 1.
      • If they are consistent, the verification is successful.
      • If they are inconsistent, download the driver package again and repeat 2.a to 2.c to verify the driver package.
  3. Extract the gsjdbc4.jar package from the driver package.

    Decompress the driver package obtained in 1 to the local PC. Then, go to any OS directory in the directory of the driver package corresponding to the type of the instance to be connected, extract the gsjdbc4.jar package from the GaussDB-Kernel_Database version_OS version_64bit_Jdbc.tar.gz package, and save it to any local directory. The following is an example:

    To connect to a distributed instance, go to the GaussDB_driver\Distributed\Euler2.5_X86_64 directory, find the GaussDB-Kernel_503.1.0.SPC2300_Euler_64bit_Jdbc.tar.gz package, and extract the gsjdbc4.jar package from it.

    NOTE:

    The same JDBC driver package is used across different operating systems and CPU architectures. You only need to focus on the instance type when obtaining the required gsjdbc4.jar package.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback