Tio Boot DocsTio Boot Docs
Home
文档导航
  • java-db
  • api-table
  • jooq
  • mysql
  • postgresql
  • oceanbase
  • Enjoy
  • Tio Boot Admin
  • java-openai
  • ai_agent
  • knowlege_base
  • voice-agent
  • ai-search
  • ai-coding
  • ai-browser
  • 案例
Abount
AI 检索
  • Github
  • Gitee
Home
文档导航
  • java-db
  • api-table
  • jooq
  • mysql
  • postgresql
  • oceanbase
  • Enjoy
  • Tio Boot Admin
  • java-openai
  • ai_agent
  • knowlege_base
  • voice-agent
  • ai-search
  • ai-coding
  • ai-browser
  • 案例
Abount
AI 检索
  • Github
  • Gitee
  • 入门

    • 01 · 入门

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

    • 02 · 部署

      • 02_deployment
      • 使用 Maven Profile 实现分环境打包 tio-boot 项目
      • Maven 项目配置详解:依赖与 Profiles 配置
      • tio-boot 打包成 FatJar
      • 使用 GraalVM 构建 tio-boot Native 程序
      • 使用 Docker 部署 tio-boot
      • 部署到 Fly.io
      • 部署到 AWS Lambda
      • 到阿里云云函数
      • 使用 Deploy 工具部署
      • 使用Systemctl启动项目
      • 使用 Jenkins 部署 Tio-Boot 项目
      • 使用 Nginx 反向代理 Tio-Boot
      • 使用 Supervisor 管理 Java 应用
      • 历史部署页与替代方案
      • 胖包与瘦包的打包与部署
    • 03 · 日志

      • 日志
      • tio-boot 整合 Logback
  • 核心开发

    • 04 · 配置

      • 04_configuration
      • 配置参数
      • 服务器监听器
      • 内置缓存系统 AbsCache
      • 使用 Redis 作为内部 Cache
      • 静态文件处理器
      • 基于域名的静态资源隔离
      • DecodeExceptionHandler
      • 开启虚拟线程(Virtual Thread)
      • 框架级错误通知
    • 05 · JSON

      • 05_json
      • Json
      • 接受 JSON 和响应 JSON
      • 响应实体类
    • 06 · Web 开发

      • Web 开发
      • 路由与参数

        • 概述
        • 添加 Controller
        • handler入门
        • Handler 的请求方法与错误响应
        • 接收请求参数
        • 接收日期参数
        • 接收数组参数
        • HttpRequest
      • 响应与文件

        • 返回字符串
        • 返回文本数据
        • 返回网页
        • 请求和响应字节
        • 文件上传
        • 文件下载
        • 返回视频文件并支持断点续传
        • HttpResponse
        • Resps
        • RespBodyVo
        • 动态 返回 CSS 实现
        • 返回图片
        • 返回 multipart
        • 使用零拷贝发送大文件
        • 分片上传
        • WebJars
      • 会话与请求控制

        • http Session
        • Cookie
        • 重定向和转发
        • Controller拦截器
        • 请求拦截器
        • LoggingInterceptor
        • 全局异常处理器
        • 跨域
        • 自定义 Handler 转发请求
        • 使用 HttpForwardHandler 转发所有请求
        • HTTP Basic 认证
        • Http响应加密
      • 异步与流式输出

        • 异步处理
        • Transfer-Encoding: chunked 实时音频播放
        • Server-Sent Events (SSE)
      • 工具与监控

        • 常用工具类
        • 接口访问统计
        • 接口请求和响应数据记录
        • JProtobuf
        • 测速
        • Gzip Bomb:使用压缩炸弹防御恶意爬虫
    • 07 · 参数校验

      • 07_validation
      • 数据紧校验规范
      • 参数校验
    • 08 · WebSocket 应用开发

      • 08_websocket
      • 使用 tio-boot 搭建 WebSocket 服务
      • WebSocket 聊天室项目示例
    • 09 · AOP

      • 09_aop
      • JFinal-aop
      • Aop 工具类
      • 配置
      • 独立使用 JFinal Aop
      • @AImport
      • 自定义注解拦截器
      • 原理解析
    • 10 · 国际化

      • 10_i18n
      • i18n
    • 11 · Enjoy 模板

      • 11_enjoy
      • tio-boot 整合 Enjoy 模版引擎文档
      • Tio-Boot 整合 Java-DB 与 Enjoy 模板引擎示例
      • 引擎配置
      • 表达式
      • 指令
      • 注释
      • 原样输出
      • Shared Method 扩展
      • Shared Object 扩展
      • Extension Method 扩展
      • Spring boot 整合
      • 独立使用 Enjoy
      • tio-boot enjoy 自定义指令 localeDate
      • PromptEngine
      • Enjoy 入门示例-擎渲染大模型请求体
      • Tio Boot + Enjoy:分页与 SEO 实战指南
      • TioBoot + Enjoy 生成 robots.txt 与 sitemap.xml:实战与SEO指南
      • Enjoy 使用示例
    • 12 · 定时任务

      • 12_scheduling
      • Quartz 定时任务集成指南
      • 分布式定时任务 xxl-jb
      • cron4j 使用指南
    • 13 · 测试

      • 13_testing
      • TioBootTest:环境与 AOP 初始化
      • 真实 HTTP 集成测试
      • 数据库集成测试与隔离
    • 14 · tio-utils

      • 14_tio-utils
      • tio-utils
      • EnvUtils 配置工具
      • Notification
      • Email
      • JSON
      • File
      • Base64
      • 上传和下载
      • Http
      • Telegram
      • RsaUtils
      • HttpUtils
      • ByteBufferUtils
      • 系统监控
      • 线程
      • 虚拟线程
      • 毫秒并发 ID (MCID) 生成方案
  • 数据库与数据访问

    • 15 · java-db

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

      • 16_api-table
      • ApiTable 概述
      • 使用 ApiTable 连接 SQLite
      • 使用 ApiTable 连接 Mysql
      • 使用 ApiTable 连接 Postgres
      • 使用 ApiTable 连接 TDEngine
      • 使用 api-table 连接 oracle
      • 使用 api-table 连接 mysql and tdengine 多数据源
      • EasyExcel 导出
      • EasyExcel 导入
      • ApiTable 的权限与业务边界
      • ApiTable 联调与故障定位
      • ApiTable 实现增删改查
      • 数组类型
      • 单独使用 ApiTable
      • TQL(Table SQL)前端输入规范
    • 17 · MyBatis

      • 17_mybatis
      • Tio-Boot 整合 MyBatis
      • 使用配置类方式整合 MyBatis
      • 整合数据源
      • 使用 mybatis-plus 整合 tdengine
      • 整合 mybatis-plus
    • 18 · jOOQ

      • 18_jooq
      • 使用配置类方式整合 jOOQ
      • tio-boot + jOOQ 事务管理
      • 批量操作与性能优化
      • 整合agroal
      • 代码生成与类型安全
      • 基于 Record / POJO 增删改查
      • UPSERT、批量更新、返回主键与高级 SQL
      • 的多表关联查询、DTO 投影、聚合统计与视图封装
      • 的窗口函数、CTE、JSON 查询与 PostgreSQL 高级 SQL 实战
      • tio-boot + jOOQ 的审计字段、乐观锁、数据权限与企业级 Repository 设计
      • 测试策略、SQL 日志、性能诊断与生产排障
      • 多租户、读写分离与多数据源设计
      • 代码生成治理、数据库迁移与团队协作规范实战
    • 19 · PostgreSQL

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

      • 20_mysql
      • 使用 Docker 运行 MySQL
      • 常见问题
    • 21 · OceanBase

      • 21_oceanbase
      • 快速体验 OceanBase 社区版
      • 快速上手 OceanBase 数据库单机部署与管理
      • 诊断集群性能
      • 优化 SQL 性能指南
      • 待定
    • 22 · Oracle

      • 22_oracle
      • Oracle
    • 23 · SQL Server

      • 23_sqlserver
      • SQL Server
    • 24 · SQLite

      • 24_sqlite
      • SQLite
    • 25 · MongoDB

      • 25_mongodb
      • tio-boot 使用 mongo-java-driver 操作 mongodb
    • 26 · Elasticsearch

      • 26_elasticsearch
      • Elasticsearch
      • JavaDB 整合 ElasticSearch
      • Elastic 工具类使用指南
      • Elastic-search 注意事项
      • ES 课程示例文档
  • 缓存与消息队列

    • 27 · Cache

      • 27_cache
      • Caffeine
      • CacheUtils 工具类
      • 使用 java-db 整合 ehcache
    • 28 · Redis

      • 28_redis
      • 使用 Docker 安装 Redis
      • 使用 java-db 整合 Redis
      • Java DB Redis 相关 Api
      • redis 使用示例
      • 和 RedisTemplate 协作
      • 使用 Jedis 连接池接入 Redis
      • hutool RedisDS
      • Redisson
      • Caffeine 与 Redis 两级缓存
      • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 29 · 消息队列

      • 29_mq
      • Mica-mqtt
      • EMQX
      • Disruptor
    • 30 · Kafka

      • 30_kafka
      • Kafka
      • AWS MSK
  • 认证与账号体系

    • 31 · 认证与权限

      • 31_authentication
      • FixedTokenInterceptor
      • TokenManager
      • 数据表
      • 匿名登录
      • 个人中心
      • 权限校验注解
      • Sa-Token
      • sa-token 登录注册
      • StpUtil.isLogin() 源码解析
    • 32 · 第三方登录注册

      • 32_third-party-auth
      • 邮箱登录和注册
      • 邮箱重置密码
      • 腾讯云短信登录注册
      • 腾讯云短信重置密码
      • 阿里云短信登录和注册
      • 阿里云短信重置密码
      • 微信登录与绑定手机号
      • 支付宝登录与绑定手机号
      • 微信小程序手机号快捷登录
      • Google登录
      • 阿里云邮件推送验证邮箱
  • 网络通信

    • 33 · AIO

      • 33_aio
      • ByteBuffer
      • AIO HTTP 服务器
      • 自定义和线程池和池化 ByteBuffer
      • AioHttpServer 应用示例 IP 属地查询
      • 手写 AIO Http 服务器
      • Java 21 中的虚拟线程与 AIO
    • 34 · t-io

      • 34_tio
      • 认识 t-io

        • t-io 核心优势与应用价值
        • t-io 消息处理流程
      • 快速上手

        • TioBootServer
        • 独立端口启动 TCP 服务器
        • 内置 TCP 处理器
        • 独立启动 UDPServer
        • 使用内置 UDPServer
      • 核心概念

        • TioConfig
        • ChannelContext
        • Packet
        • Tio 工具类
      • 消息与文件传输

        • 发送数据
        • HTTP 长连接与高效文件传输
        • 使用 AsynchronousSocketChannel 响应数据
      • 连接管理

        • 业务数据绑定
        • 业务数据解绑
        • 关闭连接
        • 资源共享
        • 成员排序
        • 拉黑 IP
      • 加密通信

        • SSL
        • Https建立连接过程
      • 心跳与监控

        • 监控: 心跳
        • 监控: 客户端的流量数据
        • 监控: 单条 TCP 连接的流量数据
        • 监控: 端口的流量数据
        • 单条通道统计: ChannelStat
        • 所有通道统计: GroupStat
      • 深入原理

        • tio-运行原理详解
        • DecodeRunnable
        • t-io 稳定性设计与资源管理
        • 深入解析 Tio 源码:构建高性能 Java 网络应用
        • HTTP、WebSocket 与 TCP 的缓冲区复用
    • 35 · tio-http-server

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

      • 36_tio-websocket
      • WebSocket 服务器
      • WebSocket Client
      • TCP数据转发
    • 37 · Netty

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

      • 38_netty-boot
      • Netty-Boot
      • 原理解析
      • 整合 Hot Reload
      • 整合 数据库
      • 整合 Redis
      • 整合 Elasticsearch
      • 整合 Dubbo
      • Listener
      • 文件上传
      • 拦截器
      • Spring Boot 整合 Netty-Boot
      • SSL 配置指南
      • ChannelInitializer
      • Reserve
  • 集成与扩展

    • 39 · 第三方集成

      • 39_integrations
      • 整合 okhttp
      • 整合 GrpahQL
      • 集成 Mailjet
      • 整合 ip2region
      • 整合 GeoLite 离线库
      • 整合 Lark 机器人指南
      • 集成 Lark Mail 实现邮件发送
      • Thymeleaf
      • Swagger
      • Clerk 验证
      • 集成datadog
    • 40 · Magic Script

      • 40_magic-script
      • tio-boot 与 magic-script 集成指南
    • 41 · Groovy

      • 41_groovy
      • tio-boot 整合 Groovy
      • 调试常用脚本
    • 42 · 爬虫

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

      • 43_dubbo
      • 概述
      • dubbo 2.6.0
      • dubbo 2.6.0 调用过程
      • dubbo 3.2.0
    • 44 · Spring

      • 44_spring
      • Spring Boot Web 整合 Tio Boot
      • spring-boot-starter-webflux 整合 tio-boot
      • tio-boot 整合 spring-boot-starter
      • Tio Boot 整合 Spring Boot Starter db
      • Tio Boot 整合 Spring Boot Starter Data Redis 指南
    • 45 · Spring Cloud

      • 45_spring-cloud
      • tio-boot spring-cloud
    • 46 · Quarkus

      • 46_quarkus
      • Quarkus(无 HTTP)整合 tio-boot(有 HTTP)
      • tio-boot + Quarkus + Hibernate ORM Panache
      • tio-boot + Quarkus + Hibernate ORM Panache + jOOQ 整合方案
    • 47 · Telegram4J

      • 47_telegram4j
      • 数据库设计
      • 基于 HTTP 协议开发 Telegram 翻译机器人
      • 基于 MTProto 协议开发 Telegram 翻译机器人
      • 过滤旧消息
      • 保存机器人消息
      • 定时推送
      • 增加命令菜单
      • 使用 telegram-Client
      • 使用自定义 StoreLayout
      • 延迟测试
      • Reactor 错误处理
      • Telegram4J 常见错误处理指南
      • 处理回调查询
      • Reactor
      • 文档翻译
      • 使用 Tio-Boot 整合 tdlight
      • tio-boot 整合 TelegramBots
      • tio-boot 整合 Telegram-Bot-Utils
      • Telegram-Bot-Utils 使用指南
    • 48 · Telegram Bots

      • 48_telegram-bots
      • TelegramBots 入门指南
      • 使用工具库 telegram-bot-base 开发翻译机器人
    • 49 · 文件存储

      • 49_file-storage
      • 文件上传数据表
      • 本地存储
      • 存储到 亚马逊 S3
      • 存储到 Cloudflare R2
      • 存储到 腾讯 COS
      • 上传文件到阿里云 OSS
    • 50 · 支付

      • 支付集成
      • 微信小程序支付:普通支付
      • 微信支付:Native 扫码支付(PC 网页扫码)
      • 支付宝:电脑网站支付接入指南
  • Firebase 与 Clerk

    • 51 · Firebase

      • 51_firebase
      • 整合 google firebase
      • Firebase Storage
      • Firebase Authentication
      • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
      • 导出用户
      • 登录注册
      • 注册回调
    • 52 · Clerk

      • 52_clerk
      • Clerk
  • 多媒体

    • 53 · 音视频处理

      • 53_media
      • JAVE 提取视频中的声音
      • Jave 提取视频中的图片
      • 待定
    • 54 · 语音识别

      • 54_asr
      • Whisper-JNI
    • 55 · 语音合成

      • 55_tts
    • 56 · 文字识别

      • 56_ocr
    • 57 · Native Media

      • 57_native-media
      • java-native-media
      • JNI 入门示例
      • mp3 拆分
      • mp4 转 mp3
      • 使用 libmp3lame 实现高质量 MP3 编码
      • Linux 编译
      • macOS 编译
      • 从 JAR 包中加载本地库文件
      • 支持的音频和视频格式
      • 任意格式转为 mp3
      • 通用格式转换
      • 通用格式拆分
      • 视频合并
      • VideoToHLS
      • split_video_to_hls 支持其他语言
      • 持久化 HLS 会话
      • 获取视频长度
      • 保存视频的最后一帧
      • 添加水印
      • linux版本
    • 58 · 计算机视觉

      • 58_computer-vision
      • 使用 Java 运行 YOLOv8 ONNX 模型进行目标检测
      • tio-boot整合yolo
      • ONNX Runtime 推理说明
      • Paddle Structure
      • tio-boot 整合 Paddle Structure
      • tio-boot整合Paddle Structure 提取图片
      • U2Net 图片去背景原理
      • tio-boot 整合 U2Net 实现图片去背景
  • AI 开发

    • 59 · java-openai

      • 59_java-openai
      • 简介
      • 流式生成
      • 图片多模态输入
      • Google Gemini接入
      • google Vertex AI 接入
      • Perplexity API
      • WhisperClient 语音识别
      • SupadataClient 获取视频字幕
      • GiteeClient 文档解析与图片 OCR
      • DeepSeekClient 官方模型查询
      • BailianTTSClient 语音合成
    • 60 · AI Agent

      • 60_ai-agent
      • 数据库设计
      • 示例问题管理
      • 会话管理
      • 历史记录
      • 意图识别
      • 智能问答
      • 文件上传与解析文档
      • 翻译
      • 名人搜索功能实现
      • Ai studio gemini youbue 问答使用说明
      • 自建 YouTube 字幕问答系统
      • 自建 获取 youtube 字幕服务
      • 使用 OpenAI ASR 实现语音识别接口(Java 后端示例)
      • 定向搜索
      • 16
      • 17
      • 18
      • 在 tio-boot 应用中整合 ai-agent
      • 接口文档
      • 自定义 ChatAskService
      • 请求记录
      • 限流和错误处理
      • 增强检索(RAG)
      • 结构化数据检索
      • AI 问答
      • 连接代码执行器
      • 待定
      • 模型编程能力评测
      • 音频会话 SDP 示例
    • 61 · 知识库

      • 61_knowledge-base
      • 学术论文
      • 数据库设计
      • 用户登录实现
      • 模型管理
      • 知识库管理
      • 文档拆分
      • 片段向量
      • 命中测试
      • 文档管理
      • 片段管理
      • 问题管理
      • 应用管理
      • 向量检索
      • 推理问答
      • 问答模块
      • 统计分析
      • 用户管理
      • api 管理
      • 存储文件到 S3
      • 文档解析优化
      • 片段汇总
      • 段落分块与检索
      • 多文档解析
      • 对话日志
      • 检索性能优化
      • Milvus
      • 文档解析方案和费用对比
      • 豫自然资办发〔2021〕18号文档解析实测
      • 离线运行向量模型
      • 爬取网页数据
    • 62 · AI 搜索

      • 62_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 部署
      • 爬取一个静态网站的所有数据
      • 网页数据预处理
      • 网页数据检索与问答流程整合
    • 63 · 语音 Agent

      • 63_voice-agent
      • 整合Gemini realtime模型
      • Voice Agent 前端接入接口文档
      • 整合千问realtime模型
      • 打断支持
      • 主动介入
      • eleven labs
      • 基于 tio-boot + ElevenLabs 构建实时语音 Agent(支持打断与主动介入)
    • 64 · AI Coding

      • 64_ai-coding
      • Cline 提示词
      • Cline 提示词-中文版本
    • 65 · AI Browser

      • deepseek-browser-use:从入门到源码
      • deepseek-browser-use:概念与学习路线
      • 安装、启动与健康检查
      • 第一个任务:打开页面、读取结果与关闭
      • 客户端:dsb 命令行、Python 与 PowerShell
      • 统一命令接口与人机协作
      • 浏览器、profile 与登录态
      • 窗口尺寸与页面视口
      • 接入智能体:观察、执行与验证
      • 表单与多层弹窗排障:防止重复提交
      • 调用追踪、页面留档与文件上传
      • 站点配方、技能与异步作业
      • Windows OCR:本地图片与页面文字识别
      • 配置项与运维自省
      • 命令清单
      • 源码教程:从 HTTP 请求到命令执行
      • DOM 原理:前端如何生成可交互快照
      • DOM 原理:Java 模型与跨 Frame 索引
      • 正文提取与上层结构化处理
      • 源码教程:生命周期、导航与页签
      • 源码教程:DOM、页面状态与元素读取
      • 源码教程:点击、输入、键盘与鼠标
      • 源码教程:等待条件与 JavaScript 执行
      • 源码教程:文件上传、截图、PDF 与 OCR
      • 源码教程:Cookie、存储与页面设置
      • 源码教程:网络记录、请求拦截与控制台
      • 源码教程:原生对话框、DOM 弹窗与人机协作
      • 源码教程:批量、配方、后台作业与维护
      • 源码教程:Chrome 走 CDP 与 CDP 客户端
      • 请求响应关联与线程约束
  • 项目实战

    • 66 · java-uni-ai-server

      • 66_java-uni-ai-server
      • 语音合成系统
      • Fish.audio TTS 接口说明文档与 Java 客户端封装
      • 整合 fishaudio 到 java-uni-ai-server 项目
      • 待定
    • 67 · java-llm-proxy

      • 67_java-llm-proxy
      • 使用tio-boot搭建多模型LLM代理服务
    • 68 · java-kit-server

      • 68_java-kit-server
      • Java 执行 python 代码
      • 通过大模型执行 Python 代码
      • 执行 Python (Manim) 代码
      • 待定
      • 待定
      • 待定
      • 视频下载增加水印说明文档
    • 69 · tio-im

      • 69_tio-im
      • 通讯协议文档
      • ChatPacket.proto 文档
      • java protobuf
      • 数据表设计
      • 创建工程
      • 登录
      • 历史消息
      • 发消息
    • 70 · tio-mail-wing

      • 70_tio-mail-wing
      • tio-mail-wing简介
      • 任务1:实现POP3系统
      • 使用 getmail 验证 tio-mail-wing POP3 服务
      • 任务2:实现 SMTP 服务
      • 数据库初始化文档
      • 用户管理
      • 邮件管理
      • 任务3:实现 SMTP 服务 数据库版本
      • 任务4:实现 POP3 服务(数据库版本)
      • IMAP 协议
      • 拉取多封邮件
      • 任务5:实现 IMAP 服务(数据库版本)
      • IMAP实现讲解
      • IMAP 手动测试脚本
      • IMAP 认证机制
      • 主动推送
      • namesapce
      • CONDSTORE and QRESYNC
    • 71 · tio-mcp-server

      • 71_tio-mcp-server
      • 实现 MCP Server 开发指南
      • MCP 协议
      • /zh/71_tio-mcp-server/11.html
    • 72 · tio-log-server

      • 72_tio-log-server
      • 简介
      • 收集 docker 日志
      • 入库
    • 73 · tio-sip

      • 73_tio-sip
      • SIP Server 第一版原理说明
      • SIP Server 第一版实战
      • 一、Windows 平台测试
      • SIP Server 第二版实战
      • SIP Server 第三版实战
      • 性能优化
      • 基于 MediaProcessor 对接 Realtime 模型说明
      • 对接大语言模型
      • 支持 G722 宽带语音
      • G722编码和解码
      • 会话级采样率转换
      • 增加 9196 回声测试分机
      • 语音系统链路说明
      • 一、Gemini Realtime 的打断机制
    • 74 · tio-boot-admin

      • 74_tio-boot-admin
      • 入门指南:使用框架内置配置
      • 手动初始化数据库
      • 配置职责、生效条件与扩展边界
      • 整合数据库
      • 与前端集成
      • 文件上传
      • 网络请求
      • 单图片管理(只读模式)
      • 多图片管理
      • 布尔值管理
      • 字段联动
      • Word 管理
      • PDF 管理
      • 文章管理
      • 富文本编辑器
      • 整合 Enjoy 模版引擎
      • 历史可选方案:Token 存储与 Sa-Token
      • 业务 API 与 H5 / 小程序联调
      • 方法路由与业务鉴权
      • 整合 Redis
      • 整合 Elasticsearch
      • 后端开发规范:tio-boot、java-db 与 Kv
      • 多表实现文件数据存储
    • 75 · 案例

      • 75_examples
      • 封装 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 命令
      • /zh/75_examples/11.html
      • /zh/75_examples/12.html
      • /zh/75_examples/13.html
  • 性能、原理与源码

    • 76 · 性能测试

      • 76_performance
      • 压力测试 - tio-http-serer
      • 压力测试 - tio-boot
      • 压力测试 - tio-boot-native
      • 压力测试 - netty-boot
      • 性能测试对比
      • TechEmpower FrameworkBenchmarks
      • 压力测试 - tio-boot 12 C 32G
      • HTTP/1.1 Pipelining 性能测试报告
      • tio-boot vs Quarkus 性能对比测试报告
    • 77 · 原理

      • 77_internals
      • 生命周期
      • 请求处理流程
      • 重要的类
    • 78 · 源码解析

      • 78_source-code
      • 源码阅读入口
      • Swagger 整合到 Tio-Boot 中的指南
      • 启动与关闭生命周期
      • HTTP 请求分发与路由优先级
      • 高性能网络编程中的 ByteBuffer 分配与回收策略
      • TioBootServerHandler 源码解析

