OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Cloud

  • Product Updates & Announcements
    • What's new
      • Release notes for 2026
      • Release notes for 2025
      • Release notes for 2024
      • Release history
    • Product announcements
      • Data development module deprecation notice
      • Optimization of Backup and Restore commercialization strategy
      • Cross-AZ data transfer billing (OceanBase Cloud on AWS)
      • Database Proxy pricing update
      • AWS instance pricing adjustment
  • 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-level caching in shared storage
      • Multi-layer online scaling and on-demand adjustment
    • Deployment modes
    • Storage architecture
    • Product specifications
    • Product billing
      • Overview
      • Instance billing
        • Tencent Cloud instance billing
        • Alibaba Cloud instance billing
        • Huawei Cloud instance billing
        • AWS instance billing
        • GCP instance billing
      • Backup and restore billing
      • SQL audit billing
      • Migrations billing
      • Database proxy billing
      • Binlog service billing
      • Overview of OceanBase Cloud support plans
      • Read-only replica billing
    • Supported database versions
  • Get Started
    • Get started with a transactional instance
    • Get started with an analytical instance
    • Get started with a Key-Value instance
  • Work with Transactional Instances
    • Overview
    • Create an instance
      • Overview
      • Create via OceanBase 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 using AWS PrivateLink
          • Connect using Azure Private Link
          • 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 using AWS PrivateLink
          • Connect using Azure Private Link
          • 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
        • 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
        • Enable storage auto-scaling
        • View history of configuration changes
        • Change configuration
        • Change configuration temporarily
        • Switch the deployment mode
      • Manage standby instances
        • Overview
        • Create a standby instance
        • Create a cross-cloud standby instance
        • Create a standby instance for an Alibaba Cloud primary 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 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 tags
      • 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 JVM-dependent services
    • 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
        • Google Cloud
        • Azure
        • Private IP address segments
      • Connect via public network
        • AWS
        • Huawei Cloud
        • Alibaba Cloud
        • Google 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 Analytical Instances
    • Overview
    • Core features
    • Create an instance
    • Connect to an instance
      • Overview
      • Get connection string
        • Overview
        • Connect using AWS PrivateLink
        • Connect using a public IP address
      • Connect with clients
        • Connect to OceanBase Cloud by using Client ODC
        • Connect to OceanBase Cloud by using a MySQL client
        • Connect to OceanBase Cloud by using OBClient
      • Connect with drivers
        • Java
          • Connect to OceanBase Cloud by using Spring Boot
          • Connect to OceanBase Cloud by using Spring Batch
          • Connect to OceanBase Cloud by using Spring Data JDBC
          • Connect to OceanBase Cloud by using Spring Data JPA
          • Connect to OceanBase Cloud by using Hibernate
          • Connect to OceanBase Cloud by using MyBatis
          • Connect to OceanBase Cloud using MySQL Connector/J
        • Python
          • Connect to OceanBase Cloud by using mysqlclient
          • Connect to OceanBase Cloud by using PyMySQL
          • Connect to OceanBase Cloud using MySQL Connector/Python
        • C
          • Connect to OceanBase Cloud using MySQL Connector/C
        • Go
          • Connect to OceanBase Cloud using Go-SQL-Driver/MySQL
        • PHP
          • Connect to OceanBase Cloud using PHP
      • Use database connection pool
        • Database connection pool configuration
        • Connect to OceanBase Cloud by using a Tomcat connection pool
        • Connect to OceanBase Cloud by using a C3P0 connection pool
        • Connect to OceanBase Cloud by using a Proxool connection pool
        • Connect to OceanBase Cloud by using a HikariCP connection pool
        • Connect to OceanBase Cloud by using a DBCP connection pool
        • Connect to OceanBase Cloud by using Commons Pool
        • Connect to OceanBase Cloud by using a Druid connection pool
    • Data table design
      • 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
      • 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 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 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
    • 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
          • Switch 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
          • 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
            • 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 tags
        • Manage recycle Bin
          • View instance recycle bin
          • Manage databases and tables in recycle bin
            • Overview
            • Instance-level recycle bin
            • Tenant-level recycle bin
    • 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
          • Switch 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
          • 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
            • 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 tags
        • Manage recycle Bin
          • View instance recycle bin
          • Manage databases and tables in recycle bin
            • Overview
            • Instance-level recycle bin
            • Tenant-level recycle bin
      • Performance test
    • Connect Key-Value instances
      • Overview
      • Connect using a public IP address
  • 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
    • Migrate data
      • Overview
      • Migrations specification
      • Purchase a data migration instance
      • Migrate data from a MySQL database to a MySQL-compatible tenant of OceanBase Database
      • Migrate data from a MySQL-compatible tenant of OceanBase Database to a MySQL database
      • Migrate data between OceanBase database tenants of 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 an OceanBase database to a Kafka instance
      • Migrate data from a TiDB database to a MySQL-compatible tenant of OceanBase Database
      • Migrate incremental data from a MySQL-compatible tenant of OceanBase Database to a TiDB Database
      • Migrate data from a PostgreSQL database to an OceanBase database
      • Migrate incremental data from an OceanBase Database to a PostgreSQL database
      • Manage data migration tasks
        • View details of a data migration task
        • Rename a data migration task
        • View and modify migration objects
        • View and modify migration parameters
        • Configure alert monitoring
        • Manage data migration tasks by using tags
        • 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
      • 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
  • Security
    • OceanBase Cloud account settings
      • Modify login password
      • Multi-factor authentication
      • 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
        • 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
  • 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
  • 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
  • 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
      • 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
        • Tenant management
          • DescribeTenants
          • DescribeTenant
          • CreateTenants
          • DeleteTenants
          • ModifyTenantName
          • ModifyTenant
          • ModifyTenantUserDescription
          • ModifyTenantUserStatus
          • GetTenantCreateConstraints
          • ModifyTenantPrimaryZone
          • GetTenantCreateCpuConstraints
          • GetTenantCreateMemConstraints
          • GetTenantModifyCpuConstraints
          • GetTenantModifyMemConstraints
          • CreateTenantSecurityIpGroup
          • DescribeTenantSecurityIpGroups
          • ModifyTenantSecurityIpGroup
          • DeleteTenantSecurityIpGroup
          • DescribeTenantPrivateLink
          • DeletePrivatelinkConnection
          • CreatePrivatelinkService
          • ConnectPrivatelinkService
          • AddPrivatelinkServiceUser
          • BatchKillProcessList
          • DescribeProcessStatsComposition
          • DescribeTenantAvailableRoZones
          • DescribeTenantAddressInfo
          • ModifyTenantReadonlyReplica
          • DescribeTenantParameters
          • UpdateTenantParameters
          • DescribeTenantParametersHistory
          • ModifyTenantTagList
        • Tenant user management
          • CreateTenantUser
          • DescribeTenantUsers
          • DeleteTenantUsers
          • ModifyTenantUserPassword
          • ModifyTenantUserRoles
        • Database management
          • CreateDatabase
          • DescribeDatabases
          • DeleteDatabases
          • ModifyDatabaseUserRoles
        • Backup and restore
          • DescribeDataBackupSet
          • DescribeRestorableTenants
          • ModifyBackupStrategy
          • CreateTenantRestoreTask
          • CreateDataBackupTask
          • DescribeOneDataBackupSet
        • Database proxy management
          • CreateTenantAddress
          • CreateTenantSingleTunnelSLBAddress
          • DeleteTenantAddress
          • DescribeTenantAddress
          • ModifyOdpClusterSpec
          • ModifyTenantAddressPort
          • ModifyTenantAddressDomainPrefix
          • ConfirmPrivatelinkConnection
          • DescribeTenantAddressInfo
        • Monitoring management
          • DescribeTenantMetrics
          • DescribeMetricsData
          • DescribeNodeMetrics
        • Diagnostic management
          • DescribeOasTopSQLList
          • DescribeOasAnomalySQLList
          • DescribeOasSlowSQLList
          • DescribeOasSQLText
          • DescribeSqlAudits
          • DescribeOutlineBinding
          • DescribeSampleSqlRawTexts
          • DescribeSQLTuningAdvices
          • DescribeOasSlowSQLSamples
          • DescribeOasSQLTrends
          • DescribeOasSQLPlanGroup
        • Security management
          • CreateSecurityIpGroup
          • DescribeInstanceSSL
          • ModifyInstanceSSL
          • DescribeTenantEncryption
          • ModifyTenantEncryption
          • ModifySecurityIps
          • DeleteSecurityIpGroup
          • DescribeTenantSecurityConfigs
          • DescribeInstanceSecurityConfigs
        • Tag management
          • DescribeTags
          • CreateTags
          • UpdateTag
          • DeleteTag
        • Historical event management
          • DescribeOperationEvents
      • 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
    • 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 monthly bills
    • View payment details
    • View orders
    • Use vouchers for payment
    • View invoices
  • Legal Agreements
    • OceanBase Cloud Services Agreement
    • Service Level Agreement
    • OceanBase Data Processing Addendum
    • Service Level Agreement for OceanBase Cloud Migration Service

