OceanBase logo

OceanBase

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

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

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

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

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

About OceanBase

Partner

Trust Center

Contact Us

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

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

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

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

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

Practical guides for utilizing OceanBase more effectively and conveniently

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

About OceanBase

Partner

Trust Center

Contact Us

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

OceanBase Cloud

  • Product Updates & Announcements
    • What's new
      • Release notes for 2026
      • Release notes for 2025
      • Release notes for 2024
      • Release history
    • Product announcements
      • Data development module deprecation notice
      • Optimization of Backup and Restore commercialization strategy
      • Cross-AZ data transfer billing (OceanBase Cloud on AWS)
      • Database Proxy pricing update
      • AWS instance pricing adjustment
  • Product Introduction
    • Overview
    • Management mode and scenarios
    • Core features
      • High availability with cross-cloud active-active architecture
      • High availability with cross-cloud primary-standby databases
      • Multi-level caching in shared storage
      • Multi-layer online scaling and on-demand adjustment
    • Deployment modes
    • Storage architecture
    • Product specifications
    • Product billing
      • Overview
      • Instance billing
        • Tencent Cloud instance billing
        • Alibaba Cloud instance billing
        • Huawei Cloud instance billing
        • AWS instance billing
        • GCP instance billing
      • Backup and restore billing
      • SQL audit billing
      • Migrations billing
      • Database proxy billing
      • Binlog service billing
      • Overview of OceanBase Cloud support plans
      • Read-only replica billing
    • Supported database versions
  • Get Started
    • Get started with a transactional instance
    • Get started with an analytical instance
    • Get started with a Key-Value instance
  • Work with Transactional Instances
    • Overview
    • Create an instance
      • Overview
      • Create via OceanBase Cloud official website
      • Create via AWS Marketplace
      • Create via GCP Marketplace
      • Create via Huawei Cloud Marketplace
      • Create via Alibaba Cloud Marketplace
      • Create via Azure Marketplace
    • Connect to an instance
      • MySQL compatible mode
        • Overview
        • Get connection string
          • Overview
          • Connect using AWS PrivateLink
          • Connect using Azure Private Link
          • Connect using Google Cloud Private Service Connect
          • Connect using Huawei Cloud VPC Endpoint
          • Connect using Alibaba Cloud VPC
          • Connect using a public IP address
          • Connect using a Huawei Cloud peering connection
        • Connect with clients
          • Connect to OceanBase Cloud by using Client ODC
          • Connect to OceanBase Cloud by using a MySQL client
          • Connect to OceanBase Cloud by using OBClient
        • Connect with drivers
          • Java
            • Connect to OceanBase Cloud using SpringBoot
            • SpringBatch sample application for connecting to OceanBase Cloud
            • spring-jdbc
            • SpringDataJPA sample application for connecting to OceanBase Cloud
            • Hibernate application development with OceanBase Cloud
            • Sample program for connecting to OceanBase Cloud
            • connector-j
            • Use TestContainers to connect to and use OceanBase Cloud
          • Python
            • Connect to OceanBase Cloud using mysqlclient
            • Connect to OceanBase Cloud using PyMySQL
            • Use the MySQL-connector-python driver to connect to and use OceanBase Cloud
            • Use SQLAlchemy to connect to an OceanBase Cloud database
            • Connect to an OceanBase Cloud database using Django
            • Connect to an OceanBase Cloud database by using peewee
          • C
            • Use MySQL Connector/C to connect to OceanBase Cloud
          • Go
            • Connect to OceanBase Cloud using the Go-SQL-Driver/MySQL driver
            • Connect to OceanBase Cloud using GORM
          • PHP
            • Use the EXT driver to connect to OceanBase Cloud
            • Connect to OceanBase Cloud by using the MySQLi driver
            • Use the PDO driver to connect to OceanBase Cloud
          • Rust
            • Rust application example for connecting to OceanBase Cloud
            • SeaORM example for connecting to OceanBase Cloud
          • ruby
            • ActiveRecord sample application for OceanBase Cloud
            • Connect to OceanBase Cloud by using mysql2
            • Connect to OceanBase Cloud by using Sequel
        • Use database connection pool
          • Database connection pool configuration
          • Connect to OceanBase Cloud by using a Tomcat connection pool
          • Connect to OceanBase Cloud by using a C3P0 connection pool
          • Connect to OceanBase Cloud by using a Proxool connection pool
          • Connect to OceanBase Cloud by using a HikariCP connection pool
          • Connect to OceanBase Cloud by using a DBCP connection pool
          • Connect to OceanBase Cloud by using Commons Pool
          • Connect to OceanBase Cloud by using a Druid connection pool
      • Oracle compatible mode
        • Overview
        • Get connection string
          • Overview
          • Connect using AWS PrivateLink
          • Connect using Azure Private Link
          • Connect using Google Cloud Private Service Connect
          • Connect using Huawei Cloud VPC Endpoint
          • Connect using a public IP address
        • Connect with clients
          • Connect to OceanBase Cloud by using OBClient
          • Connect to OceanBase Cloud by using Client ODC
        • Connect with drivers
          • Java
            • Connect to OceanBase Cloud using OceanBase Connector/J
            • Connect to OceanBase Cloud by using Spring Boot
            • SpringBatch application example for connecting to OceanBase Cloud
            • Connect to OceanBase Cloud using Spring JDBC
            • Connect to OceanBase Cloud by using Spring Data JPA
            • Connect to OceanBase Cloud by using Hibernate
            • Use MyBatis to connect to OceanBase Cloud
            • Use JFinal to connect to OceanBase Cloud
          • Python
            • Python Driver for Oracle Mode
          • C
            • Connect to OceanBase Cloud using OceanBase Connector/C
            • Connect to OceanBase Cloud using OceanBase Connector/ODBC
            • Use SqlSugar to connect to OceanBase Cloud
        • Use database connection pool
          • Database connection pool configuration
          • Sample program that uses a Tomcat connection pool to connect to OceanBase Cloud
          • C3P0 connection pool connects to OceanBase Cloud
          • Connect to OceanBase Cloud using Proxool connection pool
          • Sample program that uses HikariCP to connect to OceanBase Cloud
          • Use DBCP connection pool to connect to OceanBase Cloud
          • Connect to OceanBase Cloud by using Commons Pool
          • Connect to OceanBase Cloud by using a Druid connection pool
    • Developer guide
      • MySQL compatible mode
        • Plan database objects
          • Create a database
          • Create a table group
          • Create a table
          • Create an index
          • Create an external table
        • Write data
          • Insert data
          • Update data
          • Delete data
          • Replace data
          • Generate test data in batches
        • Read data
          • Single-table queries
          • Join tables
            • INNER JOIN queries
            • FULL JOIN queries
            • LEFT JOIN queries
            • RIGHT JOIN queries
            • Subqueries
            • Lateral derived tables
          • Use operators and functions in queries
            • Use arithmetic operators in queries
            • Use numerical functions in queries
            • Use string concatenation operators in queries
            • Use string functions in queries
            • Use datetime functions in queries
            • Use type conversion functions in queries
            • Use aggregate functions in queries
            • Use NULL-related functions in queries
            • Use the CASE conditional operator in queries
            • Use the SELECT ... FOR UPDATE statement to lock query results
            • Use the SELECT ... LOCK IN SHARE MODE statement to lock query results
          • Use a DBLink in queries
          • Set operations
        • Manage transactions
          • Overview
          • Start a transaction
          • Savepoints
            • Mark a savepoint
            • Roll back a transaction to a savepoint
            • Release a savepoint
          • Commit a transaction
          • Roll back a transaction
      • Oracle compatible mode
        • Plan database objects
          • Create a table group
          • Create a table
          • Create an index
          • Create an external table
        • Write data
          • Insert data
          • Update data
          • Delete data
          • Replace data
          • Generate test data in batches
        • Read data
          • Single-table queries
          • Join tables
            • INNER JOIN queries
            • FULL JOIN queries
            • LEFT JOIN queries
            • RIGHT JOIN queries
            • Subqueries
            • Lateral derived tables
          • Use operators and functions in queries
            • Use arithmetic operators in queries
            • Use numerical functions in queries
            • Use string concatenation operators in queries
            • Use string functions in queries
            • Use datetime functions in queries
            • Use type conversion functions in queries
            • Use aggregate functions in queries
            • Use NULL-related functions in queries
            • Use CASE functions in queries
            • Use the SELECT ... FOR UPDATE statement to lock query results
          • Use a DBLink in queries
          • Set operations
        • Manage transactions
          • Overview
          • Start a transaction
          • Savepoints
            • Mark a savepoint
            • Roll back a transaction to a savepoint
          • Commit a transaction
          • Roll back a transaction
    • Manage instances
      • Manage instances
        • View the instance list
        • Instance overview
        • Stop and restart instances
        • Unit migration
      • Manage tenants
        • Tenant overview
        • Create a tenant
        • Modify tenant specifications
        • Modify tenant names
        • Add an endpoint
        • Resource isolation
          • Overview
          • Manage resource groups
            • Create a resource group
            • View a resource group
            • Edit a resource group
            • Delete a resource group
          • Manage isolation rules
            • Create an isolation rule
            • View isolation rules
            • Edit an isolation rule
            • Delete a quarantine rule
        • Modify primary zone
        • Modify the maximum number of connections for a tenant proxy
        • Monitor tenant performance
          • Overview
          • View performance and SQL monitoring details
          • View transaction monitoring details
          • View storage and cache monitoring details
          • View Binlog service monitoring
          • Customize a monitoring dashboard for a tenant
        • Diagnostics
          • Real-time diagnostics
            • SQL diagnostics
              • Top SQL
              • Slow SQL
              • Suspicious SQL
              • High-risk SQL
            • SQL audit
        • Manage tenant parameters
          • Manage tenant parameters
          • Parameters for tenants
          • Parameter template overview
        • Delete a tenant
        • Manage databases and accounts
          • Create accounts
          • Manage accounts
          • Create a database (MySQL compatible mode)
          • Manage databases (MySQL compatible mode)
      • Monitor instance performance
        • Overview
        • Monitor the performance of databases in an instance
        • Monitor multidimensional metrics of an instance
        • Monitor the performance of hosts in an instance
        • Monitor database proxy
        • Monitor database proxy hosts
        • Monitor cross-cloud network performance
        • Customize a monitoring dashboard for an instance
      • Manage major compactions
        • Initiate a major compaction
        • View compaction records
        • Update time for compactions
      • Manage instance parameters
        • Manage parameters
        • Parameters for cluster instances
      • Change instance configurations
        • Enable storage auto-scaling
        • View history of configuration changes
        • Change configuration
        • Change configuration temporarily
        • Switch the deployment mode
      • Manage standby instances
        • Overview
        • Create a standby instance
        • Create a cross-cloud standby instance
        • Create a standby instance for an Alibaba Cloud primary instance
        • View details of primary and standby instances
        • Configure global endpoint
        • Enable automatic forwarding for write requests of standby databases
        • Primary-standby instance switchover
        • Initiate failover
        • Detach a standby instance
        • Release a standby instance
      • Release an instance
      • Database proxy
        • Overview
        • Manage database proxy
        • Direct load
      • Manage alerts
        • Overview
        • Manage alert rules
          • Create an alert rule
          • View an alert rule
          • Edit an alert rule
          • Delete an alert rule
        • View alert history
        • Manage alert templates
          • Create an alert template
          • View an alert template
          • Edit an alert template
          • Copy an alert rule template
          • Delete an alert template
        • Manage muting rules
          • Create an alert muting rule
          • View an alert muting rule
          • Edit an alert muting rule
          • Delete an alert muting rule
        • Manage alert notification templates
          • Create an alert notification template
          • View an alert notification template
          • Edit an alert notification template
          • Copy an alert notification template
          • Delete an alert notification template
        • Manage alert contacts
          • Add an alert contact
          • Add an alert contact group
          • View an alert contact
          • Edit an alert contact
          • Delete an alert contact
          • Obtain a webhook URL
        • Monitoring metrics for alerts
      • Backup and restore
        • Overview
        • Backup strategy
        • Initiate a backup immediately
        • Data backup
        • Initiate a restore
        • Data restore
        • Restore data from the instance recycle bin
      • Diagnostics
        • View performance monitoring data
        • Capacity diagnostics
        • One-click diagnostics
          • Initiate one-click diagnostics
          • View one-click diagnostic report
            • Exceptions
            • Real-time diagnostics
            • Optimization suggestions
            • Capacity management
            • Security management
        • Real-time diagnostics
          • SQL diagnostics
            • Top SQL
            • Slow SQL
            • Suspicious SQL
            • High-risk SQL
            • SQL details
            • SQL monitoring metrics list
          • Session management
            • Session management
          • Request analysis
            • Request analysis
        • Root cause diagnostics
          • Exception handling
          • Enable system autonomy
        • SQL audit
        • Materialized view analysis
        • Optimization center
          • Optimization suggestions
          • Manage active outlines
          • SQL review
          • View the optimization history
      • Manage tags
      • Manage read-only replicas
        • Overview
        • Instance read-only replicas
          • Add a read-only replica to an instance
          • View read-only replicas of an instance
          • Manage read-only replicas of an instance
          • Delete a read-only replica of an instance
        • Tenant read-only replicas
          • Add a read-only replica to a tenant
          • View read-only replicas of a tenant
          • Manage read-only replicas of a tenant
          • Delete a read-only replica of a tenant
      • Manage JVM-dependent services
    • Data source management
      • Create a data source
      • Manage data sources
      • User privileges
        • User privileges for compatibility assessment
        • User privileges for data migration
        • User privileges for performance assessment
        • User privileges for data archiving
        • User privileges for data cleanup
      • Connect via private network
        • AWS
        • Huawei Cloud
        • Alibaba Cloud
        • Google Cloud
        • Azure
        • Private IP address segments
      • Connect via public network
        • AWS
        • Huawei Cloud
        • Alibaba Cloud
        • Google Cloud
        • Azure
    • Data lifecycle management
      • Archive data
      • Clean up data
    • Manage recycle Bin
      • Instance recycle bin
      • Manage databases and tables in recycle bin
        • Overview
        • Instance-level recycle bin
        • Tenant-level recycle bin
  • Work with Analytical Instances
    • Overview
    • Core features
    • Create an instance
    • Connect to an instance
      • Overview
      • Get connection string
        • Overview
        • Connect using AWS PrivateLink
        • Connect using a public IP address
      • Connect with clients
        • Connect to OceanBase Cloud by using Client ODC
        • Connect to OceanBase Cloud by using a MySQL client
        • Connect to OceanBase Cloud by using OBClient
      • Connect with drivers
        • Java
          • Connect to OceanBase Cloud by using Spring Boot
          • Connect to OceanBase Cloud by using Spring Batch
          • Connect to OceanBase Cloud by using Spring Data JDBC
          • Connect to OceanBase Cloud by using Spring Data JPA
          • Connect to OceanBase Cloud by using Hibernate
          • Connect to OceanBase Cloud by using MyBatis
          • Connect to OceanBase Cloud using MySQL Connector/J
        • Python
          • Connect to OceanBase Cloud by using mysqlclient
          • Connect to OceanBase Cloud by using PyMySQL
          • Connect to OceanBase Cloud using MySQL Connector/Python
        • C
          • Connect to OceanBase Cloud using MySQL Connector/C
        • Go
          • Connect to OceanBase Cloud using Go-SQL-Driver/MySQL
        • PHP
          • Connect to OceanBase Cloud using PHP
      • Use database connection pool
        • Database connection pool configuration
        • Connect to OceanBase Cloud by using a Tomcat connection pool
        • Connect to OceanBase Cloud by using a C3P0 connection pool
        • Connect to OceanBase Cloud by using a Proxool connection pool
        • Connect to OceanBase Cloud by using a HikariCP connection pool
        • Connect to OceanBase Cloud by using a DBCP connection pool
        • Connect to OceanBase Cloud by using Commons Pool
        • Connect to OceanBase Cloud by using a Druid connection pool
    • Data table design
      • Table overview
      • Best practices
        • Unit 1: Best practices for optimizing storage structures and query performance
        • Unit 2: Best practices for creating special indexes
    • Export data
    • OceanBase data processing
    • Query acceleration
      • Statistics
      • Materialized views for query acceleration
      • Select a query parallelism level
    • Manage instances
      • Instance overview
      • Change configuration
      • Modify primary zone
      • Manage parameters
      • Backup and restore
        • Backup overview
        • Backup strategies
        • Immediate backup
        • Data backup
        • Initiate restore
        • Data restore
      • Monitor instance performance
        • Overview
        • Monitor the performance of databases in an instance
        • Monitor the performance of hosts in an instance
      • Manage major compactions
        • Initiate a major compaction
        • View compaction records
        • Update time for compactions
      • Database proxy
        • Overview
        • Manage database proxy
        • Direct load
      • Manage alerts
        • Overview
        • Manage alert rules
          • Create an alert rule
          • View an alert rule
          • Edit an alert rule
          • Delete an alert rule
        • View alert history
        • Manage alert templates
          • Create an alert template
          • View an alert template
          • Edit an alert template
          • Copy an alert template
          • Delete an alert template
        • Manage muting rules
          • Create an alert muting rule
          • View an alert muting rule
          • Edit an alert muting rule
          • Delete an alert muting rule
        • Manage alert notification templates
          • Create an alert notification template
          • View an alert notification template
          • Edit an alert notification template
          • Copy an alert notification template
          • Delete an alert notification template
        • Manage alert contacts
          • Add an alert contact
          • Add an alert contact group
          • View an alert contact
          • Edit an alert contact
          • Delete an alert contact
          • Obtain a webhook URL
        • Monitoring metrics for alerts
      • Diagnostics
        • View performance monitoring data
        • Capacity diagnostics
        • Real-time diagnostics
          • SQL diagnostics
            • Top SQL
            • Slow SQL
            • Suspicious SQL
            • High-risk SQL
            • SQL details
            • SQL monitoring metrics list
          • Session management
            • Session management
          • Optimization management
            • Manage active outlines
            • View the optimization history
          • Request analysis
            • Request analysis
      • Stop and restart instances
      • Release instances
      • Manage databases and accounts
        • Create and manage accounts
        • Create a database
        • Manage databases
      • Manage tags
    • Data lifecycle management
      • Archive data
      • Clean up data
    • Performance diagnosis and tuning
      • Use the DBMS_XPLAN package for performance diagnostics
      • Use the GV$SQL_PLAN_MONITOR view for performance analysis
      • Views related to AP performance analysis
    • Performance testing
    • Product integration
    • Manage recycle Bin
      • View instance recycle bin
      • Manage databases and tables in recycle bin
        • Overview
        • Instance recycle bin
  • Work with Key-Value Instances
    • Try out Key-Value instances
      • Create an instance
      • Create a tenant
      • Create an account for a database user
      • OBKV HBase data operation examples
    • Use Table model
      • Create an instance
      • Manage instances
        • Manage instances
          • View the instance list
          • Instance overview
          • Stop and restart instances
          • Release an instance
        • Manage tenants
          • Create a tenant
          • Modify tenant specifications
          • Modify tenant names
          • Delete a tenant
          • Tenant overview
          • Resource isolation
            • Overview
            • Manage resource groups
              • Create a resource group
              • View a resource group
              • Edit a resource group
              • Delete a resource group
            • Manage isolation rules
              • Create an isolation rule
              • View isolation rules
              • Edit an isolation rule
              • Delete a quarantine rule
          • Monitor tenant performance
            • Overview
            • View performance and SQL monitoring details
            • View transaction monitoring details
            • View storage and cache monitoring details
            • OBKV-Table
            • Customize a monitoring dashboard for a tenant
          • Diagnostics
            • Top SQL
          • Manage tenant parameters
            • Manage tenant parameters
            • Parameters for tenants
          • Manage databases and accounts
            • Create and manage accounts
            • Create a database
            • Manage databases
          • Switch primary zone
        • Monitor instance performance
          • Overview
          • Monitor the performance of databases in an instance
          • Monitor multi-dimensional metrics of an instance
          • Monitor the performance of hosts in a cluster
          • Customize monitoring dashboards for an instance
        • Manage major compactions
          • Initiate major compactions
          • View compaction records
          • Update time for compactions
        • Manage instance parameters
          • Parameter management overview
          • Parameters for cluster instances
        • Change instance configurations
          • View history of configuration changes
          • Change configuration
          • Switch the deployment mode
        • Database proxy
          • Overview
          • Manage database proxy
        • Manage alerts
          • Overview
          • Manage alert rules
            • Create an alert rule
            • View an alert rule
            • Edit an alert rule
            • Delete an alert rule
          • View alert history
          • Manage alert templates
            • Create an alert template
            • View an alert template
            • Edit an alert template
            • Copy an alert template
            • Delete an alert template
          • Manage muting rules
            • Create an alert muting rule
            • View an alert muting rule
            • Edit an alert muting rule
            • Delete an alert muting rule
          • Manage alert contacts
            • Add an alert contact
            • Add an alert contact group
            • View an alert contact
            • Edit an alert contact
            • Delete an alert contact
            • Obtain a webhook URL
          • Monitoring metrics for alerts
        • Backup and restore
          • Backup overview
          • Backup strategies
          • Immediate backup
          • Data backup
          • Initiate restore
          • Data restore
        • Diagnostics
          • View performance monitoring data
          • Top SQL
          • Capacity diagnostics
          • Request analysis
        • Manage tags
        • Manage recycle Bin
          • View instance recycle bin
          • Manage databases and tables in recycle bin
            • Overview
            • Instance-level recycle bin
            • Tenant-level recycle bin
    • Use HBase model
      • OBKV-HBase Overview
      • Create an instance
      • Develop in HBase model
        • Connect to an instance by using the OBKV-HBase client
      • Manage instances
        • Manage instances
          • View the instance list
          • Instance overview
          • Stop and restart instances
          • Release an instance
        • Manage tenants
          • Create a tenant
          • Modify tenant specifications
          • Modify tenant names
          • Delete a tenant
          • Tenant overview
          • Resource isolation
            • Overview
            • Manage resource groups
              • Create a resource group
              • View a resource group
              • Edit a resource group
              • Delete a resource group
            • Manage isolation rules
              • Create an isolation rule
              • View isolation rules
              • Edit an isolation rule
              • Delete a quarantine rule
          • Monitor tenant performance
            • Overview
            • View performance and SQL monitoring details
            • View transaction monitoring details
            • View storage and cache monitoring details
            • OBKV-HBase
            • Customize a monitoring dashboard for a tenant
          • Diagnostics
            • Top SQL
          • Manage tenant parameters
            • Manage tenant parameters
            • Parameters for tenants
          • Manage databases and accounts
            • Create and manage accounts
            • Create a database
            • Manage databases
          • Switch primary zone
        • Monitor instance performance
          • Overview
          • Monitor the performance of databases in an instance
          • Monitor multi-dimensional metrics of an instance
          • Monitor the performance of hosts in a cluster
          • Customize monitoring dashboards for an instance
        • Manage major compactions
          • Initiate major compactions
          • View compaction records
          • Update time for compactions
        • Manage instance parameters
          • Parameter management overview
          • Parameters for cluster instances
        • Change instance configurations
          • View history of configuration changes
          • Change configuration
          • Switch the deployment mode
        • Database proxy
          • Overview
          • Manage database proxy
        • Manage alerts
          • Overview
          • Manage alert rules
            • Create an alert rule
            • View an alert rule
            • Edit an alert rule
            • Delete an alert rule
          • View alert history
          • Manage alert templates
            • Create an alert template
            • View an alert template
            • Edit an alert template
            • Copy an alert template
            • Delete an alert template
          • Manage muting rules
            • Create an alert muting rule
            • View an alert muting rule
            • Edit an alert muting rule
            • Delete an alert muting rule
          • Manage alert contacts
            • Add an alert contact
            • Add an alert contact group
            • View an alert contact
            • Edit an alert contact
            • Delete an alert contact
            • Obtain a webhook URL
          • Monitoring metrics for alerts
        • Backup and restore
          • Backup overview
          • Backup strategies
          • Immediate backup
          • Data backup
          • Initiate restore
          • Data restore
        • Diagnostics
          • View performance monitoring data
          • Top SQL
          • Capacity diagnostics
          • Request analysis
        • Manage tags
        • Manage recycle Bin
          • View instance recycle bin
          • Manage databases and tables in recycle bin
            • Overview
            • Instance-level recycle bin
            • Tenant-level recycle bin
      • Performance test
    • Connect Key-Value instances
      • Overview
      • Connect using a public IP address
  • Migrations
    • Data migration and import solutions
    • Data assessment and migration quick start
    • Assess compatibility
      • Overview
      • Perform online assessment
      • Perform offline assessment
      • Manage compatibility assessment tasks
        • View a compatibility assessment task
        • View and download a compatibility assessment report
        • Stop a compatibility assessment task
        • Delete a compatibility assessment task
      • Obtain files for upload
      • Configure PrivateLink
      • Add an IP address to an allowlist
    • Migrate data
      • Overview
      • Migrations specification
      • Purchase a data migration instance
      • Migrate data from a MySQL database to a MySQL-compatible tenant of OceanBase Database
      • Migrate data from a MySQL-compatible tenant of OceanBase Database to a MySQL database
      • Migrate data between OceanBase database tenants of the same compatibility mode
      • Migrate data between OceanBase database tenants of different compatibility modes
      • Migrate data from an Oracle database to an Oracle-compatible tenant of OceanBase Database
      • Migrate data from an Oracle-compatible tenant of OceanBase Database to an Oracle database
      • Configure a two-way synchronization task
      • Migrate data from an OceanBase database to a Kafka instance
      • Migrate data from a TiDB database to a MySQL-compatible tenant of OceanBase Database
      • Migrate incremental data from a MySQL-compatible tenant of OceanBase Database to a TiDB Database
      • Migrate data from a PostgreSQL database to an OceanBase database
      • Migrate incremental data from an OceanBase Database to a PostgreSQL database
      • Manage data migration tasks
        • View details of a data migration task
        • Rename a data migration task
        • View and modify migration objects
        • View and modify migration parameters
        • Configure alert monitoring
        • Manage data migration tasks by using tags
        • Start, stop, and resume a data migration task
        • Clone a data migration task
        • Terminate and release a data migration task
      • Features
        • Custom DML/DDL configurations
        • DDL synchronization scope
        • Use SQL conditions to filter data
        • Rename a migration object
        • Set an incremental synchronization timestamp
        • Instructions on schema migration
        • Configure and modify matching rules
        • Wildcard rules
        • Import migration objects
        • Download conflict data
        • Change a topic
        • Column filtering
        • Data formats
      • Authorize an Alibaba Cloud account
      • SQL statements for querying table objects
      • Online DDL tools
      • Create a trigger
      • Modify the log level of a self-managed PostgreSQL instance
      • Supported DDL statements for synchronization and their limitations
        • DDL synchronization from Aurora MySQL DB clusters to MySQL-compatible tenants of OceanBase Database
        • DDL synchronization from MySQL-compatible tenants of OceanBase Database to Aurora MySQL DB clusters
        • DDL synchronization between MySQL-compatible tenants of OceanBase Database
        • DDL synchronization from Oracle databases to Oracle-compatible tenants of OceanBase Database
        • DDL synchronization from Oracle-compatible tenants of OceanBase Database to Oracle databases
        • DDL synchronization between Oracle-compatible tenants of OceanBase Database
        • DDL synchronization from OceanBase databases to Kafka instances
    • Data subscription
      • Create a data subscription task
      • Manage data subscription tasks
        • View details of a data subscription task
        • Configure subscription information
        • Modify the name of a data subscription task
        • View and modify subscription objects
        • View data subscription parameters
        • Set up data subscription alerts
        • Start, stop, and resume data subscription tasks
        • Clone a data subscription task
        • Release a data subscription task
      • Manage private connections for data subscriptions
      • Configure consumer subscription
      • Message formats
    • Data validation
      • Overview
      • Create a data validation task
      • Manage data validation tasks
        • View details of a data validation task
        • View and modify validation objects
        • View and modify validation parameters
        • Manage data validation tasks with tags
        • Start, pause, and resume data validation tasks
        • Clone a data validation task
        • Release a data validation task
      • Features
        • Import validation objects
        • Rename the validation object
        • Filter objects by using SQL conditions
        • Configure the matching rules for the validation object
    • Assess performance
      • Overview
      • Obtain traffic files from a database instance
      • Create a full performance assessment task
      • Create an SQL file parsing task
      • Create an SQL file replay task
      • Manage performance assessment tasks
        • View the details of a performance assessment task
        • View a performance assessment report
        • Retry and stop a performance assessment task
        • Delete a performance assessment task
      • Obtain a database instance
      • Create an access key
    • Import data
      • Import data
      • Direct load
      • Supported file formats and encoding formats for Data Import
      • Sample data introduction
    • Binlog service
      • Overview
      • Purchase the Binlog service
      • Manage Binlog Service
        • View details of the Binlog service
        • Change configuration
        • Modify the auto-scaling strategy for storage space
        • Modify the elasticity strategy for compute units
        • Disable the Binlog service
  • Security
    • OceanBase Cloud account settings
      • Modify login password
      • Multi-factor authentication
      • Manage AccessKeys
      • Time zone settings
      • Manage cloud marketplace accounts
      • Account audit
    • Organizations and projects
      • Overview
      • Manage organization information
      • Project management
        • Manage projects
        • Cross-project bidirectional authorization
        • Subscribe to project messages
      • Manage members
      • Permissions for roles
      • Cost management
        • Overview
        • Cost details
        • Manage cost units
      • Operation audit
    • Database accounts and privileges
      • Account privileges
      • Authorize cloud vendor accounts
      • AWS KMS key management
      • Support access control
    • Security and encryption
      • Set allowlist groups
      • SSL encryption
      • Transparent Data Encryption (TDE)
    • Monitoring dashboard
    • Events
  • SQL Console
    • Overview
    • Access SQL Console
    • SQL editing and execution
    • PL compilation
    • Result set editing
    • Execution analysis
    • Database object management
      • Create a table
      • Create a view
      • Create a function
      • Create a stored procedure
      • Create a program package
      • Create a trigger
      • Create a type
      • Create a sequence
      • Create a synonym
    • Session variable management
    • Functional keys in SQL Console
  • Integrations
    • Overview
    • Schema evolution
      • Liquibase
      • Flyway
    • Data ingestion
      • Canal
      • dbt
      • Debezium
      • Flink
      • Glue
      • Informatica Cloud
      • Kafka
      • Maxwell
      • SeaTunnel
      • DataWorks
      • NiFi
    • SQL development
      • DataGrip
      • DBeaver
      • Navicat
      • TablePlus
    • Orchestration
      • DolphinScheduler
      • Linkis
      • Airflow
    • Visualization
      • Grafana
      • Power BI
      • Quick BI
      • Superset
      • Tableau
    • Observability
      • Datadog
      • Prometheus
    • Database management
      • Bytebase
    • AI
      • LlamaIndex
      • Dify
      • LangChain
      • Tongyi Qianwen
      • OpenAI
      • n8n
      • Trae
      • SpringAI
      • Cline
      • Cursor
      • Continue
      • Toolbox
      • CamelAI
      • Firecrawl
      • Hugging Face
      • Ollama
      • Google Gemini
      • Cloudflare Workers AI
      • Jina AI
      • Augment Code
      • Claude Code
      • Kiro
    • Development tools
      • Cloudflare Workers
      • Vercel
  • Best practices
    • Best practices for achieving high availability through cross-cloud active-active deployment
    • High availability through cross-cloud primary-standby databases (1:1)
    • High availability through cross-cloud primary-standby databases (1:n)
    • High host CPU usage
    • Best practices for read/write splitting in OceanBase Cloud
  • References
    • System architecture
    • System management
    • Database object management
    • Database design and specification constraints
    • SQL reference
    • System views
    • Parameters and system variables
    • Error codes
    • Performance tuning
    • Open API References
      • Overview
      • Service endpoints
      • Using API
      • Open APIs
        • Cluster management
          • DescribeInstances
          • DescribeInstance
          • CreateInstance
          • DeleteInstance
          • ModifyInstanceName
          • describe-node-options
          • StopCluster
          • StartCluster
          • ModifyInstanceSpec
          • DescribeInstanceTopology
          • DescribeReadonlyInstances
          • CreateReadonlyInstance
          • ModifyReadonlyInstanceSpec
          • ModifyReadonlyInstanceDiskSize
          • ModifyReadonlyInstanceNodeNum
          • DeleteReadonlyInstance
          • DescribeInstanceAvailableRoZones
          • DescribeInstanceParameters
          • UpdateInstanceParameters
          • DescribeInstanceParametersHistory
          • ModifyInstanceTagList
          • ModifyInstanceNodeNum
        • Tenant management
          • DescribeTenants
          • DescribeTenant
          • CreateTenants
          • DeleteTenants
          • ModifyTenantName
          • ModifyTenant
          • ModifyTenantUserDescription
          • ModifyTenantUserStatus
          • GetTenantCreateConstraints
          • ModifyTenantPrimaryZone
          • GetTenantCreateCpuConstraints
          • GetTenantCreateMemConstraints
          • GetTenantModifyCpuConstraints
          • GetTenantModifyMemConstraints
          • CreateTenantSecurityIpGroup
          • DescribeTenantSecurityIpGroups
          • ModifyTenantSecurityIpGroup
          • DeleteTenantSecurityIpGroup
          • DescribeTenantPrivateLink
          • DeletePrivatelinkConnection
          • CreatePrivatelinkService
          • ConnectPrivatelinkService
          • AddPrivatelinkServiceUser
          • BatchKillProcessList
          • DescribeProcessStatsComposition
          • DescribeTenantAvailableRoZones
          • DescribeTenantAddressInfo
          • ModifyTenantReadonlyReplica
          • DescribeTenantParameters
          • UpdateTenantParameters
          • DescribeTenantParametersHistory
          • ModifyTenantTagList
        • Tenant user management
          • CreateTenantUser
          • DescribeTenantUsers
          • DeleteTenantUsers
          • ModifyTenantUserPassword
          • ModifyTenantUserRoles
        • Database management
          • CreateDatabase
          • DescribeDatabases
          • DeleteDatabases
          • ModifyDatabaseUserRoles
        • Backup and restore
          • DescribeDataBackupSet
          • DescribeRestorableTenants
          • ModifyBackupStrategy
          • CreateTenantRestoreTask
          • CreateDataBackupTask
          • DescribeOneDataBackupSet
        • Database proxy management
          • CreateTenantAddress
          • CreateTenantSingleTunnelSLBAddress
          • DeleteTenantAddress
          • DescribeTenantAddress
          • ModifyOdpClusterSpec
          • ModifyTenantAddressPort
          • ModifyTenantAddressDomainPrefix
          • ConfirmPrivatelinkConnection
          • DescribeTenantAddressInfo
        • Monitoring management
          • DescribeTenantMetrics
          • DescribeMetricsData
          • DescribeNodeMetrics
        • Diagnostic management
          • DescribeOasTopSQLList
          • DescribeOasAnomalySQLList
          • DescribeOasSlowSQLList
          • DescribeOasSQLText
          • DescribeSqlAudits
          • DescribeOutlineBinding
          • DescribeSampleSqlRawTexts
          • DescribeSQLTuningAdvices
          • DescribeOasSlowSQLSamples
          • DescribeOasSQLTrends
          • DescribeOasSQLPlanGroup
        • Security management
          • CreateSecurityIpGroup
          • DescribeInstanceSSL
          • ModifyInstanceSSL
          • DescribeTenantEncryption
          • ModifyTenantEncryption
          • ModifySecurityIps
          • DeleteSecurityIpGroup
          • DescribeTenantSecurityConfigs
          • DescribeInstanceSecurityConfigs
        • Tag management
          • DescribeTags
          • CreateTags
          • UpdateTag
          • DeleteTag
        • Historical event management
          • DescribeOperationEvents
      • Differences between ApsaraDB for OceanBase APIs and OceanBase Cloud APIs
    • Download OBClient
      • Download OBClient
      • Download OceanBase Connector/J
      • Download client ODC
      • Download OceanBase Connector/ODBC
      • Download OBClient Libs
    • Metrics References
      • Cluster database
      • Cluster hosts
      • Binlog service
      • Cross-cloud network channel connection
      • Performance and SQL
      • Transactions
      • Storage and caching
      • Proxy database
      • Proxy host
    • ODC User Guide
      • What is ODC?
        • What is ODC?
        • Limitations
      • Quick Start
        • Client ODC
          • Overview
          • Install Client ODC
          • Use Client ODC
        • Web ODC
          • Overview
          • Use Web ODC
      • Data Source Management
        • Create a data source
        • Data sources and project collaboration
        • Database O&M
          • Session management
          • Global variable management
          • Recycle bin management
      • SQL Development
        • Edit and execute SQL statements
        • Perform PL compilation and debugging
        • Edit and export the result set of an SQL statement
        • Execution analysis
        • Generate test data
        • System settings
        • Database objects
          • Table objects
            • Overview
            • Create a table
          • View objects
            • Overview
            • Create a view
            • Manage views
          • Materialized view objects
            • Overview
            • Create a materialized view
            • Manage materialized views
          • Function objects
            • Overview
            • Create a function
            • Manage functions
          • Stored procedure objects
            • Overview
            • Create a stored procedure
            • Manage stored procedures
          • Sequence objects
            • Overview
            • Create a sequence
            • Manage sequences
          • Package objects
            • Overview
            • Create a program package
            • Manage program packages
          • Trigger objects
            • Overview
            • Create a trigger
            • Manage triggers
          • Type objects
            • Overview
            • Create a type
            • Manage types
          • Synonym objects
            • Overview
            • Create a synonym
            • Manage synonyms
      • Import and Export
        • Import schemas and data
        • Export schemas and data
      • Database Change Management
        • User Permission Management
          • Users and roles
          • Automatic authorization
          • User permission management
        • Project collaboration management
        • Risk levels, risk identification rules, and approval processes
        • SQL check specifications
        • SQL window specification
        • Database change management
        • Batch database change management
        • Online schema changes
        • Synchronize shadow tables
        • Schema comparison
      • Data Lifecycle Management
        • Partitioning Plan Management
          • Manage partitioning plans
          • Set partitioning strategies
          • Examples
        • SQL plan task
      • Data Desensitization and Auditing
        • Desensitize data
        • Operation records
      • Notification Management
        • Overview
        • View notification records
        • Manage Notification Channel
          • Create a notification channel
          • View, edit, and delete a notification channel
          • Configure a custom channel
        • Manage notification rules
      • Best Practices
        • Tips for SQL development
        • Explore ODC team workspaces
        • Understanding real-time SQL diagnostics for OceanBase AP
        • OceanBase historical database solutions
        • ODC SQL check for automatic identification of high-risk operations
        • Manage and modify sharded databases and tables via ODC
        • Data masking and control practices
        • Enterprise-level control and collaboration: Safeguard every database change
    • Data Development
      • Overview
      • Workspace management
      • Worksheet management
      • Compute node pool management
      • Workflow management
      • Dashboard management
      • Manage Git repositories
      • SQL development
        • SQL editing and execution
        • Result set editing
        • Execution analysis
        • Database object management
          • Create a table
          • Create a view
          • Create a function
          • Create a stored procedure
        • Session variable management
        • Git integration
      • Sample datasets
      • Data development terms
  • Manage Billing
    • Access billing
    • View monthly bills
    • View payment details
    • View orders
    • Use vouchers for payment
    • View invoices
  • Legal Agreements
    • OceanBase Cloud Services Agreement
    • Service Level Agreement
    • OceanBase Data Processing Addendum
    • Service Level Agreement for OceanBase Cloud Migration Service

