Management tools

You can manage OceanBase Database by using a CLI client tool or a database management product provided by OceanBase.

OceanBase Database supports the following client tools: OceanBase Client (OBClient), MySQL client, and OceanBase Developer Center (ODC). You can also use OceanBase Cloud Platform (OCP) to manage OceanBase Database.

The following table describes the features of these database management tools. You can select one of them as needed.

OBClient

OBClient is a recommended CLI client tool used to connect to OceanBase Database. It is compatible with both MySQL and Oracle tenants in OceanBase Database.

You can contact OceanBase Technical Support to obtain the client.

After you download and install OBClient, you can execute the following statement to connect to OceanBase Database:

obclient -u[Username]@[Tenant name]#[Cluster name] -P[Port No.] -h[IP address] -p[Password] -D[Database name] -c

Note

• If the statement does not have the -c option, the hint does not take effect after you connect to the tenant.
• By default, if the statement does not have the -D[database name] option, the username is used as the database name.

For more information about how to connect to OceanBase Database by using OBClient, see Connect to OceanBase Database from OBClient.

MySQL client

MySQL client is a client tool used to connect to OceanBase Database. It is compatible only with MySQL tenants in OceanBase Database.

OceanBase Database supports MySQL client V5.5, V5.6, and V5.7. You can select one of the versions as needed.

You can execute the following statement to connect to a MySQL tenant in OceanBase Database:

mysql -u[Username]@[Tenant name]#[Cluster name] -P[Port No.] -h[IP address] -p[Password] -D[Database name] -c

Note

If the statement does not have the -c option, the hint does not take effect after you connect to the MySQL tenant.

For more information about how to connect to OceanBase Database by using a MySQL client, see Connect to OceanBase Database from a MySQL client.

OCP

OCP is a GUI-based management platform for OceanBase Database. It is an enterprise-level database management platform with OceanBase Database as its core.

OCP supports all major versions of OceanBase Database and the full-lifecycle management of components such as OceanBase clusters and OceanBase Database tenants. It manages OceanBase Database resources such as hosts, networks, and software packages. You can use OCP to manage OceanBase clusters more efficiently at reduced IT O&M costs.

As an enterprise-level database management platform for OceanBase Database, OCP provides a wealth of features in the following aspects:

• Security

  The security feature involves user management, role management, and a user center.

  In OCP, management permissions on various resources are granted to users by using roles. In the user management and role management modules, you can manage the users and roles of OCP, including creating, modifying, or dropping users and roles.

  You can also grant permissions to and revoke permissions from roles. These cover most user management functions required in common enterprise-level database monitoring software.

  The user center provides various features for personal security management, including personal settings, password box, and alert subscription management for OCP users.

• Cluster management

  OCP provides management features for OceanBase clusters throughout their lifecycle, including cluster installation, O&M, performance monitoring, configuration, upgrade, and deletion, covering most user requirements for managing OceanBase clusters.

• Tenant management

  OCP provides a variety of management features for OceanBase Database tenants, including tenant creation, tenant topology, performance monitoring, session management, and parameter management.

• Monitoring and alerts

  Monitoring and alerts are an important part of enterprise-level IT management software. OCP supports monitoring on OceanBase clusters and hosts, as well as OceanBase Database tenants.

  You can use the built-in alerts to meet basic requirements or configure custom alerts. You can also use templates to configure HTTP and custom script channels for various message channels.

• Host management

  The host management feature allows you to view host information and add or delete hosts.

• Backup and restore

  This provides full backup, incremental backup, and log backup for OceanBase clusters and OceanBase Database tenants.

• System management

  This feature mainly allows you to view tasks and manage running tasks.

For more information about the features and use of OCP, see the OCP User Guide for the corresponding version.

Note

The features and GUI vary based on the OCP version. This topic takes OCP V3.3.2 as an example. For other OCP versions, see the OCP User Guide of the corresponding version.

ODC

ODC is an enterprise-level database development platform tailored for OceanBase Database. It is compatible with both MySQL and Oracle tenants in OceanBase Database, and provides database developers with a wide range of features, such as daily development, WebSQL-based workspace, SQL diagnostics, session management, and data import and export.

ODC adopts the mature browser/server architecture, which supports cross-platform capabilities and is lightweight and easy to deploy. ODC also provides a client to help individual developers get started with OceanBase Database. It also improves the collaboration efficiency between developers and database administrators (DBAs).

Note

For more information about how to connect to OceanBase Database and about other features of ODC, see the OceanBase Developer Center User Guide of the corresponding version in the documentation center.

For more information about how to connect to OceanBase Database by using ODC, see Connect to OceanBase Database through ODC.