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

Databases

OceanBase DatabaseOceanBase AI 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 ServiceOceanBase DataPilotOceanBase OAgent

Connectors and Middleware

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

Databases

OceanBase DatabaseOceanBase AI 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 ServiceOceanBase DataPilotOceanBase OAgent
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
      • Data backup and restore
      • 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
  • Use BYOC instances
    • Prepare BYOC instance quotas
    • Create a BYOC instance
    • Connect to an instance
      • Connect in MySQL mode
        • Connect with a client
          • Connect to OceanBase Cloud using the desktop ODC
          • Connect to OceanBase Cloud using the MySQL client
          • Connect to OceanBase Cloud by using OBClient
        • Connect with a driver or ORM framework
          • Java
            • Sample application for connecting to OceanBase Cloud using Spring Boot
            • Sample application for connecting to OceanBase Cloud using Spring Batch
            • spring-jdbc
            • Sample application for connecting to OceanBase Cloud using Spring Data JPA
            • Connect to OceanBase Cloud using Hibernate
            • Sample application for connecting to OceanBase Cloud using MyBatis
            • connector-j
            • Connect to OceanBase Cloud using Testcontainers Java
          • Python
            • Connect to OceanBase Cloud using mysqlclient
            • Connect to OceanBase Cloud using PyMySQL
            • Connect to OceanBase Cloud using MySQL Connector/Python
            • Example program for connecting to OceanBase Cloud using SQLAlchemy
            • Connect to OceanBase Cloud using Django
            • Sample program for connecting to OceanBase Cloud using Peewee
          • C
            • Connect to OceanBase Cloud by using MySQL Connector/C
          • Go
            • Example program for connecting to OceanBase Cloud using Go-SQL-Driver/MySQL
            • Example program for connecting to OceanBase Cloud using GORM
          • PHP
            • Example program for connecting to OceanBase Cloud using the EXT driver
            • Connect to OceanBase Cloud by using the MySQLi driver
            • Connect to OceanBase Cloud using the PDO driver
          • Rust
            • Connect to OceanBase Cloud using Rust
            • Sample application for connecting to OceanBase Cloud using SeaORM
          • Ruby
            • Example program for connecting to OceanBase Cloud database using ActiveRecord
            • Connect to OceanBase Cloud using mysql2
            • Example program for connecting to OceanBase Cloud using Sequel
        • Use connection pools
          • Database connection pool configuration
          • Connect to OceanBase Database with Druid in a Tomcat application
          • Connect to OceanBase Database by using a C3P0 connection pool
          • Sample program for connecting to OceanBase Database using a Proxool connection pool
          • Connect to OceanBase Database by using the HikariCP connection pool
          • Connect to OceanBase Database by using a DBCP connection pool
          • Connect to OceanBase Database by using Commons Pool
          • Sample program for connecting to OceanBase Database using a Druid connection pool
      • Connect in Oracle mode
        • Connect with a client
          • Connect to OceanBase Cloud using OBClient
          • Connect to OceanBase Cloud using the desktop ODC
        • Connect with a driver or ORM framework
          • Java
            • Sample application for connecting to OceanBase Cloud using OceanBase Connector/J
            • Connect to OceanBase Cloud using Spring Boot
            • Sample application for connecting to OceanBase Cloud using Spring Batch
            • Connect to OceanBase Cloud by using Spring JDBC
            • Connect to OceanBase Cloud using Spring Data JPA
            • Connect to OceanBase Cloud using Hibernate
            • Sample application for connecting to OceanBase Cloud using MyBatis
            • Connect to OceanBase Cloud using JFinal
          • Python
            • Python Driver Oracle Mode
          • C/C++
            • Connect to OceanBase Cloud using OceanBase Connector/C
            • Sample program for connecting to OceanBase Cloud using OceanBase Connector/ODBC
            • Sample application for connecting to OceanBase Cloud using SqlSugar
        • Use connection pools
          • Database connection pool configuration
          • Connect to OceanBase Database with Druid in a Tomcat application
          • Connect to OceanBase Cloud by using a C3P0 connection pool
          • Sample application for connecting to OceanBase Cloud using a Proxool connection pool
          • Connect to OceanBase Cloud by using HikariCP connection pool
          • Connect to OceanBase Cloud by using a DBCP connection pool
          • Connect to OceanBase Cloud by using Commons Pool
          • Sample program for connecting to OceanBase Cloud using a Druid connection pool
      • Connect in KV mode
        • Connect to a cluster by using the OBKV-HBase client
    • Manage instances
      • Manage instances
        • View the instance list
        • Instance workspace overview
        • Stop and start an instance
        • Migrate resource units
      • Manage tenants
        • Tenant workspace
        • Create a tenant
        • Modify tenant specifications
        • Change the tenant name
        • Add an endpoint
        • Modify the primary zone
        • Monitor tenant performance
          • Tenant monitoring overview
          • Monitor performance and SQL
          • Monitor transactions
          • Monitor storage and cache
          • Monitor the Binlog service
          • Customize monitoring dashboards for tenants
        • Manage parameters
          • Manage tenant parameters
          • Parameter list description
          • Parameter template description
        • Delete a tenant
        • Manage databases and accounts
          • Create an account
          • Manage accounts
          • Create a database (MySQL only)
          • Manage databases (MySQL only)
      • Monitor instance performance
        • Instance monitoring overview
        • Monitor the performance of databases in a cluster
        • Monitor multi-dimensional metrics of a cluster
        • Monitor the performance of hosts in a cluster
        • Database proxy monitoring details
        • Database proxy host monitoring details
        • Customize monitoring dashboards for instances
      • Major compaction
        • Initiate a major compaction
        • View major compaction records
        • Modify the major compaction time
      • Manage instance parameters
        • Parameter management
        • Parameter list description
      • Change instance configurations
        • View the configuration change history of a cluster instance
        • Change instance configurations (pay-as-you-go)
      • Manage standby instances
        • Create a standby instance
        • Primary and standby instance workspaces
        • Set a primary/standby synchronization strategy
      • Release an instance
      • Database proxy
        • Database proxy overview
        • Manage database proxies
      • Manage alerts
        • Manage alerts
        • Manage alert rules
          • Create an alert rule
          • View an alert rule
          • Edit an alert rule
          • Delete an alert rule
        • View alert history
        • Manage trigger condition templates
          • Create a trigger condition template
          • View a trigger condition template
          • Edit a trigger condition template
          • Copy a trigger condition template
          • Delete a trigger condition 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 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
          • Get a webhook URL
        • Monitoring metrics for custom alerts
      • Backup and restore
        • Backup and restore overview
        • Modify a backup strategy
        • Perform an immediate backup
        • Initiate restore
      • Manage read-only replicas
        • Read-only replica overview
        • Instance read-only replicas
          • Add a read-only replica to an instance
          • View information about read-only replicas of an instance
          • Manage the specifications of read-only replicas
          • Delete a read-only replica of an instance
        • Tenant read-only replicas
          • Add a read-only replica for a tenant
          • View information about tenant read-only replicas
          • Modify tenant read-only replicas
          • Delete tenant read-only replicas
      • Manage tags
      • Manage JVM environment dependency services
    • Manage the recycle bin
      • Instance recycle bin
  • 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
    • 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
      • Account message subscriptions
      • Manage cloud marketplace accounts
      • Account audit
    • Organizations and projects
      • Overview
      • Manage organization information
      • Project management
        • Manage projects
        • Cross-project bidirectional authorization
        • Authorize a cloud account for BYOC
        • Manage object storage configurations
        • Manage log service 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
  • 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
          • DisconnectStandbyInstance - Detach a standby instance
        • Tenant management
          • DescribeTenants
          • DescribeTenant
          • CreateTenants
          • DeleteTenants
          • ModifyTenantName
          • ModifyTenant
          • ModifyTenantUserDescription
          • ModifyTenantUserStatus
          • GetTenantCreateConstraints
          • ModifyTenantPrimaryZone
          • GetTenantCreateCpuConstraints
          • GetTenantCreateMemConstraints
          • GetTenantModifyCpuConstraints
          • GetTenantModifyMemConstraints
          • CreateTenantSecurityIpGroup
          • DescribeTenantSecurityIpGroups
          • ModifyTenantSecurityIpGroup
          • DeleteTenantSecurityIpGroup
          • BatchKillProcessList
          • DescribeProcessStatsComposition
          • DescribeTenantAvailableRoZones
          • ModifyTenantReadonlyReplica
          • DescribeTenantParameters
          • UpdateTenantParameters
          • DescribeTenantParametersHistory
          • ModifyTenantTagList
          • DescribeTenantSqlAuditServiceInfo - Query SQL Audit Service Information for a Tenant
          • DescribeCharset
        • Tenant user management
          • CreateTenantUser
          • DescribeTenantUsers
          • DeleteTenantUsers
          • ModifyTenantUserPassword
          • ModifyTenantUserRoles
        • Database management
          • CreateDatabase
          • DescribeDatabases
          • DeleteDatabases
          • ModifyDatabaseUserRoles
          • DescribeTableSchema
          • DescribeTimeZone
          • ModifyDatabaseDescription
        • 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
          • ModifyOdpClusterSpec
        • Connection management
          • CreateTenantAddress
          • CreateTenantSingleTunnelSLBAddress
          • DeleteTenantAddress
          • DescribeTenantAddress
          • ModifyTenantAddressPort
          • ModifyTenantAddressDomainPrefix
          • ConfirmPrivatelinkConnection
          • DescribeTenantPrivateLink
          • DeletePrivatelinkConnection
          • CreatePrivatelinkService
          • ConnectPrivatelinkService
          • AddPrivatelinkServiceUser
          • DescribeTenantAddressInfo - Query Tenant Address Information
          • CreateReadonlyPrivatelink
          • CreateReadwritePrivatelink
          • DescribeTenantPublicAddress
        • 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
          • DescribeSecurityIpGroups - Query cluster allowlist groups
          • DescribeInstanceSSL
          • ModifyInstanceSSL
          • DescribeTenantEncryption
          • ModifyTenantEncryption
          • ModifySecurityIps
          • DeleteSecurityIpGroup
          • DescribeTenantSecurityConfigs
          • DescribeInstanceSecurityConfigs
        • Tag management
          • DescribeTags
          • CreateTags
          • UpdateTag
          • DeleteTag
        • Historical event management
          • DescribeOperationEvents
        • AI service management
          • CreateAIServiceAPIKey
          • DeleteAIServiceAPIKey
          • ListAIServiceAPIKeys
        • OpenAPI catalog
          • ListOpenApis - List OpenAPIs
          • DescribeOpenApi - Query OpenAPI details
      • 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
      • CMS metric compatibility
      • Prometheus monitoring metrics
      • 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 transaction details
    • View monthly bills
    • View payment details
    • Manage AI service billing
      • Usage monitoring
      • View API key records
      • Rate limits & quotas
    • Payment method
      • Bank remittances and claims
      • 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

