All Products
Search
Document Center

PolarDB:Connect to a cluster

Last Updated:Jul 25, 2023

This topic describes how to use Data Management (DMS) or a MySQL client to connect to a cluster of PolarDB for MySQL.

Prerequisites

A privileged account or a standard account is created for the cluster. For more information, see Create a database account.

Use DMS to connect to a cluster

DMS is a visualized data management service provided by Alibaba Cloud. DMS provides various management services such as data management, schema management, access control, business intelligence (BI) charts, data trends, data tracking, performance optimization, and server management. You can use DMS to manage relational databases such as MySQL, SQL Server, and PostgreSQL databases and NoSQL databases such as MongoDB and Redis databases. You can also use DMS to manage Linux servers.

  1. Log on to the PolarDB console.
  2. In the upper-left corner of the console, select the region where the cluster resides.
  3. Find the cluster, and then click the cluster ID.
  4. In the upper-right corner of the Overview page, click Log On to Database.

  5. In the dialog box that appears, enter the database account and database password that you created for the PolarDB for MySQL cluster and click Login. Logon page

    Note

    The logon account must be granted management permissions on the database. Otherwise, you cannot find the database in the left-side navigation pane of the DMS console. For information about how to modify the permissions granted to an account, see Modify the permissions of a standard account.

  6. After you log on to DMS, refresh the page. In the left-side navigation pane, click Instances Connected.

  7. In the Instances Connected list, click the cluster name, find the database, and then double-click the database name. Then, you can manage the database.

    1

Use a client to connect to a cluster

You can use a MySQL client to connect to a PolarDB cluster. The client used in the following example is HeidiSQL.

  1. Start HeidiSQL.

  2. In the lower-left corner of the session manager, click New.

  3. Specify the information about the PolarDB cluster to which you want to connect. The following table describes the parameters.

    Parameter

    Description

    Network type

    The network protocol type that is used to connect to the database. Select MariaDB or MySQL (TCP/IP).

    Hostname / IP

    Enter a public or private endpoint of the PolarDB cluster.

    • If the client runs on an Elastic Compute Service (ECS) instance that is deployed in the same region and has the same network type as the PolarDB cluster, use a private endpoint. For example, if the ECS instance and the PolarDB cluster are deployed in a virtual private cloud (VPC) in the China (Hangzhou) region, you can use a private endpoint to establish a secure and fast connection.

    • In other scenarios, use a public endpoint.

    To view the endpoint and port information about the PolarDB cluster, perform the following steps:

    1. Log on to the PolarDB console.

    2. In the upper-left corner of the page, select the region in which the cluster is deployed.

    3. Find the cluster and click the cluster ID.

    4. On the Overview page, view the endpoint and port information.

    Users

    The name of the account that is used to connect to the PolarDB cluster.

    Password

    The password of the account.

    Port

    The port number in the public or private endpoint that is used to connect to the PolarDB cluster. The default port number is 3306.

  4. Click Open. If the connection information is valid, the client is connected to the cluster. HeidiSQL is connected to the database

Use the CLI to connect to a cluster

If MySQL is installed on your server, you can run the following command in the CLI to connect to a PolarDB for MySQL cluster:

mysql -h<Endpoint> -P<Port number> -u<Username> 
Example:
mysql -hpc-bp199s527********.rwlb.rds.aliyuncs.com -P3306 -upolardb
Note

After you run the preceding command, Enter password appears. Enter the database password of the cluster as prompted to connect to the cluster.

Parameter

Description

Example

-h

The public or private endpoint of the PolarDB cluster. For more information about endpoints, see Cluster endpoints and primary endpoints.

pc-bpxxxxxxxxxxxxxx.mysql.polardb.rds.aliyuncs.com

-P

The port number that is used to connect to the PolarDB cluster.

  • If you use the private endpoint to connect to the PolarDB cluster, enter the private port number in the private endpoint.

  • If you use a public endpoint to connect to the PolarDB cluster, enter the port number in the public endpoint.

Note
  • The default port number is 3306.

  • If you want to use the default port, you do not need to specify a value for this parameter.

3306

-u

The name of the database account that is used to connect to the PolarDB cluster.

root