View and download a compatibility assessment report|OceanBase Cloud

OceanBase Cloud

Release Notes
- 2025.1.22
- 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
- Get started with a transactional instance
- Get started with an analytical instance
- Get started with a Key-Value instance
Work with Transactional Instances
- Overview
- 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
- Connect to an instance
  - 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
- Manage instances
  - 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
    - Add an endpoint
    - 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
      - Parameter template overview
    - 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
    - Configure global endpoint
    - Switchover between primary and standby instances
    - Initiate Failover
    - 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
    - Backup overview
    - Backup strategies
    - Immediate backup
    - Data backup
    - Initiate restore
    - Data restore
  - Diagnostics
    - View performance monitoring data
    - Capacity diagnostics
    - One-click diagnostics
      - Initiate one-click diagnostics
      - View one-click diagnostic report
        Exceptions
        Real-time diagnostics
        Optimization suggestions
        Capacity management
        Security management
    - Real-time diagnostics
      - SQL diagnostics
        Top SQL
        Slow SQL
        Suspicious SQL
        High-risk SQL
        SQL details
      - Session management
        Session management
      - Optimization management
        Manage active outlines
        View the optimization history
    - Root cause diagnostics
      - Exception handling
      - Enable automatic refresh of Plan Cache
    - SQL audit
  - Manage tags
- 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
- Manage recycle Bin
  - View cluster instance recycle bin
  - Manage databases and tables in recycle bin
    - Overview
    - Instance-level recycle bin
    - Tenant-level recycle bin
Work with Analytical Instances
- Overview
- Create an analytical instance
- Connect to an instance
  - Overview
  - Get connection string
    - Overview
    - Connect using AWS PrivateLink
    - 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
- Data table design
  - Overview
  - Data distribution
  - Best practices
- Query acceleration
  - Statistics
  - Materialized views
  - Hints
  - Auto DOP
  - Full direct load
  - Table groups
  - Hybrid row-column storage
- Manage instances
  - View instance workspace
  - Stop and restart instances
  - Release instances
  - Manage parameters
  - Backup and restore
    - Backup overview
    - Backup strategies
    - Immediate backup
    - Data backup
    - Initiate restore
    - Data restore
  - 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
    - View performance monitoring data
    - Capacity diagnostics
    - Real-time diagnostics
      - SQL diagnostics
        Top SQL
        SQL details
      - Session management
      - Optimization management
        Manage active outlines
        View the optimization history
  - Manage tags
- Data Development
  - Overview
  - Workspace management
  - Worksheet management
  - Compute node pool management
  - Workflow management
  - Dashboard 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
- Manage recycle Bin
  - View cluster instance recycle bin
  - Manage databases and tables in recycle bin
    - Overview
    - Instance recycle bin
- Product integration
Work with Key-Value Instances
- Use Table model
  - Manage instances
    - 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
      - Manage databases
      - 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
    - Monitor instance performance
      - Overview
      - Monitor the performance of databases in an instance
      - Monitor the performance of hosts in a cluster
      - Customize monitoring dashboards for an instance
    - Manage major compactions
      - Initiate major compactions
      - View compaction records
      - Update time for compactions
    - Manage instance parameters
      - Parameter management overview
      - Parameters for cluster instances
    - Change instance configurations
      - View history of configuration changes
      - Scale your instances
    - 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
      - View performance monitoring data
      - Top SQL
      - Capacity diagnostics
    - Backup and restore
      - Backup overview
      - Backup strategies
      - Immediate backup
      - Data backup
      - Initiate restore
      - Data restore
    - Manage tags
  - Manage recycle Bin
    - View cluster instance recycle bin
    - Manage databases and tables in recycle bin
      - Overview
      - Instance-level recycle bin
      - Tenant-level recycle bin
- Try out Key-Value instances
  - Create an instance
  - Create a tenant
  - Create an account for a database user
  - OBKV HBase data operation examples
- Use HBase model
  - OBKV-HBase Overview
  - Manage instances
    - 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
      - Manage databases
      - 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
    - Monitor instance performance
      - Overview
      - Monitor the performance of databases in an instance
      - Monitor the performance of hosts in a cluster
      - Customize monitoring dashboards for an instance
    - Manage major compactions
      - Initiate major compactions
      - View compaction records
      - Update time for compactions
    - Manage instance parameters
      - Parameter management overview
      - Parameters for cluster instances
    - Change instance configurations
      - View history of configuration changes
      - Scale your instances
    - 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
      - View performance monitoring data
      - Top SQL
      - Capacity diagnostics
    - Backup and restore
      - Backup overview
      - Backup strategies
      - Immediate backup
      - Data backup
      - Initiate restore
      - Data restore
    - Manage tags
  - Performance test
  - Manage recycle Bin
    - View cluster instance recycle bin
    - Manage databases and tables in recycle bin
      - Overview
      - Instance-level recycle bin
      - Tenant-level recycle bin
- Connect Key-Value instances
  - Overview
  - Connect using a public IP address
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
  - Migrations billing
  - Migrations specification
  - Purchase data migration instance
  - 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
  - Configure a two-way synchronization task
  - 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 parameters
    - Start and stop a data migration task
    - Clone a data migration task
    - Release a data migration task
  - Features
    - Custom DML/DDL configurations
    - DDL synchronization scope
    - 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
    - Import migration objects
    - Download conflict data
  - Alibaba Cloud account authorization
  - SQL statements for querying table objects
  - Configure endpoints
    - Configure Amazon Cloud Endpoint
    - Configure Google Cloud Endpoint
  - 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
  - Obtain MySQL instance audit logs
  - 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 access keys
- Import data
  - Import data
  - Bypass import
  - Supported file formats and encoding formats for Data Import
  - Sample data introduction
- Binlog service
  - Overview
  - Activate and manage the Binlog service
Security
- Modify login password
- Organization and project management
  - Overview
  - Manage organization access
  - Manage project access
  - Manage members
  - Role permissions
- Configure the allowlist of IP addresses
- Manage AccessKey pairs
- SSL encryption
- Support access control
- Query historical events
- Modify time zone
- Multi-factor authentication (MFA) for OB Cloud accounts
- KMS key management
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
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
Billing
- Overview
- View billing details
- View payment details
- Invoice
- View orders
- Backup billing
- SQL audit billing
OceanBase Cloud Services Agreement
OceanBase Cloud Migrations Service Level Agreement

Download PDF

Company

About OceanBase Contact Us

Product

OceanBase Dedicated OceanBase Database Quick Start Download Pricing

Resources

Docs Blog White Paper Trust Center