快速上手 OceanBase 数据库单机部署与管理

本文档详细介绍了如何快速部署 OceanBase 单机版集群、查看集群基本信息、创建租户、创建数据库和用户,以及如何连接 OceanBase 集群。通过本指南,即使是初学者也能快速上手 OceanBase 数据库的各项操作。


部署单机版 OceanBase 集群

1. 部署集群环境

  1. 登录 ECS 主机
    首先,登录到已部署 OceanBase 数据库的 ECS 主机,查看当前环境中是否已下载 OceanBase 安装包:

    $ ls | grep oceanbase
    

    说明:若环境中未发现安装包,可以前往 OceanBase 下载中心获取相应安装包。

  2. 解压安装包
    解压已下载的安装包:

    $ tar -xzf oceanbase-all-in-one-*.tar.gz
    
  3. 执行安装命令
    进入解压后的安装包目录,并启动安装:

    $ cd oceanbase-all-in-one/bin/
    $ ./install.sh
    

    安装完成后,终端会显示如下提示信息:

    #####################################################################
    Install Finished
    =====================================================================
    Setup Environment:     source ~/.oceanbase-all-in-one/bin/env.sh
    Start Web Service:     obd web
    Quick Start:           obd demo
    More Details:          obd -h
    =====================================================================
    [root@xxxxx bin]#
    

    按提示执行加载环境变量的命令:

    $ source ~/.oceanbase-all-in-one/bin/env.sh
    

    说明:执行上述命令后不会有返回值,但环境变量已成功加载。

  4. 快速部署 OceanBase 集群
    使用 obd demo 命令快速部署一个单机版 OceanBase 集群:

    $ obd demo
    

    成功执行后,终端将显示类似如下的提示信息:

    demo running
    Trace ID: 560d174c-6818-11ee-a932-00163e0b7038
    If you want to view detailed obd logs, please run: obd display-trace 560d174c-6818-11ee-a932-00163e0b7038
    

    根据提示,从返回信息中获取集群连接串,例如:

    +---------------------------------------------+
    |                   obproxy                   |
    +-----------+------+-----------------+--------+
    | ip        | port | prometheus_port | status |
    +-----------+------+-----------------+--------+
    | 127.0.0.1 | 2883 | 2884            | active |
    +-----------+------+-----------------+--------+
    obclient -h127.0.0.1 -P2883 -uroot -Doceanbase -A
    

    说明:all_in_one 安装包包含 obproxy,因此可以使用 obproxy 下的连接串登录集群。

  5. 验证部署是否成功
    使用获取的连接串登录 OceanBase 集群:

    obclient -h127.0.0.1 -P2881 -uroot -Doceanbase -A
    

    示例输出:

    obclient -h127.0.0.1 -P2883 -uroot -Doceanbase -A
    Welcome to the OceanBase.  Commands end with ; or \g.
    Your OceanBase connection id is 2
    Server version: OceanBase_CE 4.2.1.0 (r100010022023081817-0bdf1c0c5674e88c5ae9a8d0ae4f8077465d7fae) (Built Aug 18 2023 17:32:49)
    
    Copyright (c) 2000, 2018, OceanBase ...
    
    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
    
    obclient [oceanbase]>
    

    使用 exit 命令退出后,可在 Linux 命令行查看 observer 进程是否正在运行:

    ps -ef | grep observer
    

    示例输出:

    root      5354     1 17 17:29 ?        00:02:03 /root/oceanbase-ce/bin/observer -r 127.0.0.1:2882:2881 -p 2881 -P 2882 -z zone1 -c 1 -d /root/oceanbase-ce/store ...
    root      8765  1571  0 17:40 pts/0    00:00:00 grep --color=auto observer
    

