# Source: https://docs.velodb.io/cloud/4.x/integration/sql-client/dbeaver

Version: 4.x

On this page

# DBeaver

## introduce​

DBeaver is a cross-platform database tool for developers, database
administrators, analysts and anyone who works with data.

Apache Doris is highly compatible with the MySQL protocol. You can use
DBeaver's MySQL driver to connect to Apache Doris and query data in the
internal catalog and external catalog.

## Preconditions​

Dbeaver installed You can visit <https://dbeaver.io> to download and install
DBeaver

## Add data source​

Note

Currently verified using DBeaver version 24.0.0

  1. Start DBeaver

  2. Click the plus sign (**+**) icon in the upper left corner of the DBeaver window, or select **Database > New Database Connection** in the menu bar to open the **Connect to a database** interface.

![add connection
1](/assets/images/dbeaver1-08e265526a12a1b560d84b179eac1238.png)

![add connection
2](/assets/images/dbeaver2-a7f26e8015598024cb730df1f3f341d2.png)

  3. Select the MySQL driver

In the **Select your database** window, select **MySQL**.

![chose driver](/assets/images/dbeaver3-599f75b71d72b8454f6641c2e575f96c.png)

  4. Configure Doris connection

In the **main** tab of the **Connection Settings** window, configure the
following connection information:

  * Server Host: FE host IP address of the Doris cluster.
  * Port: FE query port of Doris cluster, such as 9030.
  * Database: The target database in the Doris cluster.
  * Username: The username used to log in to the Doris cluster, such as admin.
  * Password: User password used to log in to the Doris cluster.

tip

Database can be used to distinguish between internal catalog and external
catalog. If only the Database name is filled in, the current data source will
be connected to the internal catalog by default. If the format is catalog.db,
the current data source will be connected to the catalog filled in Database by
default, as shown in DBeaver The database tables are also database tables in
the connected catalog, so you can use DBeaver's MySQL driver to create
multiple Doris data sources to manage different Catalogs in Doris.

Note

Managing the external catalog connected to Doris through the Database form of
catalog.db requires Doris version 2.1.0 and above.

  * internal catalog ![connect internal catalog](/assets/images/dbeaver4-9b79f13badba5713605d6647f4648ed9.png)
  * external catalog ![connect external catalog](/assets/images/dbeaver5-f92fa21b93bffc3ce13dfb830da8dd13.png)

  5. Test data source connection

After filling in the connection information, click Test Connection in the
lower left corner to verify the accuracy of the database connection
information. DBeaver returns to the following dialog box to confirm the
configuration of the connection information. Click OK to confirm that the
configured connection information is correct. Then click Finish in the lower
right corner to complete the connection configuration. ![test
connection](/assets/images/dbeaver6-fac1178b7798f028a57c79991dd9a036.png)

  6. Connect to database

After the database connection is established, you can see the created data
source connection in the database connection navigation on the left, and you
can connect and manage the database through DBeaver. ![create
connection](/assets/images/dbeaver7-68de28fe0f0fe59c23972aa3bc39c354.png)

## Function support​

  * fully support

    * Visual viewing class 
      * Databases 
        * Tables
        * Views
      * Users 
        * Administer
      * Session Manager
      * System Info 
        * Session Variables
        * Global Variables
        * Engines
        * Charsets
        * User Priviages
        * Plugin
      * Operation class 
        * SQL editor
        * SQL console
  * basic support

The basic support part means that you can click to view without error, but due
to protocol compatibility issues, there may be incomplete display.

    * Visual viewing class 
      * dash board
      * Users/user/properties
      * Session Status
      * Global Status
  * not support

The unsupported part means that when using DBeaver to manage Doris, errors may
be reported when performing certain visual operations, or some visual
operations are not verified. Such as visual creation of database tables,
schema change, addition, deletion and modification of data, etc.

On This Page

  * introduce
  * Preconditions
  * Add data source
  * Function support