SERVICE_NAME

Description

You can execute the ALTER SYSTEM {CREATE | DELETE | START | STOP} SERVICE ... statement to perform maintenance on the SERVICE_NAME (service name) and control the creation, deletion, startup, and shutdown of the service.

Limitations and considerations

• The SERVICE_NAME feature is not supported in the META or SYS tenant.
• OceanBase Cloud Platform (OCP) ensures that only one primary tenant can be created under the SERVICE_NAME in the clusters it manages. If you want to create a primary tenant under the SERVICE_NAME, you need to make sure that no primary tenant has been created under the same SERVICE_NAME in the clusters managed by OCP.
• The FAILOVER operation automatically deletes all SERVICE_NAME from the tenant.
• A tenant can have only one SERVICE_NAME.
• Connections established through SERVICE_NAME do not have privileges to perform O&M commands related to the primary/standby role of SERVICE_NAME. Otherwise, an OB_OP_NOT_ALLOW error is returned.

Privilege requirements

The user who executes this statement must have the ALTER SYSTEM privilege. For more information about privileges in OceanBase Database, see Privilege types in MySQL mode and Privilege types in Oracle mode.

Syntax

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

Parameter explanation

Example

Create a service named service_mysql001 for the mysql001 tenant.

ALTER SYSTEM CREATE SERVICE service_mysql001 TENANT = 'mysql001';

References

• For more information about the SERVICE_NAME and its status of a tenant, query the DBA_OB_SERVICES or oceanbase.CDB_OB_SERVICES view.

• For more information about the execution of O&M commands related to a specific SERVICE_NAME, query the DBA_OB_TENANT_EVENT_HISTORY or oceanbase.CDB_OB_TENANT_EVENT_HISTORY view, specifying MODULE as SERVICE NAME.

• For more information about the SERVICE_NAME O&M command, see Create a service.

• For more information about how to connect to a tenant using SERVICE_NAME, see Connect to an OceanBase tenant (MySQL mode) or Connect to an OceanBase tenant (Oracle mode).