Tio Boot DocsTio Boot Docs
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
  • 01_tio-boot 简介

    • tio-boot:新一代高性能 Java Web 开发框架
    • tio-boot 入门示例
    • Tio-Boot 配置 : 现代化的配置方案
    • tio-boot 整合 Logback
    • tio-boot 整合 hotswap-classloader 实现热加载
    • 自行编译 tio-boot
    • 最新版本
    • 开发规范
  • 02_部署

    • 使用 Maven Profile 实现分环境打包 tio-boot 项目
    • Maven 项目配置详解:依赖与 Profiles 配置
    • tio-boot 打包成 FastJar
    • 使用 GraalVM 构建 tio-boot Native 程序
    • 使用 Docker 部署 tio-boot
    • 部署到 Fly.io
    • 部署到 AWS Lambda
    • 到阿里云云函数
    • 使用 Deploy 工具部署
    • 胖包与瘦包的打包与部署
    • 使用 Jenkins 部署 Tio-Boot 项目
    • 使用 Nginx 反向代理 Tio-Boot
    • 使用 Supervisor 管理 Java 应用
  • 03_配置

    • 配置参数
    • 服务器监听器
    • 内置缓存系统 AbsCache
    • 使用 Redis 作为内部 Cache
    • 静态文件处理器
    • 基于域名的静态资源隔离
    • DecodeExceptionHandler
  • 04_原理

    • 生命周期
    • 请求处理流程
    • 重要的类
  • 05_json

    • Json
    • 接受 JSON 和响应 JSON
    • 响应实体类
  • 06_web

    • 概述
    • 文件上传
    • 接收请求参数
    • 接收日期参数
    • 接收数组参数
    • 返回字符串
    • 返回文本数据
    • 返回网页
    • 请求和响应字节
    • 文件下载
    • 返回视频文件并支持断点续传
    • http Session
    • Cookie
    • HttpRequest
    • HttpResponse
    • Resps
    • RespBodyVo
    • /zh/06_web/19.html
    • 全局异常处理器
    • 异步
    • 动态 返回 CSS 实现
    • 返回图片
    • Transfer-Encoding: chunked 实时音频播放
    • Server-Sent Events (SSE)
    • 接口访问统计
    • 接口请求和响应数据记录
    • 自定义 Handler 转发请求
    • 使用 HttpForwardHandler 转发所有请求
    • 跨域
    • 添加 Controller
    • 常用工具类
    • HTTP Basic 认证
    • WebJars
    • JProtobuf
  • 07_validate

    • 数据紧校验规范
    • 参数校验
  • 08_websocket

    • 使用 tio-boot 搭建 WebSocket 服务
    • WebSocket 聊天室项目示例
  • 09_java-db

    • java‑db
    • 操作数据库入门示例
    • SQL 模板
    • 数据源配置与使用
    • ActiveRecord
    • Model
    • 生成器与 Model
    • Db 工具类
    • 批量操作
    • 数据库事务处理
    • Cache 缓存
    • Dialect 多数据库支持
    • 表关联操作
    • 复合主键
    • Oracle 支持
    • Enjoy SQL 模板
    • Java-DB 整合 Enjoy 模板最佳实践
    • 多数据源支持
    • 独立使用 ActiveRecord
    • 调用存储过程
    • java-db 整合 Guava 的 Striped 锁优化
    • 生成 SQL
    • 通过实体类操作数据库
    • java-db 读写分离
    • Spring Boot 整合 Java-DB
    • like 查询
    • 常用操作示例
    • Druid 监控集成指南
    • SQL 统计
  • 10_api-table

    • ApiTable 概述
    • 使用 ApiTable 连接 SQLite
    • 使用 ApiTable 连接 Mysql
    • 使用 ApiTable 连接 Postgres
    • 使用 ApiTable 连接 TDEngine
    • 使用 api-table 连接 oracle
    • 使用 api-table 连接 mysql and tdengine 多数据源
    • EasyExcel 导出
    • EasyExcel 导入
    • TQL(Table SQL)前端输入规范
    • ApiTable 实现增删改查
    • 数组类型
    • 单独使用 ApiTable
  • 11_aop

    • JFinal-aop
    • Aop 工具类
    • 配置
    • 配置
    • 独立使用 JFinal Aop
    • @AImport
    • 原理解析
  • 12_cache

    • Caffine
    • Jedis-redis
    • hutool RedisDS
    • Redisson
    • Caffeine and redis
    • CacheUtils 工具类
    • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 使用 java-db 整合 ehcache
    • 使用 java-db 整合 redis
    • Java DB Redis 相关 Api
    • redis 使用示例
  • 13_认证和权限

    • hutool-JWT
    • FixedTokenInterceptor
    • 使用内置 TokenManager 实现登录
    • 用户系统
    • 重置密码
    • 匿名登录
    • Google 登录
    • 权限校验注解
    • Sa-Token
    • sa-token 登录注册
    • StpUtil.isLogin() 源码解析
    • 短信登录
    • 移动端微信登录实现指南
    • 移动端重置密码
  • 14_i18n

    • i18n
  • 15_enjoy

    • tio-boot 整合 Enjoy 模版引擎文档
    • 引擎配置
    • 表达式
    • 指令
    • 注释
    • 原样输出
    • Shared Method 扩展
    • Shared Object 扩展
    • Extension Method 扩展
    • Spring boot 整合
    • 独立使用 Enjoy
    • tio-boot enjoy 自定义指令 localeDate
    • PromptEngine
    • Enjoy 入门示例-擎渲染大模型请求体
    • Enjoy 使用示例
  • 16_定时任务

    • Quartz 定时任务集成指南
    • 分布式定时任务 xxl-jb
    • cron4j 使用指南
  • 17_tests

    • TioBootTest 类
  • 18_tio

    • TioBootServer
    • tio-core
    • 内置 TCP 处理器
    • 独立启动 UDPServer
    • 使用内置 UDPServer
    • t-io 消息处理流程
    • tio-运行原理详解
    • TioConfig
    • ChannelContext
    • Tio 工具类
    • 业务数据绑定
    • 业务数据解绑
    • 发送数据
    • 关闭连接
    • Packet
    • 监控: 心跳
    • 监控: 客户端的流量数据
    • 监控: 单条 TCP 连接的流量数据
    • 监控: 端口的流量数据
    • 单条通道统计: ChannelStat
    • 所有通道统计: GroupStat
    • 资源共享
    • 成员排序
    • ssl
    • DecodeRunnable
    • 使用 AsynchronousSocketChannel 响应数据
    • 拉黑 IP
    • 深入解析 Tio 源码:构建高性能 Java 网络应用
  • 19_aio

    • ByteBuffer
    • AIO HTTP 服务器
    • 自定义和线程池和池化 ByteBuffer
    • AioHttpServer 应用示例 IP 属地查询
    • 手写 AIO Http 服务器
  • 20_netty

    • Netty TCP Server
    • Netty Web Socket Server
    • 使用 protoc 生成 Java 包文件
    • Netty WebSocket Server 二进制数据传输
    • Netty 组件详解
  • 21_netty-boot

    • Netty-Boot
    • 原理解析
    • 整合 Hot Reload
    • 整合 数据库
    • 整合 Redis
    • 整合 Elasticsearch
    • 整合 Dubbo
    • Listener
    • 文件上传
    • 拦截器
    • Spring Boot 整合 Netty-Boot
    • SSL 配置指南
    • ChannelInitializer
    • Reserve
  • 22_MQ

    • Mica-mqtt
    • EMQX
    • Disruptor
  • 23_tio-utils

    • tio-utils
    • HttpUtils
    • Notification
    • 邮箱
    • JSON
    • 读取文件
    • Base64
    • 上传和下载
    • Http
    • Telegram
    • RsaUtils
    • EnvUtils 使用文档
    • 系统监控
    • 毫秒并发 ID (MCID) 生成方案
  • 24_tio-http-server

    • 使用 Tio-Http-Server 搭建简单的 HTTP 服务
    • tio-boot 添加 HttpRequestHandler
    • 在 Android 上使用 tio-boot 运行 HTTP 服务
    • tio-http-server-native
    • handler 常用操作
  • 25_tio-websocket

    • WebSocket 服务器
    • WebSocket Client
  • 26_tio-im

    • 通讯协议文档
    • ChatPacket.proto 文档
    • java protobuf
    • 数据表设计
    • 创建工程
    • 登录
    • 历史消息
    • 发消息
  • 27_mybatis

    • Tio-Boot 整合 MyBatis
    • 使用配置类方式整合 MyBatis
    • 整合数据源
    • 使用 mybatis-plus 整合 tdengine
    • 整合 mybatis-plus
  • 28_mongodb

    • tio-boot 使用 mongo-java-driver 操作 mongodb
  • 29_elastic-search

    • Elasticsearch
    • JavaDB 整合 ElasticSearch
    • Elastic 工具类使用指南
    • Elastic-search 注意事项
    • ES 课程示例文档
  • 30_magic-script

    • tio-boot 整合 magic-script
  • 31_groovy

    • tio-boot 整合 Groovy
  • 32_firebase

    • 整合 google firebase
    • Firebase Storage
    • Firebase Authentication
    • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
    • 导出用户
    • 注册回调
    • 登录注册
  • 33_文件存储

    • 文件上传数据表
    • 本地存储
    • 使用 AWS S3 存储文件并整合到 Tio-Boot 项目中
    • 存储文件到 腾讯 COS
  • 34_spider

    • jsoup
    • 爬取 z-lib.io 数据
    • 整合 WebMagic
    • WebMagic 示例:爬取学校课程数据
    • Playwright
    • Flexmark (Markdown 处理器)
    • tio-boot 整合 Playwright
    • 缓存网页数据
  • 36_integration_thirty_party

    • tio-boot 整合 okhttp
    • 整合 GrpahQL
    • 集成 Mailjet
    • 整合 ip2region
    • 整合 GeoLite 离线库
    • 整合 Lark 机器人指南
    • 集成 Lark Mail 实现邮件发送
    • Thymeleaf
    • Swagger
    • Clerk 验证
  • 37_dubbo

    • 概述
    • dubbo 2.6.0
    • dubbo 2.6.0 调用过程
    • dubbo 3.2.0
  • 38_spring

    • Spring Boot Web 整合 Tio Boot
    • spring-boot-starter-webflux 整合 tio-boot
    • Tio Boot 整合 Spring Boot Starter
    • Tio Boot 整合 Spring Boot Starter Data Redis 指南
  • 39_spring-cloud

    • tio-boot spring-cloud
  • 40_mysql

    • 使用 Docker 运行 MySQL
    • /zh/42_mysql/02.html
  • 41_postgresql

    • PostgreSQL 安装
    • PostgreSQL 主键自增
    • PostgreSQL 日期类型
    • Postgresql 金融类型
    • PostgreSQL 数组类型
    • PostgreSQL 全文检索
    • PostgreSQL 查询优化
    • 获取字段类型
    • PostgreSQL 向量
    • PostgreSQL 优化向量查询
    • PostgreSQL 其他
  • 43_oceanbase

    • 快速体验 OceanBase 社区版
    • 快速上手 OceanBase 数据库单机部署与管理
    • 诊断集群性能
    • 优化 SQL 性能指南
    • /zh/43_oceanbase/05.html
  • 50_media

    • JAVE 提取视频中的声音
    • Jave 提取视频中的图片
    • /zh/50_media/03.html
  • 51_asr

    • Whisper-JNI
  • 54_native-media

    • java-native-media
    • JNI 入门示例
    • mp3 拆分
    • mp4 转 mp3
    • 使用 libmp3lame 实现高质量 MP3 编码
    • Linux 编译
    • macOS 编译
    • 从 JAR 包中加载本地库文件
    • 支持的音频和视频格式
    • 任意格式转为 mp3
    • 通用格式转换
    • 通用格式拆分
    • 视频合并
    • VideoToHLS
    • split_video_to_hls 支持其他语言
    • 持久化 HLS 会话
  • 55_telegram4j

    • 数据库设计
    • /zh/55_telegram4j/02.html
    • 基于 MTProto 协议开发 Telegram 翻译机器人
    • 过滤旧消息
    • 保存机器人消息
    • 定时推送
    • 增加命令菜单
    • 使用 telegram-Client
    • 使用自定义 StoreLayout
    • 延迟测试
    • Reactor 错误处理
    • Telegram4J 常见错误处理指南
  • 56_telegram-bots

    • TelegramBots 入门指南
    • 使用工具库 telegram-bot-base 开发翻译机器人
  • 60_LLM

    • 简介
    • AI 问答
    • /zh/60_LLM/03.html
    • /zh/60_LLM/04.html
    • 增强检索(RAG)
    • 结构化数据检索
    • 搜索+AI
    • 集成第三方 API
    • 后置处理
    • 推荐问题生成
    • 连接代码执行器
    • 避免 GPT 混乱
    • /zh/60_LLM/13.html
  • 61_ai_agent

    • 数据库设计
    • 示例问题管理
    • 会话管理
    • 历史记录
    • 对接 Perplexity API
    • 意图识别与生成提示词
    • 智能问答模块设计与实现
    • 文件上传与解析文档
    • 翻译
    • 名人搜索功能实现
    • Ai studio gemini youbue 问答使用说明
    • 自建 YouTube 字幕问答系统
    • 自建 获取 youtube 字幕服务
    • 通用搜索
    • /zh/61_ai_agent/15.html
    • 16
    • 17
    • 18
    • 在 tio-boot 应用中整合 ai-agent
    • 16
  • 62_translator

    • 简介
  • 63_knowlege_base

    • 数据库设计
    • 用户登录实现
    • 模型管理
    • 知识库管理
    • 文档拆分
    • 片段向量
    • 命中测试
    • 文档管理
    • 片段管理
    • 问题管理
    • 应用管理
    • 向量检索
    • 推理问答
    • 问答模块
    • 统计分析
    • 用户管理
    • api 管理
    • 存储文件到 S3
    • 文档解析优化
    • 片段汇总
    • 段落分块与检索
    • 多文档解析
    • 对话日志
    • 检索性能优化
    • Milvus
    • 文档解析方案和费用对比
    • 离线运行向量模型
  • 64_ai-search

    • ai-search 项目简介
    • ai-search 数据库文档
    • ai-search SearxNG 搜索引擎
    • ai-search Jina Reader API
    • ai-search Jina Search API
    • ai-search 搜索、重排与读取内容
    • ai-search PDF 文件处理
    • ai-search 推理问答
    • Google Custom Search JSON API
    • ai-search 意图识别
    • ai-search 问题重写
    • ai-search 系统 API 接口 WebSocket 版本
    • ai-search 搜索代码实现 WebSocket 版本
    • ai-search 生成建议问
    • ai-search 生成问题标题
    • ai-search 历史记录
    • Discover API
    • 翻译
    • Tavily Search API 文档
    • 对接 Tavily Search
    • 火山引擎 DeepSeek
    • 对接 火山引擎 DeepSeek
    • ai-search 搜索代码实现 SSE 版本
    • jar 包部署
    • Docker 部署
    • 爬取一个静态网站的所有数据
    • 网页数据预处理
    • 网页数据检索与问答流程整合
  • 65_java-linux

    • Java 执行 python 代码
    • 通过大模型执行 Python 代码
    • MCP 协议
    • Cline 提示词
    • Cline 提示词-中文版本
  • 66_manim

    • 简介
    • Manim 开发环境搭建
    • 生成场景提示词
    • 生成代码
    • 完整脚本示例
    • 语音合成系统
    • Fish.audio TTS 接口说明文档与 Java 客户端封装
    • 整合 fishaudio 到 java-uni-ai-server 项目
    • 执行 Python (Manim) 代码
    • 使用 SSE 流式传输生成进度的实现文档
    • 整合全流程完整文档
    • HLS 动态推流技术文档
    • manim 分场景生成代码
    • 分场景运行代码及流式播放支持
    • 分场景业务端完整实现流程
    • Maiim布局管理器
    • 仅仅生成场景代码
    • 使用 modal 运行 manim 代码
    • Python 使用 Modal GPU 加速渲染
    • Modal 平台 GPU 环境下运行 Manim
    • Modal Manim OpenGL 安装与使用
    • 优化 GPU 加速
    • 生成视频封面流程
    • Java 调用 manim 命令 执行代码 生成封面
    • Manim 图像生成服务客户端文档
    • manim render help
    • 显示 中文公式
    • manimgl
    • EGL
    • /zh/66_manim/30.html
    • /zh/66_manim/31.html
    • 成本核算
    • /zh/66_manim/33.html
  • 70_tio-boot-admin

    • 入门指南
    • 初始化数据
    • token 存储
    • 与前端集成
    • 文件上传
    • 网络请求
    • 图片管理
    • /zh/70_tio-boot-admin/08.html
    • Word 管理
    • PDF 管理
    • 文章管理
    • 富文本编辑器
  • 71_tio-boot

    • /zh/71_tio-boot/01.html
    • Swagger 整合到 Tio-Boot 中的指南
    • HTTP/1.1 Pipelining 性能测试报告
  • 80_性能测试

    • 压力测试 - tio-http-serer
    • 压力测试 - tio-boot
    • 压力测试 - tio-boot-native
    • 压力测试 - netty-boot
    • 性能测试对比
    • TechEmpower FrameworkBenchmarks
    • 压力测试 - tio-boot 12 C 32G
  • 99_案例

    • 封装 IP 查询服务
    • tio-boot 案例 - 全局异常捕获与企业微信群通知
    • tio-boot 案例 - 文件上传和下载
    • tio-boot 案例 - 整合 ant design pro 增删改查
    • tio-boot 案例 - 流失响应
    • tio-boot 案例 - 增强检索
    • tio-boot 案例 - 整合 function call
    • tio-boot 案例 - 定时任务 监控 PostgreSQL、Redis 和 Elasticsearch
    • Tio-Boot 案例:使用 SQLite 整合到登录注册系统
    • tio-boot 案例 - 执行 shell 命令

