OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Cloud

  • Product Updates & Announcements
    • What's new
      • Release notes for 2026
      • Release notes for 2025
      • Release notes for 2024
      • Release history
    • Product announcements
      • Notice of underlying component upgrades for OceanBase Cloud database proxy clusters on Alibaba Cloud
      • AI Service Model Launch and Delisting Notice
      • Data development module deprecation notice
      • Optimization of Backup and Restore commercialization strategy
      • Database proxy billing update
      • AWS instance pricing adjustment
      • Billing notice for limited-time free OMS instances
      • Notice of cross-AZ data transfer billing adjustments (OceanBase Cloud on AWS)
  • Product Introduction
    • Overview
    • Management mode and scenarios
    • Core features
      • High availability with cross-cloud active-active architecture
      • High availability with cross-cloud primary-standby databases
      • Multi-layer online scaling and on-demand adjustment
    • Deployment modes
    • Product specifications
    • Product billing
      • Overview
      • Instance billing
        • Alibaba Cloud instance billing
        • Huawei Cloud instance billing
        • AWS instance billing
        • Google Cloud instance billing
        • Azure instance billing
      • Backup and restore billing
      • SQL audit billing
      • Migrations billing
      • Database proxy billing
      • Binlog service billing
      • Read-only replica billing
      • AI model billing
    • Supported database versions
  • Get Started
    • Quick start with Flagship Edition
    • Create a Flagship Edition cluster instance
    • Create a tenant
    • Use the database
  • Work with DBaaS Instances
    • Work with flagship edition instances
      • Overview
      • Create an instance
        • Overview
        • Create via OceanBase Cloud official website
        • Create via AWS Marketplace
        • Create via GCP Marketplace
        • Create via Huawei Cloud Marketplace
        • Create via Alibaba Cloud Marketplace
        • Create via Azure Marketplace
      • Connect to an instance
        • Configure network connection
          • Overview
          • Connect using a public IP address
          • Connect using Azure Private Link
          • Connect using Google Cloud Private Service Connect
          • Connect using Huawei Cloud VPC Endpoint
          • Connect using a Huawei Cloud peering connection
          • Connect using AWS PrivateLink
          • Connect using AWS VPC peering
          • Connect using Alibaba Cloud VPC
        • MySQL compatible mode
          • 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 using SpringBoot
              • SpringBatch sample application for connecting to OceanBase Cloud
              • spring-jdbc
              • SpringDataJPA sample application for connecting to OceanBase Cloud
              • Hibernate application development with OceanBase Cloud
              • Sample program for connecting to OceanBase Cloud
              • connector-j
              • Use TestContainers to connect to and use OceanBase Cloud
            • Python
              • Connect to OceanBase Cloud using mysqlclient
              • Connect to OceanBase Cloud using PyMySQL
              • Use the MySQL-connector-python driver to connect to and use OceanBase Cloud
              • Use SQLAlchemy to connect to an OceanBase Cloud database
              • Connect to an OceanBase Cloud database using Django
              • Connect to an OceanBase Cloud database by using peewee
            • C
              • Use MySQL Connector/C to connect to OceanBase Cloud
            • Go
              • Connect to OceanBase Cloud using the Go-SQL-Driver/MySQL driver
              • Connect to OceanBase Cloud using GORM
            • PHP
              • Use the EXT driver to connect to OceanBase Cloud
              • Connect to OceanBase Cloud by using the MySQLi driver
              • Use the PDO driver to connect to OceanBase Cloud
            • Rust
              • Rust application example for connecting to OceanBase Cloud
              • SeaORM example for connecting to OceanBase Cloud
            • Ruby
              • ActiveRecord sample application for OceanBase Cloud
              • Connect to OceanBase Cloud by using mysql2
              • Connect to OceanBase Cloud by using Sequel
          • 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 compatible mode
          • 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 using OceanBase Connector/J
              • Connect to OceanBase Cloud by using Spring Boot
              • SpringBatch application example for connecting to OceanBase Cloud
              • Connect to OceanBase Cloud using Spring JDBC
              • Connect to OceanBase Cloud by using Spring Data JPA
              • Connect to OceanBase Cloud by using Hibernate
              • Use MyBatis to connect to OceanBase Cloud
              • Use JFinal to connect to OceanBase Cloud
            • Python
              • Python Driver for Oracle Mode
            • C/C++
              • Connect to OceanBase Cloud using OceanBase Connector/C
              • Connect to OceanBase Cloud using OceanBase Connector/ODBC
              • Use SqlSugar to connect to OceanBase Cloud
          • Use database connection pool
            • Database connection pool configuration
            • Sample program that uses a Tomcat connection pool to connect to OceanBase Cloud
            • C3P0 connection pool connects to OceanBase Cloud
            • Connect to OceanBase Cloud using Proxool connection pool
            • Sample program that uses HikariCP to connect to OceanBase Cloud
            • Use DBCP connection pool to connect to OceanBase Cloud
            • Connect to OceanBase Cloud by using Commons Pool
            • Connect to OceanBase Cloud by using a Druid connection pool
        • KV compatible mode
          • Connect to a cluster by using the OBKV-HBase client
      • Developer guide
        • MySQL compatible 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 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 compatible 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 aggregate functions in queries
              • Use CASE functions in queries
            • 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
        • KV compatible mode
          • OBKV-Table Java development guide
          • Table data operation examples
            • Insert data with OBKV-Table
            • Query data with OBKV-Table
            • Update data with OBKV-Table
            • Delete data with OBKV-Table
          • Table Java development
            • Connect to an instance by using the OBKV-Table Java client
          • HBase data operation examples
            • OBKV-HBase application development overview
            • OBKV-HBase data operation examples
      • Manage instances
        • Manage instances
          • View the instance list
          • Instance workbench overview
          • Stop and start instances
          • Unit migration
        • Manage tenants
          • Tenant overview
          • Create a tenant
          • Modify tenant specifications
          • Modify tenant names
          • Add an endpoint
          • Resource isolation
            • Overview
            • Manage resource groups
              • Create a resource group
              • View a resource group
              • Edit a resource group
              • Delete a resource group
            • Manage isolation rules
              • Create an isolation rule
              • View isolation rules
              • Edit an isolation rule
              • Delete a quarantine rule
          • Modify primary zone
          • Modify the maximum number of connections for a tenant proxy
          • Enable the AI function built-in AI models
          • Monitor tenant performance
            • Overview
            • View performance and SQL monitoring details
            • View transaction monitoring details
            • View storage and cache monitoring details
            • View Binlog service monitoring
            • Customize a monitoring dashboard for a tenant
          • Diagnostics
            • View performance monitoring data
            • 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 optimization history
              • SQL audit
          • Manage tenant parameters
            • Manage tenant parameters
            • Parameters for tenants
            • Parameter template overview
          • Delete a tenant
          • Manage databases and accounts
            • Create accounts
            • Manage accounts
            • Create a database (MySQL compatible mode)
            • Manage databases (MySQL compatible mode)
        • Monitor instance performance
          • Overview
          • Monitor the performance of databases in an instance
          • Monitor multidimensional metrics of an instance
          • Monitor the performance of hosts in an instance
          • Monitor database proxy
          • Monitor database proxy hosts
          • Monitor cross-cloud network performance
          • Customize a monitoring dashboard for an instance
        • Manage major compactions
          • Initiate a major compaction
          • View compaction records
          • Update time for compactions
        • Manage instance parameters
          • Manage parameters
          • Parameters for cluster instances
        • Change instance configurations
          • Set compute auto-scaling
          • Set storage auto-scaling
          • View history of configuration changes
          • Change configuration
          • Switch the deployment mode
        • Manage standby instances
          • Overview
          • Create a standby instance
          • Create a cross-cloud standby instance
          • Primary-standby instance workspace
          • Configure a primary-standby synchronization strategy
          • Configure global endpoint
          • Enable automatic forwarding of standby write requests
          • Primary-standby instance switchover
          • Initiate failover
          • Detach a standby instance
          • Release a standby instance
        • Release an instance
        • Database proxy
          • Overview
          • Manage database proxy
          • Direct load
        • 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 rule 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 notification templates
            • Create an alert notification template
            • View an alert notification template
            • Edit an alert notification template
            • Copy an alert notification template
            • Delete an alert notification template
          • 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
          • Backup strategy
          • Initiate a backup immediately
          • Data backup
          • Initiate a restore
          • Data restore
          • Restore data from the instance recycle bin
        • 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
              • SQL monitoring metrics list
            • Session management
              • Session management
            • Request analysis
              • Request analysis
          • Root cause diagnostics
            • Exception handling
            • Enable system autonomy
          • SQL audit
          • Materialized view analysis
          • Optimization center
            • Optimization suggestions
            • Manage active outlines
            • SQL review
            • View the optimization history
        • Manage read-only replicas
          • Overview
          • Instance read-only replicas
            • Add a read-only replica to an instance
            • View read-only replicas of an instance
            • Manage read-only replicas of an instance
            • Delete a read-only replica of an instance
          • Tenant read-only replicas
            • Add a read-only replica to a tenant
            • View read-only replicas of a tenant
            • Manage read-only replicas of a tenant
            • Delete a read-only replica of a tenant
        • Manage tags
        • Manage JVM-dependent services
      • Data source management
        • Overview of data source management
        • Manage data sources
        • User privileges
          • User privileges for compatibility assessment
          • User privileges for data migration
          • User privileges for performance assessment
          • User privileges for data archiving
          • User privileges for data cleanup
        • Connect via private network
          • AWS
          • Huawei Cloud
          • Alibaba Cloud
          • Azure
          • Private IP address segments
        • Connect via public network
          • AWS
          • Huawei Cloud
          • Alibaba Cloud
          • Azure
      • Data lifecycle management
        • Archive data
        • Clean up data
      • Manage recycle bin
        • Instance recycle bin
        • Manage databases and tables in recycle bin
          • Overview
          • Instance-level recycle bin
          • Tenant-level recycle bin
    • Work with transactional instances
      • Overview
      • Create an instance
        • Overview
        • Create via OceanBase Cloud official website
        • Create via AWS Marketplace
        • Create via GCP Marketplace
        • Create via Huawei Cloud Marketplace
        • Create via Alibaba Cloud Marketplace
        • Create via Azure Marketplace
      • Connect to an instance
        • MySQL compatible mode
          • Overview
          • Get connection string
            • Overview
            • Connect to a database by using AWS PrivateLink
            • Access the database by using an Azure private network connection
            • Connect using AWS VPC peering
            • Connect using Google Cloud Private Service Connect
            • Connect using Huawei Cloud VPC Endpoint
            • Connect using Alibaba Cloud VPC
            • Connect using a public IP address
            • Connect using a Huawei Cloud peering connection
          • 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 using SpringBoot
              • SpringBatch sample application for connecting to OceanBase Cloud
              • spring-jdbc
              • SpringDataJPA sample application for connecting to OceanBase Cloud
              • Hibernate application development with OceanBase Cloud
              • Sample program for connecting to OceanBase Cloud
              • connector-j
              • Use TestContainers to connect to and use OceanBase Cloud
            • Python
              • Connect to OceanBase Cloud using mysqlclient
              • Connect to OceanBase Cloud using PyMySQL
              • Use the MySQL-connector-python driver to connect to and use OceanBase Cloud
              • Use SQLAlchemy to connect to an OceanBase Cloud database
              • Connect to an OceanBase Cloud database using Django
              • Connect to an OceanBase Cloud database by using peewee
            • C
              • Use MySQL Connector/C to connect to OceanBase Cloud
            • Go
              • Connect to OceanBase Cloud using the Go-SQL-Driver/MySQL driver
              • Connect to OceanBase Cloud using GORM
            • PHP
              • Use the EXT driver to connect to OceanBase Cloud
              • Connect to OceanBase Cloud by using the MySQLi driver
              • Use the PDO driver to connect to OceanBase Cloud
            • Rust
              • Rust application example for connecting to OceanBase Cloud
              • SeaORM example for connecting to OceanBase Cloud
            • ruby
              • ActiveRecord sample application for OceanBase Cloud
              • Connect to OceanBase Cloud by using mysql2
              • Connect to OceanBase Cloud by using Sequel
          • 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 compatible mode
          • Overview
          • Get connection string
            • Overview
            • Connect to a database by using AWS PrivateLink
            • Access a database by using an Azure private network connection
            • Connect using AWS VPC peering
            • 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 using OceanBase Connector/J
              • Connect to OceanBase Cloud by using Spring Boot
              • SpringBatch application example for connecting to OceanBase Cloud
              • Connect to OceanBase Cloud using Spring JDBC
              • Connect to OceanBase Cloud by using Spring Data JPA
              • Connect to OceanBase Cloud by using Hibernate
              • Use MyBatis to connect to OceanBase Cloud
              • Use JFinal to connect to OceanBase Cloud
            • Python
              • Python Driver for Oracle Mode
            • C
              • Connect to OceanBase Cloud using OceanBase Connector/C
              • Connect to OceanBase Cloud using OceanBase Connector/ODBC
              • Use SqlSugar to connect to OceanBase Cloud
          • Use database connection pool
            • Database connection pool configuration
            • Sample program that uses a Tomcat connection pool to connect to OceanBase Cloud
            • C3P0 connection pool connects to OceanBase Cloud
            • Connect to OceanBase Cloud using Proxool connection pool
            • Sample program that uses HikariCP to connect to OceanBase Cloud
            • Use DBCP connection pool to connect to OceanBase Cloud
            • Connect to OceanBase Cloud by using Commons Pool
            • Connect to OceanBase Cloud by using a Druid connection pool
      • Developer guide
        • MySQL compatible 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 compatible 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 overview
          • Stop and restart instances
          • Unit migration
        • Manage tenants
          • Tenant overview
          • Create a tenant
          • Modify tenant specifications
          • Modify tenant names
          • Add an endpoint
          • Resource isolation
            • Overview
            • Manage resource groups
              • Create a resource group
              • View a resource group
              • Edit a resource group
              • Delete a resource group
            • Manage isolation rules
              • Create an isolation rule
              • View isolation rules
              • Edit an isolation rule
              • Delete a quarantine rule
          • Modify primary zone
          • Modify the maximum number of connections for a tenant proxy
          • Enable the AI function built-in AI models
          • Monitor tenant performance
            • Overview
            • View performance and SQL monitoring details
            • View transaction monitoring details
            • View storage and cache monitoring details
            • View Binlog service monitoring
            • Customize a monitoring dashboard for a tenant
          • Diagnostics
            • Real-time diagnostics
              • SQL diagnostics
                • Top SQL
                • Slow SQL
                • Suspicious SQL
                • High-risk SQL
              • SQL audit
          • Manage tenant parameters
            • Manage tenant parameters
            • Parameters for tenants
            • Parameter template overview
          • Delete a tenant
          • Manage databases and accounts
            • Create accounts
            • Manage accounts
            • Create a database (MySQL compatible mode)
            • Manage databases (MySQL compatible mode)
        • Monitor instance performance
          • Overview
          • Monitor the performance of databases in an instance
          • Monitor multidimensional metrics of an instance
          • Monitor the performance of hosts in an instance
          • Monitor database proxy
          • Monitor database proxy hosts
          • Monitor cross-cloud network performance
          • Customize a monitoring dashboard for an instance
        • Manage major compactions
          • Initiate a major compaction
          • View compaction records
          • Update time for compactions
        • Manage instance parameters
          • Manage parameters
          • Parameters for cluster instances
        • Change instance configurations
          • Set storage auto-scaling
          • View history of configuration changes
          • Change configuration
          • Switch the deployment mode
        • Manage standby instances
          • Overview
          • Create a standby instance
          • Create a cross-cloud standby instance
          • View details of primary and standby instances
          • Configure global endpoint
          • Enable automatic forwarding for write requests of standby databases
          • Primary-standby instance switchover
          • Initiate failover
          • Detach a standby instance
          • Release a standby instance
        • Release an instance
        • Database proxy
          • Overview
          • Manage database proxy
          • Direct load
        • 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 a trigger condition template
            • View an alert template
            • Edit an alert template
            • Copy an alert rule 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 notification templates
            • Create an alert notification template
            • View an alert notification template
            • Edit an alert notification template
            • Copy an alert notification template
            • Delete an alert notification template
          • 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
          • Backup strategy
          • Initiate a backup immediately
          • Data backup
          • Initiate a restore
          • Data restore
          • Restore data from the instance recycle bin
        • 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
              • SQL monitoring metrics list
            • Session management
              • Session management
            • Request analysis
              • Request analysis
          • Root cause diagnostics
            • Exception handling
            • Enable system autonomy
          • SQL audit
          • Materialized view analysis
          • Optimization center
            • Optimization suggestions
            • Manage active outlines
            • SQL review
            • View the optimization history
        • Manage read-only replicas
          • Overview
          • Instance read-only replicas
            • Add a read-only replica to an instance
            • View read-only replicas of an instance
            • Manage read-only replicas of an instance
            • Delete a read-only replica of an instance
          • Tenant read-only replicas
            • Add a read-only replica to a tenant
            • View read-only replicas of a tenant
            • Manage read-only replicas of a tenant
            • Delete a read-only replica of a tenant
        • Manage tags
        • Manage JVM-dependent services
      • Data source management
        • Connect via private network
          • Google Cloud
        • Connect via public network
          • Google Cloud
      • Overview of data source management
      • Data lifecycle management
        • Overview
        • Archive data
        • Clean up data
        • Data archiving configurations
      • Manage recycle Bin
        • Instance recycle bin
        • Manage databases and tables in recycle bin
          • Overview
          • Instance-level recycle bin
          • Tenant-level recycle bin
    • Work with analytical instances
      • Overview
      • Core features
      • Connect to an instance
        • Overview
        • Get connection string
          • Overview
          • Connect using AWS PrivateLink
          • 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
      • Create an instance
      • Data table design
        • Table overview
        • Best practices
          • Unit 1: Best practices for optimizing storage structures and query performance
          • Unit 2: Best practices for creating special indexes
      • Export data
      • OceanBase data processing
      • Query acceleration
        • Statistics
        • Materialized views for query acceleration
        • Select a query parallelism level
      • Manage instances
        • Instance overview
        • Change configuration
        • Set storage auto-scaling
        • Modify primary zone
        • Manage parameters
        • Backup and restore
          • Backup overview
          • Backup strategies
          • Immediate backup
          • Data Backup
          • Initiate restore
          • Data restore
        • Monitor instance performance
          • Overview
          • Monitor the performance of databases in an instance
          • Monitor the performance of hosts in an instance
        • Manage major compactions
          • Initiate a major compaction
          • View compaction records
          • Update time for compactions
        • Database proxy
          • Overview
          • Manage database proxy
          • Direct load
        • 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 a trigger condition 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 notification templates
            • Create an alert notification template
            • View an alert notification template
            • Edit an alert notification template
            • Copy an alert notification template
            • Delete an alert notification template
          • 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
              • Slow SQL
              • Suspicious SQL
              • High-risk SQL
              • SQL details
              • SQL monitoring metrics list
            • Session management
              • Session management
            • Optimization management
              • Manage active outlines
              • View the optimization history
            • Request analysis
              • Request analysis
        • Stop and restart instances
        • Release instances
        • Manage databases and accounts
          • Create and manage accounts
          • Create a database
          • Manage databases
        • Manage tags
      • Overview of data source management
      • Data lifecycle management
        • Archive data
        • Clean up data
      • Performance diagnosis and tuning
        • Use the DBMS_XPLAN package for performance diagnostics
        • Use the GV$SQL_PLAN_MONITOR view for performance analysis
        • Views related to AP performance analysis
      • Performance testing
      • Product integration
      • Manage recycle Bin
        • View instance recycle bin
        • Manage databases and tables in recycle bin
          • Overview
          • Instance recycle bin
    • Work with Key-Value instances
      • Try out Key-Value instances
        • Create an instance
        • Create a tenant
        • Create an account for a database user
        • OBKV HBase data operation examples
      • Use Table model
        • Create an instance
        • Manage instances
          • Manage instances
            • View the instance list
            • Instance overview
            • Stop and restart instances
            • Release an instance
          • Manage tenants
            • Create a tenant
            • Modify tenant specifications
            • Modify tenant names
            • Delete a tenant
            • Tenant overview
            • Resource isolation
              • Overview
              • Manage resource groups
                • Create a resource group
                • View a resource group
                • Edit a resource group
                • Delete a resource group
              • Manage isolation rules
                • Create an isolation rule
                • View isolation rules
                • Edit an isolation rule
                • Delete a quarantine rule
            • Monitor tenant performance
              • Overview
              • View performance and SQL monitoring details
              • View transaction monitoring details
              • View storage and cache monitoring details
              • OBKV-Table
              • Customize a monitoring dashboard for a tenant
            • Diagnostics
              • Top SQL
            • Manage tenant parameters
              • Manage tenant parameters
              • Parameters for tenants
            • Manage databases and accounts
              • Create and manage accounts
              • Create a database
              • Manage databases
            • Modify primary zone
          • Monitor instance performance
            • Overview
            • Monitor the performance of databases in an instance
            • Monitor multi-dimensional metrics of 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
            • Set storage auto-scaling
            • View history of configuration changes
            • Change configuration
            • Switch the deployment mode
          • 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
              • Trigger condition template management
              • 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
            • Top SQL
            • Capacity diagnostics
            • Request analysis
          • Manage recycle Bin
            • View instance recycle bin
            • Manage databases and tables in recycle bin
              • Overview
              • Instance-level recycle bin
              • Tenant-level recycle bin
          • Manage tags
      • Use HBase model
        • OBKV-HBase Overview
        • Create an instance
        • Develop in HBase model
          • Connect to an instance by using the OBKV-HBase client
        • Manage instances
          • Manage instances
            • View the instance list
            • Instance overview
            • Stop and restart instances
            • Release an instance
          • Manage tenants
            • Create a tenant
            • Modify tenant specifications
            • Modify tenant names
            • Delete a tenant
            • Tenant overview
            • Resource isolation
              • Overview
              • Manage resource groups
                • Create a resource group
                • View a resource group
                • Edit a resource group
                • Delete a resource group
              • Manage isolation rules
                • Create an isolation rule
                • View isolation rules
                • Edit an isolation rule
                • Delete a quarantine rule
            • Monitor tenant performance
              • Overview
              • View performance and SQL monitoring details
              • View transaction monitoring details
              • View storage and cache monitoring details
              • OBKV-HBase
              • Customize a monitoring dashboard for a tenant
            • Diagnostics
              • Top SQL
            • Manage tenant parameters
              • Manage tenant parameters
              • Parameters for tenants
            • Manage databases and accounts
              • Create and manage accounts
              • Create a database
              • Manage databases
            • Modify primary zone
          • Monitor instance performance
            • Overview
            • Monitor the performance of databases in an instance
            • Monitor multi-dimensional metrics of 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
            • Set storage auto-scaling
            • View history of configuration changes
            • Change configuration
            • Switch the deployment mode
          • 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
              • Trigger condition template management
              • 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
            • Top SQL
            • Capacity diagnostics
            • Request analysis
          • Manage recycle Bin
            • View instance recycle bin
            • Manage databases and tables in recycle bin
              • Overview
              • Instance-level recycle bin
              • Tenant-level recycle bin
          • Manage tags
        • Overview of data source management
        • Performance test
      • Connect Key-Value instances
        • Overview
        • Connect using Huawei Cloud VPC Endpoint
        • Connect using a public IP address
  • AI Features
    • AI services
      • Overview of AI service
      • Quick start
      • Manage AI API keys
      • Use AI models
      • Use Claude Code with OceanBase MaaS
      • Use Codex CLI and Codex App with OceanBase MaaS
      • Use the memory feature
      • AI APIs
        • Access guide
        • AI service APIs
          • AI API list
          • Anthropic compatible APIs
            • List Anthropic models
            • Create a message
            • Create a message (default base URL)
          • OpenAI compatible APIs
            • List models
            • Create chat completion
            • Create embedding
            • Rerank
            • Reranks
            • Create response
          • Vertex AI compatible APIs
            • Generate content
            • Stream generate content
          • Image and video generation APIs
            • Create an image generation task
            • Create a video generation task
            • Retrieve task status
          • Image model APIs
            • gpt-image-2 text-to-image
            • gpt-image-2 image editing
            • gemini-3-pro-image text-to-image
            • gemini-3-pro-image image-to-image / image editing
          • OpenAI compatible batches and files APIs
            • Upload file
            • List files
            • Retrieve file
            • Delete file
            • Get file content
            • Get file content (POST)
            • Create batch
            • List batches
            • openai-compatible-apis
            • Retrieve batch (POST)
            • Cancel batch
          • Memory APIs
            • listSpaces - Paginated list of memory spaces
            • createSpace - Create a memory space
            • getSpace - Get details of a specified memory space
            • updateSpace - Update the name and description of a space
            • deleteSpace - Delete a space
            • extractMemories - Extract memories from dialogue messages
            • listMemories - List memories in a space
            • addMemory - Add a memory directly
            • getMemory - Retrieve a single memory
            • updateMemory - Update a single memory
            • deleteMemory - Delete a single memory
            • distillMemory - Distill experiences from conversations
            • searchExperiences - Search for experiences
            • getExperience - Retrieve a single experience
            • deleteExperience - Delete a single experience
            • feedbackExperiences - Submit feedback on experiences
            • setExperienceObsolescence - Set the obsolete status of an experience
            • combinedSearch - Combined search for memories and experiences
      • Built-in models
    • OceanBase OAgent
      • What is OceanBase OAgent?
      • Quick start with OceanBase OAgent
      • Configure a channel
      • Set skills
      • View OceanBase OAgent token usage
  • Migrations
    • Data migration and import solutions
    • Data assessment and migration quick start
    • 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
    • Data source management
      • Create a data source
      • Manage data sources
      • User privileges
        • User privileges for compatibility assessment
        • User privileges for data migration
        • User privileges for performance assessment
        • User privileges for data archiving
        • User privileges for data cleanup
      • Connect via private network
        • AWS
        • Huawei Cloud
        • Alibaba Cloud
        • Azure
        • Private IP address range
      • Connect via public network
        • AWS
        • Huawei Cloud
        • Alibaba Cloud
        • Azure
      • Connect via VPC peering
        • Configure an AWS data service peering connection
        • Configure a Huawei Cloud data service peering connection
        • Configure an Alibaba Cloud data service peering connection
        • Configure a Google Cloud data service peering connection
    • Migrate data
      • Overview
      • Migrations specification
      • Purchase a data migration instance
      • Migrate data from a MySQL database to the MySQL-compatible mode of OceanBase Database
      • Migrate data from OceanBase Database in MySQL-compatible mode to a MySQL database
      • Data migration between tenants of OceanBase Database in the same compatibility mode
      • Migrate data between OceanBase database tenants of different compatibility modes
      • Migrate data from an Oracle database to an Oracle-compatible tenant of OceanBase Database
      • Migrate data from an Oracle-compatible tenant of OceanBase Database to an Oracle database
      • Configure a two-way synchronization task
      • Migrate data from OceanBase Database to Kafka
      • Migrate data from a TiDB database to the MySQL-compatible mode of OceanBase Database
      • Migrate incremental data from OceanBase Database in MySQL-compatible mode to TiDB Database
      • Migrate data from a PostgreSQL database to OceanBase Database
      • Migrate incremental data from OceanBase Database to PostgreSQL Database
      • Migrate data from a Lindorm/HBase database to the HBase API compatible mode of OceanBase Database
      • Migrate incremental data from OceanBase Database in HBase API compatibility mode to a Lindorm/HBase database
      • Migrate data from OceanBase Database to RocketMQ
      • Migrate data from OceanBase Database to DataHub
      • Migrate data from OceanBase Database in MySQL mode to ADB
      • Migrate data from PolarDB-X 2.0 to OceanBase Database in MySQL mode
      • 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
        • Configure alert monitoring
        • Manage data migration tasks by using tags
        • Intelligent diagnosis
        • Start, stop, and resume a data migration task
        • Clone a data migration task
        • Terminate and 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 and modify matching rules
        • Wildcard rules
        • Import migration objects
        • Download conflict data
        • Change a topic
        • Column filtering
        • Data formats
        • Partition settings
      • Authorize an Alibaba Cloud account
      • SQL statements for querying table objects
      • Online DDL tools
      • Create a trigger
      • Modify the log level of a self-managed PostgreSQL instance
      • Supported DDL statements for synchronization and their limitations
        • DDL synchronization from Aurora MySQL DB clusters to MySQL-compatible tenants of OceanBase Database
        • DDL synchronization from MySQL-compatible tenants of OceanBase Database to Aurora MySQL DB clusters
        • DDL synchronization between MySQL-compatible tenants of OceanBase Database
        • DDL synchronization from Oracle databases to Oracle-compatible tenants of OceanBase Database
        • DDL synchronization from Oracle-compatible tenants of OceanBase Database to Oracle databases
        • DDL synchronization between Oracle-compatible tenants of OceanBase Database
        • DDL synchronization from OceanBase databases to Kafka instances
    • Data subscription
      • Create a data subscription task
      • Manage data subscription tasks
        • View details of a data subscription task
        • Configure subscription information
        • Modify the name of a data subscription task
        • View and modify subscription objects
        • View data subscription parameters
        • Set up data subscription alerts
        • Start, stop, and resume data subscription tasks
        • Clone a data subscription task
        • Release a data subscription task
      • Manage private connections for data subscriptions
      • Configure consumer subscription
      • Message formats
    • Data validation
      • Overview
      • Create a data validation task
      • Manage data validation tasks
        • View details of a data validation task
        • View and modify validation objects
        • View and modify validation parameters
        • Manage data validation tasks with tags
        • Start, pause, and resume data validation tasks
        • Clone a data validation task
        • Release a data validation task
      • Features
        • Import validation objects
        • Rename the validation object
        • Filter objects by using SQL conditions
        • Configure the matching rules for the validation object
    • Assess performance
      • Overview
      • Obtain traffic files from a database instance
      • 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
      • Obtain a database instance
      • Create an access key
    • Import data
      • Import data
      • Direct load
      • Supported file formats and encoding formats for Data Import
      • Sample data introduction
    • Binlog service
      • Overview
      • Purchase the Binlog service
      • Manage Binlog service
        • View details of the Binlog service
        • Change configuration
        • Modify the auto-scaling strategy for storage space
        • Modify the elasticity strategy for compute units
        • Disable the Binlog service
    • Upgrade assistant
  • Security
    • OceanBase Cloud account settings
      • Manage personal account information
      • Multi-factor authentication
      • Organization authentication
        • Enable organization authentication
        • Configure IdP
      • Manage AccessKeys
      • Time zone settings
      • Manage cloud marketplace accounts
      • Account audit
    • Organizations and projects
      • Overview
      • Manage organization information
      • Project management
        • Manage projects
        • Cross-project bidirectional authorization
        • AI settings
        • Manage object storage configurations
        • Subscribe to project messages
      • Manage members
      • Permissions for roles
      • Cost management
        • Overview
        • Cost details
        • Manage cost units
      • Operation audit
    • Database accounts and privileges
      • Account privileges
      • Authorize cloud vendor accounts
      • AWS KMS key management
      • Support access control
    • Security and encryption
      • Set allowlist groups
      • SSL encryption
      • Transparent Data Encryption (TDE)
    • Monitoring dashboard
    • Events
    • Support plans
      • Overview of OceanBase Cloud support plans
      • Subscribe to and manage support plans
  • 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 program package
      • Create a trigger
      • Create a type
      • Create a sequence
      • Create a synonym
    • Session variable management
    • Functional keys in SQL Console
    • Intelligent SQL development
  • Integrations
    • Overview
    • Schema evolution
      • Liquibase
      • Flyway
    • Data ingestion
      • Canal
      • dbt
      • Debezium
      • Flink
      • Glue
      • Informatica Cloud
      • Kafka
      • Maxwell
      • SeaTunnel
      • DataWorks
      • NiFi
    • SQL development
      • DataGrip
      • DBeaver
      • Navicat
      • TablePlus
    • Orchestration
      • DolphinScheduler
      • Linkis
      • Airflow
    • Visualization
      • Grafana
      • Power BI
      • Quick BI
      • Superset
      • Tableau
    • Observability
      • Datadog
      • Prometheus
    • Database management
      • Bytebase
    • AI
      • LlamaIndex
      • Dify
      • LangChain
      • Tongyi Qianwen
      • OpenAI
      • n8n
      • Trae
      • SpringAI
      • Cline
      • Cursor
      • Continue
      • Toolbox
      • CamelAI
      • Firecrawl
      • Hugging Face
      • Ollama
      • Google Gemini
      • Cloudflare Workers AI
      • Qoder
      • OpenCode
      • Claude Code
      • GitHub Copilot
      • Codex
      • Jina AI
      • Augment Code
      • Claude Code
      • Kiro
    • Development tools
      • Cloudflare Workers
      • Vercel
  • Best practices
    • Best practices for achieving high availability through cross-cloud active-active deployment
    • High availability through cross-cloud primary-standby databases (1:1)
    • High availability through cross-cloud primary-standby databases (1:n)
    • High host CPU usage
    • Best practices for read/write splitting in OceanBase Cloud
    • Best practices for migrating data from AWS RDS to OceanBase Cloud
  • References
    • System architecture
    • System management
    • Database object management
    • Database design and specification constraints
    • SQL reference
    • System views
    • Parameters and system variables
    • Error codes
    • Performance tuning
    • Open API References
      • Overview of Open APIs
      • Service endpoints
      • Using API
      • Open APIs
        • Cluster management
          • DescribeInstances
          • DescribeInstance
          • CreateInstance
          • DeleteInstance
          • ModifyInstanceName
          • describe-node-options
          • StopCluster
          • StartCluster
          • ModifyInstanceSpec
          • DescribeInstanceTopology
          • DescribeReadonlyInstances
          • CreateReadonlyInstance
          • ModifyReadonlyInstanceSpec
          • ModifyReadonlyInstanceDiskSize
          • ModifyReadonlyInstanceNodeNum
          • DeleteReadonlyInstance
          • DescribeInstanceAvailableRoZones
          • DescribeInstanceParameters
          • UpdateInstanceParameters
          • DescribeInstanceParametersHistory
          • ModifyInstanceTagList
          • ModifyInstanceNodeNum
          • DescribeInstanceAnomalyEvents
          • DescribeOasClusterAnomalySqlList
          • DescribeOasClusterSlowSQLList
          • DescribeInstanceSqlAuditServiceInfo - Query SQL Audit Service Information
          • DescribeProxyClusterForInstance - Query ODP clusters associated with an instance
          • SwitchoverInstance - Perform a primary/standby switchover
        • Tenant management
          • DescribeTenants
          • DescribeTenant - Query Information of a Specified Tenant in a Specified Cluster
          • CreateTenants
          • DeleteTenants
          • ModifyTenantName
          • ModifyTenant
          • ModifyTenantUserDescription
          • ModifyTenantUserStatus
          • GetTenantCreateConstraints
          • ModifyTenantPrimaryZone
          • GetTenantCreateCpuConstraints
          • GetTenantCreateMemConstraints
          • GetTenantModifyCpuConstraints
          • GetTenantModifyMemConstraints
          • CreateTenantSecurityIpGroup
          • DescribeTenantSecurityIpGroups
          • ModifyTenantSecurityIpGroup
          • DeleteTenantSecurityIpGroup
          • DescribeTenantPrivateLink
          • DeletePrivatelinkConnection
          • CreatePrivatelinkService
          • ConnectPrivatelinkService
          • AddPrivatelinkServiceUser
          • BatchKillProcessList
          • DescribeProcessStatsComposition
          • DescribeTenantAddressInfo - Query Tenant Address Information
          • DescribeTenantAvailableRoZones
          • ModifyTenantReadonlyReplica
          • DescribeTenantParameters
          • UpdateTenantParameters
          • DescribeTenantParametersHistory
          • ModifyTenantTagList
          • CreateReadonlyPrivatelink
          • CreateReadwritePrivatelink
          • DescribeTenantPublicAddress - Query Tenant Public IP Address
          • DescribeTenantSqlAuditServiceInfo - Query SQL Audit Service Information for a Tenant
        • Tenant user management
          • CreateTenantUser
          • DescribeTenantUsers
          • DeleteTenantUsers
          • ModifyTenantUserPassword
          • ModifyTenantUserRoles
        • Database management
          • CreateDatabase
          • DescribeDatabases
          • DeleteDatabases
          • ModifyDatabaseUserRoles
          • DescribeTableSchema
        • Backup and restore
          • DescribeDataBackupSet
          • DescribeRestorableTenants
          • ModifyBackupStrategy
          • CreateTenantRestoreTask
          • CreateDataBackupTask
          • DescribeOneDataBackupSet
          • CreateBackupSetDownloadLink - Create a backup set download link
          • DeleteBackupSetDownloadTask - Delete a backup set download task
          • DescribeBackupSetDownloadLink - Query a backup set download link
          • DescribeBackupStrategy - Query backup strategy
        • Database proxy management
          • CreateTenantAddress
          • CreateTenantSingleTunnelSLBAddress
          • DeleteTenantAddress
          • DescribeTenantAddress
          • ModifyOdpClusterSpec
          • ModifyTenantAddressPort
          • ModifyTenantAddressDomainPrefix
          • ConfirmPrivatelinkConnection
          • DescribeTenantAddressInfo
        • Data source management
          • ListDataSources - List data sources
          • CreateDataSource - Create a data source
          • DeleteDataSource - Delete a data source
        • OMS project management
          • DescribeProject - Query project details
          • CreateProject - Create a project
          • DeleteProject - Delete a project
          • DescribeProjectSteps - Query project steps
          • StartProject - Start a project
          • StopProject - Stop a project
          • ResumeProject - Resume a project
          • ReleaseProject - Release project resources
          • UpdateProjectConfig - Update project configuration
          • ListProjectModifyRecords - List project modification records
          • CreateProjectModifyRecords - Create modification records (add or remove tables)
          • CancelProjectModifyRecord - Cancel a modification record
          • RetryProjectModifyRecords - Retry a modification
          • StopProjectModifyRecords - Terminate a modification
          • GetModifyRecord - Query modification record details
          • DescribeTransferMapping - Query transfer object mappings
        • Monitoring management
          • DescribeTenantMetrics
          • DescribeMetricsData
          • CreatePrometheusIntegration - Create a Prometheus Monitoring Integration
          • DeletePrometheusIntegration - Delete Prometheus Monitoring Integration
          • ListPrometheusIntegration - Query Prometheus Monitoring Integration List
          • DescribeNodeMetrics
        • Diagnostic management
          • DescribeOasTopSQLList
          • DescribeOasAnomalySQLList
          • DescribeOasSlowSQLList
          • DescribeOasSQLText
          • DescribeSqlAudits
          • DescribeOutlineBinding
          • DescribeSampleSqlRawTexts
          • DescribeSQLTuningAdvices
          • DescribeOasSlowSQLSamples
          • DescribeOasSQLTrends
          • DescribeOasSQLPlanGroup
          • DescribeRcaRecord
          • DescribeTopSQLComparision
          • DescribeSessionStatsGroupBySqlId
          • DescribeIndexes
          • DescribeOasHighRiskSQL
        • Security management
          • CreateSecurityIpGroup
          • DescribeInstanceSSL
          • ModifyInstanceSSL
          • DescribeTenantEncryption
          • ModifyTenantEncryption
          • ModifySecurityIps
          • DeleteSecurityIpGroup
          • DescribeTenantSecurityConfigs
          • DescribeInstanceSecurityConfigs
        • Tag management
          • DescribeTags
          • CreateTags
          • UpdateTag
          • DeleteTag
        • Historical event management
          • DescribeOperationEvents
        • AI service management
          • CreateAIServiceAPIKey
          • DeleteAIServiceAPIKey
          • ListAIServiceAPIKeys
      • Open API FAQ
      • Differences between ApsaraDB for OceanBase APIs and OceanBase Cloud APIs
    • Download OBClient
      • Download OBClient
      • Download OceanBase Connector/J
      • Download client ODC
      • Download OceanBase Connector/ODBC
      • Download OBClient Libs
    • Performance Tests
      • OLTP performance test: Sysbench benchmark
      • OLAP performance test: TPC-H benchmark
      • OLTP performance test: TPC-C benchmark
    • Metrics References
      • Cluster database
      • Cluster hosts
      • Binlog service
      • Cross-cloud network channel connection
      • Performance and SQL
      • Transactions
      • Storage and caching
      • Proxy database
      • Proxy host
    • ODC User Guide
      • What is ODC?
        • What is ODC?
        • Limitations
      • Quick start
        • Client ODC
          • Overview
          • Install Client ODC
          • Use Client ODC
        • Web ODC
          • Overview
          • Use Web ODC
      • Data source management
        • Create a data source
        • Data sources and project collaboration
        • Database O&M
          • Session management
          • Global variable management
          • Recycle bin management
      • SQL development
        • Edit and execute SQL statements
        • Perform PL compilation and debugging
        • Edit and export the result set of an SQL statement
        • Execution analysis
        • Generate test data
        • System settings
        • Database objects
          • Table objects
            • Overview
            • Create a table
          • View objects
            • Overview
            • Create a view
            • Manage views
          • Materialized view objects
            • Overview
            • Create a materialized view
            • Manage materialized views
          • Function objects
            • Overview
            • Create a function
            • Manage functions
          • Stored procedure objects
            • Overview
            • Create a stored procedure
            • Manage stored procedures
          • Sequence objects
            • Overview
            • Create a sequence
            • Manage sequences
          • Package objects
            • Overview
            • Create a program package
            • Manage program packages
          • Trigger objects
            • Overview
            • Create a trigger
            • Manage triggers
          • Type objects
            • Overview
            • Create a type
            • Manage types
          • Synonym objects
            • Overview
            • Create a synonym
            • Manage synonyms
      • Import and export
        • Import schemas and data
        • Export schemas and data
      • Database change management
        • User permission management
          • Users and roles
          • Automatic authorization
          • User permission management
        • Project collaboration management
        • Risk levels, risk identification rules, and approval processes
        • SQL check specifications
        • SQL window specification
        • Database change management
        • Batch database change management
        • Online schema changes
        • Synchronize shadow tables
        • Schema comparison
      • Data lifecycle management
        • Partitioning plan management
          • Manage partitioning plans
          • Set partitioning strategies
          • Examples
        • SQL plan task
      • Data desensitization and auditing
        • Desensitize data
        • Operation records
      • Notification management
        • Overview
        • View notification records
        • Manage notification channel
          • Create a notification channel
          • View, edit, and delete a notification channel
          • Configure a custom channel
        • Manage notification rules
      • Best practices
        • Tips for SQL development
        • Explore ODC team workspaces
        • Understanding real-time SQL diagnostics for OceanBase AP
        • OceanBase historical database solutions
        • ODC SQL check for automatic identification of high-risk operations
        • Manage and modify sharded databases and tables via ODC
        • Data masking and control practices
        • Enterprise-level control and collaboration: Safeguard every database change
    • Data development
      • Overview
      • Workspace management
      • Worksheet management
      • Compute node pool management
      • Workflow management
      • Dashboard management
      • Manage Git repositories
      • 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
        • Git integration
      • Sample datasets
      • Data development terms
  • Manage Billing
    • Access billing
    • View bills
      • View orders
    • View monthly bills
    • View payment details
    • Manage AI service billing
      • Usage monitoring
      • View API key records
      • Rate limits & quotas
    • Payment method
      • Use vouchers for payment
    • View invoices
  • Legal Agreements
    • OceanBase Cloud Services Agreement
    • AI Service Addendum
    • Service Level Agreement
    • OceanBase Data Processing Addendum
    • Service Level Agreement for OceanBase Cloud Migration Service
    • Historical agreements
      • Service Level Agreement for OceanBase Cloud Migration Service (Released March 20, 2026)

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Cloud

