OB Cloud Database Documentation

OceanBase Cloud

Release Notes
- 2024.11.18
- 2024.09.27
- 2024.07.18
- 2024.06.25
- 2024.04.18
Product Introduction
- Overview
- Management mode and scenarios
- Core features
  - Achieving high availability with cross-cloud active-active architecture
- Supported database versions
Get Started
- Create an instance
  - Overview
  - Create via OceanBase official website
  - Create via AWS Marketplace
  - Create via GCP Marketplace
  - Create via Huawei Cloud Marketplace
  - Create via Alibaba Cloud Marketplace
- Create a tenant
- Create an account for a database user
- Connect to an OceanBase database
Develop
- Connect to database
  - MySQL mode
    - Overview
    - Get connection string
      - Overview
      - Connect using AWS PrivateLink
      - Connect using Google Cloud Private Service Connect
      - Connect using Huawei Cloud VPC Endpoint
      - Connect using a public IP address
    - Connect with clients
      - Connect to OceanBase Cloud by using Client ODC
      - Connect to OceanBase Cloud by using a MySQL client
      - Connect to OceanBase Cloud by using OBClient
    - Connect with drivers
      - Java
        Connect to OceanBase Cloud by using Spring Boot
        Connect to OceanBase Cloud by using Spring Batch
        Connect to OceanBase Cloud by using Spring Data JDBC
        Connect to OceanBase Cloud by using Spring Data JPA
        Connect to OceanBase Cloud by using Hibernate
        Connect to OceanBase Cloud by using MyBatis
        Connect to OceanBase Cloud using MySQL Connector/J
      - Python
        Connect to OceanBase Cloud by using mysqlclient
        Connect to OceanBase Cloud by using PyMySQL
        Connect to OceanBase Cloud using MySQL Connector/Python
      - C
        Connect to OceanBase Cloud using MySQL Connector/C
      - Go
        Connect to OceanBase Cloud using Go-SQL-Driver/MySQL
      - PHP
        Connect to OceanBase Cloud using PHP
    - Use database connection pool
      - Database connection pool configuration
      - Connect to OceanBase Cloud by using a Tomcat connection pool
      - Connect to OceanBase Cloud by using a C3P0 connection pool
      - Connect to OceanBase Cloud by using a Proxool connection pool
      - Connect to OceanBase Cloud by using a HikariCP connection pool
      - Connect to OceanBase Cloud by using a DBCP connection pool
      - Connect to OceanBase Cloud by using Commons Pool
      - Connect to OceanBase Cloud by using a Druid connection pool
  - Oracle mode
    - Overview
    - Get connection string
      - Overview
      - Connect using AWS PrivateLink
      - Connect using Google Cloud Private Service Connect
      - Connect using Huawei Cloud VPC Endpoint
      - Connect using a public IP address
    - Connect with clients
      - Connect to OceanBase Cloud by using OBClient
      - Connect to OceanBase Cloud by using Client ODC
    - Connect with drivers
      - Java
        Connect to OceanBase Cloud by using OceanBase Connector/J
        Connect to OceanBase Cloud by using SpringBoot
        Connect to OceanBase Cloud by using SpringBatch
        Connect to OceanBase Cloud by using Spring Data JDBC
        Connect to OceanBase Cloud by using Spring Data JPA
        Connect to OceanBase Cloud by using Hibernate
        Connect to OceanBase Cloud by using MyBatis
        Connect to OceanBase Cloud by using JFinal
      - C
        Connect to OceanBase Cloud by using OceanBase Connector/C
        Connect to OceanBase Cloud by using OceanBase Connector/ODBC
        Connect to OceanBase Cloud by using SqlSugar
    - Use database connection pool
      - Database connection pool configuration
      - Connect to OceanBase Cloud by using a Tomcat connection pool
      - Connect to OceanBase Cloud by using a C3P0 connection pool
      - Connect to OceanBase Cloud by using a Proxool connection pool
      - Connect to OceanBase Cloud by using a HikariCP connection pool
      - Connect to OceanBase Cloud by using a DBCP connection pool
      - Connect to OceanBase Cloud by using Commons Pool
      - Connect to OceanBase Cloud by using a Druid connection pool