快速体验 OceanBase 社区版

  • 1. 背景信息
    • 1.1 组件介绍
    • 1.2 方案介绍
  • 2. 部署 OceanBase 演示环境
    • 步骤一:下载并安装 All-in-One 安装包
    • 步骤二:单机部署 OceanBase 数据库
  • 3. 部署 OceanBase 容器环境
    • 步骤一(可选):拉取 OceanBase 数据库镜像
    • 步骤二:启动 OceanBase 数据库实例
    • 步骤三:连接 OceanBase 数据库实例
  • 4. OceanBase 数据库基本操作
    • 4.1 创建数据库和用户
    • 4.2 远程连接
  • 5. Java 客户端
    • 5.1 Java 客户端远程连接
    • 5.2 Java-DB + HikariDataSource 连接
  • 6. 参考资料

1. 背景信息

OceanBase 是由蚂蚁集团开发的一款高性能、高可用、分布式关系数据库。自 V4.0.0 版本起,OceanBase 提供了统一的安装包(All-in-One Package),用户可以通过该安装包一次性完成 obd、OceanBase 数据库、ODP、OBAgent、Grafana、Prometheus 的安装。从 V4.1.0 起,All-in-One Package 新增支持安装 OCP Express。用户可根据实际需求选择部分或全部组件进行安装。