Create a data source

Last Updated:2026-09-22 07:23:31

Background information
OceanBase data sources (MySQL and Oracle compatibility modes)
OceanBase HBase API compatible mode
MySQL data source
Oracle data source
Kafka data source
PostgreSQL data source
TiDB data source
HBase data source
Lindorm data source
RocketMQ data source
DataHub data source
ADB data sources
PolarDB-X 2.0 data sources

This topic describes how to create a data source in OceanBase Cloud.

Background information

A data source is a collection of database connection information, including the connection address, port, username, and password. In OceanBase Cloud, by configuring a data source, you can quickly establish connections to databases for tasks such as data migration and job scheduling, improving operational efficiency and reliability.

OceanBase Cloud supports data sources deployed on Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud. Supported database types include OceanBase Database, MySQL, Oracle, Kafka, PostgreSQL, TiDB, HBase, Lindorm, RocketMQ, DataHub, AnalyticDB for MySQL (ADB), and PolarDB-X 2.0. Supported cloud providers and instance types vary by database type. See the following sections for details.

The connection method for a data source varies depending on the database type. Please select the appropriate connection method based on your database type.

OceanBase data sources (MySQL and Oracle compatibility modes)

For OceanBase Database, OceanBase Cloud provides four connection methods.

  • Quick connection to an OceanBase Cloud instance: This method is suitable for OceanBase Database instances created through the OceanBase Cloud console.

  • Endpoint connection, public network connection, or peering connection: Endpoint and public network connections apply to OceanBase Database deployed on Alibaba Cloud, AWS, Huawei Cloud, Azure, or Google Cloud. Peering connections apply to self-managed OceanBase Database deployed on Alibaba Cloud, AWS, or Google Cloud.