2. 【可选】重启集群

若需要重启集群,可按照以下步骤操作:

  1. 检查当前运行的集群
    查看当前运行的集群的 deployname:

    obd cluster list
    

    示例输出:

    +--------------------------------------------------+
    |                   Cluster List                   |
    +------+-------------------------+-----------------+
    | Name | Configuration Path      | Status (Cached) |
    +------+-------------------------+-----------------+
    | demo | /root/.obd/cluster/demo | running         |
    +------+-------------------------+-----------------+
    Trace ID: 7d37437c-681a-11ee-a8b4-00163e0b7038
    If you want to view detailed obd logs, please run: obd display-trace 7d37437c-681a-11ee-a8b4-00163e0b7038
    

    注意:这里的 demo 是 obd 的 deployname,而不是 OceanBase 集群内部的 cluster_name。默认的集群名为 obcluster。

  2. 重启集群
    使用 deployname 重启集群:

    obd cluster restart demo
    

    成功执行后,终端会提示类似 demo restart 的信息。


开机启动

方法一:使用 systemd 服务单元

实现 OceanBase 单机版集群的开机自动启动,利用 systemd 服务单元

  1. 创建 systemd 服务文件

使用文本编辑器创建一个新的 systemd 服务文件,例如 /etc/systemd/system/oceanbase.service:

vi /etc/systemd/system/oceanbase.service
  1. 在服务文件中添加以下内容

将以下内容粘贴到文件中(根据实际安装路径和启动命令进行调整):

[Unit]
Description=OceanBase Single-Node Cluster
After=network.target

[Service]
Type=forking
ExecStart=obd cluster start demo
ExecStop=obd cluster stop demo
Restart=on-failure
User=root
WorkingDirectory=/root

[Install]
WantedBy=multi-user.target

说明:

  • ExecStart:加载 OceanBase 环境变量并执行 obd demo 启动集群。
  • ExecStop:可选,用于停止集群的命令。
  • 确保 source 路径、用户和工作目录与实际环境一致。
  1. 保存并退出编辑器

  2. 重新加载 systemd 配置

sudo systemctl daemon-reload
  1. 启用并启动 OceanBase 服务
  • 启用开机启动:
sudo systemctl enable oceanbase.service
  • 立即启动服务以验证配置:
sudo systemctl start oceanbase.service
  1. 检查服务状态
sudo systemctl status oceanbase.service

正常情况下,服务应处于“active (running)”状态。此后,每次系统启动时,systemd 会自动启动 OceanBase 集群。

方法二:使用 /etc/rc.local(适用于支持 rc.local 的系统)

  1. 编辑 /etc/rc.local 文件