1.1 组件介绍

  • obd (OceanBase Deployer)
    OceanBase 安装部署工具,简称为 obd。它简化了 OceanBase 的安装与部署过程。详细信息请参考 OceanBase 安装部署工具文档.

  • ODP (OceanBase Database Proxy)
    OceanBase 数据库代理,是 OceanBase 数据库专用的代理服务器,简称为 ODP(又称为 OBProxy)。ODP 提供了负载均衡和高可用性支持。详细信息请参考 OceanBase 数据库代理文档.

  • OCP Express
    基于 Web 的 OceanBase 数据库 4.x 管理工具,集成在 OceanBase 数据库集群中,支持关键性能指标监控及基本数据库管理功能。详细信息请参考 OceanBase 云平台 Express (OCP Express).

  • OBAgent
    OceanBase 数据库监控采集框架,支持推送和拉取两种数据采集模式,适用于不同的应用场景。

  • Grafana
    开源的数据可视化工具,可将各种指标数据进行可视化展示,帮助直观了解系统运行状态和性能指标。详细信息可参见 Grafana 官网.

  • Prometheus
    开源的服务监控系统和时序数据库,提供通用的数据模型以及高效的数据采集、存储和查询接口。详细信息可参见 Prometheus 官网.

1.2 方案介绍