Connect to an OceanBase Cloud instance
Endpoint connection
Public network connection
Peering connection

Prerequisites

  • You have created an instance and a tenant in the OceanBase Cloud console (either MySQL-compatible or Oracle-compatible mode is acceptable), and have an available database and account.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left navigation bar, click Data Services > Data Source.

  3. On the Data Source page, depending on your actual situation, click Create Data Source in the upper-right corner > OceanBase MySQL Compatible or OceanBase Oracle Compatible.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select OB Cloud Instance.
    Instance Type Includes Cluster Instance (Transactional), Cluster Instance (Flagship), Tenant Instance, and Cluster Instance (Analytical). This option is only displayed when Connection Method is set to OceanBase Cloud Instance.

    Note

    Data migration only supports Flagship Edition instances and Cluster Instances (Analytical).

    Instance Select the target instance from the drop-down list. This option is only displayed when Connection Method is set to OB Cloud Instance.
    Database Account The username of the OceanBase database.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created an endpoint service on Alibaba Cloud, AWS, Azure, or Google Cloud and have permission to modify its allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, depending on your actual situation, click Create Data Source in the upper-right corner and then select OceanBase MySQL Compatible or OceanBase Oracle Compatible.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Endpoint.
    Connection Information Enter the endpoint service name of the selected cloud provider.
    Instance The ID or name of the instance where the OceanBase database is located. You can view the ID or name of the target instance on the Instances page.

    Note

    When the cloud provider is Alibaba Cloud, you can also select an instance of the Alibaba Cloud root account for cross-account authorization. For details, see Alibaba Cloud Account Authorization.

    Tenant The ID or name of the OceanBase database tenant.
    Database Account The username of the OceanBase database user.
    Password The password of the database user.

    After selecting Connection Method as Endpoint, you can also decide whether to perform advanced settings based on your actual situation.

    Notice

    If the new migration task requires incremental synchronization, please enable both the sys tenant account and the incremental log proxy service.

    Parameter
    Description
    sys Tenant Account After enabling the sys tenant account, you need to enter the sys account and password.
    • Sys Account: The name of the sys user. This user is mainly used to read incremental logs and database object structure information from OceanBase Database. Please create it under the sys tenant of the business cluster.
    • Password: The password of the sys user.
    Incremental Log Proxy Service After enabling the incremental log proxy service, enter the OBLogProxy Connection Information. OBLogProxy is the incremental log proxy service for OceanBase Database. It provides real-time access to and management of incremental log projects, making it easier for applications to access incremental logs from OceanBase Database. It also enables incremental log subscription in network-isolated environments. The format is OBLogProxy IP:OBLogProxy Port.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have permission to modify security group allowlists on Alibaba Cloud, AWS, Azure, or Google Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, depending on your requirements, click Create Data Source in the upper-right corner and select OceanBase MySQL Compatible or OceanBase Oracle Compatible.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP.
    Connection Information Enter the IP address or hostname for the connection.
    Instance The ID or name of the instance where the OceanBase database is located. You can view the target instance's ID or name on the Instances page.

    Note

    When the cloud provider is Alibaba Cloud, you can also select an Alibaba Cloud root account instance for cross-account authorization. For details, see Alibaba Cloud Account Authorization.

    Tenant The ID or name of the OceanBase database tenant.
    Database Account The username of the OceanBase database user.
    Password The password of the database user.

    After selecting Connection Method as Public IP, you can decide whether to perform advanced settings based on your actual situation.

    Notice

    If the migration task you create requires incremental synchronization, you must also enable the sys tenant account and the incremental log proxy service.

    Parameter
    Description
    sys Tenant Account After enabling the sys tenant account, you need to enter the account and password of the sys tenant.
    • Sys Account: The name of the sys user. This user is mainly used to read incremental logs and database object structure information from OceanBase Database. Please create it under the sys tenant of the business cluster.
    • Password: The password of the sys user.
    Incremental Log Proxy Service After enabling the incremental log proxy service, enter the OBLogProxy Connection Information. OBLogProxy is the incremental log proxy service for OceanBase Database. It provides real-time access to and management of incremental log projects, making it easier for applications to access incremental logs from OceanBase Database. It also enables incremental log subscription in network-isolated environments. The format is OBLogProxy IP:OBLogProxy Port.
  5. Click Test Connection.

  6. After the test connection succeeds, click Save.