Connect to OceanBase Cloud using Hibernate

Last Updated:2026-11-11 03:39:33

Prerequisites
Procedure
Step 1: Obtain the connection string of the OceanBase Cloud database
Step 2: Import the java-oceanbase-hibernate project into IDEA
Step 3: Modify the database connection information in the java-oceanbase-hibernate project
Step 4: Run the java-oceanbase-hibernate project
FAQ
1. Connection timeout
2. Character set issues
3. SSL connection
4. Special characters in account credentials
Sample project overview
Introduction to pom.xml code
Introduction to User.hbm.xml
Introduction to hibernate.cfg.xml
Introduction to UserDao.java
Introduction to User.java
Introduction to TestHibernate.java
Complete sample code
References

This topic describes how to build an application using the Hibernate framework and OceanBase Cloud to perform basic operations such as creating tables, inserting data, and querying data.

Download the sample project

Prerequisites

  • You have registered an OceanBase Cloud account and created a cluster instance and a MySQL-compatible tenant. For more information, see Create a cluster instance and Create a tenant.
  • You have installed JDK 1.8 and Maven.
  • You have installed IntelliJ IDEA.

Note

The tool used to run the sample code in this topic is IntelliJ IDEA 2021.3.2 (Community Edition). You can also choose a tool that suits your personal preference to run the sample code.