打开 /etc/rc.local 文件(如果不存在,可创建之):

sudo vi /etc/rc.local
  1. 在文件末尾添加启动命令

在 exit 0 之前添加:

#!/bin/bash
source /root/.oceanbase-all-in-one/bin/env.sh
obd cluster start demo

说明:

  • 确保使用正确的环境变量加载路径和启动命令。
  • 如果 /etc/rc.local 文件开头未声明 #!/bin/bash,请添加之,以确保脚本按 Bash 解释执行。
  1. 保存并退出编辑器

  2. 赋予 /etc/rc.local 可执行权限

sudo chmod +x /etc/rc.local
  1. 重启验证

重启系统,确认 OceanBase 集群自动启动:

sudo reboot

重启后,可使用 ps -ef | grep observer 或连接 OceanBase 集群验证其是否已启动。

查看 OceanBase 集群基本信息

使用 all_in_one 安装包创建的社区版单机版 OceanBase 集群会默认创建一个 Zone、一个资源池 sys_pool、一个资源规格 sys_unit_config 以及一个 MySQL 模式的 SYS 租户。

1. 连接集群

使用 root 用户登录集群的 sys 租户:

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

说明:此处 root 用户未设置密码,仅用于体验。在实际环境中,请根据需要配置相关用户密码。

2. 查看 Zone 信息

查询集群默认创建的 Zone 信息:

obclient [oceanbase]> SELECT * FROM oceanbase.DBA_OB_ZONES;

查询结果示例:

+-------+----------------------------+----------------------------+--------+-----+------------+-----------+
| ZONE  | CREATE_TIME                | MODIFY_TIME                | STATUS | IDC | REGION     | TYPE      |
+-------+----------------------------+----------------------------+--------+-----+------------+-----------+
| zone1 | 2023-05-27 22:25:04.469400 | 2023-05-27 22:25:04.469400 | ACTIVE |     | sys_region | ReadWrite |
+-------+----------------------------+----------------------------+--------+-----+------------+-----------+

说明:使用 all_in_one 包创建的集群,默认在本机上创建一个 Zone,名为 zone1,状态为可读写。

3. 查看节点信息

查询集群默认创建的节点信息:

obclient [oceanbase]> SELECT * FROM oceanbase.DBA_OB_SERVERS;

查询结果示例:

+-----------+----------+----+-------+----------+-----------------+--------+----------------------------+-----------+-----------------------+----------------------------+----------------------------+-------------------------------------------------------------------------------------------+-------------------+
| SVR_IP    | SVR_PORT | ID | ZONE  | SQL_PORT | WITH_ROOTSERVER | STATUS | START_SERVICE_TIME         | STOP_TIME | BLOCK_MIGRATE_IN_TIME | CREATE_TIME                | MODIFY_TIME                | BUILD_VERSION                                                                             | LAST_OFFLINE_TIME |
+-----------+----------+----+-------+----------+-----------------+--------+----------------------------+-----------+-----------------------+----------------------------+----------------------------+-------------------------------------------------------------------------------------------+-------------------+
| 127.0.0.1 |     2882 |  1 | zone1 |     2881 | YES             | ACTIVE | 2023-10-24 10:27:31.966797 | NULL      | NULL                  | 2023-10-24 10:27:28.301290 | 2023-10-24 10:27:33.555849 | 4.2.1.0_100000102023092807-...                                                              | NULL              |
+-----------+----------+----+-------+----------+-----------------+--------+----------------------------+-----------+-----------------------+----------------------------+----------------------------+-------------------------------------------------------------------------------------------+-------------------+

说明:默认创建了一个本地节点,IP 为 127.0.0.1,SQL 端口为 2881,RPC 端口为 2882,位于 zone1 上。

4. 查看资源信息

4.1 查看资源池信息

obclient [oceanbase]> SELECT * FROM oceanbase.DBA_OB_RESOURCE_POOLS;

结果示例:

+------------------+----------+-----------+----------------------------+----------------------------+------------+----------------+-----------+--------------+
| RESOURCE_POOL_ID | NAME     | TENANT_ID | CREATE_TIME                | MODIFY_TIME                | UNIT_COUNT | UNIT_CONFIG_ID | ZONE_LIST | REPLICA_TYPE |
+------------------+----------+-----------+----------------------------+----------------------------+------------+----------------+-----------+--------------+
|                1 | sys_pool |         1 | 2023-05-27 22:25:04.366593 | 2023-05-27 22:25:04.374066 |          1 |              1 | zone1     | FULL         |
+------------------+----------+-----------+----------------------------+----------------------------+------------+----------------+-----------+--------------+

说明:默认创建的资源池名称为 sys_pool,绑定了资源规格 ID 为 1 的配置,并分配在 zone1 上。

4.2 查看资源规格信息

obclient [oceanbase]> SELECT * FROM DBA_OB_UNIT_CONFIGS;

结果示例:

+----------------+-----------------+----------------------------+----------------------------+---------+---------+-------------+---------------+----------+----------+-------------+
| UNIT_CONFIG_ID | NAME            | CREATE_TIME                | MODIFY_TIME                | MAX_CPU | MIN_CPU | MEMORY_SIZE | LOG_DISK_SIZE | MAX_IOPS | MIN_IOPS | IOPS_WEIGHT |
+----------------+-----------------+----------------------------+----------------------------+---------+---------+-------------+---------------+----------+----------+-------------+
|              1 | sys_unit_config | 2023-05-27 22:25:04.363371 | 2023-05-27 22:25:04.363371 |       1 |       1 |  2147483648 |    2147483648 |    10000 |    10000 |           1 |
+----------------+-----------------+----------------------------+----------------------------+---------+---------+-------------+---------------+----------+----------+-------------+