Prerequisites

  • You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.

  • You have permission to modify the database instance's inbound security group rules or allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select OceanBase MySQL Compatible or OceanBase Oracle Compatible.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Instance Type Select Self-managed Database. Peering connections are supported only for this instance type.
    Connection Type Select Peering Connection.
    Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection.
    Connection Information Enter the private IP address or hostname of the OceanBase instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity.
    Instance The ID or name of the instance where the OceanBase database is located. You can view it on the Instances page.

    Note

    For Alibaba Cloud, you can also select an instance under an Alibaba Cloud root account that has granted cross-account authorization. For more information, see Alibaba Cloud account authorization.

    Tenant The ID or name of the OceanBase database tenant.
    Database Account The username of the OceanBase database user.
    Password The password of the database user.

    After you set Connection Method to Peering Connection, you can configure advanced settings as needed.

    Note

    If the migration task requires incremental synchronization, enable both the sys tenant account and the incremental log proxy service.

    Parameter
    Description
    sys Tenant Account After you enable the sys tenant account, enter the sys account and password.
    • Sys Account: The name of the sys user. This user reads incremental logs and database object structures from OceanBase Database. Create the user in the sys tenant of the business cluster.
    • Password: The password of the sys user.
    Incremental Log Proxy Service After you enable the incremental log proxy service, enter the OBLogProxy Connection Information. OBLogProxy provides real-time access to and management of incremental log projects and supports incremental log subscription in network-isolated environments. The format is OBLogProxy IP:OBLogProxy Port.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

