体验 OceanBase 数据库

本文以单机安装 OceanBase 数据库为例指导您如何快速使用 OceanBase 数据库。

组件介绍

• OBD

  OceanBase Deployer，OceanBase 安装部署工具，简称为 OBD。详细信息请参考 OBD 文档。

• ODP

  OceanBase Database Proxy，OceanBase 数据库代理，是 OceanBase 数据库专用的代理服务器，简称为 ODP（又称为 OBProxy）。详细信息请参考 ODP 文档。

• OBAgent

  OBAgent 是 OceanBase 数据库监控采集框架，支持推、拉两种数据采集模式，可以满足不同的应用场景。详细信息可参见 OBAgent 章节。

• Grafana

  Grafana 是一款开源的数据可视化工具，它可以将数据源中的各种指标数据进行可视化展示，以便更直观地了解系统运行状态和性能指标。详细信息可参见 Grafana 官网。

• Prometheus

  Prometheus 是一个开源的服务监控系统和时序数据库，其提供了通用的数据模型以及快捷数据采集、存储和查询接口。详细信息可参见 Prometheus 官网。

前提条件

在参考本文安装 OceanBase 数据库之前，确保您的软硬件环境满足以下要求：

使用 OBD 部署 OceanBase 数据库

步骤 1：下载并安装 all-in-one package

从 V4.0.0 开始，OceanBase 提供统一的安装包 all-in-one package。您可以通过这个统一的安装包一次性完成 OBD、OceanBase 数据库、ODP、OBAgent、Grafana 和 Prometheus 的安装；您可以根据实际需求选择部分组件安装或者指定组件的版本。all-in-one package 提供了两种安装方式。

在线安装 all-in-one package

执行以下命令，可以在线下载并安装 all-in-one package

bash -c "$(curl -s https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/download-center/opensource/oceanbase-all-in-one/installer.sh)"

离线安装 all-in-one package

1. 从 OceanBase 软件下载中心 下载最新的 all-in-one 安装包，并将其上传到机器的任一目录下。

2. 在安装包所在目录下执行以下命令解压安装包并安装。

   [admin@test001 ~]$ tar -xzf oceanbase-all-in-one-*.tar.gz
   [admin@test001 ~]$ cd oceanbase-all-in-one/bin/
   [admin@test001 bin]$ ./install.sh
   [admin@test001 bin]$ source ~/.oceanbase-all-in-one/bin/env.sh
   

步骤 2：使用 obd demo 快速部署单机体验环境

1. 执行 obd demo 命令部署 OceanBase 数据库

   [admin@test001 ~]$ obd demo
   

   obd demo 命令默认在当前用户家目录下以最小规格部署并启动 OceanBase 数据库及相关组件（包括 ODP、OBAgent、Grafana 和 Prometheus），固定部署名为 demo。如需更多定制化的部署形式，参见 快速部署命令。

   您也可以使用 OBD 命令管理该 OceanBase 数据库，详细命令介绍请参考 集群命令组。

   说明

   当安装 grafana 或 prometheus 时，会输出 grafana 或 prometheus 的访问地址。在阿里云或其他云环境下，可能出现因无法获取公网 IP 而输出内网地址的情况，此 IP 非公网地址，您需要使用正确的地址。

2. 执行输出中的连接命令连接数据库

   obd demo 命令成功执行后会输出通过 OBClient 连接 OceanBase 数据库的命令，示例如下。

   • 通过 2881 端口直连数据库

     [admin@test001 ~]$ obclient -h127.0.0.1 -P2881 -uroot@sys -Doceanbase -A
     

   • 通过 ODP 代理访问数据库

     [admin@test001 ~]$ obclient -h127.0.0.1 -P2883 -uroot@sys -Doceanbase -A
     

     使用 OBClient 客户端连接 OceanBase 集群的详细操作可参考 通过 OBClient 连接 OceanBase 数据库。

