modify readme
This commit is contained in:
a1iive
parent
ad1da8d5bf
commit
faca126d19
142
README.md
142
README.md
@ -1,56 +1,122 @@
|
||||
# What is OceanBase Database
|
||||
<p align="center">
|
||||
<a href="https://github.com/oceanbase/oceanbase">
|
||||
<img alt="OceanBase Logo" src="docs/Oceanbase-LogoRGB.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">
|
||||
<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/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>
|
||||
|
||||
OceanBase Database is a native distributed relational database. It is developed entirely by Ant Group. OceanBase Database is built on a common server cluster. Based on the Paxos protocol and its distributed structure, OceanBase Database provides high availability and linear scalability. OceanBase Database is not dependent on specific hardware architectures.
|
||||
**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.
|
||||
|
||||
## Core features
|
||||
# Key features
|
||||
* Transparent Scalability
|
||||
* Ultra-fast Performance
|
||||
* Real-time Operational Analytics
|
||||
* Continuous Availability
|
||||
* MySQL Compatible
|
||||
* Cost Effeciency
|
||||
|
||||
- Scalable OLTP
|
||||
- Linear scalability by adding nodes to the cluster
|
||||
- Partition-level leader distribution and transparent data shuffling
|
||||
- Optimized performance for distributed transaction through "table group" technology
|
||||
- High concurrency updates on hot row through early lock release (ELR)
|
||||
- 80000+ connections per node and unlimited connections in one instance through multi threads and coroutines
|
||||
- Prevent silent data corruption (SDC) through multidimensional data consistency checksum
|
||||
- No.1 in TPC-C benchmark with 707 million tpmC
|
||||
- Operational OLAP
|
||||
- Process analytical tasks in one engine, no need to migrate data to OLAP engine
|
||||
- Analyze large amounts of data on multiple nodes in one OceanBase cluster with MPP architecture
|
||||
- Advanced SQL engine with CBO optimizer, distributed execution scheduler and global index
|
||||
- Fast data loading through parallel DML, and with only 50% storage cost under compression
|
||||
- Broke world record with 15.26 million QphH in TPC-H 30TB benchmark in 2021
|
||||
- Multi-tenant
|
||||
- Create multiple tenants (instances) in one OceanBase cluster with isolated resource and access
|
||||
- Multidimensional and transparently scale up/out for each tenant, and scaling up takes effect immediately
|
||||
- Database consolidation: multi-tenant and flexible scaling can achieve resource pooling and improve utilization
|
||||
- Improve management efficiency and reduce costs without compromising performance and availability
|
||||
See [key features](https://en.oceanbase.com/product/opensource) to learn more details.
|
||||
|
||||
## Quick start
|
||||
|
||||
See [Quick start](https://open.oceanbase.com/quickStart) to try out OceanBase Database.
|
||||
|
||||
## System architecture
|
||||
# System architecture
|
||||
The operation of an OceanBase Database is supported by different components in the storage, replication, transaction, SQL, and access layers:
|
||||
* **Storage layer**: Stores the data of a table or a table partition.
|
||||
* **Replication layer**: Ensures data consistency between replicas of a partition based on consensus algorithms.
|
||||
* **Transaction layer**: Ensures the atomicity and isolation of the modifications to one or multiple partitions.
|
||||
* **SQL layer**: Translates SQL queries into executions over the storage.
|
||||
* **Access layer**: Forwards user queries to the appropriate OceanBase Database instances for processing.
|
||||
|
||||
|
||||
|
||||
## Roadmap
|
||||
[Learn More](https://en.oceanbase.com/docs/community-observer-en-10000000000829641)
|
||||
# Quick start
|
||||
|
||||
## How to deploy
|
||||
|
||||
### 🔥 Deploy by all-in-one
|
||||
|
||||
You can quickly deploy a standalone OceanBase Database to experience with the following commands.
|
||||
|
||||
```shell
|
||||
# download and install all-in-one package (internet connection is required)
|
||||
$> 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
|
||||
|
||||
# quickly deploy OceanBase database
|
||||
$> obd demo
|
||||
```
|
||||
### 🐳 Deploy by docker
|
||||
|
||||
1. Pull OceanBase image (optional)
|
||||
```shell
|
||||
$> docker pull oceanbase/oceanbase-ce
|
||||
```
|
||||
2. Start an 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.
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
See [OceanBase Developer Document](https://github.com/oceanbase/oceanbase/wiki/Compile) to learn how to compile and deploy a munually compiled observer.
|
||||
|
||||
# Roadmap
|
||||
|
||||
See [OceanBase Roadmap](https://github.com/orgs/oceanbase/projects).
|
||||
|
||||
|
||||
## Case study
|
||||
# Case study
|
||||
|
||||
For our success stories, see [Success stories](https://www.oceanbase.com/en/customer/home).
|
||||
See [success stories](https://en.oceanbase.com/customer/home).
|
||||
|
||||
## Contributing
|
||||
# Contributing
|
||||
|
||||
Your contributions to our code will be highly appreciated. For details about how to contribute to OceanBase, see [Contribute to OceanBase](https://github.com/oceanbase/oceanbase/wiki/Contribute-to-OceanBase).
|
||||
Contributions are highly appreciated. Read the [Contribute to OceanBase](https://github.com/oceanbase/oceanbase/wiki/Contribute-to-OceanBase) guide to getting started.
|
||||
|
||||
## Licensing
|
||||
# License
|
||||
|
||||
OceanBase Database is licensed under the Mulan Public License, Version 2. See the [LICENSE](LICENSE) file for more info.
|
||||
|
||||
## Community
|
||||
# Community
|
||||
|
||||
- [oceanbase.slack](https://join.slack.com/t/oceanbase/shared_invite/zt-1e25oz3ol-lJ6YNqPHaKwY_mhhioyEuw)
|
||||
- [Forum (Simplified Chinese)](https://ask.oceanbase.com/)
|
||||
- [DingTalk 33254054 (Simplified Chinese)](https://h5.dingtalk.com/circle/healthCheckin.html?corpId=ding12cfbe0afb058f3cde5ce625ff4abdf6&53108=bb418&cbdbhh=qwertyuiop&origin=1)
|
||||
- [WeChat (Simplified Chinese)](https://gw.alipayobjects.com/zos/oceanbase/0a69627f-8005-4c46-be1f-aac7a2b85c13/image/2022-03-01/85d42796-4e22-463a-9658-57402d7b9bc3.png)
|
||||
Join the OceanBase community via:
|
||||
|
||||
* [Slack Workspace](https://join.slack.com/t/oceanbase/shared_invite/zt-1e25oz3ol-lJ6YNqPHaKwY_mhhioyEuw)
|
||||
* [Chinese User Forum](https://ask.oceanbase.com/)
|
||||
* DingTalk Group: 33254054 ([QR code](docs/DingTalk.JPG))
|
||||
* WeChat Group (Add the assistant with WeChat ID: OBCE666)
|
||||
BIN
docs/DingTalk.JPG
Normal file
BIN
docs/DingTalk.JPG
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 204 KiB |
50
docs/Oceanbase-LogoRGB.svg
Normal file
50
docs/Oceanbase-LogoRGB.svg
Normal file
@ -0,0 +1,50 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg id="_图层_1" data-name="图层 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 95.26 13.73">
|
||||
<defs>
|
||||
<style>
|
||||
.cls-1 {
|
||||
fill: #0181fd;
|
||||
}
|
||||
|
||||
.cls-2 {
|
||||
fill: #fff;
|
||||
}
|
||||
|
||||
.cls-3 {
|
||||
fill: #ffa005;
|
||||
}
|
||||
|
||||
.cls-4 {
|
||||
fill: #181818;
|
||||
}
|
||||
|
||||
.cls-5 {
|
||||
fill: #07c846;
|
||||
}
|
||||
</style>
|
||||
</defs>
|
||||
<rect class="cls-2" width="95.26" height="13.73"/>
|
||||
<g>
|
||||
<g>
|
||||
<path class="cls-4" d="M51,2.66l-4.58,8.49h2.28l.74-1.48h3.05l.24,1.48h2.28l-1.68-8.49h-2.33Zm-.7,5.34l1.44-2.83,.48,2.83h-1.92Z"/>
|
||||
<path class="cls-4" d="M31.98,3.71c-.33-.41-.76-.72-1.28-.95-.52-.23-1.11-.34-1.77-.34s-1.3,.11-1.9,.34c-.6,.23-1.13,.55-1.6,.95-.47,.41-.86,.88-1.18,1.42-.32,.54-.53,1.13-.64,1.76-.11,.63-.1,1.22,.04,1.76,.13,.54,.36,1.02,.69,1.42,.33,.41,.75,.72,1.27,.95,.52,.23,1.11,.34,1.78,.34s1.29-.11,1.89-.34c.6-.23,1.13-.55,1.61-.95,.47-.41,.87-.88,1.19-1.42,.32-.54,.53-1.13,.64-1.76,.11-.63,.1-1.22-.04-1.76-.13-.54-.37-1.02-.7-1.42m-1.84,4.12c-.17,.29-.38,.53-.63,.74-.25,.21-.53,.37-.83,.49-.3,.12-.61,.17-.92,.17s-.6-.06-.86-.17c-.26-.12-.48-.28-.65-.49-.17-.21-.3-.46-.37-.74-.07-.29-.08-.6-.03-.93,.06-.34,.17-.65,.35-.93,.17-.29,.38-.53,.63-.74,.25-.21,.52-.37,.82-.49,.3-.12,.61-.17,.92-.17s.6,.06,.86,.17c.26,.12,.48,.28,.66,.49,.18,.21,.31,.46,.38,.74,.08,.29,.08,.6,.03,.93-.06,.34-.17,.65-.34,.93"/>
|
||||
<polygon class="cls-4" points="46.4 9.28 42.07 9.28 42.32 7.81 46.51 7.81 46.82 5.94 42.64 5.94 42.88 4.52 47.21 4.52 47.53 2.66 41.06 2.66 39.61 11.15 46.08 11.15 46.4 9.28"/>
|
||||
<polygon class="cls-4" points="61.29 7.75 58.79 2.66 56.65 2.66 55.2 11.15 57.34 11.15 58.23 6.05 60.72 11.15 62.85 11.15 64.3 2.66 62.17 2.66 61.29 7.75"/>
|
||||
<path class="cls-4" d="M70.83,8.68c.04-.26,.06-.5,.04-.72-.02-.23-.08-.43-.19-.61s-.25-.33-.45-.46c-.19-.12-.44-.22-.73-.28,.34-.2,.61-.43,.8-.72,.2-.28,.33-.64,.41-1.06,.12-.71,.02-1.25-.31-1.62-.33-.38-.87-.56-1.63-.56h-3.47l-1.45,8.49h3.72c.44,0,.84-.05,1.2-.16,.37-.1,.69-.26,.97-.47,.28-.21,.51-.47,.7-.78,.19-.31,.31-.66,.38-1.06m-3.67-4.34h.67c.67,0,.96,.27,.86,.82-.09,.55-.47,.82-1.14,.82h-.67l.28-1.64Zm1.07,4.88c-.26,.14-.65,.21-1.19,.21h-.75l.31-1.8h.75c.54,0,.91,.07,1.12,.21,.21,.14,.29,.37,.23,.69-.05,.32-.21,.54-.47,.69"/>
|
||||
<path class="cls-4" d="M83.57,5.97c-.16-.06-.33-.12-.5-.17-.17-.05-.32-.11-.45-.19-.13-.07-.23-.16-.3-.25-.07-.1-.09-.22-.07-.37,.04-.22,.15-.39,.35-.53,.2-.14,.43-.2,.71-.2,.22,0,.44,.05,.65,.14,.22,.09,.42,.24,.62,.43l1.14-1.72c-.37-.23-.77-.4-1.19-.51-.42-.12-.84-.17-1.25-.17-.44,0-.84,.07-1.22,.2-.38,.13-.71,.32-.99,.57-.29,.24-.52,.54-.72,.88-.19,.34-.33,.72-.4,1.14-.07,.42-.07,.77,.01,1.04,.08,.27,.21,.5,.39,.68,.18,.18,.39,.32,.63,.43,.25,.11,.5,.21,.76,.3,.22,.08,.4,.16,.56,.23,.15,.07,.27,.14,.36,.22,.09,.08,.15,.17,.17,.26,.03,.09,.03,.2,0,.33-.04,.21-.15,.4-.35,.56-.2,.17-.47,.25-.82,.25-.31,0-.6-.07-.89-.21-.29-.14-.57-.36-.84-.65l-1.22,1.78c.78,.64,1.69,.96,2.73,.96,.5,0,.96-.07,1.38-.21,.42-.14,.79-.33,1.1-.59,.32-.25,.57-.55,.78-.91,.2-.35,.34-.75,.41-1.18,.11-.65,.04-1.17-.22-1.57-.26-.4-.71-.72-1.37-.96"/>
|
||||
<path class="cls-4" d="M38.16,2.42c-.57,0-1.14,.11-1.7,.33-.56,.22-1.07,.53-1.54,.92-.46,.39-.86,.86-1.19,1.41-.33,.54-.55,1.14-.66,1.8-.11,.65-.09,1.26,.05,1.81,.15,.55,.38,1.03,.71,1.43,.33,.4,.73,.71,1.21,.93,.48,.22,1.01,.33,1.57,.33,.28,0,.56-.03,.85-.08,.29-.06,.61-.14,.96-.26l.23-.08,.45-2.61c-.65,.6-1.31,.9-2,.9-.31,0-.59-.06-.84-.18-.25-.12-.45-.29-.62-.5-.16-.21-.28-.46-.34-.74-.06-.29-.07-.6,0-.93,.06-.33,.17-.64,.33-.92,.16-.29,.36-.53,.59-.74,.23-.21,.49-.37,.79-.49,.29-.12,.6-.18,.92-.18,.73,0,1.28,.31,1.67,.93l.45-2.64c-.32-.15-.64-.26-.94-.33-.3-.07-.62-.11-.95-.11"/>
|
||||
<path class="cls-4" d="M78.31,9.36c-.35-.07-1.02-.11-2.18,.17l.26,1.65h2.28l-.36-1.81Z"/>
|
||||
<path class="cls-4" d="M78.22,8.87l-.37-1.87c-.55,0-1.24,.09-2.1,.31-.09,.02-.19,.05-.29,.08-.47,.13-.91,.22-1.31,.28l1.25-2.46,.27,1.65c.86-.22,1.55-.3,2.1-.31l-.77-3.85h-2.33l-4.58,8.49h2.28l.82-1.62c.69-.05,1.52-.17,2.46-.43,.14-.04,.27-.07,.39-.1,1.16-.27,1.83-.24,2.18-.17"/>
|
||||
<g>
|
||||
<path class="cls-4" d="M89.66,6.01c-1.7,.44-2.99,.4-3.55,.35l-.3,1.83c.16,.01,.35,.02,.56,.03,.84,.02,2.06-.06,3.54-.45,1.4-.37,2.23-.34,2.65-.27l.3-1.83c-.71-.07-1.75-.03-3.21,.35"/>
|
||||
<path class="cls-4" d="M90.1,2.73c-1.62,.42-2.87,.41-3.47,.36l-.45,2.8c.4,.04,1.15,.07,2.15-.07l.16-.98c.56-.07,1.19-.18,1.87-.36,1.5-.39,2.34-.34,2.73-.26l.3-1.84c-.71-.09-1.77-.05-3.29,.34"/>
|
||||
<path class="cls-4" d="M89.25,9.18c-.54,.14-1.03,.23-1.48,.29l.15-.9c-.62,.07-1.16,.09-1.59,.08-.21,0-.39-.01-.55-.03l-.46,2.72c.18,.01,.39,.03,.64,.03,.84,.02,2.06-.06,3.54-.45,1.32-.35,2.13-.35,2.58-.29l.3-1.83c-.71-.06-1.72,0-3.13,.36"/>
|
||||
</g>
|
||||
</g>
|
||||
<g>
|
||||
<path class="cls-5" d="M11.91,12.89c.36-.15,.72-.29,1.1-.42,.17-.06,.35-.12,.52-.17,.14-.04,.28-.08,.42-.12,2.12-.59,4.27-.75,6.35-.52v-2.17c-2.3-.23-4.67-.03-7.02,.63-.14,.04-.28,.08-.42,.12-.18,.06-.37,.12-.55,.18-.36,.12-.72,.26-1.07,.4l.67,2.06Z"/>
|
||||
<path class="cls-1" d="M20.29,2.46v6.49c-2.39-.23-4.85-.02-7.27,.69-.3,.09-.59,.18-.89,.28-.36,.12-.72,.24-1.07,.34-3.06,.9-6.16,1.22-9.18,1V4.77c2.36,.23,4.79,.02,7.18-.66,.33-.09,.65-.2,.98-.31,.33-.11,.66-.22,.98-.32,3.09-.92,6.22-1.24,9.27-1.03Z"/>
|
||||
<path class="cls-3" d="M10.26,.84c-.36,.15-.72,.29-1.1,.42-.17,.06-.35,.12-.52,.17-.14,.04-.28,.08-.42,.12-2.12,.59-4.27,.75-6.35,.52v2.17c2.3,.23,4.67,.03,7.02-.63,.14-.04,.28-.08,.42-.12,.18-.06,.37-.12,.55-.18,.36-.12,.72-.26,1.07-.4l-.67-2.06Z"/>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 5.5 KiB |
Loading…
x
Reference in New Issue
Block a user