OceanBase HBase API compatible mode

For the OceanBase HBase API compatible mode, OceanBase Cloud provides a quick connection for an OceanBase Cloud instance.

Connect to OceanBase Cloud instance

Prerequisites

  • You have created a cluster instance of the KV or Flagship Edition and a tenant in OceanBase HBase API-compatible mode, and have an available database and account.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left navigation pane, click Data Services > Data Source.

  3. On the Data Source page, depending on your actual situation, click Create Data Source in the upper-right corner > OceanBase HBase API Compatible.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select OceanBase Cloud Instance.
    Instance Type Includes Cluster Instance (Key-Value) or Cluster Instance (Flagship)
    Instance Select the target instance from the drop-down list.
    Tenant Select the target tenant from the drop-down list.
    Database Account The username of the OceanBase database.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

MySQL data source

For MySQL databases, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.

Endpoint connection
Public network connection
Peering connection

Prerequisites

  • You have created an endpoint service on Alibaba Cloud, AWS, Azure, or Google Cloud and have permission to modify its allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source > MySQL in the upper-right corner.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Link.
    When you set Cloud Vendor to AWS and select Enable for the Require Acceptance to Use Endpoint parameter when creating the endpoint service, the Data Migration Service prompts you to open the AWS console and Accept the Endpoint Connection Request the first time it accesses the private link.
    Instance Type
    • When you select Alibaba Cloud as the cloud provider, the instance types supported are RDS MySQL, PolarDB MySQL, and Self-managed MySQL.
    • When you select AWS as the cloud provider, the instance types supported are Aurora MySQL, RDS MySQL, and Self-managed MySQL.
    • When you select Azure as the cloud provider, the instance types supported are Azure MySQL and Self-managed MySQL.
    • When you select Google Cloud as the cloud provider, the instance type supported is Self-managed MySQL.
    Connection Information Enter the name of the endpoint service of the selected cloud provider.
    Database Account The username of the MySQL database.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have permission to modify the security group allowlist on Alibaba Cloud, AWS, Azure, or Google Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Sources page, click Create Data Source in the upper-right corner and select MySQL.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP. You must first add the data source IP address displayed on the page to the allowlist of the MySQL database instance to ensure connectivity. For more information, see the Select a public network connection section.
    Instance Type
    • If Cloud Vendor is set to Alibaba Cloud, the instance types supported are RDS MySQL, PolarDB MySQL, and Self-managed MySQL.
    • If the cloud provider is set to AWS, the instance types supported are Aurora MySQL, RDS MySQL, and Self-managed MySQL.
    • If the cloud provider is set to Azure, the instance types supported are Azure MySQL and Self-managed MySQL.
    • If the cloud provider is set to Google Cloud, the instance type supported is Self-managed MySQL.
    Connection Information Enter the IP address or hostname to connect to.
    Database Account The username of the MySQL database.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.

  • You have permission to modify the database instance's inbound security group rules or allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select MySQL.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Instance Type Select a MySQL instance type that supports peering connections for the selected cloud provider.
    Connection Type Select Peering Connection.
    Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection.
    Connection Information Enter the private IP address or hostname of the MySQL instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity.
    Database Account The username of the MySQL database user.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Oracle data source

