English | 中文

OceanBase Developer Center (ODC)

OceanBase Developer Center, or ODC for short, is an open-source, all-encompassing tool for collaborative database development and data management across various scenarios. By streamlining collaborative efforts, ODC addresses the challenges of risk management during database changes, efficient data management, and data security concerns.

🤔 What ODC Offers and Why Choose ODC?

Effortless SQL Development, Anytime, Anywhere

• Utilizing modern web architecture, ODC provides unparalleled accessibility to your databases, allowing you to perform SQL development tasks on the go, right from your web browser.
• ODC boasts a comprehensive and user-friendly SQL development environment that encompasses all the features you'd expect from desktop development tools, and even offers support for PL debugging.

Guard Every Change in Your SQL Development Journey

• Throughout the entire SQL development process, ODC is your steadfast companion, offering risk control at every turn. From visual object management to SQL queries, data editing, and import/export tasks, ODC comes equipped with built-in risk management tools.
• ODC introduces project-based collaboration and change approval workflows, complemented by SQL validation rules, SQL window guidelines, and risk level identification.

Automated Data Lifecycle Management

• ODC facilitates data retention policies, enabling you to effortlessly purge or archive data based on specified time frames, and build a hot-cold data separation system tailored to your needs in just 5 minutes.
• Beyond time-based data handling, ODC supports batch processing based on partitioning, allowing you to efficiently manage large datasets.
• With ODC's SQL scheduled tasks, completing computational tasks becomes a breeze, rendering traditional CRONTAB systems obsolete.

Sensitive Data Protection in Every Scenario

• ODC's data desensitization capabilities extend to both static and dynamic scenarios, ensuring that sensitive information remains safeguarded during schema changes, SQL queries, result set exports, and data extractions.
• Security administrators can configure sensitive data rules and desensitization algorithms, ensuring that both DBAs and developers are unable to access sensitive data.

Seamless Integration Without Additional Code Development

• Integrate ODC seamlessly into your current database development workflow without the need for disruptive changes.
• From Single Sign-On (SSO) to approval integration, SQL review integration, bastion host integration, and audit integration, ODC offers a comprehensive suite of features that cater to enterprise control needs.

🚀 Installation and Deployment

ODC comes in two distinct forms: the dynamic Web version and the efficient Desktop version. Let's take a closer look at these offerings:

• Desktop Version: Effortless Individual Development

  The Desktop version is designed for personal development scenarios, offering an efficient and user-friendly SQL development tool. Supported operating systems include Windows and MacOS.

• Web Version: Unleash Collaborative Power

  The Web version caters to multi-person collaborative development scenarios, encompassing collaborative development, risk control, data security, and more. It serves as an integrated platform for database development, management, and control. The Web version provides various installation mediums, such as rpm and Docker images, supporting x86 and ARM architectures. It also encapsulates all the features of SQL development in the Desktop version.

Deploying the Web Version

Please note that the deployment steps outlined in this section are meant for experiencing the functionality. For production environment deployment, please refer to the Deployment Guide.

Before You Start

The ODC Web version is packaged as a Docker image and relies on an OceanBase MySQL tenant as MetaDB. If you have not had a MetaDB, please follow (Optional) Step 1: Create a MetaDB below for instructions.

Before you start, ensure that your environment meets the following requirements:

• Docker is installed and the service is up and running. It is recommended to use the latest version of Docker.
• The deployment machine for ODC has at least 2 available CPU cores and 4 GB of RAM.
• The MetaDB requires a minimum specification of 1 vCPU and 4 GB of RAM.

(Optional) Step 1: Create a MetaDB

Use the sample script below to create a MetaDB if you do not already have one. To create a MetaDB, it would require an OceanBase cluster and a test tenant, which the script would also complete for you. The creation process may take about 2 minutes.

Please note that the deployment machine for the OceanBase cluster should have at least 4 vCPUs and 8 GB of RAM.

This script is for demo purposes only. If you have already had a MetaDB, please skip this step.

# Start an OceanBase cluster, which would automatically create a test tenant.
docker run -p 2881:2881 --name oceanbase-ce -d oceanbase/oceanbase-ce

# Connect to the test tenant within the cluster.
docker exec -it oceanbase-ce ob-mysql root

# Create a database user 'odc' and schema 'odc_metadb' within the tenant. Replace <password> with the actual password of your choice.
CREATE USER odc IDENTIFIED BY '<password>';
CREATE DATABASE odc_metadb;
GRANT ALL ON odc_metadb.* TO odc;

Step 2: Launch the ODC Server

Use the script below to launch the ODC Docker container.

# Launch ODC Server. The following example limits the container to 2 CPU cores and 4 GB of memory.

# Replace <your_metadb_password> with the actual password of your MetaDB. If you have followed Step 1 above to create the MetaDB, then replace <your_metadb_password> with the password you set in Step 1.