- Developer guide
  - MySQL mode
    - Plan database objects
      - Create a database
      - Create a table group
      - Create a table
      - Create an index
      - Create an external table
    - Write data
      - Insert data
      - Update data
      - Delete data
      - Replace data
      - Generate test data in batches
    - Read data
      - Single-table queries
      - Join tables
        INNER JOIN queries
        FULL JOIN queries
        LEFT JOIN queries
        RIGHT JOIN queries
        Subqueries
        Lateral derived tables
      - Use operators and functions in queries
        Use arithmetic operators in queries
        Use numerical functions in queries
        Use string concatenation operators in queries
        Use string functions in queries
        Use datetime functions in queries
        Use type conversion functions in queries
        Use aggregate functions in queries
        Use NULL-related functions in queries
        Use the CASE conditional operator in queries
        Use the SELECT ... FOR UPDATE statement to lock query results
        Use the SELECT ... LOCK IN SHARE MODE statement to lock query results
      - Use a DBLink in queries
      - Set operations
    - Manage transactions
      - Overview
      - Start a transaction
      - Savepoints
        Mark a savepoint
        Roll back a transaction to a savepoint
        Release a savepoint
      - Commit a transaction
      - Roll back a transaction
  - Oracle mode
    - Plan database objects
      - Create a table group
      - Create a table
      - Create an index
      - Create an external table
    - Write data
      - Insert data
      - Update data
      - Delete data
      - Replace data
      - Generate test data in batches
    - Read data
      - Single-table queries
      - Join tables
        INNER JOIN queries
        FULL JOIN queries
        LEFT JOIN queries
        RIGHT JOIN queries
        Subqueries
        Lateral derived tables
      - Use operators and functions in queries
        Use arithmetic operators in queries
        Use numerical functions in queries
        Use string concatenation operators in queries
        Use string functions in queries
        Use datetime functions in queries
        Use type conversion functions in queries
        Use aggregate functions in queries
        Use NULL-related functions in queries
        Use CASE functions in queries
        Use the SELECT ... FOR UPDATE statement to lock query results
      - Use a DBLink in queries
      - Set operations
    - Manage transactions
      - Overview
      - Start a transaction
      - Savepoints
        Mark a savepoint
        Roll back a transaction to a savepoint
      - Commit a transaction
      - Roll back a transaction
Instance Management
- Dedicated (Transactional)
  - Manage instances
    - View the instance list
    - Instance workspace
    - Stop and restart instances
    - Release an instance
  - Manage tenants
    - Create a tenant
    - Modify tenant specifications
    - Modify tenant names
    - Delete a tenant
    - Tenant workspace
    - Create an account
    - Create a database (MySQL mode)
    - Manage databases (MySQL mode)
    - Manage accounts
    - Monitor tenant performance
      - Overview
      - View performance and SQL monitoring details
      - View transaction monitoring details
      - View storage and cache monitoring details
      - Customize a monitoring dashboard for a tenant
    - Manage tenant parameters
      - Manage tenant parameters
      - Parameters for tenants
    - Switch primary zone
    - Account privileges
    - Tenant specification limitations
  - Monitor instance performance
    - Overview
    - Monitor the performance of databases in an instance
    - Monitor the performance of hosts in a cluster
    - Customize a monitoring report for a cluster
  - Manage major compactions
    - Initiate major compactions
    - View compaction records
    - Update time for compactions
  - Manage instance parameters
    - Manage parameters
    - Parameters for cluster instances
  - Change instance configurations
    - Enable storage auto-scaling
    - View history of configuration changes
    - Scale your instances
  - Manage standby instances
    - Overview
    - Create a standby instance (same cloud provider)
    - Create a standby instance for an Alibaba Cloud primary instance
    - View details of primary and standby instances
    - Switchover between primary and standby instances
    - Detach a standby instance
    - Release a standby instance
  - Database proxy
    - Overview
    - Manage database proxy
  - Manage alerts
    - Overview
    - Manage alert rules
      - Create an alert rule
      - View an alert rule
      - Edit an alert rule
      - Delete an alert rule
    - View alert history
    - Manage alert templates
      - Create an alert template
      - View an alert template
      - Edit an alert template
      - Copy an alert template
      - Delete an alert template
    - Manage muting rules
      - Create an alert muting rule
      - View an alert muting rule
      - Edit an alert muting rule
      - Delete an alert muting rule
    - Manage alert contacts
      - Add an alert contact
      - Add an alert contact group
      - View an alert contact
      - Edit an alert contact
      - Delete an alert contact
      - Obtain a webhook URL
    - Monitoring metrics for alerts
  - Backup and restore
    - Overview
    - Overview (GCP)
    - Backup strategies
    - Manually initiate a backup task
    - Data backup
    - Initiate a restore task
    - Restore data from a backup
  - Diagnostics
    - Overview
    - Capacity diagnostics
    - Session management
    - SQL audit
    - SQL diagnostics
      - TopSQL
      - Slow SQL
      - Suspicious SQL
      - High-risk SQL
      - SQL details
    - Optimization records
      - Manage active outlines
      - View the optimization history
  - Manage tags