Procedure

Note

The procedure described in this topic is based on the Windows environment. If you are using a different operating system or compiler, the steps may vary slightly.

  1. Obtain the connection string of the OceanBase Cloud database.
  2. Import the java-oceanbase-hibernate project into IDEA.
  3. Modify the database connection information in the java-oceanbase-hibernate project.
  4. Run the java-oceanbase-hibernate project.

Step 1: Obtain the connection string of the OceanBase Cloud database

  1. Log in to the OceanBase Cloud console. On the instance list page, expand the target instance's information. Under the target tenant, select Connect > Get connection string.

    For more detailed operations, see Get a connection string.

  2. Fill in the corresponding information in the following URL based on your created OceanBase Cloud database.

    Note

    This URL information is required in the hibernate.cfg.xml file.

    jdbc:oceanbase://host:port/schema_name?user=$user_name&password=$password
    

    Parameter description:

    • host: The connection address of the OceanBase Cloud database, for example, t********.********.oceanbase.cloud.
    • port: The connection port of the OceanBase Cloud database. Default value: 3306.
    • schema_name: The name of the schema to be accessed.
    • user_name: The account used to access the database.
    • password: The password of the account.

For more information about URL parameters, see Database URL.

Step 2: Import the java-oceanbase-hibernate project into IDEA

Download the sample project.

  1. Open IntelliJ IDEA and select File > Open....

  2. In the Open File or Project window that appears, select the corresponding project file and click OK to complete the import.

  3. IntelliJ IDEA automatically identifies the various files in the project. In the Project tool window, you can view the project's directory structure, file list, module list, dependencies, and other information. The Project tool window is usually located on the far left side of the IntelliJ IDEA interface and is open by default. If the Project tool window is closed, you can reopen it by clicking View > Tool Windows > Project in the menu bar or using the shortcut key Alt + 1.

    Note

    When importing a project in IntelliJ IDEA, it automatically detects the pom.xml file in the project, downloads the required dependency libraries based on the dependencies described in the file, and adds them to the project.

  4. View the project.

Step 3: Modify the database connection information in the java-oceanbase-hibernate project

Modify the database connection information in the hibernate.cfg.xml file based on the information obtained in Step 1: Obtain the OceanBase Cloud connection string.

Note

To add additional properties to the JDBC connection string, see Database URL.

Example:

  • The database driver name is: com.mysql.cj.jdbc.Driver
  • The OceanBase Cloud connection address is t5******.********.oceanbase.cloud.
  • The access port is 3306.
  • The name of the schema to access is test.
  • The tenant connection account is mysql001.
  • The password is ******.

Sample code:

<property name="hibernate.connection.driver_class">com.mysql.cj.jdbc.Driver</property>
<property name="hibernate.connection.url">jdbc:mysql://t5******.********.oceanbase.cloud:3306/test</property>
<property name="hibernate.connection.username">mysql001</property>
<property name="hibernate.connection.password">******</property>

Step 4: Run the java-oceanbase-hibernate project

Run the application

  1. Locate the TestHibernate.java file within the src > test > java directory of the project structure.
  2. In the tool menu bar, select Run (U) > Run > TestHibernate, or directly click the green triangle in the upper-right corner to run it.
  3. Use IDEA's console to view the project's log information and output results.

Output

User{id=2, name='update'}
User{id=3, name='user_insert3'}
User{id=4, name='user_insert4'}
User{id=5, name='user_insert5'}

FAQ

1. Connection timeout

If you encounter a connection timeout, you can configure the connection timeout parameter in the JDBC URL:

jdbc:mysql://host:port/database?connectTimeout=30000&socketTimeout=60000

2. Character set issues

To ensure correct character encoding, set the appropriate character set parameter in the JDBC URL:

jdbc:mysql://host:port/database?characterEncoding=utf8&useUnicode=true

3. SSL connection

To enable SSL connection with OceanBase Cloud, add the following parameter to the JDBC URL:

jdbc:mysql://host:port/database?useSSL=true&requireSSL=true

4. Special characters in account credentials