说明:系统默认的资源规格 sys_unit_config 定义了 CPU、内存和日志盘大小等资源信息。

4.3 查看 Unit 信息

obclient [oceanbase]> SELECT * FROM GV$OB_UNITS;

结果示例:

+-----------+----------+---------+-----------+-------+-----------+------------+---------+---------+-------------+---------------------+---------------------+-------------+---------------+-----------------+------------------+--------+----------------------------+
| SVR_IP    | SVR_PORT | UNIT_ID | TENANT_ID | ZONE  | ZONE_TYPE | REGION     | MAX_CPU | MIN_CPU | MEMORY_SIZE | MAX_IOPS            | MIN_IOPS            | IOPS_WEIGHT | LOG_DISK_SIZE | LOG_DISK_IN_USE | DATA_DISK_IN_USE | STATUS | CREATE_TIME                |
+-----------+----------+---------+-----------+-------+-----------+------------+---------+---------+-------------+---------------------+---------------------+-------------+---------------+-----------------+------------------+--------+----------------------------+
| 127.0.0.1 |     2882 |       1 |         1 | zone1 | ReadWrite | sys_region |       2 |       2 |  2147483648 | 9223372036854775807 | 9223372036854775807 |           2 |    2147483648 |        87471014 |                0 | NORMAL | 2023-10-24 14:14:26.026707 |
+-----------+----------+---------+-----------+-------+-----------+------------+---------+---------+-------------+---------------------+---------------------+-------------+---------------+-----------------+------------------+--------+----------------------------+

4.4 查看 OBServer 信息

obclient [oceanbase]> SELECT * FROM GV$OB_SERVERS;

结果示例:

+-----------+----------+-------+----------+--------------+------------------+--------------+------------------+--------------+--------------+-------------------+-------------------+-----------------+--------------------+------------------+-------------------------+--------------+-------------------------+-----------------------+
| SVR_IP    | SVR_PORT | ZONE  | SQL_PORT | CPU_CAPACITY | CPU_CAPACITY_MAX | CPU_ASSIGNED | CPU_ASSIGNED_MAX | MEM_CAPACITY | MEM_ASSIGNED | LOG_DISK_CAPACITY | LOG_DISK_ASSIGNED | LOG_DISK_IN_USE | DATA_DISK_CAPACITY | DATA_DISK_IN_USE | DATA_DISK_HEALTH_STATUS | MEMORY_LIMIT | DATA_DISK_ABNORMAL_TIME | SSL_CERT_EXPIRED_TIME |
+-----------+----------+-------+----------+--------------+------------------+--------------+------------------+--------------+--------------+-------------------+-------------------+-----------------+--------------------+------------------+-------------------------+--------------+-------------------------+-----------------------+
| 127.0.0.1 |     2882 | zone1 |     2881 |           16 |               16 |            1 |                1 |   5368709120 |   2147483648 |       16106127360 |        2147483648 |       134217728 |        21474836480 |          4194304 | NORMAL                  |   6442450944 | NULL                    | NULL                  |
+-----------+----------+-------+----------+--------------+------------------+--------------+------------------+--------------+--------------+-------------------+-------------------+-----------------+--------------------+------------------+-------------------------+--------------+-------------------------+-----------------------+

说明:这里显示了 OBServer 的资源分配情况,如 CPU、内存、磁盘容量等。

4.5 查询 Unit 列表和部署位置

查询当前集群的 unit 对应的租户、所在的主机等详细信息:

obclient [oceanbase]> SELECT
  /*+ QUERY_TIMEOUT(5000000) */
  t1.UNIT_ID,
  t1.RESOURCE_POOL_ID,
  t1.ZONE,
  t1.SVR_IP,
  t1.SVR_PORT,
  t1.STATUS,
  t2.REPLICA_TYPE,
  t2.TENANT_ID,
  t3.TENANT_NAME,
  t2.NAME AS RESOURCE_POOL_NAME,
  t1.MIGRATE_FROM_SVR_IP,
  t1.MIGRATE_FROM_SVR_PORT,
  t1.MANUAL_MIGRATE
FROM
  oceanbase.DBA_OB_UNITS AS t1
  JOIN oceanbase.DBA_OB_RESOURCE_POOLS AS t2 ON t1.RESOURCE_POOL_ID = t2.RESOURCE_POOL_ID
  JOIN oceanbase.DBA_OB_TENANTS t3 ON t2.TENANT_ID = t3.TENANT_ID;

查询结果示例:

+---------+------------------+-------+-----------+----------+--------+--------------+-----------+-------------+--------------------+---------------------+-----------------------+----------------+
| UNIT_ID | RESOURCE_POOL_ID | ZONE  | SVR_IP    | SVR_PORT | STATUS | REPLICA_TYPE | TENANT_ID | TENANT_NAME | RESOURCE_POOL_NAME | MIGRATE_FROM_SVR_IP | MIGRATE_FROM_SVR_PORT | MANUAL_MIGRATE |
+---------+------------------+-------+-----------+----------+--------+--------------+-----------+-------------+--------------------+---------------------+-----------------------+----------------+
|       1 |                1 | zone1 | 127.0.0.1 |     2882 | ACTIVE | FULL         |         1 | sys         | sys_pool           | NULL                |                  NULL | NULL           |
+---------+------------------+-------+-----------+----------+--------+--------------+-----------+-------------+--------------------+---------------------+-----------------------+----------------+

4.6 查看租户信息

查询默认的 SYS 租户信息:

obclient [oceanbase]> SELECT * FROM DBA_OB_TENANTS;

结果示例:

+-----------+-------------+-------------+----------------------------+----------------------------+--------------+---------------+-------------------+--------------------+--------+---------------+--------+-------------+-------------------+------------------+----------+----------------+--------------+--------------------+--------------+----------------------------+----------+------------+-----------+
| TENANT_ID | TENANT_NAME | TENANT_TYPE | CREATE_TIME                | MODIFY_TIME                | PRIMARY_ZONE | LOCALITY      | PREVIOUS_LOCALITY | COMPATIBILITY_MODE | STATUS | IN_RECYCLEBIN | LOCKED | TENANT_ROLE | SWITCHOVER_STATUS | SWITCHOVER_EPOCH | SYNC_SCN | REPLAYABLE_SCN | READABLE_SCN | RECOVERY_UNTIL_SCN | LOG_MODE     | ARBITRATION_SERVICE_STATUS | UNIT_NUM | COMPATIBLE | MAX_LS_ID |
+-----------+-------------+-------------+----------------------------+----------------------------+--------------+---------------+-------------------+--------------------+--------+---------------+--------+-------------+-------------------+------------------+----------+----------------+--------------+--------------------+--------------+----------------------------+----------+------------+-----------+
|         1 | sys         | SYS         | 2023-10-24 10:27:27.897488 | 2023-10-24 10:27:27.897488 | RANDOM       | FULL{1}@zone1 | NULL              | MYSQL              | NORMAL | NO            | NO     | PRIMARY     | NORMAL            |                0 |     NULL |           NULL |         NULL |               NULL | NOARCHIVELOG | DISABLED                   |        1 | 4.2.1.0    |         1 |
+-----------+-------------+-------------+----------------------------+----------------------------+--------------+---------------+-------------------+--------------------+--------+---------------+--------+-------------+-------------------+------------------+----------+----------------+--------------+--------------------+--------------+----------------------------+----------+------------+-----------+