- Dedicated (Analytical)
  - Create an analytical instance
  - Connect to instances
  - View instance workspace
  - Stop and restart instances
  - Release instances
  - Manage parameters
  - Backup and restore
    - Overview
    - Backup strategies
    - Manually initiate a backup task
    - Data backup
    - Initiate a restore task
    - Restore data from a backup
  - Monitor instance performance
    - View performance monitoring
    - Monitor the performance of databases in an instance
    - Monitor the performance of hosts in an instance
  - Manage major compactions
    - Initiate major compactions
    - View compaction records
    - Update time for compactions
  - Database proxy
    - Overview
    - Manage database proxy
  - Manage alerts
    - Overview
    - Manage alert rules
      - Create an alert rule
      - View an alert rule
      - Edit an alert rule
      - Delete an alert rule
    - View alert history
    - Manage alert templates
      - Create an alert template
      - View an alert template
      - Edit an alert template
      - Copy an alert template
      - Delete an alert template
    - Manage muting rules
      - Create an alert muting rule
      - View an alert muting rule
      - Edit an alert muting rule
      - Delete an alert muting rule
    - Manage alert contacts
      - Add an alert contact
      - Add an alert contact group
      - View an alert contact
      - Edit an alert contact
      - Delete an alert contact
      - Obtain a webhook URL
    - Monitoring metrics for alerts
  - Diagnostics
    - Overview
    - SQL diagnostics
    - Session management
    - Capacity diagnostics
    - Optimization records
      - Manage active outlines
      - View the optimization history
  - Manage tags
Security
- Query historical events
- Configure the allowlist of IP addresses
- SSL link encryption
- Modify login password
- Manage AccessKey pairs
- Multi-factor authentication (MFA) for OB Cloud accounts
- Modify time zone
- KMS key management
Migrations
- Data migration and import solutions
- Assess compatibility
  - Overview
  - Perform online assessment
  - Perform offline assessment
  - Manage compatibility assessment tasks
    - View a compatibility assessment task
    - View and download a compatibility assessment report
    - Stop a compatibility assessment task
    - Delete a compatibility assessment task
  - Obtain files for upload
  - Configure PrivateLink
  - Add an IP address to an allowlist
- Migrate data
  - Overview
  - Migrate data from a MySQL database to a MySQL tenant of OceanBase Database
  - Migrate data from a MySQL tenant of OceanBase Database to a MySQL database
  - Migrate data between OceanBase databases
  - Migrate data from an Oracle database to an Oracle tenant of OceanBase Database
  - Migrate data from an Oracle tenant of OceanBase Database to an Oracle database
  - Manage data migration tasks
    - View details of a data migration task
    - Rename a data migration task
    - View and modify migration objects
    - View and modify migration parameter configuration
    - Start and stop a data migration task
    - Clone a data migration task
    - Delete a data migration task
  - Features
    - DML filtering
    - DDL synchronization
    - Use SQL conditions to filter data
    - Rename a migration object
    - Set an incremental synchronization timestamp
    - Instructions on schema migration
    - Configure migration object matching rules
    - Wildcard rules
  - Alibaba Cloud account authorization
  - Configure Private Service Connect
  - Add an IP address to an allowlist
  - Supported DDL statements for synchronization and their limitations
    - DDL synchronization from Aurora MySQL DB clusters to MySQL tenants of OceanBase Database
    - DDL synchronization from MySQL tenants of OceanBase Database to Aurora MySQL DB clusters
    - DDL synchronization between MySQL tenants of OceanBase Database
    - Supported DDL operations for synchronization from an Oracle database to an Oracle tenant of OceanBase Database
    - Synchronize DDL operations from an Oracle tenant of OceanBase Database to an Oracle database
    - Supported DDL operations for synchronization between Oracle tenants of OceanBase Database
- Assess performance
  - Overview
  - Preliminary steps
  - Create a full performance assessment task
  - Create an SQL file parsing task
  - Create an SQL file replay task
  - Manage performance assessment tasks
    - View the details of a performance assessment task
    - View a performance assessment report
    - Retry and stop a performance assessment task
    - Delete a performance assessment task
    - How to retrieve database instances
  - Obtain database instance
  - Create S3 access keys
- Import data
  - Import data
  - Supported file formats and encoding formats for Data Import
  - Sample data introduction
- Binlog service
  - Overview
  - Activate and manage the Binlog service