For Oracle databases, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.

Endpoint connection
Public network connection
Peering connection

Prerequisites

  • You have created an endpoint service on Alibaba Cloud, AWS, Azure, or Google Cloud and have permission to modify its allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner > Oracle.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Link.
    When Cloud Vendor is set to AWS and Enable is selected for the Require Acceptance to Use Endpoint parameter when creating the endpoint service, the first time the data migration service accesses the private link, you are prompted to open the AWS console and Accept Endpoint Connection Request for the incoming request.
    Instance Type
    • When the cloud provider is AWS, the instance types supported are RDS Oracle and Self-managed Oracle.
    • When the cloud provider is Alibaba Cloud, Azure, or Google Cloud, the instance type supported is Self-managed Oracle.
    Connection Information Enter the name of the endpoint service of the selected cloud provider.
    Service Name The service name of the Oracle database.
    Database Account The username of the Oracle database.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have permission to modify the security group allowlist on Alibaba Cloud, AWS, Azure, or Google Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source > Oracle in the upper-right corner.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP. You must first add the data source IP address displayed on the page to the allowlist of the Oracle database instance to ensure connectivity. For more information, see the Select a public network connection section.
    Instance Type
    • If the cloud provider is set to AWS, the instance type can be RDS Oracle or Self-managed Oracle.
    • If the cloud provider is set to Alibaba Cloud, Azure, or Google Cloud, the instance type can be Self-managed Oracle.
    Connection Information Enter the IP address or hostname to connect to.
    Service Name The service name of the Oracle database.
    Database Account The username of the Oracle database user.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.

  • You have permission to modify the database instance's inbound security group rules or allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select Oracle.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Instance Type Only Self-managed Oracle is supported.
    Connection Type Select Peering Connection.
    Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection.
    Connection Information Enter the private IP address or hostname of the Oracle instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity.
    Service Name The service name of the Oracle database.
    Database Account The username of the Oracle database user.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Kafka data source

For Kafka instances, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.

Endpoint connection
Public network connection
Peering connection

Prerequisites

  • You have created an endpoint service on Alibaba Cloud, AWS, or Google Cloud and have permission to modify its allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source > Kafka in the upper-right corner.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Link.
    When Cloud Vendor is set to AWS and Require Enable is selected for the Require Accept to Use Endpoint parameter when creating the endpoint service, the first time the data migration service accesses the private link, you are prompted to open the AWS console and perform the Accept Endpoint Connection Request operation for the incoming request.
    Instance Type Includes Self-managed Kafka and Cloud Instance Kafka.
    Connection Information Enter the name of the endpoint service of the selected cloud provider and the Kafka access point.

    Notice

    • For cloud-managed Kafka on Alibaba Cloud, you cannot enter a domain name when entering the Kafka access point; only an IP address is supported.

    Based on your business requirements, choose whether to enable SASL under Security Authentication. If SASL is enabled, configure the following parameters.

    Parameter
    Description
    Authentication Method Supports PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.
    • The PLAIN authentication method is relatively simple but does not support dynamic user changes and configures the username and password in plaintext, which is not secure.
    • SCRAM (Salted Challenge Response Authentication Mechanism) addresses security issues by using the traditional mechanism of username and password authentication. Kafka supports SCRAM-SHA-256, which can be used with TLS to perform secure authentication.
      This authentication method allows for dynamic user changes, and user data is stored in Zookeeper. Before starting a broker, communication with Zookeeper is required to create a communication user between Zookeeper and the broker. However, this authentication method requires configuring the username and password in plaintext.
    • Kafka supports SCRAM-SHA-512, which can be used with TLS to perform secure authentication.
    Username The username used for data migration.
    Password The password of the user used for data migration.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have permission to modify the security group allowlist on Alibaba Cloud, AWS, or Google Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select Kafka.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP. You must first add the data source IP address displayed on the page to the allowlist of the Kafka instance to ensure connectivity. For more information, see Select a public network connection.
    Instance Type Includes Self-managed Kafka and Cloud Instance Kafka.
    Connection Information Enter the Kafka access point information.

    If the security authentication configuration for the Kafka data source is not completed, the data migration task using this data source as the source or target may fail. The configuration area for security authentication is as follows.

    1. Click Upload File to upload the trust certificate with the .jks extension.

    2. Based on your business requirements, choose whether to enable SASL. If you enable SASL, configure the following parameters.

      Parameter
      Description
      Authentication Method Supports PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.
      • The PLAIN authentication method is relatively simple but cannot dynamically change users and configures the username and password in plaintext, which is not secure.
      • The SCRAM (Salted Challenge Response Authentication Mechanism) authentication method addresses security issues by implementing the traditional username and password authentication mechanism. Kafka supports SCRAM-SHA-256, which can be used with TLS to perform security authentication.
        This authentication method allows dynamic user changes, and user data is stored in Zookeeper. Before starting a broker, communication with Zookeeper is required to create a communication user for the broker. However, this authentication method requires configuring the username and password in plaintext.
      • Kafka supports SCRAM-SHA-512, which can be used with TLS to perform security authentication.
      Username The username used for data migration.
      Password The password for the user used for data migration.
  5. Click Test Connection.

  6. After the test connection succeeds, click Save.