Download PDF

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

The Unified Distributed Database for the AI Era.

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

© OceanBase 2026. All rights reserved

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

    Sample program that uses a Tomcat connection pool to connect to OceanBase Cloud

    Last Updated:2026-04-07 08:08:33  Updated
    share
    What is on this page
    Prerequisites
    Procedure
    Step 1: Import the tomcat-oceanbase-client project into IntelliJ IDEA
    Step 2: Modify the database connection information in the tomcat-oceanbase-client project
    Step 3: Set up the Tomcat runtime environment for the tomcat-oceanbase-client project
    Step 4: Run the tomcat-oceanbase-client project
    Project code
    Introduction to the pom.xml file
    Introduction to the application.properties file
    web.xml
    UserConfig.java file
    Introduction to the UserController.java file
    Introduction to the User.java file
    Complete code
    References

    folded

    share

    This topic describes how to build an application by using a Tomcat connection pool, OceanBase Connector/J, and OceanBase Cloud. The application can perform basic database operations, such as creating a table, inserting data, deleting data, updating data, and querying data.

    Download the tomcat-oceanbase-client sample project Sample program that uses a Tomcat connection pool to connect to OceanBase Cloud (Oracle compatible mode)

    Prerequisites

    • You have registered an account for OceanBase Cloud, created an instance and an Oracle-compatible tenant. For more information, see Create an instance and Create a tenant.
    • You have obtained the connection string for the target Oracle-compatible tenant. For more information, see Obtain the connection string.
    • You have installed JDK 1.8 and Maven.
    • You have installed IntelliJ IDEA.

    Note

    The code examples in this topic are run in IntelliJ IDEA 2021.3.2 (Community Edition). You can also use other tools that you prefer.

    Procedure

    Note

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

    Step 1: Import the tomcat-oceanbase-client project into IntelliJ IDEA

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

      file

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

    3. IntelliJ IDEA will automatically identify the various types of files in the project and display the project's directory structure, file list, module list, and dependency relationships in the Project tool window. The Project tool window is usually located on the far left of the IntelliJ IDEA interface and is typically open by default. If it is closed, you can reopen it by selecting View > Tool Windows > Project from the menu bar or by using the shortcut key Alt + 1.

      Note

      When importing a project into IntelliJ IDEA, it will automatically detect the pom.xml file in the project, download the required dependency libraries based on the described dependencies in the file, and add them to the project.

    4. View the project.

      tomcat

    Step 2: Modify the database connection information in the tomcat-oceanbase-client project

    Modify the database connection information in the application.properties file based on the connection string information obtained from the prerequisites.

    Here is an example:

    #Apache Commons DBCP2 Connection Pool
    #Database Connection Pool Driver Class Name
    db.app.pool.driverClassName=com.oceanbase.jdbc.Driver
    #Database URL
    db.app.pool.url=jdbc:oceanbase://t5******.********.oceanbase.cloud:1521/SYS?characterEncoding=UTF-8
    #Database username
    db.app.pool.username=test_user
    #Database password
    db.app.pool.password=******
    #Initial size of connection pool
    db.app.pool.initialSize=3
    #Maximum number of connections in the connection pool
    db.app.pool.maxTotal=10
    #Maximum number of idle connections in the connection pool
    db.app.pool.maxIdle=20
    #Minimum number of idle connections in the connection pool
    db.app.pool.minIdle=5
    #Maximum wait time for obtaining connections (in milliseconds)
    db.app.pool.maxWaitMillis=5000
    #Verify the connection's query statement
    db.app.pool.validationQuery=select 1 from dual
    
    • The name of the database driver is: com.oceanbase.jdbc.Driver
    • The connection address is t5******.********.oceanbase.cloud.
    • The access port is 1521.
    • The schema to be accessed is sys.
    • The tenant connection account is test_user.
    • The password is ******.

    Step 3: Set up the Tomcat runtime environment for the tomcat-oceanbase-client project

    1. Download Tomcat 8.5.95.

      Download the compressed package of Tomcat 8.5.95 from the Apache Tomcat official website and decompress it to the directory where you want to install Tomcat.

    2. Configure Tomcat in IDEA.

      Open IntelliJ IDEA, go to the File menu, and select Settings > Plugins. In the middle search box of the Settings window, search for Smart Tomcat, download it, and select Apply. At this point, the Tomcat Server tab will appear at the bottom left of the Settings window. Enter the Tomcat Server tab, click the + button on the right, select the decompressed Tomcat directory, click Apply, and then click OK to complete the configuration.

    3. Create a Tomcat runtime configuration.

      In the top toolbar of IDEA, select Run > Edit Configurations. In the Run/Debug Configurations window, click the + button, select Tomcat Server, enter the server name in the Name field, select the installed version of Tomcat in the Configuration dropdown list, change the Context path value to /, enter 8080 in the SSL port field. In the Before launch dropdown list, click + and select Launch Web Browser. Click Edit and enter the URL as http://localhost:8080/hello/getData. Click Apply and then OK to complete the configuration.

    4. Run the Tomcat server.

      In the top toolbar of IDEA, select the Tomcat runtime configuration you just created. Click the green triangle button to start the Tomcat server. You can view the startup logs of the Tomcat server in the Run window of IDEA.

    Step 4: Run the tomcat-oceanbase-client project

    1. Run the project.

      In the top toolbar of IDEA, select the Tomcat runtime configuration you just created. Click the green triangle button to start the Tomcat server. Open the path http://localhost:8080/hello/getData in Google or IE browser to view the running results.

    2. View the running results.

      View the project's log information and output results in the console window of IDEA.

      • The result after data insertion.

        tomcat connection pool test0
        tomcat connection pool test1
        tomcat connection pool test2
        tomcat connection pool test3
        tomcat connection pool test4
        tomcat connection pool test5
        tomcat connection pool test6
        tomcat connection pool test7
        tomcat connection pool test8
        tomcat connection pool test9
        
      • The result after data modification.

        -----After modification-----
        POOl connection pool test0
        POOl connection pool test1
        POOl connection pool test2
        POOl connection pool test3
        POOl connection pool test4
        POOl connection pool test5
        POOl connection pool test6
        POOl connection pool test7
        POOl connection pool test8
        POOl connection pool test9
        
      • The result returned to the web interface.

        Web

    Project code

    Click tomcat-oceanbase-client to download the project code. This is a compressed package named tomcat-oceanbase-client.

    After decompressing it, you will find a folder named tomcat-oceanbase-client. The directory structure is as follows:

    │--pom.xml
    │
    ├─.idea
    │
    ├─src
    │  ├─main
    │  │  ├─java
    │  │  │  └─com
    │  │  │      └─oceanbase
    │  │  │          └─testtomcat
    │  │  │              ├─config
    │  │  │              │   └─UserConfig.java
    │  │  │              │
    │  │  │              ├─controller
    │  │  │              │   └─UserController.java
    │  │  │              │
    │  │  │              └─pojo
    │  │  │                  └─User.java
    │  │  │
    │  │  ├─resources
    │  │  │    └─application.properties
    │  │  │    
    │  │  └─webapp    
    │  │      └─WEB-INF
    │  │          └─web.xml
    │  │             
    │  │                
    │  │
    │  └─test
    │      └─java
    │         
    │
    └─target
    

    File description:

    • pom.xml: the configuration file of the Maven project, which contains information about the project's dependencies, plugins, and build process.
    • .idea: a directory used in the IDE (Integrated Development Environment) to store project-related configuration information.
    • src: a directory typically used to store the source code of the project.
    • main: a directory for storing the main source code and resource files.
    • java: a directory for storing Java source code.
    • com: the root directory for storing Java packages.
    • oceanbase: the root directory for storing the project.
    • testtomcat: a directory for storing the relevant code of the JFinal framework.
    • config: a directory for storing configuration files, including the configuration class files of the application.
    • UserConfig.java: the user configuration class file.
    • controller: a directory for storing the controller class files of the application.
    • UserController.java: the user controller class file.
    • pojo: a directory for storing JavaBeans or entity classes.
    • User.java: the user entity class file.
    • resources: a directory for storing resource files, such as configuration files and SQL files.
    • application.properties: the configuration file for storing database connection information.
    • webapp: the directory for storing the static resources and configuration files of the Web application.
    • WEB-INF: the WEB-INF directory of the Web application, used for storing configuration files and other protected resource files.
    • web.xml: the deployment descriptor file of the Web application.
    • test: a directory for storing test code and resource files.
    • target: a directory for storing the compiled Class files, Jar packages, and other files.

    Introduction to the pom.xml file

    Note

    If you only want to verify the example, you can use the default code without any modifications. Alternatively, you can modify the pom.xml file based on your specific requirements, as explained below.

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

    1. File declaration statement.

      This statement declares the file as an XML file using XML version 1.0 and character encoding UTF-8.

      Sample code:

      <?xml version="1.0" encoding="UTF-8"?>
      
    2. Configure the POM namespace and 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 as http://maven.apache.org/POM/4.0.0 and the location of the POM XSD file as 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.

      Sample 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 specify the project identifier as com.oceanbase.
      2. Use <artifactId> to specify the project dependency as tomcat-oceanbase-client.
      3. Use <version> to specify the project version as 1.0-SNAPSHOT.
      4. Use <packaging> to specify the project packaging method as a WAR file (Web Application Archive).

      Sample code:

       <groupId>com.oceanbase</groupId>
       <artifactId>tomcat-oceanbase-client</artifactId>
       <version>1.0-SNAPSHOT</version>
       <!-- Packaging method (default to jar) -->
       <packaging>war</packaging>
      
    4. Configure the Maven version.

      The <maven.compiler.source> and <maven.compiler.target> elements specify that both the source code version and target code version of the compiler are Java 8.

      Sample code:

       <properties>
           <maven.compiler.source>8</maven.compiler.source>
           <maven.compiler.target>8</maven.compiler.target>
       </properties>
      
    5. Configure core dependencies.

      1. Specify the organization as com.jfinal, the name as jfinal, and the version as 5.0.6. This dependency allows you to use the features of the JFinal framework.

        Sample code:

        <dependency>
            <groupId>com.jfinal</groupId>
            <artifactId>jfinal</artifactId>
            <version>5.0.6</version>
        </dependency>
        
      2. Specify the organization as com.alibaba, the name as druid, and the version as 1.2.8. This dependency allows you to use the Druid library for managing and optimizing the retrieval and release of database connections.

        Sample code:

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.8</version>
        </dependency>
        
      3. Specify the organization as org.apache.commons, the name as commons-dbcp2, and the version as 2.9.0. This dependency allows you to use the Apache Commons DBCP2 library for managing and optimizing the retrieval and release of database connections.

        Sample code:

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-dbcp2</artifactId>
            <version>2.9.0</version>
        </dependency>
        
      4. Specify the organization as com.oceanbase, the name as oceanbase-client, and the version as 2.4.3. This dependency allows you to use the client features provided by OceanBase, such as connection, query, and transaction.

        Sample code:

            <dependencies>
            <dependency>
                <groupId>com.oceanbase</groupId>
                <artifactId>oceanbase-client</artifactId>
                <version>2.4.3</version>
            </dependency>
            </dependencies>
        

    Introduction to the application.properties file

    The application.properties file is used to configure database connection information for connecting to OceanBase Database. It includes the class name of the database driver, connection URL, username, password, and related connection pool configurations. These configurations are used to obtain and manage database connections in the application for database operations.

    • Use db.app.pool.driverClassName to specify the database driver as com.oceanbase.jdbc.Driver, which is used to establish a connection with OceanBase Database.

    • Use db.app.pool.url to specify the URL for connecting to the database.

    • Use db.app.pool.username to specify the username for connecting to the database.

    • Use db.app.pool.password to specify the password for connecting to the database.

    • Use db.app.pool.initialSize to specify the initial size of the connection pool as 3, which means that 3 database connections are created initially.

    • Use db.app.pool.maxTotal to specify the maximum size of the connection pool as 10, which means that up to 10 database connections can be created in the connection pool.

    • Use db.app.pool.maxIdle to specify the maximum number of idle connections in the connection pool as 20.

    • Use db.app.pool.minIdle to specify the minimum number of idle connections in the connection pool as 5.

    • Use db.app.pool.maxWaitMillis to specify the timeout for database connections as 5000ms, which means that if a database connection cannot be obtained within 5000ms, a timeout exception is thrown.

    • Use db.app.pool.validationQuery to specify the SQL query statement for validating database connections as select 1 from dual, which is executed when a connection is obtained from the connection pool to verify its validity.

      Sample code:

        #Apache Commons DBCP2 Connection Pool
        #Database Connection Pool Driver Class Name
        db.app.pool.driverClassName=com.oceanbase.jdbc.Driver
        #Database URL
        db.app.pool.url=jdbc:oceanbase:////host:port/schema_name?characterEncoding=UTF-8
        #Database username
        db.app.pool.username=user_name
        #Database password
        db.app.pool.password=******
        #Initial size of connection pool
        db.app.pool.initialSize=3
        #Maximum number of connections in the connection pool
        db.app.pool.maxTotal=10
        #Maximum number of idle connections in the connection pool
        db.app.pool.maxIdle=20
        #Minimum number of idle connections in the connection pool
        db.app.pool.minIdle=5
        #Maximum wait time for obtaining connections (in milliseconds)
        db.app.pool.maxWaitMillis=5000
        #Verify the connection's query statement
        db.app.pool.validationQuery=select 1 from dual
      

    Common DBCP configurations for the built-in connection pool of Tomcat:

    Notice

    The specific attribute (parameter) configurations depend on the project requirements and the characteristics of the database. We recommend that you adjust and configure them based on your actual situation.

    Attribute Default Value Description
    username N/A The username used to connect to the database.
    password N/A The password used to connect to the database.
    url N/A The URL used to connect to the database.
    driverClassName N/A The standard Java class name of the database driver.
    connectionProperties N/A The connection properties sent to the JDBC driver when a new connection is established, in the format of [propertyName=property;].
    defaultAutoCommit driver default The default auto-commit state when a connection is created by the connection pool. If this attribute is not set, the setAutoCommit method will not be called.
    defaultReadOnly driver default The default read-only state when a connection is created by the connection pool. If this attribute is not set, the setReadOnly method will not be called.
    defaultTransactionIsolation driver default The default transaction isolation level when a connection is created by the connection pool.
    defaultCatalog N/A The default catalog when a connection is created by the connection pool.
    cacheState true Specifies whether to cache the read-only and auto-commit settings of the connection. If this attribute is set to true, the current read-only and auto-commit settings will be cached during the first read or write and all subsequent writes. This eliminates the need for any further database queries when calling getter.
    defaultQueryTimeout null The query timeout for the connection creation statement in the connection pool. If this attribute is not null, the value of this Integer attribute determines the query timeout for creating a connection from the pool; if this attribute is null, the driver's default value will be used.
    enableAutoCommitOnReturn true Specifies whether to check and configure the auto-commit setting of the returned connection.
    rollbackOnReturn true Specifies whether to roll back non-read-only connections that have auto-commit disabled when they are returned to the pool. If this attribute is set to true, non-read-only connections that have auto-commit disabled will be rolled back when they are returned to the pool.
    initialSize 0 The initial number of connections created when the connection pool starts.
    maxTotal 8 The maximum number of active connections that can be allocated from the connection pool.
    maxIdle 8 The maximum number of idle connections to keep in the connection pool, without releasing additional connections. A negative value indicates no limit.
    minIdle 0 The minimum number of idle connections to keep in the connection pool, without creating additional connections. A value of 0 means no connections will be created.
    maxWaitMillis indefinitely The maximum number of milliseconds to wait (when no connections are available) before an exception is thrown, with a value of -1 indicating an indefinite wait.
    validationQuery N/A The SQL query statement used to validate a connection. If this attribute is specified, it must be at least an SQL SELECT statement that returns one row; if this attribute is not specified, the connection will be validated by calling the isValid method.
    validationQueryTimeout no timeout The timeout in seconds before a connection validation query fails. If this attribute is set to a positive value, this value will be passed to the driver's Statement using the setQueryTimeout method when executing the validation query.
    testOnCreate false Specifies whether to validate the object after it is created. If the object cannot be validated, the borrow attempt that triggered its creation will fail.
    testOnBorrow true Specifies whether to validate the object before borrowing it from the connection pool. If the object cannot be validated, it will be removed from the connection pool, and another object will be borrowed.
    testOnReturn false Specifies whether to validate the object before it is returned to the pool.
    testWhileIdle false Specifies whether to validate the object if an idle object evictor (if present) validates it. If the object fails validation, it will be removed from the connection pool.
    timeBetweenEvictionRunsMillis -1 The number of milliseconds to sleep between runs of the idle object evictor thread. If this attribute is set to a non-positive value, the idle object evictor thread will not run.
    numTestsPerEvictionRun 3 The number of objects to check during each run of the idle object evictor thread.
    minEvictableIdleTimeMillis 1000 * 60 * 30 The minimum amount of time an object can be idle in the connection pool.
    softMinEvictableIdleTimeMillis -1 The minimum amount of time a connection can be idle in the pool, including the MinIdle constraint.
    maxConnLifetimeMillis -1 The maximum lifetime of a connection, in milliseconds. After this time, the connection will not be activated, passivated, or validated. A value of 0 or less means the connection has an infinite lifetime.
    logExpiredConnections true Specifies whether to log connections that are closed by the pool due to exceeding the maximum lifetime. A value of false means that expired connection logging is disabled.
    connectionInitSqls null The set of SQL statements used to initialize a physical connection when it is first created. These statements are only executed when a connection factory configured with this attribute creates a connection.
    lifo true Specifies whether the borrowObject method returns the most recently used connection from the pool. A value of true means that the borrowObject method returns the most recently used last in connection (if an idle connection is available); a value of false means that connections are retrieved from the idle instance pool in the order they were returned to the pool (FIFO queue).
    poolPreparedStatements false Specifies whether to enable the prepared statement pool.
    maxOpenPreparedStatements unlimited The maximum number of open statements that can be allocated from the connection pool. A negative value indicates no limit.
    accessToUnderlyingConnectionAllowed false Specifies whether to allow access to the underlying connection.
    removeAbandonedOnMaintenance false Specifies whether to remove abandoned connections during the maintenance period of the connection pool. If this attribute is set to true, abandoned connections will be removed during the maintenance period (at the end of eviction) unless maintenance is enabled by setting timeBetweenEvictionRunsMillis to a positive value, in which case this attribute is ineffective.
    removeAbandonedOnBorrow false Specifies whether to remove abandoned connections when they are borrowed from the connection pool. If set to True, abandoned connections are removed each time a connection is borrowed from the pool, with the following additional requirements:
    • getNumActive() > getMaxTotal() - 3
    • getNumIdle() < 2
    removeAbandonedTimeout 300 Specifies the timeout period before abandoned connections are removed, in seconds. This parameter specifies the maximum idle time before a connection is considered abandoned and can be removed.
    logAbandoned false Specifies whether to log the stack trace of the application code that abandoned the connection. Generating a stack trace increases the overhead for each connection open or new statement.
    abandonedUsageTracking false Specifies whether to log the stack trace of abandoned connections. If set to True, the connection pool logs the stack trace each time a method is called on a pooled connection and retains the most recent stack trace to help debug abandoned connections. This setting increases overhead.
    fastFailValidation false Specifies whether to quickly fail for connections that throw a fatal SQLException. If set to True, validation requests for disconnected connections immediately fail without calling the driver's isValid method or attempting to execute a validation query. The default SQL_STATE codes that are considered fatal disconnection signals are as follows:
    • 57P01 (Admin shutdown)
    • 57P02 (Crash shutdown)
    • 57P03 (Connection not available)
    • 01002 (SQL92 disconnect error)
    • JZ0C0 (Sybase disconnect error)
    • JZ0C1 (Sybase disconnect error)
    • Any SQL_STATE code that starts with 08
    To override this default set of disconnection codes, set the disconnectionSqlCodes property.
    disconnectionSqlCodes null Specifies a comma-separated list of SQL_STATE codes that are considered fatal disconnection signals. This setting is effective only when fastFailValidation is set to True.
    jmxName N/A Specifies the data source object that is operable and monitorable, and registers the data source as a JMX MBean under the specified name. The name must comply with the JMX object name syntax (see javadoc).

    web.xml

    The web.xml file is used to configure the filters of a Web application.

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

    1. A file declaration statement.

      This statement declares that the file is an XML file, the XML version is 1.0, and the character encoding is UTF-8.

      Sample code:

      <?xml version="1.0" encoding="UTF-8"?>
      
    2. The XML namespace and XML model version are configured.

      1. The xmlns:xsi attribute specifies the XML namespace as http://www.w3.org/2001/XMLSchema-instance.
      2. The xmlns attribute specifies the XML namespace as http://java.sun.com/xml/ns/javaee.
      3. The xsi:schemaLocation attribute specifies the XML namespace as http://java.sun.com/xml/ns/javaee and the location of the XML XSD file as http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd.
      4. The <id> and <version> elements specify the ID of the Web application as WebApp_ID and the version number as 3.0.

      Sample code:

       <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                xmlns="http://java.sun.com/xml/ns/javaee" 
                xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" 
                id="WebApp_ID" 
                version="3.0">
      
    3. The JFinal filter is configured.

      A filter named jfinal is configured to use the JFinal framework in the Web application. The class of the filter is specified as com.jfinal.core.JFinalFilter. The configClass initialization parameter is specified to indicate the location of the JFinal framework configuration class as com.oceanbase.testtomcat.config.UserConfig. The JFinal filter is used to use the JFinal framework in the Web application and configure the behavior of the JFinal framework based on the specified configuration class.

      Sample code:

       <filter>
           <filter-name>jfinal</filter-name>
           <filter-class>com.jfinal.core.JFinalFilter</filter-class>
           <init-param>
               <param-name>configClass</param-name>
               <!-- your jfinal configuration location -->
               <param-value>com.oceanbase.testtomcat.config.UserConfig</param-value>
           </init-param>
       </filter>
      
    4. The JFinal filter mapping is configured.

      The jfinal filter is applied to all request paths, meaning that the filter will be applied to all requests in the application.

      Sample code:

       <filter-mapping>
           <filter-name>jfinal</filter-name>
           <url-pattern>/*</url-pattern>
       </filter-mapping>
      

    UserConfig.java file

    The UserConfig.java file is used to configure the routing, plugins, database connections, and other related information of an application.

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

    1. Import other classes and interfaces.

      Declare the interfaces and classes included in the current file:

      • StatFilter class: used to statistics the performance of database access.
      • JdbcConstants class: used to define constants for database types.
      • WallFilter class: used to prevent SQL injection attacks.
      • PropKit class: used to read configuration files.
      • ActiveRecordPlugin class: used to operate databases.
      • Db class: used to execute database operations.
      • OracleDialect class: used to specify the dialect of a database.
      • DruidPlugin class: used to connect to a database.
      • Engine class: used to configure a template engine.
      • UserController class: used to handle requests related to users.
      • User class: used to pass and store user data.

      Sample code:

      import com.alibaba.druid.filter.stat.StatFilter;
      import com.alibaba.druid.util.JdbcConstants;
      import com.alibaba.druid.wall.WallFilter;
      import com.jfinal.config.*;
      import com.jfinal.kit.PropKit;
      import com.jfinal.plugin.activerecord.ActiveRecordPlugin;
      import com.jfinal.plugin.activerecord.Db;
      import com.jfinal.plugin.activerecord.dialect.OracleDialect;
      import com.jfinal.plugin.druid.DruidPlugin;
      import com.jfinal.template.Engine;
      import com.oceanbase.testjfinal.controller.UserController;
      import com.oceanbase.testjfinal.pojo.User;
      
    2. Define the UserConfig class.

      By overriding the methods of the JFinalConfig class, you can configure constants, routing, plugins, and database connections.

      1. Define the configConstant method.

        Used to configure constants of the JFinal framework. The PropKit class is used to read the configuration from the configuration file.

        Sample code:

        @Override
        public void configConstant(Constants constants) {
            PropKit.use("application.properties");
        }
        
      2. Define the configRoute method.

        Used to configure routing mappings. The routes.add method is used to map the "/hello" path to the default access page of the UserController class.

        Sample code:

        @Override
        public void configRoute(Routes routes) {
            routes.add("/hello", UserController.class, "/");
        }
        
      3. Define the configEngine method.

        Used to configure the template engine.

        Sample code:

        @Override
        public void configEngine(Engine engine) {
        }
        
      4. Define the configPlugin method.

        Used to configure plugins of the application. The init method is called to initialize the database connection and table structure. The DruidPlugin and ActiveRecordPlugin plugins are created and added to plugins. The addMapping method of activeRecordPlugin is called to add the mapping between the database table and the entity class. The TEST_USER table is mapped to the User class.

        Sample code:

        @Override
        public void configPlugin(Plugins plugins) {
            init();
            DruidPlugin druidPlugin = createDruidPlugin();
            plugins.add(druidPlugin);
        
            ActiveRecordPlugin activeRecordPlugin = createActiveRecordPlugin(druidPlugin);
            activeRecordPlugin.addMapping("TOMCAT_TEST", User.class);
            plugins.add(activeRecordPlugin);
        }
        
      5. Define the createDruidPlugin method.

        Used to create the DruidPlugin plugin and configure related parameters, including the connection pool size, SQL firewall, and connection error handling.

        • The get method of PropKit is called to obtain the database connection-related attribute values from the configuration file, including the URL, username, password, and driver class. Then, the DruidPlugin object is created and initialized using the obtained attribute values.

        • The addFilter method is called to add a StatFilter instance to the DruidPlugin for statistics of database access performance. A WallFilter instance is created, the setDbType method is called to set the database type to OceanBase, and the WallFilter instance is added to the DruidPlugin for SQL firewall filtering.

        • The setInitialSize method is called to set the initial size of the connection pool; the setMaxPoolPreparedStatementPerConnectionSize method is called to set the maximum number of prepared statements per connection pool; the setTimeBetweenConnectErrorMillis method is called to set the time interval between two connection errors; and the setValidationQuery method is called to set the connection validation query statement. Finally, the created DruidPlugin instance is returned.

          Sample code:

          private DruidPlugin createDruidPlugin() {
              DruidPlugin druidPlugin = new DruidPlugin(
                  PropKit.get("db.app.pool.url"),
                  PropKit.get("db.app.pool.username"),
                  PropKit.get("db.app.pool.password"),
                  PropKit.get("db.app.pool.driverClassName")
              );
          
              druidPlugin.addFilter(new StatFilter());
              WallFilter wallFilter = new WallFilter();
              wallFilter.setDbType(JdbcConstants.OCEANBASE);
              druidPlugin.addFilter(wallFilter);
          
              druidPlugin.setInitialSize(PropKit.getInt("db.app.pool.initialSize"));
              druidPlugin.setMaxPoolPreparedStatementPerConnectionSize(PropKit.getInt("db.app.pool.maxTotal"));
              druidPlugin.setTimeBetweenConnectErrorMillis(PropKit.getInt("db.app.pool.maxWaitMillis"));
              druidPlugin.setValidationQuery("select 1 from dual");
          
              return druidPlugin;
          }
          
      6. Define the init method.

        Used to initialize the database connection and create the database table. The initDbConnection method is called to initialize the database connection, and an ActiveRecordPlugin instance is returned. Then, an SQL statement is executed to query whether the TOMCAT_TEST user table exists. If the TOMCAT_TEST table exists, the SQL statement DROP TABLE TOMCAT_TEST is executed to delete the table. Then, the CREATE TABLE statement is executed to create a database table named TOMCAT_TEST, which contains the ID and USERNAME fields. Finally, the connection of the ActiveRecordPlugin plugin is closed to release the database connection.

        Sample code:

        public void init() {
            ActiveRecordPlugin arp = initDbConnection();
        
            // Check if table exists
            boolean tableExists = Db.queryInt("SELECT COUNT(*) FROM USER_TABLES WHERE TABLE_NAME = 'TOMCAT_TEST'") > 0;
        
            // Drop table if it exists
            if (tableExists) {
                Db.update("DROP TABLE TOMCAT_TEST");
            }
        
            // Create table
            String sql = "CREATE TABLE TOMCAT_TEST (ID NUMBER(10), USERNAME VARCHAR2(50))";
            Db.update(sql);
        
            arp.stop();
        }
        
      7. Define the initDbConnection method.

        Used to initialize the database connection. First, the createDruidPlugin method is called to create the DruidPlugin object and assign it to the druidPlugin variable. This method is responsible for creating and configuring the DruidPlugin for database connection pool management. Then, the createActiveRecordPlugin method is called to create the ActiveRecordPlugin object and pass the DruidPlugin object as a parameter to this method. This method is responsible for creating and configuring the ActiveRecordPlugin for database operation management. Then, the druidPlugin.start method is called to start the DruidPlugin and initialize the database connection pool. Finally, the activeRecordPlugin.start method is called to start the ActiveRecordPlugin, which will initialize the database operation-related settings based on the configuration.

        Sample code:

        private ActiveRecordPlugin initDbConnection() {
            DruidPlugin druidPlugin = createDruidPlugin();
            ActiveRecordPlugin activeRecordPlugin = createActiveRecordPlugin(druidPlugin);
        
            druidPlugin.start();
            activeRecordPlugin.start();
        
            return activeRecordPlugin;
        }
        
      8. Define the ConfigInterceptor and ConfigHandler methods.

        Used to perform global configuration during system initialization.

        Sample code:

        @Override
        public void configInterceptor(Interceptors interceptors) {
        }
        
        @Override
        public void configHandler(Handlers handlers) {
        }
        

    Introduction to the UserController.java file

    The UserController.java file uses the getData method to insert data into a database, query data, and return the query results in JSON format to the client. It uses the Db class provided by the JFinal framework to perform database operations and the custom User class for data mapping to achieve database operations and data return functionality.

    The UserController.java file contains the following code:

    1. Import other classes and interfaces.

      Declare the interfaces and classes included in this file:

      • Controller class: used to handle requests and responses.
      • Db class: used to perform database operations.
      • Record class: used to perform database operations, such as querying, inserting, updating, and deleting data.
      • ArrayList class: used to create an empty list.
      • User class: used to map database tables.
      • List interface: used to operate on query result sets.

      Sample code:

      import com.jfinal.core.Controller;
      import com.jfinal.plugin.activerecord.Db;
      import com.jfinal.plugin.activerecord.Record;
      
      import java.util.ArrayList;
      import java.util.List;
      
    2. Define the UserController class.

      This class provides a controller for the JFinal framework and uses the getData method to insert data into and query data from a database.

      1. Insert data. Create a list dataList containing 10 Record objects, each with different ID and USERNAME field values. Then, use the Db.batchSave method to batch save the records in the dataList list to a database table named TOMCAT_TEST.

        Sample code:

                for (int i = 0; i < 10; i++) {
                    Record record = new Record().set("ID", i).set("USERNAME", "tomcat connection pool test" + i);
                    dataList.add(record);
                }
                Db.batchSave("TOMCAT_TEST", dataList, dataList.size());
        
      2. Query data. Use the Db.find method to execute an SQL query and store the results in the resultList list. Use an enhanced for loop to traverse each Record object in the resultList list. Use the getStr method to obtain the value of the specified field in the Record object and use the System.out.println method to print the value.

        Sample code:

            List<Record> resultList = Db.find("SELECT * FROM TOMCAT_TEST");
            for (Record result : resultList) {
                System.out.println(result.getStr("USERNAME"));
            }
        
      3. Modify data. Use a loop to iterate 10 times and execute an update statement in each iteration. The update statement uses the Db.update method to update records in the TOMCAT_TEST database table based on conditions.

        Sample code:

            for (int i = 0; i < 10; i++) {
                Db.update("UPDATE TOMCAT_TEST SET USERNAME = 'POOl connection pool test" + i + "' WHERE ID = " + i);
            }
        
      4. Query the modified data. Query the TOMCAT_TEST database table and save the results in the modifiedList list. Print the prompt -----Modified-----. Traverse the modifiedList list and print the value of the USERNAME field for each record. Use the renderJson method to render the response message Data retrieved successfully in JSON format and return it to the client.

        Sample code:

                List<Record> modifiedList = Db.find("SELECT * FROM TOMCAT_TEST");
                System.out.println("-----Modified-----");
                for (Record modified : modifiedList) {
                    System.out.println(modified.getStr("USERNAME"));
                }
                renderJson("Data retrieved successfully");
        

    Introduction to the User.java file

    The User.java file is used to implement the mapping between a database table and a Java object.

    The User.java file contains the following code:

    1. Import the Model class.

      The Model class is used to map database tables and operate on data.

    2. Define the User class.

      The User class uses the methods provided by the inherited Model class to perform database operations.

      Sample code:

      import com.jfinal.plugin.activerecord.Model;
      
      
          public class User extends Model<User> {
              public static final User dao = new User();
      
      }
      

    Complete code

    pom.xml
    application.properties
    web.xml
    UserConfig.java
    UserController.java
    User.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>tomcat-oceanbase-client</artifactId>
        <version>1.0-SNAPSHOT</version>
        <!-- Packaging method (default to jar) -->
        <packaging>war</packaging>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
        <dependencies>
            <dependency>
                <groupId>com.jfinal</groupId>
                <artifactId>jfinal</artifactId>
                <version>5.0.6</version>
            </dependency>
    
    
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.2.8</version>
            </dependency>
    
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-dbcp2</artifactId>
                <version>2.9.0</version>
            </dependency>
            <dependency>
                <groupId>com.oceanbase</groupId>
                <artifactId>oceanbase-client</artifactId>
                <version>2.4.3</version>
            </dependency>
    
        </dependencies>
    </project>
    
        #Apache Commons DBCP2 Connection Pool
        #Database Connection Pool Driver Class Name
        db.app.pool.driverClassName=com.oceanbase.jdbc.Driver
        #Database URL
        db.app.pool.url=jdbc:oceanbase://host:port/schema_name?characterEncoding=UTF-8
        #Database username
        db.app.pool.username=user_name
        #Database password
        db.app.pool.password=******
        #Initial size of connection pool
        db.app.pool.initialSize=3
        #Maximum number of connections in the connection pool
        db.app.pool.maxTotal=10
        #Maximum number of idle connections in the connection pool
        db.app.pool.maxIdle=20
        #Minimum number of idle connections in the connection pool
        db.app.pool.minIdle=5
        #Maximum wait time for obtaining connections (in milliseconds)
        db.app.pool.maxWaitMillis=5000
        #Verify the connection's query statement
        db.app.pool.validationQuery=select 1 from dual
    
    <?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
        <filter>
            <filter-name>jfinal</filter-name>
            <filter-class>com.jfinal.core.JFinalFilter</filter-class>
            <init-param>
                <param-name>configClass</param-name>
                <!-- your jfinal configuration location -->
                <param-value>com.oceanbase.testjfinal.config.UserConfig</param-value>
            </init-param>
        </filter>
    
        <filter-mapping>
            <filter-name>jfinal</filter-name>
            <url-pattern>/*</url-pattern>
        </filter-mapping>
    </web-app>
    
    package com.oceanbase.testtomcat.config;
    
    import com.alibaba.druid.filter.stat.StatFilter;
    import com.alibaba.druid.util.JdbcConstants;
    import com.alibaba.druid.wall.WallFilter;
    import com.jfinal.config.*;
    import com.jfinal.kit.PropKit;
    import com.jfinal.plugin.activerecord.ActiveRecordPlugin;
    import com.jfinal.plugin.activerecord.Db;
    import com.jfinal.plugin.activerecord.dialect.OracleDialect;
    import com.jfinal.plugin.druid.DruidPlugin;
    import com.jfinal.template.Engine;
    import com.oceanbase.testtomcat.controller.UserController;
    import com.oceanbase.testtomcat.pojo.User;
    
    public class UserConfig extends JFinalConfig {
        @Override
        public void configConstant(Constants constants) {
            // Read properties configuration
            PropKit.use("application.properties");
        }
    
        @Override
        public void configRoute(Routes routes) {
            // Set the default access page for project startup, which does not need to be set in the web.
            routes.add("/hello", UserController.class);
    
        }
    
        @Override
        public void configEngine(Engine engine) {
        }
    
        @Override
        public void configPlugin(Plugins plugins) {
            init();
            DruidPlugin druidPlugin = createDruidPlugin();
            plugins.add(druidPlugin);
    
            ActiveRecordPlugin activeRecordPlugin = createActiveRecordPlugin(druidPlugin);
            activeRecordPlugin.addMapping("TOMCAT_TEST", User.class);
            plugins.add(activeRecordPlugin);
        }
    
        private DruidPlugin createDruidPlugin() {
            DruidPlugin druidPlugin = new DruidPlugin(
                    PropKit.get("db.app.pool.url"),
                    PropKit.get("db.app.pool.username"),
                    PropKit.get("db.app.pool.password"),
                    PropKit.get("db.app.pool.driverClassName")
            );
    
            druidPlugin.addFilter(new StatFilter());
            WallFilter wallFilter = new WallFilter();
            wallFilter.setDbType(JdbcConstants.OCEANBASE);
            druidPlugin.addFilter(wallFilter);
    
            druidPlugin.setInitialSize(PropKit.getInt("db.app.pool.initialSize"));
            druidPlugin.setMaxPoolPreparedStatementPerConnectionSize(PropKit.getInt("db.app.pool.maxTotal"));
            druidPlugin.setTimeBetweenConnectErrorMillis(PropKit.getInt("db.app.pool.maxWaitMillis"));
            druidPlugin.setValidationQuery("select 1 from dual");
    
            return druidPlugin;
        }
    
        private ActiveRecordPlugin createActiveRecordPlugin(DruidPlugin druidPlugin) {
            ActiveRecordPlugin activeRecordPlugin = new ActiveRecordPlugin(druidPlugin);
            activeRecordPlugin.setDialect(new OracleDialect());
    
            return activeRecordPlugin;
        }
    
        public void init() {
            ActiveRecordPlugin arp = initDbConnection();
    
            // Check if table exists
            boolean tableExists = Db.queryInt("SELECT COUNT(*) FROM USER_TABLES WHERE TABLE_NAME = 'TOMCAT_TEST'") > 0;
    
            // Drop table if it exists
            if (tableExists) {
                Db.update("DROP TABLE TOMCAT_TEST");
            }
    
            // Create table
            String sql = "CREATE TABLE TOMCAT_TEST (ID NUMBER(10), USERNAME VARCHAR2(50))";
            Db.update(sql);
    
            arp.stop();
        }
        private ActiveRecordPlugin initDbConnection() {
            DruidPlugin druidPlugin = createDruidPlugin();
            ActiveRecordPlugin activeRecordPlugin = createActiveRecordPlugin(druidPlugin);
    
            druidPlugin.start();
            activeRecordPlugin.start();
    
            return activeRecordPlugin;
        }
    
        @Override
        public void configInterceptor(Interceptors interceptors) {
        }
    
        @Override
        public void configHandler(Handlers handlers) {
        }
    }
    
    package com.oceanbase.testtomcat.controller;
    
    import com.jfinal.core.Controller;
    import com.jfinal.plugin.activerecord.Db;
    import com.jfinal.plugin.activerecord.Record;
    
    import java.util.ArrayList;
    import java.util.List;
    
    public class UserController extends Controller {
    
        public void getData() {
            try {
                List<Record> dataList = new ArrayList<>();
                // Insert data
                for (int i = 0; i < 10; i++) {
                    Record record = new Record().set("ID", i).set("USERNAME", "tomcat connection pool test" + i);
                    dataList.add(record);
                }
                Db.batchSave("TOMCAT_TEST", dataList, dataList.size());
                // Query data
                List<Record> resultList = Db.find("SELECT * FROM TOMCAT_TEST");
                for (Record result : resultList) {
                    System.out.println(result.getStr("USERNAME"));
                }
                // Modify data
                for (int i = 0; i < 10; i++) {
                    Db.update("UPDATE TOMCAT_TEST SET USERNAME = 'POOl connection pool test" + i + "' WHERE ID = " + i);
                }
                // Query modified data
                List<Record> modifiedList = Db.find("SELECT * FROM TOMCAT_TEST");
                System.out.println("-----Modified-----");
                for (Record modified : modifiedList) {
                    System.out.println(modified.getStr("USERNAME"));
                }
                renderJson("Data retrieved successfully");
            } catch (Exception e) {
                e.printStackTrace();
                renderJson("Error occurred");
            }
        }
    }
    
    package com.oceanbase.testtomcat.pojo;
    
    import com.jfinal.plugin.activerecord.Model;
    
    
        public class User extends Model<User> {
            public static final User dao = new User();
    
    }
    

    References

    For more information about OceanBase Connector/J, see OceanBase JDBC driver.

    Previous topic

    Database connection pool configuration
    Last

    Next topic

    C3P0 connection pool connects to OceanBase Cloud
    Next
    What is on this page
    Prerequisites
    Procedure
    Step 1: Import the tomcat-oceanbase-client project into IntelliJ IDEA
    Step 2: Modify the database connection information in the tomcat-oceanbase-client project
    Step 3: Set up the Tomcat runtime environment for the tomcat-oceanbase-client project
    Step 4: Run the tomcat-oceanbase-client project
    Project code
    Introduction to the pom.xml file
    Introduction to the application.properties file
    web.xml
    UserConfig.java file
    Introduction to the UserController.java file
    Introduction to the User.java file
    Complete code
    References