SQL Console
- Overview
- Access SQL Console
- SQL editing and execution
- PL compilation
- Result set editing
- Execution analysis
- Database object management
  - Create a table
  - Create a view
  - Create a function
  - Create a stored procedure
  - Create a sequence
  - Create a trigger
  - Create a type
  - Create a sequence
  - Create a synonym
- Session variable management
- Functional keys in SQL Console
Data Development
- Overview
- Workspace management
- Worksheet management
- SQL development
  - SQL editing and execution
  - Result set editing
  - Execution analysis
  - Database object management
    - Create a table
    - Create a view
    - Create a function
    - Create a stored procedure
  - Session variable management
- Sample datasets
- Data development terms
Data Source Management
- Create a data source
- Manage data sources
- Configure allowlists
  - Configure the allowlist when connecting using private network
  - Add an IP address to an allowlist
- User privileges
Data Lifecycle Management
- Archive data
- Clean up data
Organization and Project Management
- Overview
- Manage organization access
- Manage project access
- Manage members
- Role permissions
Billing
- Overview
- View billing details
- View payment details
- Invoice
- View orders
Integrations
- Overview
- Schema evolution
  - Liquibase
- Data ingestion
  - Flink
  - Canal
  - Maxwell
  - SeaTunnel
  - Debezium
  - DataWorks
  - Informatica Cloud
  - Kafka
  - dbt
  - Glue
- SQL development
  - Navicat
  - DBeaver
  - DataGrip
  - TablePlus
- Orchestration
  - DolphinScheduler
  - Linkis
  - Airflow
- Visualization
  - Superset
  - Quick BI
  - Tableau
  - Power BI
  - Grafana
- Observability
  - Prometheus
  - Datadog
- Database management
  - Bytebase
- AI
  - LlamaIndex
  - LangChain
  - Qwen
  - OpenAI
References
- Open API References
  - Overview
  - Service access point
  - Using API
  - Open API List
    - Cluster management
      - # DescribeInstances
      - # DescribeInstance
      - # CreateInstance
      - # ModifyInstanceSpec
      - # ModifyInstanceNodeNum
      - # DeleteInstance
      - # ModifyInstanceName
      - # DescribeNodeOptions
      - # StopCluster
      - # StartCluster
    - Tenant management
      - DescribeTenants
      - DescribeTenant
      - CreateTenants
      - DeleteTenants
      - ModifyTenantName
      - ModifyTenant
      - CreateConstraints
      - CreateCpuConstraints
      - CreateMemConstraints
      - ModifyCpuConstraints
      - ModifyMemConstraints
      - CreateTenantSecurityIpGroup
      - DescribeTenantSecurityIpGroups
      - ModifyTenantSecurityIpGroup
      - DeleteTenantSecurityIpGroup
    - Tenant user management
      - CreateTenantUser
      - DescribeTenantUsers
      - DeleteTenantUsers
      - ModifyTenantUserPassword
    - Database management
      - CreateDatabase
      - DescribeDatabases
      - DeleteDatabases
    - Monitoring management
      - DescribeNodeMetrics
      - DescribeTenantMetrics
      - DescribeMetricsData
    - Diagnostic management
      - DescribeOasTopSQLList
      - DescribeOasAnomalySQLList
      - DescribeOasSlowSQLList
      - # DescribeOasSQLText
- Download OBClient
  - Download OBClient
  - Download OceanBase Connector/J
  - Download the ODC client
  - Download OceanBase Connector/ODBC
  - Download OBClient Libs
FAQ
- How to reset your password
- How to disable multi-factor authentication (MFA)
OceanBase Cloud Services Agreement

Download PDF

Create and Manage Database

Create a Database

Configure a Database

Connect to the Database

Optimize the Database

1
Purchase a cluster instance
OceanBase Cloud supports two service modes: cluster instance and tenant instance. You can select a service mode based on your business needs.
For more information, see "Create a cluster instance".
2
View instance information
After you create an instance, you can log in to the OceanBase Cloud console and view the details about the instance.
For more information, see "Instance workspace".
3
Create a tenant
After you purchase a cluster instance, you need to create a tenant.
For more information, see "Create a tenant".

Dive Deep into OceanBase Database

OceanBase Concepts
Learn more about the principles and technologies of OceanBase Database
Documents
OceanBase Reference
Learn more about the configuration items, variables, views, and error codes of OceanBase Database
Documents
OceanBase SQL
Learn more about the SQL syntax of OceanBase Database
Documents

Create and Manage Database

Dive Deep into OceanBase Database

OceanBase Concepts

OceanBase Reference

OceanBase SQL