SERVICE_NAME - OceanBase 数据库 V4.2.1 | OceanBase 文档中心

文档反馈

分布式版-V4.2.1LTS

V4.2.1 文档更新记录
简介
快速上手
应用开发
部署数据库
数据迁移
管理数据库
参考指南
- 系统原理
- 系统管理
- 数据库对象管理
- 数据库设计规范和约束
- SQL 参考
  - SQL 语法
    - 系统租户
      - 管理命令概述
      - ALTER SYSTEM
        ACTIVATE STANDBY
        ADD RESTORE SOURCE
        SET LOG_ARCHIVE_DEST
        SET LOG_ARCHIVE_DEST_STATE
        ARCHIVELOG
        NOARCHIVELOG
        ARBITRATION
        BOOTSTRAP
        BACKUP KEY
        BACKUP
        BACKUP CLUSTER PARAMETERS
        BALANCE TASK
        CANCEL BACKUP
        CANCEL BALANCE JOB
        CANCEL DELETE BACKUP
        CANCEL MIGRATE UNIT
        CANCEL REPLICA TASK
        CANCEL RESTORE
        CANCEL RECOVER TABLE
        CANCEL TRANSFER PARTITION
        CLEAR RESTORE SOURCE
        MAJOR 和 MINOR
        MIGRATE REPLICA
        MIGRATE UNIT
        MODIFY LS
        MODIFY PAXOS_REPLICA_NUM
        MODIFY REPLICA
        DELETE BACKUP POLICY
        FLUSH PLAN CACHE
        JOB
        SET LOG_RESTORE_SOURCE
        PARAMETER
        RECOVER STANDBY
        RECOVER STANDBY CANCEL
        REMOVE REPLICA
        REFRESH
        RESTORE
        RESTORE PREVIEW
        RECOVER TABLE
        SET DATA_BACKUP_DEST
        SERVER
        SERVICE_NAME
        SWITCHOVER
        THROTTLE
        TRANSFER PARTITION
        WASH MEMORY FRAGMENTATION
        ZONE
      - ALTER RESOURCE POOL
      - ALTER RESOURCE TENANT
      - ALTER RESOURCE UNIT
      - ALTER TENANT
      - CREATE RESOURCE POOL
      - CREATE RESOURCE UNIT
      - CREATE TENANT
      - CREATE STANDBY TENANT
      - DROP RESOURCE POOL
      - DROP RESOURCE UNIT
      - DROP TENANT
      - SET DECRYPTION
      - SET ENCRYPTION
      - SHOW RESTORE PREVIEW
    - 普通租户（MySQL 模式）
    - 普通租户（Oracle 模式）
  - SQL 实践和建议
  - PL 参考
  - 预留关键字（MySQL 模式）
  - 预留关键字（Oracle 模式）
- 系统视图
- 配置项和系统变量
- 错误码
- 性能调优
- 性能测试
- 数据库代理
- 驱动
- 平台产品
- 组件 & 工具
常见问题
版本发布记录
术语

SERVICE_NAME

更新时间：2026-07-15 22:01:30

分享

描述

ALTER SYSTEM {CREATE | DELETE | START | STOP} SERVICE ... 语句用于维护 SERVICE_NAME（服务名），控制 SERVICE_NAME 的创建、删除、启动和停止等操作。

说明

对于 OceanBase 数据库 V4.2.1 版本，从 V4.2.1 BP9 版本开始支持 SERVICE_NAME 功能。通过 OCP 进行服务名管理和主备切换操作，参见主备租户日常切换。

使用限制及注意事项

META/SYS 租户不支持 SERVICE_NAME 功能。
OceanBase 云平台（OceanBase Cloud Platform，OCP）保证了在其管理的集群范围内，一个 SERVICE_NAME 下只能有一个主租户，用户黑屏设置 SERVICE_NAME 需要自行保证。
FAILOVER 操作自动删除租户下所有 SERVICE_NAME。
一个租户最多有一个 SERVICE_NAME。
通过 SERVICE_NAME 建立的连接，不允许执行 SERVICE_NAME 和租户主备角色转换有关运维命令，否则会报 OB_OP_NOT_ALLOW 错误。

权限要求

执行该语句的用户需要拥有 ALTER SYSTEM 权限。有关 OceanBase 数据库权限的详细介绍，请参见 MySQL 模式下的权限分类和 Oracle 模式下的权限分类。

语法

ALTER SYSTEM {CREATE | DELETE | START | STOP} SERVICE service_name [tenant = 'tenant_name'];

参数解释

参数	描述
CREATE	创建服务。创建服务后，自动启动服务。
DELETE	删除服务。删除服务前，服务需要已经被停止。
START	启动服务。启动服务后，可以通过本 `SERVICE_NAME` 建 Session 或者允许请求。
STOP	停止服务。停止服务后，既不存在通过该 `SERVICE_NAME` 启动的 Session，也不能通过该 `SERVICE_NAME` 建立新的 Session。
service_name	指定服务名称。
tenant_name	可选项，指定待操作的租户。如果不显式指定待操作的租户，则默认租户名为当前租户。注意系统租户不支持 `SERVICE_NAME` 功能，即在系统租户下执行时该语句时，必须指定 `TENANT = tenant_name` 子句。

示例

为租户 mysql001 创建服务 service_mysql001。

ALTER SYSTEM CREATE SERVICE service_mysql001 TENANT = 'mysql001';

有帮助

无帮助