From e052c19b71ea93306eaf5688379af6e6deb1fe9a Mon Sep 17 00:00:00 2001 From: wugongbo <49148749+wugongbo@users.noreply.github.com> Date: Thu, 6 Nov 2025 19:50:36 +0800 Subject: [PATCH] Update 02_ecological-tools.md Refreshed all the links and improved descriptions --- .../02_ecological-tools.md | 136 ++++++++++-------- 1 file changed, 73 insertions(+), 63 deletions(-) diff --git a/docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md b/docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md index 93204bf40..714ce4ea0 100755 --- a/docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md +++ b/docs/user_manual/quick_starts/en-US/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md @@ -1,11 +1,11 @@ --- -title: OceanBase ecological tools +title: OceanBase ecosystem tools weight: 3 --- -# 1.2 OceanBase ecological tools +# 1.2 OceanBase ecosystem tools -This topic introduces various OceanBase ecological tools, including those for installation and deployment, monitoring, and migration and synchronization. +This topic introduces various OceanBase ecosystem tools, including those for installation and deployment, monitoring, and migration and synchronization. > **Note** > @@ -15,178 +15,188 @@ This topic introduces various OceanBase ecological tools, including those for in ### ODP -OceanBase Database Proxy (ODP) is a proxy server dedicated for OceanBase Database. Unlike other ecological tools described in this topic, ODP is a part of the OceanBase Database kernel that comprises OBServer nodes and ODP. OceanBase Database stores replicas of user data on multiple OBServer nodes. When receiving an SQL request from a user, ODP forwards the request to the optimal OBServer node and returns the execution result to the user. Core features of ODP include connection management, optimal routing, high-performance forwarding, easy O&M, high availability, and proprietary protocol. +OceanBase Database Proxy (ODP) is a dedicated proxy server for OceanBase Database. Unlike other ecosystem tools covered in this topic, ODP is a part of the OceanBase Database kernel, which consists of OBServer nodes and ODP. OceanBase Database stores replicas of user data across multiple OBServer nodes. Upon receiving an SQL request from a user, ODP forwards the request to the optimal OBServer node and returns the execution result to the user. Key features of ODP include connection management, optimal routing, high-performance forwarding, easy operation and maintenance (O&M), high availability, and a proprietary protocol. -For more information, see [OceanBase Database Proxy](https://en.oceanbase.com/docs/common-odp-doc-en-10000000001177429). +For details, see [OceanBase Database Proxy](https://en.oceanbase.com/docs/common-odp-doc-en-10000000002135903). ## Installation and deployment tools ### OCP -OceanBase Cloud Platform (OCP) is an enterprise-level management platform tailored for OceanBase clusters. It is compatible with all major OceanBase Database versions. It provides GUI-based management capabilities, including lifecycle management of database components and resources (such as hosts, networks, and software packages), fault recovery, performance diagnostics, as well as monitoring and alerting. OCP aims to help enterprises manage OceanBase clusters more efficiently at lower IT O&M costs and shorten the user learning curve. +OceanBase Cloud Platform (OCP) is an enterprise-grade management platform designed for OceanBase clusters. It is compatible with all major OceanBase Database versions. OCP provides GUI-based management capabilities, including lifecycle management of database components and resources (such as hosts, networks, and software packages), fault recovery, performance diagnostics, monitoring, and alerting. OCP helps enterprises manage OceanBase clusters more efficiently, reduces IT O&M costs, and shortens the user learning curve. -For more information about the system architecture and features of OCP, see [OceanBase Cloud Platform](https://en.oceanbase.com/docs/common-ocp-10000000001553919). +For more information about the system architecture and features of OCP, see [OceanBase Cloud Platform](https://en.oceanbase.com/docs/common-ocp-10000000002854293). ### OCP Express OCP Express is a web-based management tool for OceanBase Database V4.x. Integrated with OceanBase clusters, OCP Express allows you to view key performance metrics and perform basic database management operations on OceanBase clusters. -OCP Express is derived from OCP. It retains the core capabilities of OCP and adjusts the overall layout of features to provide a brand-new user experience. Feature configurations are also rearranged in OCP Express so that OCP Express can be deployed on any database node with the minimum resource consumption. OCP Express allows you to gain extensive control over OceanBase Database V4.x at minimum costs. +Derived from OCP, OCP Express retains core features but offers a refreshed layout for a better user experience. Feature configurations are rearranged to allow deployment on any database node with the minimum resource consumption. OCP Express provides broad control over OceanBase Database V4.x while minimizing costs. -OCP Express is intended for lightweight O&M management and is integrated with the managed OceanBase cluster for dedicated management. It minimizes resource consumption while meeting basic O&M requirements. OCP is intended for the O&M of large-scale complex clusters, and you can manage multiple OceanBase clusters in OCP. It provides more management capabilities than OCP Express. An additional OceanBase cluster is needed to store the data of OCP, and higher resource configurations are needed to implement the capabilities of OCP. +Intended for lightweight O&M management, OCP Express integrates with the managed OceanBase cluster for one-to-one dedicated management. It supports basic O&M needs with fewer resources. In contrast, targeted large-scale and complex clusters, OCP supports managing multiple OceanBase clusters and provides richer management capabilities than OCP Express. However, OCP requires an additional OceanBase cluster to store its own data and demands higher resource configurations. > **Note** > -> OCP Express applies to the O&M of an OceanBase cluster in a development and testing environment with no more than 20 servers and 3 to 5 tenants. We recommend that you use OCP in a production environment. +> OCP Express is suitable for O&M of OceanBase clusters in development and testing environments with no more than 20 servers and 3 to 5 tenants. We recommend using OCP for production environments. -For more information about the system architecture and features of OCP Express, see [OCP Express](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375615). +For more information about the system architecture and features of OCP Express, see [OCP Express](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001971292). ### OBD -OceanBase Deployer (OBD) allows you to install and deploy an OceanBase cluster on the CLI or GUI. OBD standardizes the complex configuration process to simplify cluster deployment. +OceanBase Deployer (OBD) enables installation and deployment of OceanBase clusters through CLI or GUI. It standardizes the complex configuration process, simplifying cluster deployment. -In CLI-based deployment, you can edit the configuration file to flexibly adjust the configurations. This deployment mode requires expertise and is suitable for users who have a deep understanding of OceanBase Database. In GUI-based deployment, you can easily deploy a cluster by following the wizard. This deployment mode is suitable for users who want to quickly experience OceanBase Database in a standard environment. +* CLI-based deployment lets you edit configuration files for flexible adjustment and requires deep OceanBase knowledge. -Besides cluster deployment, OBD also provides general O&M capabilities such as the package manager, stress test software, and cluster management to deliver better user experience on OceanBase Database. +* GUI-based deployment uses a wizard to guide you through easily setting up clusters, ideal for quickly trying OceanBase in standard environments. -For more information, see [OceanBase Deployer](https://en.oceanbase.com/docs/obd-en). +In addition to cluster deployment, OBD provides general O&M capabilities such as the package management, stress testing, and cluster management for better user experience. + +For details, see [OceanBase Deployer](https://en.oceanbase.com/docs/obd-en). ### ob-operator -ob-operator is a tool built based on the Kubernetes Operator framework for managing OceanBase clusters on Kubernetes. It provides a simple and reliable way to implement containerized deployment of OceanBase clusters and simplifies the O&M of OceanBase clusters. ob-operator defines various resources for OceanBase Database and implements the corresponding coordination logic. It allows you to manage OceanBase clusters in a declarative manner, just as you would manage native Kubernetes resources. +ob-operator is built on the Kubernetes Operator framework to manage OceanBase clusters on Kubernetes. It provides a simple and reliable way to implement the containerized deployment of and simplify the O&M of OceanBase clusters. ob-operator defines various resources for OceanBase Database and implements the corresponding coordination logic, allowing you to manage OceanBase clusters declaratively, much like native Kubernetes resources. -For more information about the features and usage instructions of ob-operator, see [Kubernetes Operator for OceanBase](https://en.oceanbase.com/docs/community-ob-operator-doc-en-10000000001195649). +For more information about the features and usage instructions of ob-operator, see [Kubernetes Operator for OceanBase](https://en.oceanbase.com/docs/community-ob-operator-doc-en-10000000001735158). ## Monitoring tools ### OCP / OCP Express -OCP and OCP Express not only allow you to create and manage clusters and tenants, but also provide features such as performance diagnostics, and monitoring and alerting. For more information, see the description of OCP and OCP Express in 'Installation and deployment tools'. - -### DOOBA - -DOOBA is an internal O&M script of OceanBase Database that is developed in Python for performance monitoring. After you connect to the sys tenant of OceanBase Database by running a MySQL command, you can run DOOBA to display the queries per second (QPS) and the average response time (RT) of the SQL statements executed in the tenant in real time. The supported SQL types include `SELECT`, `UPDATE`, `INSERT`, `DELETE`, and `COMMIT`. You can also view the QPS and RT of SQL statements executed on each OBServer node. - -For more information, see [DOOBA](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375726). +In addition to cluster and tenant management, OCP and OCP Express provide performance diagnostics, monitoring, and alerting features. See the description of OCP and OCP Express in [Installation and deployment tools](#Installation and deployment tools) for details. ### OBAgent -OceanBase Agent (OBAgent) is a framework for monitoring data collection and O&M. +OceanBase Agent (OBAgent) is a monitoring data collection and O&M framework. -* Monitoring data collection +* Data collection - OBAgent supports data collection in pushing and pulling modes for different scenarios. By default, OBAgent supports plug-ins for server data collection, OceanBase Database metrics collection, log collection, monitoring data label processing, and HTTP service of the Prometheus protocol. OBAgent allows you to push data to Pushgateway, vmagent, Elasticsearch, Simple Log Service (SLS), and Alertmanager. You can also develop plug-ins to enable OBAgent to collect data from other sources or customize the data processing process. + OBAgent supports push and pull modes for various scenarios. By default, OBAgent supports plug-ins for server data collection, OceanBase Database metrics collection, log collection, monitoring data label processing, and HTTP service of the Prometheus protocol. Data can be pushed to Pushgateway, vmagent, Elasticsearch, Simple Log Service (SLS), and Alertmanager. You can also develop plug-ins to enable OBAgent to collect data from other sources or customize the data processing process. * O&M - OBAgent allows you to configure hot updates. It also provides APIs for OBAgent O&M, file operations, and RPM package operations. You can use these APIs as needed. + OBAgent offers hot update configuration and APIs for O&M, file, and RPM package operations. -For more information, see the [obagent repository](https://github.com/oceanbase/obagent) on GitHub. +For details, see the [obagent repository](https://github.com/oceanbase/obagent). ## Migration and synchronization tools ### OMS -OceanBase Migration Service (OMS) is a service that supports data interaction between a homogeneous or heterogeneous data source and OceanBase Database. OMS provides the capabilities for online migration of existing data and real-time synchronization of incremental data. +OceanBase Migration Service (OMS) supports data migration between a homogeneous or heterogeneous data source and OceanBase Database. It handles online migration of existing data and real-time synchronization of incremental data. -OMS Community Edition provides a visualized and centralized management platform. You can migrate data with simple configurations. OMS Community Edition aims to help you migrate and synchronize data in real time from homogeneous or heterogeneous data sources to OceanBase Database at a low cost and low risk. +OMS Community Edition provides a visual, centralized management platform for you to migrate data in real time with simple configuration. It helps you migrate and synchronize data in real time from a homogeneous or heterogeneous data source to OceanBase Database at a low cost and at a low risk. -For more information, see [OceanBase Migration Service](https://en.oceanbase.com/docs/oms-en). +For details, see [OceanBase Migration Service](https://en.oceanbase.com/docs/oms-en). ### OBLogProxy -OBLogProxy is the incremental log proxy service of OceanBase Database. It establishes connections with OceanBase Database to read incremental logs and provides downstream services with change data capture (CDC) capabilities. +OBLogProxy is the incremental log proxy service of OceanBase Database. It connects to OceanBase Database to read incremental logs and enables downstream CDC (change data capture). -OBLogProxy supports the following two modes: +It supports two modes: -* The binlog mode of OBLogProxy is designed for compatibility with MySQL binlogs. It allows you to use MySQL binlog incremental parsing tools to synchronize OceanBase Database logs in real time. Thereby, you can smoothly use MySQL binlog tools with OceanBase Database. +* Binlog mode: Compatible with MySQL binlogs, allowing the use of MySQL binlog parsing tools to synchronize OceanBase Database logs in real time. -* OBLogProxy in CDC mode subscribes to data changes in OceanBase Database and synchronizes these data changes to downstream services in real time for real-time or quasi-realtime data replication and synchronization. +* CDC mode: Subscribes to data changes in OceanBase Database and synchronizes these to downstream services for real-time or near real-time replication and synchronization. -For more information, see [OBLogProxy](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375722). +For details, see [OBLogProxy](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001971288). ### OBLOADER & OBDUMPER OceanBase provides the data import tool OBLOADER and the data export tool OBDUMPER. -OBLOADER provides extensive command-line options that allow you to import database object definitions and table data to OceanBase Database in complex scenarios. We recommend that you use OBLOADER in combination with OBDUMPER. You can also use OBLOADER to import files in the CSV format that are exported by using third-party tools, such as Navicat, MyDumper, and SQL Developer, to OceanBase Database. OBLOADER fully exploits the features of the distributed OceanBase Database system and is particularly optimized in import performance. +OBLOADER offers extensive command-line options to import database object definitions and table data to OceanBase Database in complex scenarios. It works well with OBDUMPER and can import CSV files exported by tools like Navicat, MyDumper, or SQL Developer. OBLOADER leverages OceanBase Database's distributed architecture and optimizes the import performance. -You can use OBDUMPER to export table data from OceanBase Database to files in the SQL or CSV format. You can also use it to export objects defined in the database to files. +OBDUMPER supports exporting table data from OceanBase Database to SQL or CSV files and also supports exporting objects defined in the database to files. -For more information, see [OceanBase Loader and Dumper](https://en.oceanbase.com/docs/obloader-obdumper-en). +For details, see [OceanBase Loader and Dumper](https://en.oceanbase.com/docs/obloader-obdumper-en). ## O&M tools ### OCP / OCP Express -In addition to creating and managing clusters and tenants, OCP also supports fault recovery, performance diagnostics, and monitoring and alerting. +OCP supports creating and managing clusters and tenants, fault recovery, performance diagnostics, and monitoring and alerting. -Unlike OCP, OCP Express does not support advanced O&M capabilities, such as backup and restore, version upgrade, and cluster scaling, aiming to reduce resource usage. OCP Express is more lightweight than OCP and is designed to meet the basic O&M and monitoring requirements of a single cluster. We recommend that you use OCP in a production environment. +Compared with OCP, OCP Express does not support advanced O&M capabilities, such as backup and restore, version upgrade, and cluster scaling, aiming to reduce resource usage. OCP Express is more lightweight than OCP and is designed to meet the basic O&M and monitoring requirements of a single cluster. For production environments, we recommend using OCP. -For more information, see the description of OCP and OCP Express in 'Installation and deployment tools'. +See the description of OCP and OCP Express in [Installation and deployment tools](#Installation and deployment tools) for details. ### OBShell -OceanBase Shell (OBShell) is an out-of-the-box command-line tool provided by OceanBase Database Community Edition for O&M engineers and developers to manage local OceanBase clusters. OBShell supports cluster O&M and provides O&M and management APIs based on OceanBase Database. This allows products from different ecosystems to manage the same OceanBase cluster in a unified manner, reducing the difficulty in and costs of OceanBase cluster management. +OceanBase Shell (OBShell) is an out-of-the-box CLI tool for O&M engineers and developers to manage local OceanBase clusters. It supports cluster O&M and provides O&M APIs based on OceanBase Database, enabling unified management across different ecosystem tools and reducing operational complexity and costs. -You do not need to separately install OBShell. As long as OceanBase Database Community Edition is installed, you can find the OBShell executable file in the `bin` directory under the working directory of each OBServer node. +OBShell requires no separate installation. It is included with OceanBase Database Community Edition, located in the `bin` directory under the working directory of each OBServer node. -For more information, see [OBShell](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001378072). +For details, see [OBShell](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001973568). ### obdiag -obdiag is a CLI diagnostic tool designed for OceanBase Database. At present, it can scan, collect, and analyze diagnostic information such as the logs, SQL audit records, and the process stack information of OceanBase Database. You can use obdiag easily, no matter whether your OceanBase cluster is deployed manually or by using OCP or OBD. +obdiag is a CLI diagnostic tool designed for OceanBase Database. It scans, collects, and analyzes logs, SQL audit records, and process stack information about OceanBase Database. You can use obdiag easily, no matter whether your OceanBase cluster is deployed manually or by using OCP or OBD. -obdiag allows you to use command lines to: (a) inspect OceanBase clusters for existing or possible exceptions, analyze their causes, and provide O&M suggestions; (b) collect diagnostic information dispersed across nodes and return the information to the obdiag server in a package; (c) analyze OceanBase Database logs to identify errors that have occurred; and (d) perform end-to-end diagnostics based on the `trace.log` file. +obdiag can: -For more information, see [OceanBase Diagnostic Tool](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375725). +* Inspect OceanBase clusters for existing or possible exceptions, analyze causes, and provide O&M suggestions. +* Collect diagnostic information dispersed across nodes and package it for reporting. +* Analyze logs to detect errors. +* Perform end-to-end diagnostics using the `trace.log` file. + +For details, see [OceanBase Diagnostic Tool](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001971285). ### ob_error -ob_error is an error code parsing tool of OceanBase Database. ob_error returns the corresponding causes and solutions for each error code you entered. With ob_error, you can get basic error information without looking up the documentation. +ob_error is an error code parsing tool that returns causes and solutions for OceanBase error codes, letting you troubleshoot issues without searching documentation. -For more information, see [ob_error](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001375718). +For details, see [ob_error](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001971282). ### ob_admin -ob_admin is an O&M tool for OceanBase Database. It provides the slog_tool, log_tool, dumpsst, and dump_backup features to troubleshoot issues such as data inconsistency, data loss, and data errors. +ob_admin offers tools like slog_tool, log_tool, dumpsst, and dump_backup for troubleshooting data inconsistency, loss, and errors. -For more information, see [ob_admin](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001378074). +For details, see [ob_admin](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001973570). ## GUI-based development tools ### ODC -OceanBase Developer Center (ODC) is a GUI-based development tool and a collaborative management platform for data development and production change. ODC is provided in two forms: Client ODC and Web ODC. Client ODC focuses on database development. It is lightweight and easy to deploy on Windows, macOS, and Linux. As for Web ODC, in addition to database development, Web ODC also provides collaborative management features to ensure the security, compliance, and efficiency of database changes. +OceanBase Developer Center (ODC) is a GUI-based development tool and a collaborative management platform for data development and production change, available as Client ODC and Web ODC. + +* Client ODC focuses on database development and is lightweight and easy to deploy on Windows, macOS, and Linux. +* Web ODC adds the collaborative management features to ensure the security, compliance, and efficiency of database changes. + +Specifically, Web ODC supports: -Web ODC allows you to work in Individual Workspace mode or Team Workspace mode. Individual Workspace is suitable for individual developers and allows you to use features of Client ODC in a browser. You can access and create data sources as needed and develop databases with various windows and tools provided on the platform. Team Workspace is ideal for developers and database administrators (DBAs) to collaborate with each other. It is both a development tool and a collaborative management platform. ODC provides a variety of database development and management features, such as project collaboration, stable change, data security, and hot/cold data separation. +* Individual Workspace for individual developers to develop databases through a browser. +* Team Workspace for developers and database administrators (DBAs) to collaborate, enabling project collaboration, controlled change, data security, and hot/cold data separation. -For more information, see [OceanBase Developer Center](https://en.oceanbase.com/docs/odc-en). +For details, see [OceanBase Developer Center](https://en.oceanbase.com/docs/odc-en). > **Note** > -> In addition to ODC, you can also use third-party GUI-based development tools such as Navicat and DBeaver to connect to OceanBase Database. +> In addition to ODC, third-party GUI-based development tools like Navicat and DBeaver can also connect to OceanBase Database. ## Database drivers ### OceanBase Connector/J -OceanBase Connector/J is a driver that implements the JDBC API to provide connections to OceanBase Database for Java-based applications. OceanBase Connector/J is a JDBC Type 4 driver that can be connected to a database engine by using local protocols. +OceanBase Connector/J is used for Java-based applications to connect to OceanBase Database. It is a JDBC Type 4 driver that can be connected to a database engine through local protocols. OceanBase Database supports OceanBase Connector/J and is fully compatible with MySQL Connector Java, the native JDBC driver for MySQL. OceanBase Connector/J is fully compatible with MySQL JDBC. OceanBase Connector/J automatically determines whether OceanBase Database runs in MySQL or Oracle mode and supports both modes at the protocol layer. -For more information, see [OceanBase Connector/J](https://en.oceanbase.com/docs/oceanbase-connector-j-en). +For details, see [OceanBase Connector/J](https://en.oceanbase.com/docs/oceanbase-connector-j-en). ### OceanBase Connector/C OceanBase Connector/C is an OBClient development component based on C/C++. OceanBase Connector/C supports C API libraries. OceanBase Connector/C allows C/C++ applications to access OceanBase distributed database clusters from the underlying layer. Then, the applications can perform operations such as database connection, data access, error processing, and prepared statement processing. -Also known as LibobClient, OceanBase Connector/C allows an application to run as an independent server process to communicate with OBServer nodes by using network connections. A client application references the C API header file during compilation and can link to the C API library file. +Also known as LibobClient, OceanBase Connector/C allows an application to run as an independent server process to coimage +image +image +mmunicate with OBServer nodes by using network connections. A client application references the C API header file during compilation and can link to the C API library file. -For more information, see [OceanBase Connector/C](https://en.oceanbase.com/docs/oceanbase-connector-c-en). +For more information about OceanBase Connector/C, see [OceanBase Connector/C](https://en.oceanbase.com/docs/oceanbase-connector-c-en). ### OceanBase Connector/ODBC -ODBC stands for Open Database Connectivity. OceanBase Connector/ODBC is designed for data sharing between heterogeneous databases. It has become a major part of the Windows Open System Architecture (WOSA) and a database access API standard in Windows-based environments. +ODBC (Open Database Connectivity) enables data sharing between heterogeneous databases. It has become a major part of the Windows Open System Architecture (WOSA) and a database access API standard in Windows-based environments. -For more information, see [OceanBase Connector/ODBC](https://en.oceanbase.com/docs/obodbc-en). \ No newline at end of file +For details, see [OceanBase Connector/ODBC](https://en.oceanbase.com/docs/obodbc-en).