# Set the initial password for your admin account of ODC using the parameter <your_admin_password>. This password would be the one you use to log into the ODC Web. The password must satisfy the following requirements:
# - At least 2 digits
# - At least 2 lowercase letters
# - At least 2 uppercase letters
# - At least 2 special characters, allowed special characters includes ._+@#$%
# - No spaces or other special characters
# - 8~32 characters in length

# The process to launch ODC may take about 2 minutes.

 docker run -d -it --name odc --network host \
 --cpu-period 100000 --cpu-quota 200000 --memory=4G \
 -e "DATABASE_HOST=127.0.0.1" -e "DATABASE_PORT=2881" -e "DATABASE_NAME=odc_metadb" \
 -e "DATABASE_USERNAME=odc@test" -e 'DATABASE_PASSWORD=<your_metadb_password>' \
 -e 'ODC_ADMIN_INITIAL_PASSWORD=<your_admin_password>' \
 -e "ODC_SERVER_PORT=8989" \
 oceanbase/odc:latest

What to do next

After deploying ODC Web, you can follow our Quick Start guide to start your journey with ODC.

Installing the Desktop Version

The Desktop version harnesses Electron technology to transform the web application into a desktop application, offering compatibility with multiple desktop operating systems. Installing the desktop application is straightforward: simply download the version-specific installer and double-click to initiate the installation process.

ODC Desktop version employs the h2database embedded database as MetaDB, eliminating the need for MetaDB database configuration.

Here are the download links for ODC Desktop version installers:

• Windows 64-bit version: odc-win64-with-jre.exe
• MacOS version: odc-macos-with-jre.dmg
• Fedora/Ubuntu version: odc-ubuntu.deb

What to do next

After installing the Desktop version, you can follow our Quick Start guide to start your journey with ODC.

🤝 Join the Contributing Community

ODC envisions an open community, collaboratively crafting a database development and control management tool. We welcome your contributions in any form:

• Report bugs through Issues.
• Participate in or initiate discussions via Discussion.
• Contribute bug fixes or new features through Pull requests.
• Share ODC to your friends and colleagues, and help expand the ODC community's influence.

For detailed guidelines on contributing, please refer to the Contribution Guide. For comprehensive guidance on different types of code changes via pull requests, consult the Pull requests.

🛤️ Roadmap Ahead

Here's a glimpse into ODC's 2024 roadmap.

Focus Area	Q1	Q2	Q3	Q4
HTAP Collaborative Development	Support Doris data source Support Oracle data source Support homogeneous database schema comparison/synchronization Built-in common code snippets	Support natural language conversion to SQL Support real-time query and analysis Support result set conversion to chart Support global database object retrieval and positioning Provide dbt-oceanbase plug-in	Support Git repository integration Support dbt development integration Support natural language conversion to chart Support sharing scripts and code snippets within projects	Support AI task orchestration Support DAG task orchestration Support lightweight report management Support heterogeneous database schema comparison/synchronization
Change and Risk Control	Support database-level access control Support sending alerts on task exceptions Support automatic identification of offline DDL changes	Support logical database DDL changes Support online schema changes Support multi-database (pipeline) changes Support assigning database administrator Support table-level access control Add global project administrator	Support logical database DML/DQL Support configuring SQL check based on templates Support sensitive column access application Provide change rollback capability based on row-level recycle bin	Support automatic identification of sensitive data Support state-based schema changes Include command line window actions in operational auditing
Data Lifecycle Management	Data archiving/cleanup supports SQL preview Data archiving/cleanup supports unique index tables Data archiving supports source and target tables to be in the same database Partitioning plan supports OB Oracle data source	Data archiving source query performance optimization Support for archiving from OB to Files/OSS/S3 Homogeneous data archiving supports DDL incremental change synchronization	Support for archiving from OB to COS/OBS Support heterogeneous database archiving table structure synchronization Support for archiving associated (foreign key) table scenarios Risk prompts for data archiving/cleanup	Data archiving/cleanup supports logical database Data archiving/cleanup supports Oracle data source
Ease of Use	Optimize SQL development page interaction Optimize database search capability Desktop version supports custom JVM parameters Support custom configuration items (including shortcuts, etc.)	UI theme renewal New project control concept guidance Optimize ticket management page interaction Enhance code auto-completion capability	Optimize PL development experience Optimize wide table scenario page interaction Desktop version startup speed optimized to within 20s	Provide SQL formatting capability based on templates Optimize operation record page interaction

License

ODC is licensed under the Apache-2.0 license.

Help and Support

We welcome you to raise any questions or provide feedback through GitHub Issues. If you have trouble accessing GitHub, you can also join our DingTalk Group to seek assistance there.

• GitHub Issues
• Discord Server
• ODC DingTalk Group