为了助力用户快速上手体验 OceanBase 数据库,提供了以下三种不同的部署方案。用户可根据自身的环境和需求灵活选择:

  1. 方案一:部署 OceanBase 演示环境
    适用于仅有一台机器的情况,快速搭建一个可用的 OceanBase 数据库环境。该环境具备数据库的基本功能,适合初步了解 OceanBase 数据库,但不具备分布式能力及高可用特性,不建议长期使用。具体操作步骤请参考 方案一:部署 OceanBase 演示环境。

  2. 方案二:部署 OceanBase 集群环境
    适用于需要深入了解 OceanBase 分布式数据库架构及功能特性的用户。该集群环境具备数据库的完整能力及分布式高可用特性。需要至少准备三台配置为 4vCPU、10 GB 内存、50 GB 磁盘的主机。具体操作步骤请参考 方案二:部署 OceanBase 集群环境。

  3. 方案三:部署 OceanBase 容器环境
    适用于希望通过容器化方式部署和管理 OceanBase 数据库的用户。该方案未经过大规模验证,建议谨慎使用。操作步骤请参考 方案三:部署 OceanBase 容器环境。

2. 部署 OceanBase 演示环境

当仅拥有一台可用机器时,可参考以下步骤使用 obd demo 命令快速部署单机 OceanBase 数据库。