Download PDF

Release notes for 2026 Release notes for 2025 Release notes for 2024 Release history Data development module deprecation notice Optimization of Backup and Restore commercialization strategy Cross-AZ data transfer billing (OceanBase Cloud on AWS) Database Proxy pricing update AWS instance pricing adjustment Overview Management mode and scenarios High availability with cross-cloud active-active architecture High availability with cross-cloud primary-standby databases Multi-level caching in shared storage Multi-layer online scaling and on-demand adjustment Deployment modes Storage architecture Product specifications Overview Backup and restore billing SQL audit billing Migrations billing Database proxy billing Binlog service billing Overview of OceanBase Cloud support plans Read-only replica billing Supported database versions Get started with a transactional instance Get started with an analytical instance Get started with a Key-Value instance Overview 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 Release an instance Manage tags Manage JVM-dependent services Create a data source Manage data sources Archive data Clean up data Instance recycle bin Overview Core features Create an instance Overview Table overview Export data OceanBase data processing Statistics Materialized views for query acceleration Select a query parallelism level Instance overview Change configuration Modify primary zone Manage parameters Stop and restart instances Release instances Manage tags Archive data Clean up data 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 View instance recycle bin Create an instance Create a tenant Create an account for a database user OBKV HBase data operation examples Create an instance OBKV-HBase Overview Create an instance Performance test Overview Connect using a public IP address Data migration and import solutions Data assessment and migration quick start Overview Perform online assessment Perform offline assessment Obtain files for upload Configure PrivateLink Add an IP address to an allowlist Overview Migrations specification Purchase a data migration instance Migrate data from a MySQL database to a MySQL-compatible tenant of OceanBase Database Migrate data from a MySQL-compatible tenant of OceanBase Database to a MySQL database Migrate data between OceanBase database tenants of 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 an OceanBase database to a Kafka instance
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Cloud
iconOceanBase Cloud

    Create a data source

    Last Updated:2026-04-07 08:08:33  Updated
    share
    What is on this page
    Background information
    OceanBase data sources (MySQL and Oracle compatible modes)
    MySQL data sources
    Oracle data sources
    Kafka data sources
    PostgreSQL data source
    TiDB data source

    folded

    share

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

    Background information

    A data source is a collection of database connection information, such as the connection address, port number, username, and password. In OceanBase Cloud, you can configure a data source to quickly establish a database connection during tasks such as data migration and job scheduling, so as to improve the operation efficiency and reliability.

    At present, OceanBase Cloud data sources support the following cloud vendors: Amazon Web Services (AWS), Huawei Cloud, Google Cloud, Alibaba Cloud, and Microsoft Azure. Supported database types are OceanBase Database (MySQL and Oracle compatible modes), MySQL (including Aurora MySQL, RDS MySQL, Cloud MySQL, PolarDB MySQL, Azure MySQL, and self-managed MySQL), Oracle (including RDS Oracle and self-managed Oracle), Kafka (including cloud instance Kafka and self-managed Kafka), PostgreSQL (including RDS PostgreSQL, Azure for PostgreSQL, and self-managed PostgreSQL), and self-managed TiDB.

    The data source connection type varies based on the database type. You must select a connection type based on your database type.

    OceanBase data sources (MySQL and Oracle compatible modes)

    OceanBase Cloud provides three connection types for OceanBase data sources.

    • OceanBase Cloud Instance: This connection type applies to OceanBase Database instances created in the OceanBase Cloud console and realizes quick connection.

    • Endpoint or public IP: This connection type applies to OceanBase Database instances deployed in AWS, Huawei Cloud, Google Cloud, Alibaba Cloud, or Azure.

    OceanBase Cloud Instance
    Endpoint
    Public IP

    Prerequisites

    • You have created an instance and a tenant of OceanBase Database (MySQL or Oracle compatible mode) in the OceanBase Cloud console, and prepared a database account.

    • You have the privileges of the organization admin or project admin of the OceanBase Cloud console.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Sources page, click Create Data Source > OceanBase MySQL Compatible or OceanBase Oracle Compatible based on the actual situation.

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

      Parameter Description
      Cloud Vendor At present, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region of the data source.
      Connection Type Select OceanBase Cloud Instance.
      Instance Type Valid values: Dedicated (Transactional), Shared, and Dedicated (Analytical). This parameter is displayed only when Connection Type is set to OceanBase Cloud Instance.

      Notice

      Migration supports only the Dedicated (Transactional) and Dedicated (Analytical) instance types.

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

    6. After the test succeeds, click Save.

    Prerequisites

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

    • You have the privileges of the organization admin or project admin of the OceanBase Cloud console.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Sources page, click Create Data Source > OceanBase MySQL Compatible or OceanBase Oracle Compatible based on the actual situation.

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

      Parameter Description
      Cloud Vendor At present, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region of the data source.
      Connection Type Select Endpoint.
      Connection Information Enter the name of the endpoint service of the selected cloud vendor.
      Instance The ID or name of the instance to which the OceanBase database belongs. You can view the ID or name of the target instance on the Instances page.

      Note

      When the cloud vendor is Alibaba Cloud, you can also select a cross-account authorized instance of an Alibaba Cloud account. For more information, see Alibaba Cloud account authorization.

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

      If you set Connection Type to Endpoint, you can choose whether to configure advanced settings as needed.

      Notice

      If incremental synchronization is required in your migration task, you must also toggle on sys Tenant Account and OBLogProxy.

      Parameter Description
      sys Tenant Account After you toggle on sys Tenant Account, you must specify sys Account and Password.
      • sys Account: the username of the user in the sys tenant. The user reads incremental logs of OceanBase Database and obtains database object schemas. You must create the user in the sys tenant of your business cluster.
      • Password: the password of the user.
      OBLogProxy After you toggle on OBLogProxy, you must specify OBLogProxy connection information. oblogproxy is a proxy service for managing incremental logs of OceanBase Database. It provides project intervention and management capabilities as services to allow applications to access and manage real-time incremental logs of OceanBase Database. It also addresses the need for incremental log subscriptions in network isolation mode. The value is in the format of oblogproxy IP address:oblogproxy port number.
    5. Click Test Connection.

    6. After the test succeeds, click Save.

    Prerequisites

    • You have the privilege to modify the security group allowlist of AWS, Huawei Cloud, Google Cloud, Alibaba Cloud, or Azure.

    • You have the privileges of the organization admin or project admin of the OceanBase Cloud console.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Sources page, click Create Data Source > OceanBase MySQL Compatible or OceanBase Oracle Compatible based on the actual situation.

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

      Parameter Description
      Cloud Vendor At present, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region of the data source.
      Connection Type Select Public IP.
      Connection Information Enter the IP address or host name to connect.
      Instance The ID or name of the instance to which the OceanBase database belongs. You can view the ID or name of the target instance on the Instances page.

      Note

      When the cloud vendor is Alibaba Cloud, you can also select a cross-account authorized instance of an Alibaba Cloud account. For more information, see Alibaba Cloud account authorization.

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

      If you set Connection Type to Public IP, you can choose whether to configure advanced settings as needed.

      Notice

      If incremental synchronization is required in your migration task, you must also toggle on sys Tenant Account and OBLogProxy.

      Parameter Description
      sys Tenant Account After you toggle on sys Tenant Account, you must specify sys Account and Password.
      • sys Account: the username of the user in the sys tenant. The user reads incremental logs of OceanBase Database and obtains database object schemas. You must create the user in the sys tenant of your business cluster.
      • Password: the password of the user.
      OBLogProxy After you toggle on OBLogProxy, you must specify OBLogProxy connection information. oblogproxy is a proxy service for managing incremental logs of OceanBase Database. It provides project intervention and management capabilities as services to allow applications to access and manage real-time incremental logs of OceanBase Database. It also addresses the need for incremental log subscriptions in network isolation mode. The value is in the format of oblogproxy IP address:oblogproxy port number.
    5. Click Test Connection.

    6. After the test succeeds, click Save.

    MySQL data sources

    OceanBase Cloud provides two connection types for MySQL data sources: Endpoint and Public IP.

    Endpoint
    Public IP

    Prerequisites

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

    • You have the privileges of the organization admin or project admin of the OceanBase Cloud console.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Source page, choose Create Data Source > MySQL.

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

      Parameter Description
      Cloud Vendor At present, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region of the data source.
      Connection Type Select Endpoint. You must add the account ID displayed on the page to the allowlist of your endpoint service. This way, the endpoint of this account can connect to your endpoint service. For more information, see the corresponding topic under Connect via private network.
      • When you select Cloud Vendor as AWS, if you selected Acceptance required for the parameter Require acceptance for endpoint when you created the endpoint service, the data migration service will prompt you to go to the AWS console to perform the Accept endpoint connection request operation in the AWS console when the data migration service first connects to the PrivateLink.
      • If you set Cloud Vendor to Google Cloud, add an authorized project to Published Services. After that, no manual authorization is required during a data source connection test.
      Instance Type
      • When Cloud Vendor is set to Alibaba Cloud, instance types RDS MySQL, PolarDB MySQL, and Self-managed MySQL are supported.
      • When Cloud Vendor is set to AWS, instance types Aurora MySQL, RDS MySQL, and Self-managed MySQL are supported.
      • When Cloud Vendor is set to Google Cloud, instance types Cloud MySQL and Self-managed MySQL are supported.
      • When Cloud Vendor is set to Huawei Cloud, instance types RDS MySQL and Self-managed MySQL are supported.
      • When Cloud Vendor is set to Azure, instance types Azure MySQL and Self-managed MySQL are supported.
      Connection Information Enter the name of the endpoint service of the selected cloud vendor.
      Database Account The username of a user in the MySQL database.
      Password The password of the database user.
    5. Click Test Connection.

    6. After the test succeeds, click Save.

    Prerequisites

    • You have the privilege to modify the security group allowlist of AWS, Huawei Cloud, Google Cloud, Alibaba Cloud, or Azure.

    • You have the privileges of the organization admin or project admin of the OceanBase Cloud console.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Sources page, click Create Data Source > MySQL.

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

      Parameter Description
      Cloud Vendor At present, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region of the data source.
      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 corresponding topic under Connect via public network.
      Instance Type
      • When Cloud Vendor is set to Alibaba Cloud, instance types RDS MySQL, PolarDB MySQL, and Self-managed MySQL are supported.
      • When Cloud Vendor is set to AWS, instance types Aurora MySQL, RDS MySQL, and Self-managed MySQL are supported.
      • When Cloud Vendor is set to Google Cloud, instance types Cloud MySQL and Self-managed MySQL are supported.
      • When Cloud Vendor is set to Huawei Cloud, instance types RDS MySQL and Self-managed MySQL are supported.
      • When Cloud Vendor is set to Azure, instance types Azure MySQL and Self-managed MySQL are supported.
      Connection Information Enter the IP address or host name to connect.
      Database Account The username of a user in the MySQL database.
      Password The password of the database user.
    5. Click Test Connection.

    6. After the test succeeds, click Save.

    Oracle data sources

    OceanBase Cloud provides two connection types for Oracle data sources: Endpoint and Public IP.

    Endpoint
    Public IP

    Prerequisites

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

    • You have the privileges of the organization admin or project admin of the OceanBase Cloud console.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Sources page, click Create Data Source > Oracle.

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

      Parameter Description
      Cloud Vendor At present, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region of the data source.
      Connection Type Select Endpoint. You must add the account ID displayed on the page to the allowlist of your endpoint service. This way, the endpoint of this account can connect to your endpoint service. For more information, see the corresponding topic under Connect via private network.
      • When you select Cloud Vendor as AWS, if you selected Acceptance required for the parameter Require acceptance for endpoint when you created the endpoint service, the data migration service will prompt you to go to the AWS console to perform the Accept endpoint connection request operation in the AWS console when the data migration service first connects to the PrivateLink.
      • If you set Cloud Vendor to Google Cloud, add an authorized project to Published Services. After that, no manual authorization is required during a data source connection test.
      Instance Type
      • When Cloud Vendor is set to AWS, instance types RDS Oracle and Self-managed Oracle are supported.
      • When Cloud Vendor is set to Alibaba Cloud, Google Cloud, Huawei Cloud, or Azure, only the Self-managed Oracle instance type is supported.
      Connection Information Enter the name of the endpoint service of the selected cloud vendor.
      Service Name The service name of the Oracle database.
      Database Account The username of a user in the Oracle database.
      Password The password of the database user.
    5. Click Test Connection.

    6. After the test succeeds, click Save.

    Prerequisites

    • You have the privilege to modify the security group allowlist of AWS, Huawei Cloud, Google Cloud, Alibaba Cloud, or Azure.

    • You have the privileges of the organization admin or project admin of the OceanBase Cloud console.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Sources page, click Create Data Source > Oracle.

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

      Parameter Description
      Cloud Vendor At present, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region of the data source.
      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 corresponding topic under Connect via public network.
      Instance Type
      • When Cloud Vendor is set to AWS, instance types RDS Oracle and Self-managed Oracle are supported.
      • When Cloud Vendor is set to Alibaba Cloud, Google Cloud, Huawei Cloud, or Azure, only the Self-managed Oracle instance type is supported.
      Connection Information Enter the IP address or host name to connect.
      Service Name The service name of the Oracle database.
      Database Account The username of a user in the Oracle database.
      Password The password of the database user.
    5. Click Test Connection.

    6. After the test succeeds, click Save.

    Kafka data sources

    OceanBase Cloud supports two connection methods for a Kafka instance: Endpoint and Public IP.

    Endpoint
    Public IP

    Prerequisites

    • You have created a endpoint service on Alibaba Cloud, AWS, Google Cloud, or Huawei Cloud and have the permission to modify the allowlist of the endpoint service.

    • You have the permissions of an organization admin or project admin 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.

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

      Parameter Description
      Cloud Vendor Currently, Alibaba Cloud, AWS, Google Cloud, and Huawei Cloud are supported.
      Region The region where the data source is located.
      Connection Type Select Endpoint. You need to add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint to connect to the endpoint service. For more information, see the corresponding topic under Connect via private network.
      • When you select Cloud Vendor as AWS, if you selected Acceptance required for the parameter Require acceptance for endpoint when you created the endpoint service, the data migration service will prompt you to go to the AWS console to perform the Accept endpoint connection request operation in the AWS console when the data migration service first connects to the PrivateLink.
      • If you select Google Cloud as the cloud vendor, you need to add the authorized project to the published services. After you add the authorization, you do not need to manually authorize the data source when you test the connection.
      Instance Type The type of the Kafka instance. Valid values: Self-managed Kafka and Cloud Instance Kafka.
      Connection Information The name of the endpoint service and the Kafka endpoint of the selected cloud vendor.

      Notice

      For Alibaba Cloud Kafka Instance, you can enter only an IP address, not a domain name, when you enter the Kafka endpoint.

      You can choose to enable SASL in Security Authentication as needed. If you enable SASL, configure the following parameters.

      Parameter Description
      Authentication Method The authentication method. Valid values: PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.
      • The PLAIN authentication method is simple but cannot dynamically change users. It stores usernames and passwords in plaintext, which is not secure.
      • SCRAM (Salted Challenge Response Authentication Mechanism) solves security issues by using the traditional username and password authentication mechanism. Kafka supports SCRAM-SHA-256, which can be used together with TLS for secure authentication.
        This authentication method allows dynamic user changes, and stores user data in Zookeeper. Before starting a broker, you need to communicate with Zookeeper to create a communication user between the broker and Zookeeper. However, this authentication method stores the username and password in plaintext.
      • Kafka also supports SCRAM-SHA-512, which can be used together with TLS for secure authentication.
      Username The username for data migration.
      Password The password for data migration.
    5. Click Test Connection.

    6. After the test succeeds, click Save.

    Prerequisites

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

    • You have the permissions of an organization admin or project admin 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.

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

      Parameter Description
      Cloud Vendor Currently, Alibaba Cloud, AWS, Google Cloud, and Huawei Cloud are supported.
      Region The region where the data source is located.
      Connection Type Select Public IP. You need to add the data source IP address displayed on the page to the allowlist of the Kafka instance to ensure connectivity. For more information, see the corresponding topic under Connect via public network.
      Instance Type The type of the Kafka instance. Valid values: Self-managed Kafka and Cloud Instance Kafka.
      Connection Information The Kafka endpoint.

      If the Kafka data source has not been configured with security authentication, a data migration task that uses the data source as the source or destination may fail to connect. Configure the security authentication parameters as follows.

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

      2. You can choose to enable SASL as needed. If you enable SASL, configure the following parameters.

        Parameter Description
        Authentication Method The authentication method. Valid values: PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.
        • The PLAIN authentication method is simple but cannot dynamically change users. It stores usernames and passwords in plaintext, which is not secure.
        • SCRAM (Salted Challenge Response Authentication Mechanism) solves security issues by using the traditional username and password authentication mechanism. Kafka supports SCRAM-SHA-256, which can be used together with TLS for secure authentication.
          This authentication method allows dynamic user changes, and stores user data in Zookeeper. Before starting a broker, you need to communicate with Zookeeper to create a communication user between the broker and Zookeeper. However, this authentication method stores the username and password in plaintext.
        • Kafka also supports SCRAM-SHA-512, which can be used together with TLS for secure authentication.
        Username The username for data migration.
        Password The password for data migration.
    5. Click Test Connection.

    6. After the test succeeds, click Save.

    PostgreSQL data source

    For a PostgreSQL database, OceanBase Cloud provides two connection methods: endpoint connection and public IP connection.

    Endpoint connection
    Public IP connection

    Prerequisites

    • You have created an endpoint service for connecting to the cloud service and have the permission to modify the allowlist of the endpoint service.

    • You have the permission of an organization admin or project admin of OceanBase Cloud.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Source page, click Create Data Source > PostgreSQL.

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

      Parameter Description
      Cloud Service Currently, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region where the data source is located.
      Connection Type Select Endpoint. You need to add the displayed account ID to the allowlist of your endpoint service to allow the endpoint to connect to the endpoint service. For more information, see the corresponding topic under Connect via private network.
      • When you select Cloud Vendor as AWS, if you selected Acceptance required for the parameter Require acceptance for endpoint when you created the endpoint service, the data migration service will prompt you to go to the AWS console to perform the Accept endpoint connection request operation in the AWS console when the data migration service first connects to the PrivateLink.
      • When you select Google Cloud as the cloud service, add the authorized project to Published Services. After the authorization is added, no manual authorization is required when you test the connection to the data source.
      Instance Type
      • When you select AWS as the cloud service, the instance type can be RDS PostgreSQL, Aurora PostgreSQL, or Self-managed PostgreSQL.
      • When you select Huawei Cloud or Alibaba Cloud as the cloud service, the instance type can be RDS PostgreSQL or Self-managed PostgreSQL.
      • When you select Google Cloud as the cloud service, the instance type can be Cloud PostgreSQL or Self-managed PostgreSQL.
      • When you select Azure as the cloud service, the instance type can be Azure for PostgreSQL or Self-managed PostgreSQL.
      Endpoint Enter the name of the endpoint service of the selected cloud service.
      Database Name The name of the PostgreSQL database.
      Database Account The username of the PostgreSQL database.
      Password The password of the database user.
    5. Click Test Connection.

    6. After the test is successful, click Save.

    Prerequisites

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

    • You have the permission of an organization admin or project admin of OceanBase Cloud.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Source page, click Create Data Source > PostgreSQL.

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

      Parameter Description
      Cloud Service Currently, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region where the data source is located.
      Connection Type Select Public IP. You need to add the displayed data source IP address to the allowlist of the PostgreSQL database instance to ensure connectivity. For more information, see the corresponding topic under Connect via public network.
      Instance Type
      • When you select AWS as the cloud service, the instance type can be RDS PostgreSQL, Aurora PostgreSQL, or Self-managed PostgreSQL.
      • When you select Huawei Cloud or Alibaba Cloud as the cloud service, the instance type can be RDS PostgreSQL or Self-managed PostgreSQL.
      • When you select Google Cloud as the cloud service, the instance type can be Cloud PostgreSQL or Self-managed PostgreSQL.
      • When you select Azure as the cloud service, the instance type can be Azure for PostgreSQL or Self-managed PostgreSQL.
      Endpoint Enter the IP address or hostname of the data source to be connected.
      Database Name The name of the PostgreSQL database.
      Database Account The username of the PostgreSQL database.
      Password The password of the database user.
    5. Click Test Connection.

    6. After the test is successful, click Save.

    TiDB data source

    For a TiDB database, OceanBase Cloud provides two connection methods: endpoint connection and public IP connection.

    Endpoint connection
    Public IP connection

    Prerequisites

    • You have created an endpoint service for connecting to the cloud service and have the permission to modify the allowlist of the endpoint service.

    • You have the permission of an organization admin or project admin of OceanBase Cloud.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Source page, click Create Data Source > TiDB.

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

      Parameter Description
      Cloud Service Currently, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region where the data source is located.
      Connection Type Select Endpoint. You need to add the displayed account ID to the allowlist of your endpoint service to allow the endpoint to connect to the endpoint service. For more information, see the corresponding topic under Connect via private network.
      • When you select Cloud Vendor as AWS, if you selected Acceptance required for the parameter Require acceptance for endpoint when you created the endpoint service, the data migration service will prompt you to go to the AWS console to perform the Accept endpoint connection request operation in the AWS console when the data migration service first connects to the PrivateLink.
      • When you select Google Cloud as the cloud service, add the authorized project to Published Services. After the authorization is added, no manual authorization is required when you test the connection to the data source.
      Instance Type Only Self-managed TiDB is supported.
      Endpoint Enter the name of the endpoint service of the selected cloud service.
      Database Account The username of the TiDB database.
      Password The password of the database user.
    5. Click Test Connection.

    6. After the test is successful, click Save.

    Prerequisites

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

    • You have the permission of an organization admin or project admin of OceanBase Cloud.

    Procedure

    1. Log in to the OceanBase Cloud console.

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

    3. On the Data Source page, click Create Data Source > PostgreSQL.

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

      Parameter Description
      Cloud Service Currently, Alibaba Cloud, AWS, Google Cloud, Huawei Cloud, and Azure are supported.
      Region The region where the data source is located.
      Connection Type Select Public IP. You need to add the displayed data source IP address to the allowlist of the TiDB database instance to ensure connectivity. For more information, see the corresponding topic under Connect via public network.
      Instance Type Only Self-managed TiDB is supported.
      Endpoint Enter the IP address or hostname of the data source to be connected.
      Database Account The username of the TiDB database.
      Password The password of the database user.

      If you want to obtain incremental data from TiDB by using Kafka, you need to fill in Incremental Sync Settings to enable Binlog and TiCDC data sources. If you do not fill in the following configurations, when you create a data migration task to migrate data from the TiDB database to the MySQL compatible mode of OceanBase Database, you cannot select Incremental Synchronization on the Select Type & Objects page.

      Parameter Description
      Kafka Data Source The Kafka data source is used to save the incremental logs of TiDB data converted by the TiCDC tool, so that the data migration service can consume the data.

      Notice

      You can select only a Kafka data source of the same cloud service as TiDB.

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

    6. After the test is successful, click Save.

    Previous topic

    Manage JVM-dependent services
    Last

    Next topic

    Manage data sources
    Next
    What is on this page
    Background information
    OceanBase data sources (MySQL and Oracle compatible modes)
    MySQL data sources
    Oracle data sources
    Kafka data sources
    PostgreSQL data source
    TiDB data source