3. （可选）配置密码

   使用 obd demo 命令快速部署 OceanBase 数据库后，您可参考如下步骤为 demo 集群配置密码。

   1. 修改配置文件

      obd cluster edit-config demo
      

      执行上述命令打开配置文件后，在配置文件中 oceanbase-ce 组件下添加 root_password: xxxx，添加完成后保存退出。示例如下：

      oceanbase-ce:
        servers:
          - 127.0.0.1
        global:
          home_path: /home/admin/oceanbase-ce
          ... # 省略部分配置项
          log_disk_size: 13G
          root_password: ******
      

   2. 重启集群

      修改并保存配置文件后，OBD 会输出待执行的重启命令，直接复制执行即可，示例如下。

      [admin@test001 ~]$ obd cluster edit-config demo
      Search param plugin and load ok
      Search param plugin and load ok
      Parameter check ok
      Save deploy "demo" configuration
      Use `obd cluster reload demo` to make changes take effect.
      Trace ID: 29dd12fa-3d73-11ee-91bc-00163e01cd7a
      If you want to view detailed obd logs, please run: obd display-trace 29dd12fa-3d73-11ee-91bc-00163e01cd7a
      

      从输出可以看出，修改配置文件中 root@sys 用户密码后，需执行 obd cluster reload demo 命令重启 demo 集群。

使用 Docker 部署 OceanBase 数据库

您可参考本节内容在 Docker 容器里启动 OceanBase 数据库，帮助您快速了解 OceanBase 数据库。

（可选）步骤一：拉取 OceanBase 数据库镜像

运行如下命令，拉取 OceanBase 数据库所需镜像。

• 搜索 OceanBase 数据库相关镜像

  [admin@test001 ~]$ docker search oceanbase
  

• 拉取 OceanBase 数据库最新镜像

  [admin@test001 ~]$ docker pull oceanbase/oceanbase-ce
  

  说明

  上述命令默认拉取最新版本，可根据实际需求在 Docker 镜像 中选择版本。

步骤二：启动 OceanBase 数据库实例

运行如下命令，启动 OceanBase 数据库实例。

• 根据当前容器部署最大规格实例

  [admin@test001 ~]$ sudo docker run -p 2881:2881 --name obstandalone -e MODE=normal -d oceanbase/oceanbase-ce
  

• 部署 mini 的独立实例

  [admin@test001 ~]$ sudo docker run -p 2881:2881 --name obstandalone -e MODE=mini -d oceanbase/oceanbase-ce
  

其中：

• --name 用于设置 Docker 容器名称，比如示例中创建一个名为 obstandalone 的 Docker 容器。

• -e 用于设置环境变量，其中 MODE 用于设置 OceanBase 数据库的部署规格。

启动预计需要 2~5 分钟。执行以下命令，如果返回 boot success!，则表示启动成功。

[admin@test001 ~]$ sudo docker logs obstandalone | tail -1
boot success!

步骤三：连接 OceanBase 数据库实例

oceanbase-ce 镜像安装了 OBD（OceanBase Deployer，OceanBase 安装部署工具）和 OBClient（OceanBase 命令行客户端）。您可选择进入容器，使用 OBD 命令管理和 OBClient 客户端连接实例，也可使用宿主机本地 OBClient 或 MySQL 客户端连接到 OceanBase 数据库实例。

进入容器后连接

1. 进入 Docker 容器

   [admin@test001 ~]$ sudo docker exec -it obstandalone bash
   

2. 查看集群详情

   # 查看集群列表
   obd cluster list
   # 查看 obcluster 集群详情
   obd cluster display obcluster
   

3. 连接集群

   obclient -h127.0.0.1 -uroot@sys -A -Doceanbase -P2881 -p
   

使用宿主机本地客户端连接

您可选择使用宿主机本地 OBClient 或 MySQL 客户端连接到 OceanBase 数据库实例，示例如下：

[admin@test001 ~]$ obclient -uroot@sys -h127.0.0.1 -P2881 -p

连接成功后，终端将显示如下内容：

Welcome to the OceanBase.  Commands end with ; or \g.
Your OceanBase connection id is 3221487727
Server version: 5.7.25 OceanBase 4.0.0 (r10100032022041510-a09d3134c10665f03fd56d7f8bdd413b2b771977) (Built Oct 15 2022 02:16:22)

Copyright (c) 2000, 2022, OceanBase and/or its affiliates. All  rights reserved.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

obclient [(none)]>