If the username or password contains special characters (such as #), they need to be URL-encoded:

String encodedPassword = URLEncoder.encode(password, "UTF-8");

Notice

When using MySQL Connector/J 8.x, ensure that the account credentials do not contain the number sign (#). Otherwise, you may encounter connection errors.

Sample project overview

Click java-oceanbase-hibernate to download the project code, which is a compressed file named java-oceanbase-hibernate.zip.

After decompressing it, you will get a folder named java-oceanbase-hibernate. The directory structure is as follows:

│--pom.xml
│
├─.idea
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─oceanbase
│  │  │          ├─dao
│  │  │          │   └─--UserDao.java
│  │  │          │
│  │  │          └─pojo
│  │  │              └─--User.java
│  │  │
│  │  └─resources
│  │      │--hibernate.cfg.xml
│  │      │
│  │      └─com
│  │          └─oceanbase
│  │              └─pojo
│  │                  └─--User.hbm.xml
│  │
│  └─test
│      └─java
│          └─--TestHibernate.java
│
└─target

File description:

  • pom.xml: The configuration file for the Maven project, containing information such as project dependencies, plugins, and builds.
  • .idea: A directory used by the IDE (Integrated Development Environment) to store project-related configuration information.
  • src: Typically denotes the directory that holds the project's source code.
  • main: The directory for storing the main source code and resource files.
  • java: The directory for storing Java source code.
  • com: The root directory for Java packages.
  • oceanbase: The root directory for the project.
  • dao: The directory for storing Data Access Object (DAO) packages, used to access databases or other data storage services.
  • UserDao.java: The user data access object, used for operations such as creating, reading, updating, and deleting user data.
  • User.java: The user persistence object, used to map fields from the user data table.
  • pojo: Plain Old Java Objects (POJOs), storing Java classes corresponding to database tables. Used to map database tables or other data storage structures.
  • resources: The directory for storing resource files, such as configuration files and SQL files.
  • hibernate.cfg.xml: The configuration file for Hibernate, used to configure basic parameters and set up information like the data source.
  • User.hbm.xml: The mapping file for the user persistence object, used to define the mapping relationship between the user persistence object and the user data table.
  • test: The directory for storing test code and resource files.
  • TestHibernate.java: The Java class for testing Hibernate.
  • target: The directory for storing compiled class files, JAR packages, and other files.

Introduction to pom.xml code

Note

If you just want to verify the example, use the default code without modification. You can also modify the pom.xml file according to your needs as described below.

The content of the pom.xml configuration file is as follows:

  1. The file declaration statement.

    Declares that this file is an XML file, using XML version 1.0 and character encoding UTF-8.

    Code:

    <?xml version="1.0" encoding="UTF-8"?>
    
  2. Configure the POM namespace and POM model version.

    1. Use xmlns to specify the POM namespace as http://maven.apache.org/POM/4.0.0.
    2. Use xmlns:xsi to specify the XML namespace as http://www.w3.org/2001/XMLSchema-instance.
    3. Use xsi:schemaLocation to specify the POM namespace, http://maven.apache.org/POM/4.0.0, and the location of its XSD file, http://maven.apache.org/xsd/maven-4.0.0.xsd.
    4. Use the <modelVersion> element to specify the POM model version used by this POM file as 4.0.0.

    Code:

    <project xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
    </project>
    
  3. Configure basic information.

    1. Use <groupId> to set the group ID to com.oceanbase.
    2. Use <artifactId> to set the artifact ID to java-oceanbase-hibernate.
    3. Use <version> to specify the project version as 1.0-SNAPSHOT.

    Code:

     <groupId>com.oceanbase</groupId>
     <artifactId>java-oceanbase-hibernate</artifactId>
     <version>1.0-SNAPSHOT</version>
    
  4. Define the project build process using <build>.

    1. Use <plugins> to specify the plugins configured in the project.
    2. Use <plugin> to specify a plugin to configure in the project.
    3. Use <groupId> to set the group ID to org.apache.maven.plugins.
    4. Use <artifactId> to set the artifact ID to maven-compiler-plugin.
    5. Use <configuration> to specify the parameters for the configured plugin.
    6. Use <source> to specify the compiler source code version as 8.
    7. Use <target> to specify the compiler target code version as 8.

    Code:

     <build>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <configuration>
                     <source>8</source>
                     <target>8</target>
                 </configuration>
             </plugin>
         </plugins>
     </build>
    
  5. Define the components on which the project depends using <dependencies>.

    1. Specify the dependency's organization as com.oceanbase, name as oceanbase-client, and version as 2.4.2.

      Sample code:

          <dependencies>
          <dependency>
              <groupId>com.oceanbase</groupId>
              <artifactId>oceanbase-client</artifactId>
              <version>2.4.2</version>
          </dependency>
          </dependencies>
      
    2. Specify the dependency's test framework as junit, name as junit, and version as 4.13.

      Sample code:

          <dependencies>
          <dependency>
              <groupId>junit</groupId>
              <artifactId>junit</artifactId>
              <version>4.13</version>
          </dependency>
          </dependencies>
      
    3. Specify the dependency's framework as org.hibernate, core library as hibernate-core, and version as 5.2.17.Final.

      Sample code:

      <dependencies>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-core</artifactId>
            <version>5.2.17.Final</version>
        </dependency>
      </dependencies>
      
    4. Specify the dependency's framework as org.hibernate, data source library as hibernate-c3p0, and version as 5.2.17.Final.

      Sample code:

      <dependencies>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-c3p0</artifactId>
            <version>5.2.17.Final</version>
        </dependency>
      </dependencies>
      

Introduction to User.hbm.xml

The User.hbm.xml file is a Hibernate mapping file that maps Java objects to tables in the database.

The code in the User.hbm.xml file mainly includes the following parts:

  1. File declaration statement.

    Declares this file as an XML file, using XML version 1.0 and character encoding UTF-8. It also specifies the DTD version and location for the Hibernate mapping file, setting the DTD document type to hibernate-mapping, version 3.0, language EN, and the file URL as http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd.

    Sample code:

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE hibernate-mapping PUBLIC
            "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
            "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
    
  2. Configuration of the mapping file.

    Defines a Hibernate mapping file to map the entity class named User to a database table named test_hibernate_mysql.

    1. Uses the package attribute to specify the Java package in the mapping file as com.oceanbase.pojo.
    2. Uses the class tag to map data from the database table. The name attribute specifies the Java class name as User, and the table attribute specifies the database table name as test_hibernate_mysql.
    3. Defines the primary key attribute using id. The name attribute specifies the member variable id of the Java class User, and the column attribute specifies the database field name as USER_ID.
    4. Defines the primary key generation strategy using generator. The class attribute specifies the primary key generator type as sequence. The param element specifies the sequence name in the database as SQ_USER. The name attribute specifies this attribute corresponds to the USER_NAME column in the database table and sets its data type to string.

    Sample code:

    <hibernate-mapping package="com.oceanbase.pojo">
    <class name="User" table="test_hibernate_mysql">
        <!-- Configure primary key generation strategy -->
        <id name="id" column="USER_ID">
            <generator class="sequence">
                <param name="sequence">SQ_USER</param>
            </generator>
        </id>
        <!-- Configuration Tables and Properties -->
        <property name="name" column="USER_NAME" type="string"/>
    </class>
    </hibernate-mapping>
    

Introduction to hibernate.cfg.xml

The hibernate.cfg.xml file is a configuration file for Hibernate, used to configure the running environment of Hibernate and the parameters for connecting to a database.

The code in the hibernate.cfg.xml file mainly includes the following parts:

  1. The document declaration statement.

    Declares that this file is an XML file, using XML version 1.0 and character encoding UTF-8. It also specifies the DTD version and location for the Hibernate configuration file, setting the DTD document type to hibernate-configuration, version 3.0, language EN, and the file URL as http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd.

    Code:

    <?xml version="1.0" encoding="utf-8"?>
    <!DOCTYPE hibernate-configuration PUBLIC
            "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
            "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
    
  2. Configure the configuration parameters.

    In the <hibernate-configuration> root element, use the <session-factory> element to set up Hibernate's session factory, which is responsible for creating and managing session objects. The session factory includes configurations such as the driver class name for connecting to the database, URL, username, and password, connection pool parameters, database dialect, SQL output and formatting, automatic creation of database tables, current session context, batch processing, and second-level caching.

    1. Configure database information.

      Configure the parameters for Hibernate to connect to the database, including the driver class name, URL, username, and password for connecting to the database.

      • Use hibernate.connection.driver_class to specify the database driver as com.mysql.cj.jdbc.Driver, used to establish a connection with OceanBase Cloud.
      • Use the hibernate.connection.url element to specify the database URL, including the database address, port number, and database name.
      • Use the hibernate.connection.username element to specify the username for connecting to the database.
      • Use the hibernate.connection.password element to specify the password for connecting to the database.

      Code:

          <property name="hibernate.connection.driver_class">com.mysql.cj.jdbc.Driver</property>
          <property name="hibernate.connection.url">jdbc:oceanbase://host:port/schema_name</property>
          <property name="hibernate.connection.username">user_name</property>
          <property name="hibernate.connection.password">******</property>
      
    2. Configure connection pool information.

      Configure the relevant parameters for the connection pool used by Hibernate. Specify the connection pool as C3P0. Parameter settings include the maximum and minimum number of connections in the pool, timeout period, maximum idle time for a connection, number of cached Statement objects, idle test time for a connection, number of connections acquired at once, and connection validation method.

      Note

      The following parameters are for reference only and do not represent a complete list of supported parameters. To configure other parameters, refer to the relevant documentation for more detailed parameter information.

      • Use hibernate.connection.provider_class to specify the connection pool as C3P0, which manages the creation and release of database connections.
      • Use hibernate.c3p0.max_size to specify the maximum number of connections in the pool as 60.
      • Use hibernate.c3p0.min_size to specify the minimum number of connections in the pool as 30.
      • Use hibernate.c3p0.checkoutTimeout to specify the timeout period for acquiring a connection from the pool as 30000 milliseconds.
      • Use hibernate.c3p0.timeout to specify the maximum idle time for a connection as 2000 milliseconds; connections exceeding this time will be closed.
      • Use hibernate.c3p0.max_statements to specify the maximum number of SQL statements cached in the pool as 100.
      • Use hibernate.c3p0.idle_test_period to specify the detection cycle for idle connections in the pool as 3000 milliseconds.
      • Use hibernate.c3p0.acquire_increment to specify the increment in the number of connections when the pool dynamically grows as 3.
      • Use hibernate.c3p0.validate to specify the connection validation method as true.

      Sample code:

      <property name="hibernate.connection.provider_class">org.hibernate.c3p0.internal.C3P0ConnectionProvider</property>
      <property name="hibernate.c3p0.max_size">60</property>
      <property name="hibernate.c3p0.min_size">30</property>
      <property name="hibernate.c3p0.checkoutTimeout">30000</property>
      <property name="hibernate.c3p0.timeout">20000</property>
      <property name="hibernate.c3p0.max_statements">100</property>
      <property name="hibernate.c3p0.idle_test_period">3000</property>
      <property name="hibernate.c3p0.acquire_increment">3</property>
      <property name="hibernate.c3p0.validate">true</property>
      
    3. Configure SQL interaction information. Configure information related to the connection between Hibernate and the database. This includes the database dialect, SQL printing and formatting, automatic table creation, the current session context, batch processing size, cache usage, and the loading of mapping files.

      • Use dialect to specify the database dialect as MySQL 5.7 to ensure compatibility with a specific database.
      • Use hibernate.show_sql to set whether to print SQL statements generated by Hibernate to the console.
      • Use hibernate.format_sql to set whether to format printed SQL statements.
      • Use hbm2ddl.auto to set automatic table creation.
      • Use current_session_context_class to specify the use of a thread-level current session context.
      • Use hibernate.jdbc.batch_size to set the batch processing size.
      • Use hibernate.cache.use_second_level_cache to set whether to enable the second-level cache.
      • Specify to load the mapping file com/oceanbase/pojo/User.hbm.xml.

      Sample code:

        <property name="dialect">org.hibernate.dialect.MySQL57Dialect</property>
        <property name="hibernate.show_sql">true</property>
        <property name="hibernate.format_sql">true</property>
        <property name="hbm2ddl.auto">create</property>
        <property name="current_session_context_class">thread</property>
        <property name="hibernate.jdbc.batch_size">10</property>
        <property name="hibernate.cache.use_second_level_cache">false</property>
        <mapping resource="com/oceanbase/pojo/User.hbm.xml"/>
      

Introduction to UserDao.java

The UserDao.java file uses a User Data Access Object (DAO) class to implement CRUD operations on user data via a Session object.

The code in the UserDao.java file mainly consists of the following parts:

  1. References to other classes and interfaces.

    Declares that this file contains the following interfaces and classes:

    • User class: used to manipulate user objects.
    • Session interface: used to interact with the database.
    • SessionFactory interface: used to create a Session instance.
    • Transaction class: used to manage database transactions.
    • Configuration class: used to load the Hibernate configuration file.
    • Query class: used to execute query operations.
    • List interface: used to manipulate query result sets.

    Code:

    import com.oceanbase.pojo.User;
    import org.hibernate.Session;
    import org.hibernate.SessionFactory;
    import org.hibernate.Transaction;
    import org.hibernate.cfg.Configuration;
    import org.hibernate.query.Query;
    import java.util.List;
    
  2. Definition of the UserDao class.

The UserDao Java class serves as a data access object for persisting user objects. It encapsulates a series of methods related to database interaction, performing CRUD operations on user objects. By calling the methods in the UserDao class, you can conveniently interact with the database and implement persistent operations.

  1. Initialization of a UserDao class instance.

    Uses an object initialization block to initialize a Session object during the class instantiation process.

    First, create a Configuration object and call its configure method to read the Hibernate configuration file (hibernate.cfg.xml). Then, call the buildSessionFactory method to create a SessionFactory object. Finally, call the openSession method to create a Session object and assign it to the session variable.

    Code:

    private Session session;
    {
        Configuration cfg = new Configuration().configure();
        // Create SessionFactory
        SessionFactory sessionFactory = cfg.buildSessionFactory();
        session = sessionFactory.openSession();
    } //Read the hibernate.cfg.xml file
    
  2. Querying corresponding user information by ID.

    Uses the selectUserById method to query corresponding user information based on the provided ID parameter.

    Uses the session object's get method to retrieve the User record with the specified ID from the database based on the passed User.class and ID parameters, and stores it in the user variable.

    Code:

    public User selectUserById(int ID) {
        User user = session.get(User.class, ID);
        return user;
    }
    
  3. Querying user information by username.

    Uses the selectUserbyName method to query user information by username. First, defines an HQL (Hibernate Query Language) statement to query user data with a specified name. The table name is test_hibernate_mysql, the table alias is u, and the query field name is name. Uses the Session object's createQuery method to create a Query object, passing the HQL statement and the entity class as parameters. Uses the Query object's setParameter method to set query parameters, where 0 indicates the position of the parameter and name indicates the value of the parameter. Uses the Query object's list method to execute the query and convert the query results into a list of User objects.

    Sample code:

    public List<User> selectUserbyName(String name) {
      String sql = "FROM test_hibernate_mysql u WHERE u.name =?";
      Query<User> query = session.createQuery(sql, User.class);
      query.setParameter(0, name);
      List<User> users = query.list();
      return users;
    }
    
  4. Query all user data.

    The selectUser method is used to query all user data. Define an SQL statement to query all user data. Use the createNativeQuery method of a Session object to create a Query object and pass the SQL statement as a parameter. Then, use the addEntity method to add the entity class User to the query so that the query result can be converted into a list of User objects. Execute the query using the getResultList method of the Query object and convert the query result into a list of User objects.

    Sample code:

    public List<User> selectUser() {
        String sql = "SELECT * FROM test_hibernate_mysql";
        Query<User> query = session.createNativeQuery(sql).addEntity(User.class);
        List<User> users = query.getResultList();
        return users;
    }
    
  5. Insert user data.

    The insertUser method is used to insert user information. Specify a parameter user of type User to pass the user object to be inserted. Create a transaction object by calling the beginTransaction method of the Hibernate Session and save it in the variable beginTransaction. Use the save method to persist the user object to the database. Obtain the current transaction by calling the getTransaction method of the Session and call the commit method to commit the transaction, persisting the previous operations to the database and returning the result of the insertion operation.

    Sample code:

    public int insertUser(User user) {
        // open transaction
        Transaction beginTransaction = session.beginTransaction();
        session.save(user);
        session.getTransaction().commit();
        return 1;
    }
    
  6. Delete user data.

    The deleteUserById method is used to delete the user record corresponding to the passed ID from the database. Specify an integer parameter id to pass the ID of the user to be deleted. Start a new transaction by calling the beginTransaction method of the Hibernate Session. Use the get method to obtain the corresponding user object based on the specified user ID and entity class type (User.class). Use the delete method to delete the user object. Obtain the current transaction by calling the getTransaction method of the Session and call the commit method to commit the transaction, persisting the deleted user information to the database and returning the result of the deletion operation.

    Sample code:

    public int deleteUserById(int id) {
        // open transaction
        session.beginTransaction();
        User user = session.get(User.class, id);
        session.delete(user);
        session.getTransaction().commit();
        return 1;
    }
    
  7. Modify user data.

    The updateUserById method is used to update the corresponding user information. Specify a parameter user of type User to specify the user data to be updated. Use the beginTransaction method of a Session object to start a transaction. Use the get method of a Session object to obtain the corresponding User object based on the user ID. Use the merge method of a Session object to merge the passed User object with the obtained User object, updating the passed user data to the database. Use the getTransaction method of a Session object to obtain the current transaction and call the commit method to commit the transaction, returning the result of the modification operation.

    Sample code:

    public int updateUserById(User user) {
        // open transaction
        session.beginTransaction();
        User user1 = session.get(User.class, user.getId());
        session.merge(user);
        session.getTransaction().commit();
        return 1;
    }
    

Introduction to User.java

The User.java file defines the user entity and its fields, constructors, and accessors.

The code in the User.java file mainly includes the following parts:

  1. References to other classes.

    Declare that this file uses JPA annotations to configure the mapping between related classes and database tables:

    • Column annotation: Identifies the correspondence between an attribute in the entity class and a column in the database table.
    • Entity annotation: Maps to a table in the database.
    • GeneratedValue annotation: Indicates that the value of the attribute is automatically generated.
    • GenerationType annotation: Specifies the primary key generation strategy.
    • Id annotation: Specifies the unique identifier attribute.
    • Table annotation: Indicates the table name corresponding to the entity class.

    Sample code:

    import javax.persistence.Column;
    import javax.persistence.Entity;
    import javax.persistence.GeneratedValue;
    import javax.persistence.GenerationType;
    import javax.persistence.Id;
    import javax.persistence.Table;
    
  2. Map a table in the database.

    Define an entity class that maps to a database table, and specify the table name corresponding to the entity class as test_hibernate_mysql.

    Sample code:

    @Entity
    @Table(name = "test_hibernate_mysql")
    
  3. Define the User class.

    Use it to map to a table named test_hibernate_mysql in the database.

    1. Define two attributes id and name. Use annotations to identify the correspondence between the id and name attributes in the User class and the columns in the database table. Use the @Id annotation to designate the id attribute as the primary key. Use the @GeneratedValue annotation to specify the sequence as the primary key generation strategy. Use the @Column annotation to specify the mapping between the attribute and the column in the database table. The id attribute stores the user ID, and the name attribute stores the username.

      Sample code:

      @Id
      @GeneratedValue(strategy = GenerationType.SEQUENCE)
      @Column(name = "user_id")
      private int id;
      
      @Column(name = "user_name")
      private String name;
      
    2. Create a User object.

      Define two constructors for the User class to create User objects. Define a no-argument constructor for Hibernate queries. Define a parameterized constructor to initialize the id and name attributes.

      Sample code:

      public User() {
      }
      
      public User(int id, String name) {
          this.id = id;
          this.name = name;
      }
      
    3. Get and set the values of id and name.

      Define four methods in the User class to get and set the values of the id and name attributes. The getId method retrieves the id value, and the setId method sets the id value. The getName method retrieves the value of the username name. The setName method sets the value of the username name.

      Sample code:

      public int getId() {
          return id;
      }
      
      public void setId(int id) {
          this.id = id;
      }
      
      public String getName() {
          return name;
      }
      
      public void setName(String name) {
          this.name = name;
      }
      
    4. Return a string representation of the User object.

      Override the toString method in the User class to return a string representation of the User object. Define @Override to override the method with the same name in the parent class. Define the toString method to return a string representation of the User object. Format the values of the id and name attributes into a string using string concatenation, and return it to the caller.

      Sample code:

      @Override
      public String toString() {
          return "User{" +
                  "id=" + id +
                  ", name='" + name + '\'' +
                  '}';
      }
      

Introduction to TestHibernate.java

The TestHibernate.java file demonstrates the basic database operation features of Hibernate by performing insert, delete, update, and query operations on UserDao objects.

The code in the TestHibernate.java file mainly includes the following parts:

  1. References to other classes and interfaces.

    Declare the classes and interfaces related to this file, including UserDao, User, Session, SessionFactory, Configuration, etc.

    • UserDao class: used to perform database operations related to users.
    • User class: used to manipulate user objects.
    • Session interface: used for session operations with the database.
    • SessionFactory interface: used to create Session objects.
    • Configuration class: used to configure Hibernate.
    • SessionImpl class: used to obtain the underlying JDBC connection.
    • Test annotation: used to mark test methods.
    • IOException class: used to handle I/O exceptions.
    • Connection class: used to obtain a JDBC connection.
    • SQLException class: used to handle SQL exceptions.
    • List interface: used to store query result sets.
    • UUID class: used to generate unique identifiers.

    Code:

    import com.oceanbase.dao.UserDao;
    import com.oceanbase.pojo.User;
    import org.hibernate.Session;
    import org.hibernate.SessionFactory;
    import org.hibernate.cfg.Configuration;
    import org.hibernate.internal.SessionImpl;
    import org.junit.Test;
    import java.io.IOException;
    import java.sql.Connection;
    import java.sql.SQLException;
    import java.util.List;
    import java.util.UUID;
    
  2. Define the testHibernate method. The testHibernate method includes basic operations such as insert, delete, update, and query. Create a UserDao object and insert five user records in a loop. Call the insertUser method to insert user data. Call the deleteUserById method to delete the user with id 1. Call the updateUserById method to update the user with id 2. Call the selectUser method to query all user data. Traverse the query results and print them to the console.

    Code:

    public class TestHibernate {
        @Test
        public void testHibernate() throws SQLException, IOException {
            UserDao userDao = new UserDao();
            for (int i = 1; i <= 5; i++) {
                userDao.insertUser(new User(i, "user_insert" + i));
            }
            int deleteUserById = userDao.deleteUserById(1);
            int update = userDao.updateUserById(new User(2, "update"));
            List<User> users = userDao.selectUser();
            users.forEach(System.out::println);
        }
    }
    

Complete sample code

pom.xml
User.hbm.xml
hibernate.cfg.xml
UserDao.java
User.java
TestHibernate.java
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.oceanbase</groupId>
    <artifactId>java-oceanbase-hibernate</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.27</version>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-core</artifactId>
            <version>5.2.17.Final</version>
        </dependency>
        <!-- Hibernate c3p0 connection pool-->
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-c3p0</artifactId>
            <version>5.2.17.Final</version>
        </dependency>

    </dependencies>

</project>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-mapping PUBLIC
        "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
        "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
<hibernate-mapping package="com.oceanbase.pojo">
    <class name="User" table="test_hibernate_mysql">
        <!-- Configure primary key generation strategy -->
        <id name="id" column="USER_ID">
            <generator class="sequence">
                <param name="sequence">SQ_USER</param>
            </generator>
        </id>
        <!-- Configuration Tables and Properties -->
        <property name="name" column="USER_NAME" type="string"/>
    </class>
</hibernate-mapping>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
        "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
        "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>

    <session-factory>
        <property name="hibernate.connection.driver_class">com.mysql.cj.jdbc.Driver</property>
        <property name="hibernate.connection.url">jdbc:mysql://host:port/schema_name</property>
        <property name="hibernate.connection.username">user_name</property>
        <property name="hibernate.connection.password">******</property>
        <property name="hibernate.connection.provider_class">org.hibernate.c3p0.internal.C3P0ConnectionProvider</property>
        <property name="hibernate.c3p0.max_size">60</property>
        <property name="hibernate.c3p0.min_size">30</property>

        <property name="hibernate.c3p0.checkoutTimeout">30000</property>
        <property name="hibernate.c3p0.timeout">20000</property>

        <property name="hibernate.c3p0.max_statements">100</property>
        <property name="hibernate.c3p0.idle_test_period">3000</property>
        <property name="hibernate.c3p0.acquire_increment">3</property>
        <property name="hibernate.c3p0.validate">true</property>

        <property name="dialect">org.hibernate.dialect.MySQL57Dialect</property>
        <property name="hibernate.show_sql">true</property>
        <property name="hibernate.format_sql">true</property>
        <property name="hbm2ddl.auto">create</property>
        <property name="current_session_context_class">thread</property>
        <property name="hibernate.jdbc.batch_size">10</property>
        <property name="hibernate.cache.use_second_level_cache">false</property>
        <mapping resource="com/oceanbase/pojo/User.hbm.xml"/>
    </session-factory>
</hibernate-configuration>
package com.oceanbase.dao;

import com.oceanbase.pojo.User;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.Transaction;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

import java.util.List;

public class UserDao {
    private Session session;
    {
        Configuration cfg = new Configuration().configure();
        // Create SessionFactory
        SessionFactory sessionFactory = cfg.buildSessionFactory();
        session = sessionFactory.openSession();
    } //Read the hibernate.cfg.xml file
//    private Session session = HibernateUtil.getSession();

    public User selectUserById(int ID) {
        User user = session.get(User.class, ID);
        return user;
    }

    public List<User> selectUserbyName(String name) {
        String sql = "FROM test_hibernate_mysql u WHERE u.name =?";
        Query<User> query = session.createQuery(sql, User.class);
        query.setParameter(0, name);
        List<User> users = query.list();
        return users;
    }

    public List<User> selectUser() {
        String sql = "SELECT * FROM test_hibernate_mysql";
        Query<User> query = session.createNativeQuery(sql).addEntity(User.class);
        List<User> users = query.getResultList();
        return users;
    }

    public int insertUser(User user) {
        // open transaction
        Transaction beginTransaction = session.beginTransaction();
        session.save(user);
        session.getTransaction().commit();
        return 1;
    }

    public int deleteUserById(int id) {
        // open transaction
        session.beginTransaction();
        User user = session.get(User.class, id);
        session.delete(user);
        session.getTransaction().commit();
        return 1;
    }

    public int updateUserById(User user) {
        // open transaction
        session.beginTransaction();
        User user1 = session.get(User.class, user.getId());
        session.merge(user);
        session.getTransaction().commit();
        return 1;
    }

}
package com.oceanbase.pojo;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name = "test_hibernate_mysql")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE)
    @Column(name = "user_id")
    private int id;

    @Column(name = "user_name")
    private String name;

    public User() {
    }

    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}