Prerequisites

  • You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.

  • You have permission to modify the database instance's inbound security group rules or allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select Kafka.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Instance Type Includes Self-managed Kafka and Cloud Instance Kafka.
    Connection Type Select Peering Connection.
    Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection.
    Kafka Endpoint Enter the Kafka endpoint. Add the IP address displayed on the page to the Kafka instance's inbound security group rules or allowlist to enable connectivity.

    If security authentication is not configured for the Kafka data source, data migration tasks that use the data source as the source or target may fail to connect. Configure security authentication as follows:

    1. Click Upload File and upload a trust certificate with the .jks extension.

    2. Enable SASL as needed. If you enable SASL, configure the following parameters.

      Parameter
      Description
      Authentication Method Supports PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.
      • PLAIN cannot dynamically change users and stores the username and password in plaintext, which provides limited security.
      • SCRAM (Salted Challenge Response Authentication Mechanism) authenticates users by username and password. Kafka supports SCRAM-SHA-256 with TLS. This method supports dynamic user changes and stores user data in ZooKeeper. Before you start a broker, create the user that the broker uses to communicate with ZooKeeper. The username and password are configured in plaintext.
      • Kafka also supports SCRAM-SHA-512 with TLS.
      Username The username used for data migration.
      Password The password of the user used for data migration.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

PostgreSQL data source

For PostgreSQL databases, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.

Endpoint connection
Public network connection
Peering connection

Prerequisites

  • You have created an endpoint service on Alibaba Cloud, AWS, or Google Cloud and have permission to modify its allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner > PostgreSQL.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Connection.
    When Cloud Vendor is set to AWS and Enable is selected for the Require Acceptance to Use Endpoint parameter when creating the endpoint service, the first time the data migration service accesses the private connection, you are prompted to open the AWS console and Accept the Endpoint Connection Request for the incoming request.
    Instance Type
    • When the cloud provider is AWS, the instance types supported are RDS PostgreSQL, Aurora PostgreSQL, and Self-managed PostgreSQL.
    • When the cloud provider is Alibaba Cloud, the instance types supported are RDS PostgreSQL and Self-managed PostgreSQL.
    • When the cloud provider is Google Cloud, the instance type supported is Self-managed PostgreSQL.
    Connection Information Enter the name of the endpoint service for the selected cloud provider.
    Database Name The name of the PostgreSQL database.
    Database Account The username of the PostgreSQL database user.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have permission to modify the security group allowlist on Alibaba Cloud, AWS, or Google Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select PostgreSQL.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP. You must add the data source IP address displayed on the page to the allowlist of the PostgreSQL database instance to ensure connectivity. For more information, see the Select a public network connection section.
    Instance Type
    • If the cloud provider is AWS, the instance types supported are RDS PostgreSQL, Aurora PostgreSQL, and Self-managed PostgreSQL.
    • If the cloud provider is Alibaba Cloud, the instance types supported are RDS PostgreSQL and Self-managed PostgreSQL.
    • If the cloud provider is Google Cloud, the instance type supported is Self-managed PostgreSQL.
    Connection Information Enter the IP address or hostname to connect to.
    Database Name The name of the PostgreSQL database.
    Database Account The username for the PostgreSQL database.
    Password The password for the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.

  • You have permission to modify the database instance's inbound security group rules or allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select PostgreSQL.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Instance Type Select RDS PostgreSQL or Self-managed PostgreSQL for the selected cloud provider.
    Connection Type Select Peering Connection.
    Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection.
    Connection Information Enter the private IP address or hostname of the PostgreSQL instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity.
    Database Name The name of the PostgreSQL database.
    Database Account The username of the PostgreSQL database user.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

TiDB data source

For TiDB databases, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.

Endpoint connection
Public network connection
Peering connection

Prerequisites

  • You have created an endpoint service on Alibaba Cloud, AWS, Azure, or Google Cloud and have permission to modify its allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select TiDB.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Network Connection.
    When Cloud Vendor is set to AWS and Enable is selected for the Require Acceptance to Use Endpoint parameter when creating the endpoint service, the first time the data migration service accesses the private connection, you are prompted to open the AWS console and Accept the Endpoint Connection Request.
    Instance Type Currently only supports Self-managed TiDB.
    Connection Information Enter the name of the endpoint service of the selected cloud provider.
    Database Account The username of the TiDB database.
    Password The password of the database user.
  5. Click Test Connection.

  6. After the test connection succeeds, click Save.

Prerequisites

  • You have permission to modify security group allowlists on Alibaba Cloud, AWS, Azure, or Google Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and then select TiDB.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP. You must first add the data source IP address displayed on the page to the allowlist of the TiDB database instance to ensure connectivity. For more information, see the Select a public network connection section.
    Instance Type Currently only supports Self-managed TiDB.
    Connection Information Enter the IP address or hostname for the connection.
    Database Account The username for the TiDB database.
    Password The password for the database user.

    If you need to obtain incremental data from TiDB via Kafka, fill in the Incremental Sync Settings section to enable the Binlog and TiCDC data sources. If you do not configure this section, you will not be able to select Incremental Synchronization on the Select Type & Objects page when creating a data migration task from a new TiDB database to OceanBase Database in MySQL-compatible mode.

    Parameter
    Description
    Kafka Data Source The Kafka data source is used to store information about Binlogs and incremental logs of TiDB data converted by the TiCDC tool, facilitating consumption by data migration.

    Note

    You can only select a Kafka data source from the same cloud provider as TiDB.

    Topic Select the topic of the Kafka data source to bind from the drop-down list.
    TiDB Data Format When migrating data from a TiDB database to OceanBase Database in MySQL-compatible mode, you can choose data in TiCDC or TiDB Binlog format. Select from the drop-down list.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.

  • You have permission to modify the database instance's inbound security group rules or allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select TiDB.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Instance Type Only Self-managed TiDB is supported.
    Connection Type Select Peering Connection.
    Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection.
    Connection Information Enter the private IP address or hostname of the TiDB instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity.
    Database Account The username of the TiDB database user.
    Password The password of the database user.

    If you need to obtain incremental TiDB data through Kafka, configure Incremental Sync Settings to enable the Binlog and TiCDC data sources. Otherwise, you cannot select Incremental Synchronization on the Select Type & Objects page when you create a data migration task from TiDB to OceanBase Database in MySQL-compatible mode.

    Parameter
    Description
    Kafka Data Source The Kafka data source stores the TiDB incremental logs converted by Binlog or TiCDC for consumption by data migration.

    Note

    You can select only a Kafka data source from the same cloud provider as TiDB.

    Topic Select the topic to bind from the drop-down list.
    TiDB Data Format When you migrate data from TiDB to OceanBase Database in MySQL-compatible mode, select the TiCDC or TiDB Binlog format from the drop-down list.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

HBase data source

For an HBase data source, OceanBase Cloud provides a public network connection method.

Public network connection

Prerequisites

  • You have permission to modify the security group allowlist on Alibaba Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select HBase.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP. You must first add the displayed data source IP address to the allowlist of the HBase database instance to ensure connectivity. For more information, see Select a public network connection.
    Instance Type Currently only supports Alibaba Cloud HBase Enhanced Edition.
    Connection Information Enter the IP address or hostname for the connection.
    Port The port used for accessing your database. The specific value depends on your endpoint service configuration.
    Database Account The username for the HBase database.
    Password The password for the database user.

    If you need to obtain HBase incremental data via Kafka, please fill in the Kafka data source and Topic. Missing configurations may result in unavailable incremental synchronization.

    Parameter
    Description
    Kafka Data Source You can select a Kafka data source saved during data transfer. For details, see the Kafka data sources section in this topic.

    Note

    You can only select a Kafka data source from the same cloud provider.

    Topic You can select or enter a Topic.
    Incremental Data Format Select the supported incremental data format. Currently supports DEBEZIUM_V2.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Lindorm data source

For a Lindorm data source, OceanBase Cloud provides a public network connection method.

Public network connection

Prerequisites

  • You have permission to modify the security group allowlist on Alibaba Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select Lindorm.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP. You must first add the displayed data source IP address to the allowlist of the Lindorm database instance to ensure connectivity. For more information, see Select a public network connection.
    Instance Type Currently only supports Alibaba Cloud Lindorm.
    Connection Information Enter the IP address or hostname to connect to.
    Port The port used for accessing your database. The specific value depends on your endpoint service configuration.
    Database Account The username for the Lindorm database.
    Password The password for the database user.

    If you need to obtain Lindorm incremental data via Kafka, please fill in the Kafka data source and Topic. Missing configurations may result in unavailable incremental synchronization.

    Parameter
    Description
    Kafka Data Source You can select a Kafka data source saved during data transmission. For details, see the Kafka data sources section in this topic.

    Note

    You can only select a Kafka data source from the same cloud provider.

    Topic You can select or enter a Topic.
    Incremental Data Format Select the supported incremental data format. Currently supports DEBEZIUM_V2.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

RocketMQ data source

For the RocketMQ data source, OceanBase Cloud provides both public network and private network connection methods.

Private network connection
Public network connection

Prerequisites

  • You have created an endpoint service on Alibaba Cloud, AWS, or Google Cloud and have permission to modify its allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner > RocketMQ.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Private Network. You must first add the account ID displayed in How to obtain? to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select a private link.

    Note

    When the cloud provider is set to AWS and Required is selected for Require Acceptance to Use Endpoint when creating the endpoint service, the Data Migration Service prompts you to open the AWS console and perform the Accept Endpoint Connection Request operation for the incoming request the first time it accesses the private connection.

    Instance Type The default is Self-managed RocketMQ.
    Namesrv Configuration Enter the endpoint service information and corresponding RocketMQ access point information for the namesrv configuration.

    Notice

    Ensure that each endpoint service node corresponds one-to-one with a RocketMQ access point.

    Broker Configuration Enter the endpoint service information and corresponding RocketMQ access point information for the broker configuration.

    Notice

    Ensure that each endpoint service node corresponds one-to-one with a RocketMQ access point.

    Based on your business requirements, choose whether to enable Security Authentication. If enabled, configure the following parameters.

    Parameter
    Description
    Authentication Method You can select AccessKey.
    AccessKey The AccessKey ID you created in the cloud account management console, used for authentication.
    SecretKey The AccessKey Secret you created in the cloud account management console, used for authentication.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have permission to modify the security group allowlist on Alibaba Cloud, AWS, or Google Cloud.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select RocketMQ.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP.
    Instance Type
    • The Alibaba Cloud channel supports RocketMQ on Alibaba Cloud and Self-managed RocketMQ.
    • The AWS channel only supports Self-managed RocketMQ.
    RocketMQ Access Point Enter the RocketMQ access point ID and port. You must first add the data source IP address displayed on the page to the allowlist of the RocketMQ instance to ensure connectivity. For more information, see Select a public network connection.

    Based on your business requirements, choose whether to enable Security Authentication. If enabled, configure the following parameters.

    Note

    • When the data source is a RocketMQ cloud instance on Alibaba Cloud V4.x, you need to enter the AK/SK corresponding to the cloud account.
    • When the data source is a RocketMQ cloud instance on Alibaba Cloud V5.x, you need to enter the AK/SK that controls access to the cloud instance.
    Parameter
    Description
    Authentication Method You can select AccessKey.
    AccessKey The AccessKey ID you created in the cloud account management console, used for identity authentication.
    SecretKey The AccessKey Secret you created in the cloud account management console, used for identity authentication.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