步骤一:下载并安装 All-in-One 安装包

  1. 下载安装包
    从 OceanBase 软件下载中心 下载最新版本的 All-in-One 安装包,并将其上传到目标机器的任一目录下。

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

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 数据库

执行以下命令,快速部署 OceanBase 数据库:

obd demo

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

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

注意事项:

  • 安装 Grafana 或 Prometheus 时,系统会输出其访问地址。在阿里云或其他云环境下,可能因无法获取公网 IP 而输出内网地址,此 IP 非公网地址,需使用正确的地址进行访问。

  • obd demo 命令成功执行后,会输出通过 OBClient 连接 OceanBase 数据库的命令示例:

    通过 2881 端口直连数据库

obclient -h127.0.0.1 -P2883 -uroot -p'password' -Doceanbase -A

通过 ODP 代理访问数据库

obclient -h127.0.0.1 -P2883 -uroot -Doceanbase -A -p'password'

使用 OBClient 客户端连接 OceanBase 集群的详细操作可参见 通过 OBClient 连接 OceanBase 租户.

可选:配置密码

在使用 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 会输出待执行的重启命令,直接复制执行即可:

    obd cluster reload demo
    

    或根据输出提示执行对应命令。您也可以查看详细的 obd 日志以获取更多信息:

    obd display-trace <Trace ID>
    