说明:默认 SYS 租户为 MySQL 模式租户,其名称为 sys,Tenant_ID 为 1,Primary Zone 为 RANDOM。

4.7 查看租户资源部署位置

obclient [oceanbase]> SELECT a.TENANT_NAME, a.TENANT_ID, b.SVR_IP
FROM DBA_OB_TENANTS a, GV$OB_UNITS b
WHERE a.TENANT_ID = b.TENANT_ID;

查询结果示例:

+-------------+-----------+-----------+
| TENANT_NAME | TENANT_ID | SVR_IP    |
+-------------+-----------+-----------+
| sys         |         1 | 127.0.0.1 |
+-------------+-----------+-----------+

说明:SYS 租户的资源部署在本地节点 127.0.0.1 上。

4.8 查询数据库列表

obclient [oceanbase]> SELECT
  o.CREATED AS GMT_CREATE,
  o.OBJECT_ID AS DATABASE_ID,
  d.DATABASE_NAME,
  c.ID AS COLLATION_TYPE,
  NULL AS PRIMARY_ZONE,
  0 AS READ_ONLY
FROM
  oceanbase.DBA_OB_DATABASES d
  JOIN oceanbase.DBA_OBJECTS o
    ON d.DATABASE_NAME = o.OBJECT_NAME
  JOIN information_schema.collations c
    ON d.COLLATION = c.COLLATION_NAME
WHERE
  o.OBJECT_TYPE = 'DATABASE';

查询结果示例:

+---------------------+-------------+--------------------+----------------+--------------+-----------+
| GMT_CREATE          | DATABASE_ID | DATABASE_NAME      | COLLATION_TYPE | PRIMARY_ZONE | READ_ONLY |
+---------------------+-------------+--------------------+----------------+--------------+-----------+
| 2023-07-20 16:32:22 |      500001 | test               |             45 |         NULL |         0 |
| ...                 |      ...    | ...                |             ...|          ... |       ... |
+---------------------+-------------+--------------------+----------------+--------------+-----------+

说明:通过以上 SQL 可查询集群中所有已创建的数据库信息。

4.9 查看租户白名单

obclient> SHOW VARIABLES LIKE 'ob_tcp_invited_nodes';

查询结果示例:

+----------------------+-------+
| Variable_name        | Value |
+----------------------+-------+
| ob_tcp_invited_nodes | %     |
+----------------------+-------+

说明:默认情况下,租户白名单设置为 %,表示允许所有 IP 连接该租户。

4.10 查看租户系统变量

查询 session 和 global 级别的系统变量,例如 ob_query_timeout:

obclient [oceanbase]> SELECT * FROM INFORMATION_SCHEMA.SESSION_VARIABLES WHERE VARIABLE_NAME = 'ob_query_timeout';

结果示例:

+------------------+----------------+
| VARIABLE_NAME    | VARIABLE_VALUE |
+------------------+----------------+
| ob_query_timeout | 10000000       |
+------------------+----------------+

查询 global 变量:

obclient [oceanbase]> SELECT * FROM INFORMATION_SCHEMA.GLOBAL_VARIABLES WHERE VARIABLE_NAME = 'ob_query_timeout';

结果示例:

+------------------+----------------+
| VARIABLE_NAME    | VARIABLE_VALUE |
+------------------+----------------+
| ob_query_timeout | 10000000       |
+------------------+----------------+

4.11 查看集群配置项

通过查询 GV$OB_PARAMETERS 视图查看指定配置项:

obclient [oceanbase]> SELECT * FROM GV$OB_PARAMETERS WHERE NAME LIKE '%syslog_level%';

结果示例:

+-----------+----------+-------+---------+-----------+--------------+-----------+-------+------------------------------------------------------------------------------------------------------------------------------+----------+-------------------+
| SVR_IP    | SVR_PORT | ZONE  | SCOPE   | TENANT_ID | NAME         | DATA_TYPE | VALUE | INFO                                                                                                                         | SECTION  | EDIT_LEVEL        |
+-----------+----------+-------+---------+-----------+--------------+-----------+-------+------------------------------------------------------------------------------------------------------------------------------+----------+-------------------+
| 127.0.0.1 |     2882 | zone1 | CLUSTER |      NULL | syslog_level | NULL      | WDIAG | specifies the current level of logging. There are DEBUG, TRACE, WDIAG, EDIAG, INFO, WARN, ERROR, seven different log levels. | OBSERVER | DYNAMIC_EFFECTIVE |
+-----------+----------+-------+---------+-----------+--------------+-----------+-------+------------------------------------------------------------------------------------------------------------------------------+----------+-------------------+

创建租户

OceanBase 集群支持 MySQL 模式和 Oracle 模式的租户。本文档以开源版 OceanBase 为例,仅支持 MySQL 模式的租户创建。创建租户的流程包括三个步骤:创建资源规格、创建资源池、创建租户。

注意事项:创建租户前,请做好充分的资源规划。本文以 root 用户为例,所有操作通过 SQL 命令行进行。

步骤一:创建资源规格

资源规格定义了 CPU、内存、磁盘空间、IOPS 等资源项。

  1. 查看已有资源规格

    obclient [oceanbase]> SELECT * FROM DBA_OB_UNIT_CONFIGS;
    

    示例输出显示系统默认的 sys_unit_config 规格。

  2. 创建新的资源规格
    示例:创建名称为 s1_unit_config 的资源规格,配置为 1 核 CPU、2G 内存、6G 日志盘空间:

    obclient [oceanbase]> CREATE RESOURCE UNIT s1_unit_config
                  MEMORY_SIZE = '2G',
                  MAX_CPU = 1, MIN_CPU = 1,
                  LOG_DISK_SIZE = '6G',
                  MAX_IOPS = 10000, MIN_IOPS = 10000, IOPS_WEIGHT = 1;
    

    参数说明:

    • UNIT_NAME:资源规格名称。
    • MAX_CPU 和 MIN_CPU:CPU 上下限,单位为核。
    • MEMORY_SIZE:内存大小,最小为 1G。
    • LOG_DISK_SIZE:日志盘空间,默认值为内存的 3 倍,最小为 2G。
    • IOPS 参数用于租户间 IOPS 隔离,可选。
  3. 确认规格创建成功

    obclient [oceanbase]> SELECT * FROM DBA_OB_UNIT_CONFIGS WHERE NAME = 's1_unit_config';
    

步骤二:创建资源池

创建资源池时,可以指定刚创建的资源规格。

  1. 查看已有资源池

    obclient [oceanbase]> SELECT * FROM DBA_OB_RESOURCE_POOLS;
    
  2. 创建新的资源池
    示例:创建名称为 mq_pool_01 的资源池,在 zone1 区域创建 1 个 Unit,使用前面创建的 s1_unit_config 规格:

    obclient [oceanbase]> CREATE RESOURCE POOL mq_pool_01
                  UNIT='s1_unit_config',
                  UNIT_NUM=1,
                  ZONE_LIST=('zone1');
    

    参数说明:

    • UNIT:指定资源规格名称。
    • UNIT_NUM:在目标 Zone 中创建的 Unit 数量。
    • ZONE_LIST:指定资源池的区域分布列表。
  3. 确认资源池创建成功

    obclient [oceanbase]> SELECT * FROM DBA_OB_RESOURCE_POOLS WHERE NAME = 'mq_pool_01';
    

步骤三:创建租户