DataHub data source

For a DataHub data source, OceanBase Cloud provides both private network and public network connection methods.

Private network connection
Public network connection

Prerequisites

  • You have configured Alibaba Cloud to complete RAM access permission control. For detailed operations, see Add access control for an Alibaba Cloud DataHub instance in Add an Alibaba Cloud instance to the allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner > DataHub.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Private Network.
    Instance Type The default is Alibaba Cloud DataHub Instance.
    Access Point Select a target address access point from the drop-down list. You must first add the data source IP address displayed on the page to the allowlist of the cloud database security group to ensure connectivity. For details, see Add access control for an Alibaba Cloud DataHub instance in Add an Alibaba Cloud instance to the allowlist.
    Project Name The name of the DataHub instance.
    AccessKey The AccessKey ID you created in the cloud account management console, used for authentication.
    SecretKey The AccessKey Secret you created in the cloud account management console, used for authentication.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have permission to modify the Alibaba Cloud security group allowlist.

  • You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, click Data Services > Data Source.

  3. On the Data Source page, click Create Data Source in the upper-right corner and select DataHub.

  4. In the Create Data Source dialog box, configure the parameters.

    Parameter
    Description
    Cloud Provider Currently supports Alibaba Cloud.
    Region Select the region where the data source is located.
    Connection Type Select Public IP.
    Instance Type The default value is Alibaba Cloud DataHub Instance.
    Access Point Information about the DataHub instance. You must first add the displayed data source IP address to the allowlist of the cloud database security group to ensure connectivity. For details, see Add access control for Alibaba Cloud DataHub instances in Add an Alibaba Cloud instance to the allowlist.
    Project Name The name of the DataHub instance.
    AccessKey The AccessKey ID you created in the cloud account management console, used for authentication.
    SecretKey The AccessKey Secret you created in the cloud account management console, used for authentication.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

ADB data sources

OceanBase Cloud supports private connection, public connection, and peering connection for AnalyticDB for MySQL (ADB).

Private connection
Public connection
Peering connection

Prerequisites

  • You have created an ADB instance and obtained a valid database account and password.

  • You have created an endpoint service on Alibaba Cloud for accessing the ADB instance and configured the endpoint service allowlist. For more information, see Configure an Alibaba Cloud endpoint.

  • You have the Organization Admin or Project Admin role in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, choose Data Services > Data Sources.

  3. On the Data Sources page, click Create Data Source in the upper-right corner, and then select AnalyticDB for MySQL (ADB).

  4. In the Create AnalyticDB for MySQL(ADB) data source dialog box, configure the parameters.

    Parameter
    Description
    Cloud provider Only Alibaba Cloud is supported.
    Region Select the region where the ADB instance is located.
    Instance type Select AnalyticDB for MySQL (ADB).
    Connection type Select Private Connection.
    Endpoint service ID Enter the ID of the endpoint service used to access the ADB instance. Click How to get it to view the instructions.
    Port Enter the port used for the connection. The default port is 3306. Specify the port based on the endpoint service configuration.
    Account Enter the database account of the ADB instance.
    Password Enter the password of the database account.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created an ADB instance, obtained its public connection address, and obtained a valid database account and password.

  • You have permissions to modify the allowlist of the ADB instance.

  • You have the Organization Admin or Project Admin role in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, choose Data Services > Data Sources.

  3. On the Data Sources page, click Create Data Source in the upper-right corner, and then select AnalyticDB for MySQL (ADB).

  4. In the Create AnalyticDB for MySQL(ADB) data source dialog box, configure the parameters.

    Parameter
    Description
    Cloud provider Only Alibaba Cloud is supported.
    Region Select the region where the ADB instance is located.
    Instance type Select AnalyticDB for MySQL (ADB).
    Connection type Select Public IP.
    Connection information Enter the public IP address or hostname of the ADB instance. Add the IP address displayed on the page to the instance allowlist so that OceanBase Cloud can access the instance. Click How to configure to view instructions on configuring the allowlist.
    Port Enter the connection port of the ADB instance. The default port is 3306. Specify the port based on the instance configuration.
    Account Enter the database account of the ADB instance.
    Password Enter the password of the database account.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created an ADB instance and obtained a valid database account and password.

  • You have prepared a peering connection that can access the ADB instance.

  • You have the Organization Admin or Project Admin role in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, choose Data Services > Data Sources.

  3. On the Data Sources page, click Create Data Source in the upper-right corner, and then select AnalyticDB for MySQL (ADB).

  4. In the Create AnalyticDB for MySQL(ADB) data source dialog box, configure the parameters.

    Parameter
    Description
    Cloud provider Only Alibaba Cloud is supported.
    Region Select the region where the ADB instance is located.
    Instance type Select AnalyticDB for MySQL (ADB).
    Connection type Select Peering Connection.
    Peering connection ID Select the ID of the peering connection used to access the ADB instance.
    Connection information Enter the IP address or hostname used to access the ADB instance over the selected peering connection.
    Port Enter the connection port of the ADB instance. The default port is 3306. Specify the port based on the instance configuration.
    Account Enter the database account of the ADB instance.
    Password Enter the password of the database account.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

PolarDB-X 2.0 data sources

OceanBase Cloud supports private connection, public connection, and peering connection for PolarDB-X 2.0.

Private connection
Public connection
Peering connection

Prerequisites

  • You have created a PolarDB-X 2.0 instance and obtained a valid database account and password.

  • You have created an endpoint service on Alibaba Cloud for accessing the PolarDB-X 2.0 instance and configured the endpoint service allowlist. For more information, see Configure an Alibaba Cloud endpoint.

  • You have the Organization Admin or Project Admin role in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, choose Data Services > Data Sources.

  3. On the Data Sources page, click Create Data Source in the upper-right corner, and then select PolarDB-X 2.0.

  4. In the Create PolarDB-X 2.0 data source dialog box, configure the parameters.

    Parameter
    Description
    Cloud provider Only Alibaba Cloud is supported.
    Region Select the region where the PolarDB-X 2.0 instance is located.
    Instance type Select PolarDB-X 2.0.
    Connection type Select Private Connection.
    Endpoint service ID Enter the ID of the endpoint service used to access the PolarDB-X 2.0 instance. Click How to get it to view the instructions.
    Port Enter the port used for the connection. The default port is 3306. Specify the port based on the endpoint service configuration.
    Account Enter the database account of the PolarDB-X 2.0 instance.
    Password Enter the password of the database account.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created a PolarDB-X 2.0 instance, obtained its public connection address, and obtained a valid database account and password.

  • You have permissions to modify the allowlist of the PolarDB-X 2.0 instance.

  • You have the Organization Admin or Project Admin role in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, choose Data Services > Data Sources.

  3. On the Data Sources page, click Create Data Source in the upper-right corner, and then select PolarDB-X 2.0.

  4. In the Create PolarDB-X 2.0 data source dialog box, configure the parameters.

    Parameter
    Description
    Cloud provider Only Alibaba Cloud is supported.
    Region Select the region where the PolarDB-X 2.0 instance is located.
    Instance type Select PolarDB-X 2.0.
    Connection type Select Public IP.
    Connection information Enter the public IP address or hostname of the PolarDB-X 2.0 instance. Add the IP address displayed on the page to the instance allowlist so that OceanBase Cloud can access the instance.
    Port Enter the connection port of the PolarDB-X 2.0 instance. The default port is 3306. Specify the port based on the instance configuration.
    Account Enter the database account of the PolarDB-X 2.0 instance.
    Password Enter the password of the database account.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Prerequisites

  • You have created a PolarDB-X 2.0 instance and obtained a valid database account and password.

  • You have prepared a peering connection that can access the PolarDB-X 2.0 instance.

  • You have the Organization Admin or Project Admin role in the OceanBase Cloud console.

Procedure

  1. Log in to the OceanBase Cloud console.

  2. In the left-side navigation pane, choose Data Services > Data Sources.

  3. On the Data Sources page, click Create Data Source in the upper-right corner, and then select PolarDB-X 2.0.

  4. In the Create PolarDB-X 2.0 data source dialog box, configure the parameters.

    Parameter
    Description
    Cloud provider Only Alibaba Cloud is supported.
    Region Select the region where the PolarDB-X 2.0 instance is located.
    Instance type Select PolarDB-X 2.0.
    Connection type Select Peering Connection.
    Peering connection ID Select the ID of the peering connection used to access the PolarDB-X 2.0 instance.
    Connection information Enter the IP address or hostname used to access the PolarDB-X 2.0 instance over the selected peering connection.
    Port Enter the connection port of the PolarDB-X 2.0 instance. The default port is 3306. Specify the port based on the instance configuration.
    Account Enter the database account of the PolarDB-X 2.0 instance.
    Password Enter the password of the database account.
  5. Click Test Connection.

  6. After the connection test succeeds, click Save.

Previous topic

Add an IP address to an allowlist
Last

Next topic

Manage data sources
Next
on this page
Background information
OceanBase data sources (MySQL and Oracle compatibility modes)
OceanBase HBase API compatible mode
MySQL data source
Oracle data source
Kafka data source
PostgreSQL data source
TiDB data source
HBase data source
Lindorm data source
RocketMQ data source
DataHub data source
ADB data sources
PolarDB-X 2.0 data sources