3. 部署 OceanBase 容器环境

通过 Docker 容器部署 OceanBase 数据库,帮助用户快速了解 OceanBase 数据库。

步骤一(可选):拉取 OceanBase 数据库镜像

运行以下命令,拉取 OceanBase 数据库所需的 Docker 镜像:

  1. 搜索 OceanBase 数据库相关镜像

    sudo docker search oceanbase
    
  2. 拉取最新镜像

    sudo docker pull oceanbase/oceanbase-ce
    

    说明:
    若拉取 Docker 镜像失败,可从 quay.io 或 ghcr.io 仓库中拉取镜像,只需将上述拉取命令中的 oceanbase/oceanbase-ce 替换为 quay.io/oceanbase/oceanbase-ce 或 ghcr.io/oceanbase/oceanbase-ce。例如:

    sudo docker pull quay.io/oceanbase/oceanbase-ce
    

    确保步骤二中的镜像仓库地址与步骤一保持一致。

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

运行以下命令,启动 OceanBase 数据库实例:

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

    sudo docker run -p 2881:2881 --name obstandalone -e MODE=normal -e OB_TENANT_PASSWORD=***** -d oceanbase/oceanbase-ce
    
  2. 部署 mini 的独立实例

    sudo docker run -d -p 2881:2881 --name obstandalone -e MODE=mini -e OB_TENANT_PASSWORD=123456 oceanbase/oceanbase-ce
    

    参数说明:

    • --name:设置 Docker 容器名称,例如 obstandalone。
    • -e:设置环境变量,其中 MODE 用于设置 OceanBase 数据库的部署规格,OB_TENANT_PASSWORD 用于设置 root@test 用户密码。