import com.oceanbase.dao.UserDao;
import com.oceanbase.pojo.User;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
import org.hibernate.internal.SessionImpl;
import org.junit.Test;

import java.io.IOException;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.List;
import java.util.UUID;

public class TestHibernate {
    @Test
    public void testHibernate() throws SQLException, IOException {
        UserDao userDao = new UserDao();
        for (int i = 1; i <= 5; i++) {
            userDao.insertUser(new User(i, "user_insert" + i));
        }
        int deleteUserById = userDao.deleteUserById(1);
        int update = userDao.updateUserById(new User(2, "update"));
        List<User> users = userDao.selectUser();
        users.forEach(System.out::println);
    }
}

References

For more information about OceanBase Connector/J, see OceanBase JDBC Driver

Previous topic

Sample application for connecting to OceanBase Cloud using Spring Data JPA
Last

Next topic

Sample application for connecting to OceanBase Cloud using MyBatis
Next
on this page
Prerequisites
Procedure
Step 1: Obtain the connection string of the OceanBase Cloud database
Step 2: Import the java-oceanbase-hibernate project into IDEA
Step 3: Modify the database connection information in the java-oceanbase-hibernate project
Step 4: Run the java-oceanbase-hibernate project
FAQ
1. Connection timeout
2. Character set issues
3. SSL connection
4. Special characters in account credentials
Sample project overview
Introduction to pom.xml code
Introduction to User.hbm.xml
Introduction to hibernate.cfg.xml
Introduction to UserDao.java
Introduction to User.java
Introduction to TestHibernate.java
Complete sample code
References