在创建完资源池后,即可创建租户并将资源池分配给租户。

  1. 查看现有租户信息

    obclient [oceanbase]> SELECT * FROM DBA_OB_TENANTS;
    
  2. 创建新的租户
    示例:创建名为 mq_t1 的租户,设置 Primary Zone 为 zone1,指定资源池为 mq_pool_01,并允许所有 IP 连接:

    obclient [oceanbase]> CREATE TENANT IF NOT EXISTS mq_t1
                  PRIMARY_ZONE='zone1',
                  RESOURCE_POOL_LIST=('mq_pool_01')
                  SET OB_TCP_INVITED_NODES='%';
    

    参数说明:

    • IF NOT EXISTS:可选参数,若租户已存在则跳过创建。
    • tenant_name:租户名称,2~128 个字符,只能包含字母、数字和下划线,以字母或下划线开头。
    • PRIMARY_ZONE:指定租户的主区域。可使用 RANDOM 表示随机选择。
    • RESOURCE_POOL_LIST:指定分配给租户的资源池列表。多个资源池要求 UNIT_NUM 一致且 Zone 互斥。
    • OB_TCP_INVITED_NODES:租户连接的 IP 白名单, % 表示允许所有客户端连接。
  3. 确认租户创建成功

    obclient [oceanbase]> SELECT * FROM DBA_OB_TENANTS WHERE TENANT_NAME = 'mq_t1';
    

    结果示例:

    +-----------+-------------+-------------+----------------------------+----------------------------+--------------+---------------+-------------------+--------------------+--------+...
    |      1002 | mq_t1       | USER        | 2023-10-24 10:47:07.457885 | 2023-10-24 10:47:23.921931 | zone1        | FULL{1}@zone1 | NULL              | MYSQL              | NORMAL | ...
    +-----------+-------------+-------------+----------------------------+----------------------------+--------------+---------------+-------------------+--------------------+--------+...
    
  4. 修改租户管理员密码并重新登录
    租户创建成功后,默认管理员用户(MySQL 模式为 root)的密码为空。建议立即修改密码。 退出当前连接:

    obclient> exit
    

    重新登录新租户 mq_t1 的 root 用户:

    $ obclient -h127.0.0.1 -P2881 -uroot@mq_t1 -A
    

    在连接后修改密码:

    obclient [(none)]> ALTER USER root IDENTIFIED BY '新密码';
    

    修改密码成功后,退出并使用新的密码重新登录:

    $ obclient -h127.0.0.1 -P2881 -uroot@mq_t1 -p新密码 -A
    

创建数据库

在 OceanBase 集群的 MySQL 模式下,Database 是数据库对象的集合。创建数据库有助于分离管理不同应用的数据。

权限要求

确保当前登录用户拥有 CREATE 权限。默认情况下,root 用户已具备此权限。

创建步骤

  1. 连接集群并切换到 sys 租户

    $ obclient -h127.0.0.1 -uroot@sys -P2881 -Doceanbase -A
    
  2. 创建数据库 创建名为 testdb 的数据库,并指定字符集为 utf8mb4:

    obclient [(none)]> CREATE DATABASE testdb DEFAULT CHARACTER SET utf8mb4;
    
  3. 查询数据库列表验证创建

    obclient [oceanbase]> SHOW DATABASES;
    

    输出应包含 testdb 数据库:

    +--------------------+
    | Database           |
    +--------------------+
    | information_schema |
    | LBACSYS            |
    | mysql              |
    | oceanbase          |
    | ORAAUDITOR         |
    | SYS                |
    | test               |
    | testdb             |
    +--------------------+
    
  4. 使用创建好的数据库

    obclient [oceanbase]> USE testdb;
    

    提示符将切换至 [testdb]>,表示当前数据库为 testdb。


创建用户

在日常操作中,往往需要为应用创建具有特定权限的数据库用户。

权限要求

创建用户需要 CREATE USER 权限。默认情况下,仅集群管理员和租户管理员拥有此权限。

用户命名规则

  • 用户名在同一租户内唯一,不同租户下可重名。
  • 用户名长度不超过 64 个字节,建议遵循以字母开头、包含字母、数字和下划线的命名规则。

创建步骤

  1. 连接指定租户 以 root 用户登录 mq_t1 租户,并切换到 test 数据库:

    $ obclient -h127.0.0.1 -P2881 -uroot@mq_t1 -Dtest -A
    
  2. 创建普通用户并授权

    • 创建用户 test 并设置密码:
      obclient [test]> CREATE USER 'test' IDENTIFIED BY '密码';
      
    • 授予用户 test 对 testdb 库中所有表的 SELECT 权限:
      obclient [test]> GRANT SELECT ON testdb.* TO test;
      
  3. 查看创建的用户

    obclient [(test)]> SELECT user FROM mysql.user WHERE user='test';
    

    输出:

    +------+
    | user |
    +------+
    | test |
    +------+
    1 row in set
    
  4. 创建超级权限用户

    • 创建用户 dba_test 并设置密码:
      obclient [test]> CREATE USER 'dba_test' IDENTIFIED BY '密码';
      
    • 授予 dba_test 超级权限:
      obclient [test]> GRANT ALL ON *.* TO dba_test;
      

      说明:超级权限用户仅为示例,在生产环境中应遵循最小权限原则。

  5. 查看用户权限

    • 查看用户 test 被授予的权限:
      obclient [test]> SHOW GRANTS FOR test;
      
      输出示例:
      +--------------------------------------+
      | Grants for test@%                    |
      +--------------------------------------+
      | GRANT USAGE ON *.* TO 'test'         |
      | GRANT SELECT ON `testdb`.* TO 'test' |
      +--------------------------------------+
      
    • 查看用户级权限:
      obclient [test]> SELECT * FROM mysql.user WHERE user='test'\G;
      
    • 查看数据库级权限:
      obclient [test]> SELECT * FROM mysql.db WHERE user='test'\G;
      

连接 OceanBase 集群

本节介绍如何使用 OBClient 连接 OceanBase 集群的不同租户。

连接操作

  1. 基本连接命令格式

    obclient -hIP -u用户名@租户名#集群名 -P端口 -p密码 -c -A -D数据库名
    

    参数说明:

    • -h:OceanBase 节点 IP 地址。
    • -u:连接账户,格式为 用户名@租户名#集群名。例如 root@sys#obcluster。
    • -P:连接端口,默认 2881(直连方式)或 2883(通过 OBProxy)。
    • -p:密码,可选参数,若不指定则会提示输入密码。
    • -c:在 MySQL 运行环境中不忽略注释。
    • -A:连接时不自动获取统计信息。
    • -D:指定要访问的数据库名称。
  2. 示例连接 使用 OBClient 连接 sys 租户:

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

    成功连接后,终端提示符类似于:

    Welcome to the OceanBase.  Commands end with ; or \g.
    Your OceanBase connection id is 3221684181
    Server version: OceanBase 4.2.1.0 (Built ...)
    
    obclient [oceanbase]>
    

    输入 exit 或按 Ctrl+D 可退出 OBClient 命令行。


参考链接

  • OceanBase 官方演示网站

通过本指南,您已经了解了从部署单机版 OceanBase 集群到基本管理操作的全过程。本文档覆盖了集群部署、资源配置、租户和数据库管理以及用户管理等方方面面,帮助您快速上手 OceanBase 数据库。

Edit this page
Last Updated: 10/1/26, 4:55 AM
Contributors: litongjava
Prev
快速体验 OceanBase 社区版
Next
诊断集群性能