启动预计需要 2~5 分钟。 可通过以下命令查看启动状态:

sudo docker logs -f obstandalone

或

sudo docker logs obstandalone | tail -1

输出 boot success! 表示启动成功。

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

OceanBase-CE 镜像内置了 obd(OceanBase Deployer)和 OBClient(OceanBase 命令行客户端)。用户可选择以下方式进行连接:

  1. 进入容器后连接

    sudo docker exec -it obstandalone bash
    

    进入容器后,可使用 obd 管理和 OBClient 连接实例:

    • 查看集群列表:

      obd cluster list
      
    • 查看集群详情:

      obd cluster display obcluster
      
    • 连接集群:

      obclient -h127.0.0.1 -uroot -A -Doceanbase -P2881 -p
      
  2. 使用宿主机本地客户端连接

    可使用宿主机本地的 OBClient 或 MySQL 客户端连接到 OceanBase 数据库实例:

    obclient -h172.17.0.1 -P2881 -uroot -Doceanbase -A
    

    连接成功后,终端将显示类似如下内容:

    Welcome to the OceanBase.  Commands end with ; or \g.
    Your OceanBase connection id is 3221711319
    Server version: OceanBase_CE 4.3.0.1 (r100000242024032211-0193a343bc60b4699ec47792c3fc4ce166a182f9) (Built Mar 22 2024 13:19:48)
    
    Copyright (c) 2000, 2018, OceanBase and/or its affiliates. All rights reserved.
    
    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
    
    obclient [(none)]>
    

4. OceanBase 数据库基本操作

4.1 创建数据库和用户

在连接到 OceanBase 数据库后,可以执行以下 SQL 命令创建数据库和用户:

CREATE DATABASE robot;
CREATE USER robot IDENTIFIED BY 'robot_123456';
GRANT ALL ON robot.* TO robot@'%' IDENTIFIED BY 'robot_123456';
USE robot;

4.2 远程连接

使用以下命令进行远程连接:

obclient -h172.17.0.1 -P2881 -urobot -Drobot -A -p

数据库连接串包含了访问数据库所需的参数信息。在创建应用程序前,可通过数据库连接串验证登录数据库,确保连接参数正确。

参数说明:

  • -h:OceanBase 数据库连接 IP,可能是 ODP 地址。
  • -u:租户的连接用户名,格式为 用户@租户#集群名称。默认集群租户为 sys,默认管理员用户为 root。直接连接数据库时不需填写集群名称,通过 ODP 连接时需填写。
  • -p:用户密码。
  • -P:OceanBase 数据库连接端口,也是 ODP 的监听端口。
  • -D:需要访问的数据库名称。

5. Java 客户端

OceanBase-CE 社区版几乎完全兼容 MySQL,这意味着用户可以无缝迁移现有的 MySQL 应用程序到 OceanBase-CE,享受其高性能和高可用性的优势。

<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.45</version>
</dependency>

5.1 Java 客户端远程连接

以下是一个简单的 Java 示例,用于连接 OceanBase 数据库并执行基本的数据库操作:

package com.litongjava.file.example;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;

