Interpretation of OceanBase Community Edition ODC Functions

In the previous issue of the OceanBase Community Edition Function Interpretation series, we brought you the OCP function interpretation (click here to review: "OceanBase Community Edition OCP Function Interpretation"), as the most important ecological tool product connecting users and databases, this article continues Based on the latest community version 3.1.2 released by OceanBase, the functional interpretation of the product tool ODC is carried out.

OceanBase Community Edition ODC (OceanBase Developer Center), as an enterprise-level database development platform tailored for OceanBase database, aims to help enterprises use the database safely and efficiently, and at the same time improve the efficiency of collaboration between the relevant roles in the enterprise using the database. The community version ODC has been officially launched since 3.1.2, which supports connecting to the database in OceanBase community version MySQL mode, and can open the SQL window, anonymous block window and command line window according to the development requirements. At the tool level, it provides database developers with functions such as visual management capabilities of various database objects, WebSQL, SQL diagnosis, simulated data, session management, recycle bin management, and import and export functions. At the same time, it provides console capabilities at the platform level, and users can achieve unified management of resources and permissions through the console.

Product Architecture

The overall architecture of OceanBase Community Edition ODC (OceanBase Developer Center) consists of three capabilities, including basic capabilities, core capabilities and high-level capabilities. The following figure shows the architecture diagram of the current version:

1. User management: provide services such as user registration, system login, and account password modification.

2. Connection management: Provide OceanBase MySQL mode service. Support users to create database connections and save the created connection information, and provide the ability to copy and delete connections with one click.

3. Object management: Provides a service for visual creation and guidance of database objects, which reduces the user's threshold for use. At the same time, the object management also provides the service of online editing of table data when viewing table data.

4. Console: It supports saving and re-modifying the content in the SQL window, which can help users to reuse scripts. At the same time, it supports one-click formatting of SQL scripts and structured display of SQL content. In the process of writing SQL, the SQL editor can provide users with intelligent hints to simplify the writing difficulty. The result set obtained by running SQL supports editing and exporting.

5. Toolset: Contains session management, recycle bin management, and import and export tools. Session management supports the modification of database session attributes and global attributes, and also supports the user to terminate the specified database session. Recycle bin management supports users to clear and restore database objects. Import and export supports users to import and export multiple tables or single tables and multiple data formats.

6. SQL Diagnosis: It is convenient for users to view the SQL execution plan and resource consumption during SQL execution. Can help users locate problems in SQL scripts.

As a cross-platform tool based on modern Web technology, ODC supports Windows, Mac, and Linux operating systems, and supports client and WEB versions (the WEB version provides docker images).

In order to achieve cross-platform features, the ODC client version is developed with Electron. Like Chrome, Electron is based on Chromium for page rendering. Based on Electron technology, it provides two product forms of client version and WEB version through a set of B/S architecture. In the client version, a Java WEB service is also running, and the Electron front-end communicates with the Java WEB service through the HTTP protocol.

Connect to OceanBase through the client

For personal development scenarios, it is recommended to use client-side ODC for development. Client ODC has the characteristics of easy installation and barrier-free upgrade. Users only need to download the installation media and follow the installation prompts to complete the installation. The client version includes all the tool capabilities in ODC, which can meet the needs of personal development. ODC client version supports Windows and Mac operating systems.

The following figure shows the main functions of the ODC client:

Note: The gray part is the planning function, which is not yet supported in the current version.

Connect OceanBase via Web

For enterprise-level development scenarios, the WEB version of ODC is recommended. In addition to the basic tool capabilities, the WEB version of ODC also includes enterprise collaboration capabilities, and the WEB version is more secure in terms of stability and performance.

Compared with the client version, ODC WEB version adds team collaboration function, supports permission control, and administrators can configure the permissions of ordinary users (including whether to allow the creation of personal connections, whether to have access permissions to public connections, and read and write control of public connections). ). ODC users who are granted the administrator role can view the public resource management console tab on the ODC home page, but this tab is not displayed on the home page of non-administrator users.

The console provides services such as user management, role management, public connection management, resource group management, and system settings. Grant users public and personal resource permissions through roles, and you can use resource groups to grant or reclaim permissions for public connections in batches.

At present, you can access OceanBase Community Edition through ODC to experience the product functions introduced above. In subsequent articles, we will introduce how to use ODC to access and operate the OceanBase database.

If you encounter any problems in the process of learning and using ODC, or what features you expect in the subsequent versions of ODC, please contact us through the OceanBase community Q&A area.