hcq/oceanbase
hcq/oceanbase
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add chinese readme

Browse Source
This commit is contained in:
wangyunlai 2023-07-05 08:27:16 +00:00
parent 0ebc7ab3fd
commit 91d69a89cb
2 changed files with 177 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -33,30 +33,41 @@
</a>
</p>
[中文版](README_CN.md)
**OceanBase Database** is a distributed relational database. It is developed entirely by Ant Group. OceanBase Database is built on a common server cluster. Based on the [Paxos](https://lamport.azurewebsites.net/pubs/lamport-paxos.pdf) protocol and its distributed structure, OceanBase Database provides high availability and linear scalability. OceanBase Database is not dependent on specific hardware architectures.
# Key features
* **Transparent Scalability** : An OceanBase cluster can be scaled out to 1,500 nodes transparently, handling petabytes of data and a trillion rows of records.
* **Ultra-fast Performance** : The only distributed database that has refreshed both TPC-C record, at 707 million tmpC, and TPC-H record, at 15.26 million QphH @30000GB.
* **Real-time Operational Analytics** : A unified system for both transactional and real-time operational analytics workloads.
* **Continuous Availability** : OceanBase Database adopts Paxos Consensus algorithm to achieve Zero RPO and less than 8 seconds of RTO.
* **MySQL Compatible** : OceanBase Database is highly compatible with MySQL, which ensures that zero or few modification is needed for migration.
* **Cost Effeciency** : The cutting-edge compression technology saves 70%-90% of storage costs without compromising performance. The multi-tenancy architecture achieves higher resource utilization.
- **Transparent Scalability**
An OceanBase cluster can be scaled out to 1,500 nodes transparently, handling petabytes of data and a trillion rows of records.
- **Ultra-fast Performance**
The only distributed database that has refreshed both TPC-C record, at 707 million tmpC, and TPC-H record, at 15.26 million QphH @30000GB.
- **Real-time Operational Analytics**
A unified system for both transactional and real-time operational analytics workloads.
- **Continuous Availability**
OceanBase Database adopts Paxos Consensus algorithm to achieve Zero RPO and less than 8 seconds of RTO.
- **MySQL Compatible**
OceanBase Database is highly compatible with MySQL, which ensures that zero or few modification is needed for migration.
- **Cost Effeciency**
The cutting-edge compression technology saves 70%-90% of storage costs without compromising performance. The multi-tenancy architecture achieves higher resource utilization.
See also [key features](https://en.oceanbase.com/product/opensource) for more details.
# System architecture
![image.png](https://cdn.nlark.com/yuque/0/2022/png/25820454/1667369873624-c1707034-471a-4f79-980f-6d1760dac8eb.png)
[Learn More](https://en.oceanbase.com/docs/community-observer-en-10000000000829641)
# Quick start
## How to deploy
### 🔥 Deploy by all-in-one
## 🔥 Start with all-in-one
You can quickly deploy a standalone OceanBase Database to experience with the following commands.
@ -71,36 +82,26 @@ source ~/.oceanbase-all-in-one/bin/env.sh
obd demo
```
### 🐳 Deploy by docker
## 🐳 Start with docker
1. Pull OceanBase image (optional):
1. Start an OceanBase Database instance:
```shell
docker pull oceanbase/oceanbase-ce
# Deploy a mini standalone instance.
docker run -p 2881:2881 --name oceanbase-ce -e MINI_MODE=1 -d oceanbase/oceanbase-ce
```
2. Start an OceanBase Database instance:
2. Connect to the OceanBase Database instance:
```shell
# Deploy an instance with the maximum specifications supported by the container.
docker run -p 2881:2881 --name obstandalone -e MINI_MODE=0 -d oceanbase/oceanbase-ce
# Or deploy a mini standalone instance.
docker run -p 2881:2881 --name obstandalone -e MINI_MODE=1 -d oceanbase/oceanbase-ce
```
3. Connect to the OceanBase Database instance:
```shell
docker exec -it obstandalone ob-mysql sys # Connect to the root user of the sys tenant.
docker exec -it obstandalone ob-mysql root # Connect to the root user of the test tenant.
docker exec -it obstandalone ob-mysql test # Connect to the test user of the test tenant.
docker exec -it oceanbase-ce ob-mysql sys # Connect to the root user of the sys tenant.
```
See also [Quick experience](https://en.oceanbase.com/docs/community-observer-en-10000000000829647) or [Quick Start (Simplified Chinese)](https://www.oceanbase.com/docs/common-oceanbase-database-cn-10000000001692850) for more details.
## How to build
## 👨‍💻 Start developing
See [OceanBase Developer Document](https://github.com/oceanbase/oceanbase/wiki/Compile) to learn how to compile and deploy a munually compiled observer.
See [OceanBase Developer Document](https://github.com/oceanbase/oceanbase/wiki/Compile) to learn how to compile and deploy a manually compiled observer.
# Roadmap
@ -112,6 +113,12 @@ OceanBase makes data management and use easier with technology innovation. It ha
See also [success stories](https://en.oceanbase.com/customer/home) and [Who is using OceanBase](https://github.com/oceanbase/oceanbase/issues/1301) for more details.
# System architecture
![oceanbase architecture](https://cdn.nlark.com/yuque/0/2022/png/25820454/1667369873624-c1707034-471a-4f79-980f-6d1760dac8eb.png)
[Learn More](https://en.oceanbase.com/docs/community-observer-en-10000000000829641)
# Contributing
Contributions are highly appreciated. Read the [development guide](docs/README.md) to getting started.

137
README_CN.md Normal file
View File

@ -0,0 +1,137 @@
<p align="center">
<a href="https://github.com/oceanbase/oceanbase">
<img alt="OceanBase Logo" src="images/logo.svg" width="50%" />
</a>
</p>
<p align="center">
<a href="https://github.com/oceanbase/oceanbase/blob/master/LICENSE">
<img alt="license" src="https://img.shields.io/badge/license-MulanPubL--2.0-blue" />
</a>
<a href="https://github.com/oceanbase/oceanbase/releases/latest">
<img alt="license" src="https://img.shields.io/badge/dynamic/json?color=blue&label=release&query=tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Foceanbase%2Foceanbase%2Freleases%2Flatest" />
</a>
<a href="https://github.com/oceanbase/oceanbase">
<img alt="stars" src="https://img.shields.io/badge/dynamic/json?color=blue&label=stars&query=stargazers_count&url=https%3A%2F%2Fapi.github.com%2Frepos%2Foceanbase%2Foceanbase" />
</a>
<a href="https://github.com/oceanbase/oceanbase">
<img alt="forks" src="https://img.shields.io/badge/dynamic/json?color=blue&label=forks&query=forks&url=https%3A%2F%2Fapi.github.com%2Frepos%2Foceanbase%2Foceanbase" />
</a>
<a href="https://en.oceanbase.com/docs/community-observer-en-10000000000829617">
<img alt="English doc" src="https://img.shields.io/badge/docs-English-blue" />
</a>
<a href="https://www.oceanbase.com/docs/oceanbase-database-cn">
<img alt="Chinese doc" src="https://img.shields.io/badge/文档-简体中文-blue" />
</a>
<a href="https://github.com/oceanbase/oceanbase/actions/workflows/compile.yml">
<img alt="building status" src="https://img.shields.io/github/actions/workflow/status/oceanbase/oceanbase/compile.yml?branch=master" />
</a>
<a href="https://github.com/oceanbase/oceanbase/commits/master">
<img alt="last commit" src="https://img.shields.io/github/last-commit/oceanbase/oceanbase/master" />
</a>
<a href="https://join.slack.com/t/oceanbase/shared_invite/zt-1e25oz3ol-lJ6YNqPHaKwY_mhhioyEuw">
<img alt="Join Slack" src="https://img.shields.io/badge/slack-Join%20Oceanbase-brightgreen?logo=slack" />
</a>
</p>
[English](README.md)
**OceanBase Database** 是一个分布式关系型数据库。完全由蚂蚁集团自主研发。 OceanBase 基于 [Paxos](https://lamport.azurewebsites.net/pubs/lamport-paxos.pdf) 协议以及分布式架构，实现了高可用和线性扩展。OceanBase 数据库运行在常见的服务器集群上，不依赖特殊的硬件架构。
# 关键特性
- **水平扩展**
实现透明水平扩展，支持业务快速的扩容缩容，同时通过准内存处理架构实现高性能。支持集群节点超过数千个，单集群最大数据量超过 3PB，最大单表行数达万亿级。
- **极致性能**
唯一一个刷新了 TPC-C 记录（7.07 亿 tmpC）和 TPC-H 记录（1526 万 QphH @30000GB）的分布式数据库。
- **实时分析**
基于“同一份数据，同一个引擎”，同时支持在线实时交易及实时分析两种场景，“一份数据”的多个副本可以存储成多种形态，用于不同工作负载，从根本上保持数据一致性。
- **高可用**
独创“三地五中心”容灾架构方案，建立金融行业无损容灾新标准。支持同城/异地容灾，可实现多地多活，满足金融行业 6 级容灾标准（RPO=0，RTO< 30s），数据零丢失。
- **MySQL 兼容**
高度兼容 MySQL，覆盖绝大多数常见功能，支持过程语言、触发器等高级特性，提供自动迁移工具，支持迁移评估和反向同步以保障数据迁移安全，可支撑金融、政府、运营商等关键行业核心场景替代。
- **低成本**
基于 LSM-Tree 的高压缩引擎，存储成本降低 70% - 90%；原生支持多租户架构，同集群可为多个独立业务提供服务，租户间数据隔离，降低部署和运维成本。
更多信息请参考[OceanBase 产品](https://www.oceanbase.com/product/oceanbase)。
# 快速开始
## 🔥 使用 all-in-one
可以执行下面的命令快速部署一个 OceanBase 数据库实例。
**注意**: 只能在 Linux 平台上使用。
```shell
# 下载并安装 all-in-one （需要联网）
bash -c "$(curl -s https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/download-center/opensource/oceanbase-all-in-one/installer.sh)"
source ~/.oceanbase-all-in-one/bin/env.sh
# 快速部署 OceanBase database
obd demo
```
## 🐳 使用 docker
1. 启动OceanBase数据库实例
```shell
# 部署一个mini模式实例
docker run -p 2881:2881 --name oceanbase-ce -e MINI_MODE=1 -d oceanbase/oceanbase-ce
```
2. 连接OceanBase
```shell
docker exec -it oceanbase-ce ob-mysql sys # 连接root用户sys租户
```
更多信息参考[快速体验 OceanBase 数据库](https://www.oceanbase.com/docs/common-oceanbase-database-cn-10000000001692850)。
## 👨‍💻 使用开发模式
参考[OceanBase 开发者文档](https://github.com/oceanbase/oceanbase/wiki/Compile)了解如何编译和部署手动编译的observer。
# Roadmap
请参考 [Roadmap 2023](https://github.com/oceanbase/oceanbase/issues/1364) 了解OceanBase规划。 更多详细信息请参考 [OceanBase Roadmap](https://github.com/orgs/oceanbase/projects)。
# 案例
OceanBase通过技术创新让数据管理和使用更简单。OceanBase已服务超过 400 家来自不同行业的客户，包括金融服务、电信、零售、互联网等。
更详细的信息请参考[客户案例](https://www.oceanbase.com/customer/home)和[谁在使用 OceanBase](https://github.com/oceanbase/oceanbase/issues/1301)。
# 系统架构
![oceanbase architecture](https://cdn.nlark.com/yuque/0/2022/png/25820454/1667369873624-c1707034-471a-4f79-980f-6d1760dac8eb.png)
[了解更多](https://www.oceanbase.com/docs/common-oceanbase-database-cn-10000000001687855)
# 社区贡献
非常欢迎社区贡献。请阅读[开发指南](docs/README.md)。
# License
OceanBase 数据库根据 Mulan 公共许可证版本 2 获得许可。有关详细信息，请参阅 [LICENSE](LICENSE) 文件。
# 社区
有以下加入社区的方法：
* [中文论坛](https://ask.oceanbase.com/)
* [Slack Workspace](https://join.slack.com/t/oceanbase/shared_invite/zt-1e25oz3ol-lJ6YNqPHaKwY_mhhioyEuw)
* 钉钉群: 33254054 ([QR code](images/dingtalk.svg))
* 微信群 (添加微信小助手: OBCE666)