public class OceanbaseConnectExample {
  public static void main(String[] args) {
    String url = "jdbc:mysql://xxxx:2881/robot?user=robot&password=robot_123456&useSSL=false";
    try {
      Class.forName("com.mysql.jdbc.Driver").newInstance();
      try {
        Connection connection = DriverManager.getConnection(url);
        System.out.println(connection.getAutoCommit());
        Statement sm = connection.createStatement();
        // 新建表 t_meta_form
        sm.executeUpdate("CREATE TABLE t_meta_form (name varchar(36), id int)");
        // 插入数据
        sm.executeUpdate("INSERT INTO t_meta_form VALUES ('an', '1')");
        // 查询数据,并输出结果
        ResultSet rs = sm.executeQuery("SELECT * FROM t_meta_form");
        while (rs.next()) {
          String name = rs.getString("name");
          String id = rs.getString("id");
          System.out.println(name + ',' + id);
        }
        // 删除表
        sm.executeUpdate("DROP TABLE t_meta_form");
      } catch (SQLException se) {
        System.out.println("error!");
        se.printStackTrace();
      }
    } catch (Exception ex) {
      ex.printStackTrace();
    }
  }
}

5.2 Java-DB + HikariDataSource 连接

以下是使用 HikariCP 连接池与 Java-DB 结合的配置示例:

app.properties

jdbc.url=jdbc:mysql://xxxx:2881/robot?user=robot&password=robot_123456&useSSL=false

DbConfig.java

package com.litongjava.file.config;

import com.jfinal.template.Engine;
import com.jfinal.template.source.ClassPathSourceFactory;
import com.litongjava.annotation.AConfiguration;
import com.litongjava.annotation.Initialization;
import com.litongjava.constatns.ServerConfigKeys;
import com.litongjava.db.activerecord.ActiveRecordPlugin;
import com.litongjava.db.activerecord.OrderedFieldContainerFactory;
import com.litongjava.db.activerecord.dialect.MysqlDialect;
import com.litongjava.tio.boot.server.TioBootServer;
import com.litongjava.tio.utils.environment.EnvUtils;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@AConfiguration
public class DbConfig {

  @Initialization
  public void config() {
    // 获取数据库连接信息
    String jdbcUrl = EnvUtils.getStr(ServerConfigKeys.JDBC_URL);

    // 初始化 HikariCP 数据库连接池
    HikariConfig config = new HikariConfig();
    // 设定基本参数
    config.setJdbcUrl(jdbcUrl);

    HikariDataSource hikariDataSource = new HikariDataSource(config);

    // 初始化 ActiveRecordPlugin
    ActiveRecordPlugin arp = new ActiveRecordPlugin(hikariDataSource);

    // 开发环境下启用开发模式
    if (EnvUtils.isDev()) {
      arp.setDevMode(true);
    }

    // 是否展示 SQL
    boolean showSql = EnvUtils.getBoolean("jdbc.showSql", false);
    log.info("show sql:{}", showSql);
    arp.setShowSql(showSql);
    arp.setDialect(new MysqlDialect());
    arp.setContainerFactory(new OrderedFieldContainerFactory());

    // 配置引擎
    Engine engine = arp.getEngine();
    engine.setSourceFactory(new ClassPathSourceFactory());
    engine.setCompressorOn(' ');
    engine.setCompressorOn('\n');

    // 启动 ActiveRecordPlugin
    arp.start();

    // 在应用销毁时停止数据库连接池
    HookCan.me().addDestroyMethod(() -> {
      arp.stop();
      hikariDataSource.close();
    });
  }
}

6. 参考资料

  • OceanBase 官方文档

通过上述步骤,您可以快速部署并体验 OceanBase 社区版的强大功能。无论是单机环境、集群环境还是容器化部署,OceanBase 都能为您的应用提供稳定、高效的数据库支持。同时,OceanBase-CE 与 MySQL 的高度兼容性,使得现有的 MySQL 应用能够轻松迁移至 OceanBase,享受其分布式架构带来的优势。

Edit this page
Last Updated:
Contributors: Tong Li
Next
快速上手 OceanBase 数据库单机部署与管理