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

Databases

OceanBase DatabaseOceanBase AI DatabaseOceanBase Cloud OceanBase Best Practices

Tools

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

Connectors and Middleware

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

Databases

OceanBase DatabaseOceanBase AI DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

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

Tools

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

OceanBase AI Database

V4.6.3
  • Introduction
    • Overview
    • Core features
    • System architecture
  • Get Started
    • Get started with OceanBase AI Database
  • Deploy
    • Choose an appropriate deployment plan
    • Deployment process
    • Before deployment
      • Prepare servers
      • Configure Servers
      • Prepare object storage
      • Prepare installation packages
      • Deploy OAT
    • Add a server
    • Deploy OCP
      • OCP deployment overview
      • Upload installation packages
      • Create MetaDB
      • Deploy OCP
    • Deploy OceanBase AI Database
      • Create an object storage configuration
      • Deploy a LogService cluster by using OCP
      • Deploy an OceanBase AI Database cluster using OCP
    • (Optional) Deploy OBProxy
    • Deploy Java SDK
    • Recommended configurations
  • Connect
    • Overview of connection methods
    • Clients
      • MySQL client
      • OBClient
      • ODC
    • GUI tools
      • DBeaver
      • Navicat
    • Drivers and ORMs
      • Connect via driver or ORM framework
      • Examples
        • C#
          • MySQL Connector/C
        • Go
          • Go-SQL-Driver/MySQL
          • GORM
        • Java
          • Connector/J
          • Spring JDBC
          • SpringBoot
          • SpringBatch
          • SpringDataJPA
          • Hibernate
          • MyBatis
          • TestContainers
        • PHP
          • EXT
          • MySQLi
          • PDO
        • Python
          • PyMySQL
          • mysqlclient
          • MySQL-connector-python
          • SQLAlchemy
          • Django
          • peewee
    • Connection pool
      • Database connection pool configuration
      • Tomcat
      • C3P0
      • Proxool
      • HikariCP
      • DBCP
      • Commons Pool
      • Druid
      • JDBC
    • Connect to OceanBase AI Database by using SDK
  • Design Database Schema
    • Overview of database schema design
    • Table design
    • Data distribution
    • Indexes
    • Data types
    • Logical table
      • Logical table overview
      • Agent hybrid search scenario
        • Overview
        • Quick start
        • Collection and namespace management
        • Write data
        • Search data
        • Indexes and embedding functions
        • Monitoring and maintenance
        • API reference
      • Flash application scenario
        • Overview
        • Limitations and constraints
        • Connect
        • Quick start
        • Collection and app management
        • Data operations
  • Data Pipeline
    • Data ingestion
      • Data migration
        • Data migration overview
        • Use mydumper and myloader to migrate data from a MySQL database
        • Use DBCAT to migrate table structures from a MySQL database
        • Use DataX to migrate table data from a MySQL database
        • Use DBCAT to migrate table structures from an Oracle database
        • Use DataX to migrate table data from an Oracle database
        • Use DBCAT to migrate table structures from a DB2 LUW database
        • Migrate from CSV files
          • Use DataX
          • Use LOAD DATA
        • Migrate by using SQL statements
          • Migrate data between tables
          • Migrate resource units
          • Export data using the OUTFILE statement
      • Data import
        • Data import overview
        • Import data by using the LOAD DATA statement
        • INSERT INTO SELECT
          • Use the INSERT INTO SELECT FROM FILES statement for direct load
          • Import data from external tables using INSERT INTO SELECT
        • Import data via direct load using the CREATE TABLE AS SELECT statement
        • Import data by using obloader
    • Data delivery
      • Export data
      • Data lake
        • Data lake overview
        • Data lake integration
          • Access Hive tables through HMS Catalog
          • Load an Iceberg table through Catalog
          • Read Paimon tables by using plugins
          • ODPS Catalog and external tables
          • Catalogs and external tables
          • File external tables
        • External tables via URL
    • Data sharing
      • Automatic catalog data synchronization
      • Manual catalog data synchronization
  • Data Processing
    • Structured data processing
      • In-database processing
      • Materialized views
      • Data processing tools
    • Unstructured data processing
      • Vector embedding
        • Overview of Vector Embedding Technology
        • Use the AI_EMBED function
        • Use external embedding models
  • Data Branching
    • Overview of Fork
    • Fork Table
    • Fork Database
  • AI Search
    • Vector search
      • Vector search overview
      • Perform vector search using SQL
      • Vector data types overview
      • Store vector data
      • Vector index
        • Overview of vector indexes
        • Vector index memory management
        • Dense index
          • Overview of dense indexes
          • Index type selection
          • HNSW series indexes
          • IVF series indexes
        • Sparse index
          • In-memory sparse vector index
        • Monitor and maintain indexes
        • Index performance optimization
      • Search index
      • Use SQL functions
      • Vector nearest neighbor search
      • FAQ on AI scenarios
    • Semantic search
    • Full-text search
    • Hybrid search
    • Rerank search
  • Query Acceleration
    • Statistics
    • Choose the query parallelism
    • Accelerate queries with materialized views
  • Manage
    • Log in to an user tenant
    • Manage clusters
      • Cluster overview
      • Compute service management
        • Cluster parameters
        • Common cluster operations
          • View a zone
          • View a node
          • Restart a node
          • Add a node
          • Delete a node
          • Isolate a node
          • Replace a node
          • Start a zone
          • Add a zone
          • Delete a zone
          • Modify a zone
          • Isolate a zone
          • View cluster parameters
          • Modify cluster parameters
          • Reset cluster parameters
          • Update object storage access credentials
        • Data load balancing
          • Data load balancing overview
          • Transfer a partition
          • Cancel a partition transfer task
          • Cancel a balance job
          • Stop and resume a balance job
          • Table group weight management
            • Aggregation of user tables under a database
            • Set table group weights
            • Clear a table group's weight
            • Application scenarios of table group weight balancing
          • Partition weight management
            • Set partition weights
            • Clear partition weights
          • Partition balance management
            • Configure a scheduled partition balancing task
            • Manually trigger partition balancing
            • View the configurations of a scheduled partition balancing task
            • View the trigger history of scheduled partition balancing tasks
            • View background partition balancing tasks
            • View the history of background partition balancing tasks
          • GTS exclusive application case
      • Object storage management
        • Object storage overview
        • Update object storage information
        • Object storage-related views and parameters
        • FAQ on object storage
      • LogService management
        • LogService parameters
        • LogService operations
          • View a LogService node
          • Add a LogService node
          • Delete a LogService node
          • Replace a LogService node
          • Rotate LogService access credentials
          • View LogService parameters
          • Modify LogService parameters
        • LogService load balancing
          • LogService load balancing overview
          • View the load balancing status
          • Configure the load balancing strategy
    • Manage tenants
      • Tenant introduction
      • Tenant capacity
      • Tenant types
      • User tenant introduction
      • Tenant system variables
      • Common tenant operations
        • Create a tenant
        • Resource isolation
          • Resource isolation overview
          • Configure cgroup
          • Configure global CPU resource isolation for foreground and background tasks
          • Calibrate disk performance
          • Configure resource isolation within a tenant
          • Update a plan directive
          • Delete a plan directive
          • Delete a resource management plan
          • Delete a resource group
          • Clear cgroup configurations
          • Resource isolation configuration examples for background tasks
        • View tenant and resource information
        • View and set the tenant allowlist
        • View tenant system variables
        • Modify tenant system variables
        • Scale in/out
          • Introduction to tenant scaling
          • Resource planning for tenant scaling
          • Tenant pre-scaling
          • Scale tenants by adjusting resource specifications
          • Scale tenants by adjusting the unit number
          • Scale tenants by adjusting the primary zone
          • Smooth scaling application scenarios
        • Modify attributes of a resource pool
        • Modify tenant attributes
        • Lock and unlock a tenant
        • Drop a tenant
        • Restore a tenant
        • Rename a tenant
        • Manage resource pools
          • View resource pools
          • Allocate a resource pool to a tenant
          • Remove resource pools from a tenant
          • Merge and split a resource pool
          • Drop a resource pool
        • Manage resource specifications
          • View resource specifications
          • Modify a unit config
          • Drop a unit config
    • Manage log streams
      • Create a log stream
      • Modify a log stream
    • Manage replicas
      • Replicas
      • Replica distribution
        • Locality
        • Common locality operations
          • View locality
          • Modify locality
          • Add a replica
          • Reduce replicas
          • Adjust the distribution of replicas
          • View the locality change history
          • Replica migration
          • Modify the quorum size of a log stream
          • Cancel a replica task
      • Traffic distribution
      • Data distribution
    • High availability
      • High availability overview
      • Multi-replica disaster recovery
        • Data link introduction
        • High availability at the proxy layer
        • High availability at the database layer
        • Disaster recovery deployment solutions
      • Manage recycle bin
        • Overview of the recycle bin
        • Enable or disable the recycle bin
        • View recycle bin objects
        • Restore objects from the recycle bin
        • Clean up the recycle bin
      • Flashback query
    • Security and permissions
      • Overview of security permissions
      • Identification and authentication
        • Identity authentication
          • Identity authentication
          • Password complexity
          • Handle login failures
      • Access control
        • Overview of access control
        • Users and permissions
          • User and permission overview
          • Permissions
            • Permission classification
            • Create a user
            • Grant privileges directly
            • Privilege delegation
            • Role management
              • Role management overview
              • Create a role
              • Add privileges to a role
              • Grant roles to users or other roles
              • Activate a role
              • View roles
              • Revoke privileges from a role
              • Revoke roles from a user or role
              • Drop a role
            • Indirect authorization
            • View user privileges
            • Revoke privileges
            • Lock or unlock a user
            • Drop a user
        • Row-level security
          • Row-level security
        • Network security access control
        • RPC connection authentication
      • Data encryption
        • Data encryption overview
        • Data transmission encryption
          • Overview of data transmission encryption
          • Transport encryption for OBServer
          • ODP transmission encryption
        • Tenant master key management
          • Overview of tenant master keys
          • Generate tenant master key
        • Data storage encryption
          • Overview of database transparent encryption
          • Set up transparent data encryption for a newly created table
          • Enable transparent data encryption for an existing table
          • Decrypt a table
        • Column encryption
          • Column encryption overview
          • Create a column encryption rule
          • Column encryption privilege management
          • FAQ on column encryption
      • Security audit
        • Security audit overview
        • Security audit
          • Enable security auditing
          • Set an auditing rule
          • View auditing records
          • Disable security auditing
    • Backup and restore
      • Overview of physical backup and restore
      • Physical backup and restore with a minimal experience
      • Log archive
        • Overview of log archiving
        • Prepare for log archiving
        • Enable archiving mode
        • Suspend archiving
        • Disable archiving mode
        • View piece information
        • View archiving progress
        • View the archiving history
        • View archive parameters
        • Change the archive destination
        • Clear the archive path configuration
        • Introduction to log archiving views
      • Data backup
        • Data backup overview
        • Prepare for backup
        • Initiate a full data backup
        • Back up parameters
        • Stop a backup
        • View the data backup progress
        • View data backup results
        • View data backup parameters
        • Change the backup destination
        • Introduction to data backup-related views
      • Update object storage key information
      • Clear backup data
        • Automatic backup cleanup
          • Automatically clean up expired backups
          • Delete a cleanup policy
        • Manual backup cleanup
          • Manually trigger expired backup cleanup
          • Manually clean up specified backup or archive data
          • Manually clear a backup or archive path
        • Cancel a cleanup task
        • View backup cleanup progress
        • View backup cleanup results
        • Introduction to backup cleanup parameters
        • Introduction to cleanup-related views
      • Restore data
        • Preparations before restore
        • Perform physical restore
        • Restore from a specified path
        • Cancel physical restore
        • View the physical restore progress
        • View the result of physical restore
        • Segment-based log replay for a standby tenant
        • Convert a standby tenant into a primary tenant
        • Upgrade a tenant after restore is complete
        • Introduction to physical restore parameters
        • Introduction to views related to physical restore
      • Backup and restore performance tuning
      • Appendix: S3 path format
    • Monitor
      • Monitoring overview
      • Metrics
        • System monitoring
          • Overview of system monitoring metrics
          • SYSSTAT metrics
          • Wait events
          • Lock events
        • SQL monitoring
          • Overview of SQL monitoring
          • SQL audit
          • Execution plans
      • Root service events
      • Cases
    • Logs
      • Log overview
      • Log levels
      • Log interpretation
      • Log stability
      • Log control methods
      • Log compression and decompression
      • Log monitoring metrics
      • Alert logs
      • View logs
        • Search for the logs of a specific SQL request
        • Query the log of a previous SQL request by using the SQL Trace feature
  • Performance Test
    • TPC-DS
      • OceanBase AI Database TPC-DS test
      • OceanBase AI Database TPC-DS test report
    • TPC-H
      • OceanBase AI Database TPC-H test
      • OceanBase AI Database TPC-H test report
  • Reference
    • System management
      • Configuration management
        • Introduction to Configuration Management
        • Set parameters
        • Set variables
      • Storage management
        • Minor compaction management
          • Overview of minor compaction
          • Automatic minor compaction
          • Manually trigger a minor compaction
          • View minor compaction information
          • Modify minor compaction settings
        • Major compaction management
          • Overview of major compaction management
          • Automatically trigger a major compaction
          • Schedule daily tenant major compactions
          • Window compaction
          • Adaptive compaction
          • Manually trigger a major compaction
          • View major compaction information
          • Manually control a major compaction
          • Modify major compaction configuration
        • Data compression
          • Data compression overview
          • Use data encoding and compression
        • Use the TTL feature
        • Custom hot and cold data storage policies
          • Overview of custom hot/cold storage policies
          • Create a table-level hot/cold storage policy
          • Create a partition-level hot/cold storage policy
          • Modify a table-level hot/cold storage policy
          • Modify a partition-level hot/cold storage policy
          • O&M guide for custom hot/cold storage policies
      • Memory management
        • Memory management overview
        • Memory structure
        • Set the maximum memory for a database
        • Internal system memory management
        • Memory management within a tenant
        • Plan cache memory management
        • Memleak-based regular memory leak diagnostics mechanism
        • View memory usage information
        • Common memory issues
      • Process management
        • Overview of OceanBase AI Database threads
        • Multi-tenant threads
        • View thread status
        • Background threads of OceanBase AI Database
        • FAQ about multi-tenant threads
      • Disk management
        • Configure dynamic expansion of disk data files
        • View disk space usage of a tenant or table
    • Database object management
      • Overview of database object management
      • Create and manage databases
        • Create a database
        • View databases
        • Modify a database
        • Drop a database
      • Create and manage tables
        • About tables
        • Create a table
        • Column Skip Index attribute
        • Define an auto-increment column
        • Define column constraints
        • View tables
        • Modify a table
        • Change the attribute of a replicated table
        • Truncate a table
        • Drop a table
        • Lock a table
        • Create and manage external tables
          • External tables and external files
          • Create and query external tables
          • Create a partitioned external table
          • Manage external files
          • Data type mappings
      • Create and manage partitions
        • Partitioning overview
        • Create a partitioned table
        • Partition splitting
          • Overview of partition splitting
          • Manually split a partition
          • Automatic partition splitting
          • Recommended configurations for automatic partitioning
        • Dynamic partitioning
          • Overview of dynamic partitioning
          • Create a dynamic partitioned table
          • View a dynamic partitioned table
          • Modify a dynamic partitioned table
          • Dynamic partition management tasks
        • Modify partitioning rules
        • Add a partition
        • Drop a partition
        • Truncate partitions
        • Partition pruning
        • Query data from a specified partition
        • Create indexes on partitioned tables
          • Index overview
          • Local index
          • Global index
        • Partition exchange
      • Create and manage table groups
        • About table groups
        • Create a table group
        • View table group information
        • Add tables to a table group
        • Modify the SHARDING attribute of a table group
        • Manage tables within a table group
        • Delete a table group
      • Create and manage indexes
        • About indexes
        • Create an index
        • View indexes
        • Monitor indexes
        • Drop an index
        • List of system functions supported for function-based indexes
        • List of system functions not supported for function-based indexes
      • Manage views
        • Manage regular views
        • Manage materialized views
          • Overview of materialized views
          • Materialized view logs
          • Create a materialized view
          • Refresh a materialized view
          • Query rewrite using materialized views
          • Query materialized views
          • Modify materialized view attributes
          • Drop a materialized view
          • Materialized view resource isolation
      • Create and manage sequences
        • Create a sequence
        • View sequences
        • Reference a sequence
        • Modify a sequence
        • Drop a sequence
      • Create and manage triggers
        • Overview
        • Create a DML trigger
        • View trigger information
        • Drop a trigger
      • Create and manage DBLinks
        • Create a DBLink
        • View created DBLinks
        • Manage DBLinks
        • Access data in a remote database through DBLink
        • Drop a DBLink
      • Create and manage catalogs
        • Overview of Catalog
        • Create a catalog
        • View catalogs
        • Drop a catalog
    • Write and read data
      • Write data
        • Insert data
        • Update data
        • Delete data
        • Replace data
        • Generate test data in batches
      • Read data
        • Single-table query
        • Join tables
          • INNER JOIN
          • FULL JOIN
          • LEFT JOIN
          • RIGHT JOIN
          • Subqueries
          • Lateral derived table
        • Use operators and functions in queries
          • Use arithmetic operators in queries
          • Use numeric functions in queries
          • Use string concatenation operators in queries
          • Use string functions in queries
          • Use time 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
          • Lock query results with SELECT FOR UPDATE
          • Lock in share mode
          • Use regular expressions in queries
        • Query using DBLink
        • Set operations
    • Transaction management
      • Transaction management 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
    • AI Function service
      • Overview of AI Function Service
      • Get started with AI Function Service
      • AI Function Service Permissions
      • Register an AI model
      • Interaction with AI models (Batch File)
      • Syntax and examples of AI functions
      • View AI model information
    • SQL reference
      • SQL syntax
        • System tenants
          • Overview of management commands
          • ALTER SYSTEM
            • ACTIVATE STANDBY
            • ADD REPLICA
            • ADD RESTORE SOURCE
            • ARCHIVELOG
            • BOOTSTRAP
            • BACKUP KEY
            • BACKUP
            • BACKUP CLUSTER PARAMETERS
            • BALANCE TASK
            • BALANCE JOB
            • CANCEL BACKUP
            • CANCEL DELETE BACKUP
            • CANCEL MIGRATE UNIT
            • CANCEL REPLICA TASK
            • CANCEL RESTORE
            • CANCEL RECOVER TABLE
            • CANCEL TRANSFER PARTITION
            • CREATE LS
            • CLEAR RESTORE SOURCE
            • DELETE BACKUP POLICY
            • DELETE BACKUP ALL
            • DELETE BACKUPSET/ARCHIVELOG_PIECE
            • DELETE OBSOLETE BACKUP
            • LOAD MODULE DATA
            • MAJOR AND MINOR
            • MIGRATE REPLICA
            • MIGRATE UNIT
            • MODIFY LS
            • MODIFY PAXOS_REPLICA_NUM
            • MODIFY REPLICA
            • NOARCHIVELOG
            • FLUSH PLAN CACHE
            • FLUSH SEQUENCE CACHE
            • FLUSH LOCAL_CACHE
            • FLASHBACK STANDBY LOG
            • JOB
            • SET LOG_RESTORE_SOURCE
            • PARAMETER
            • RECOVER STANDBY
            • RECOVER STANDBY CANCEL
            • REMOVE REPLICA
            • REFRESH
            • RESTORE
            • RESTORE PREVIEW
            • SET DATA_BACKUP_DEST
            • SERVER
            • SERVICE_NAME
            • SWITCHOVER
            • SET LOG_ARCHIVE_DEST
            • SET LOG_ARCHIVE_DEST_STATE
            • THROTTLE
            • TRANSFER PARTITION
            • TTL
            • WASH MEMORY FRAGMENTATION
            • ZONE
          • ALTER RESOURCE POOL
          • ALTER RESOURCE TENANT
          • ALTER RESOURCE UNIT
          • ALTER TENANT
          • CREATE RESOURCE POOL
          • CREATE RESOURCE UNIT
          • CREATE TENANT
          • DROP RESOURCE POOL
          • DROP RESOURCE UNIT
          • DROP TENANT
          • SET DECRYPTION
          • SET ENCRYPTION
          • SHOW RESTORE PREVIEW
        • User tenants
          • Basic elements
            • ROWID Pseudo-Column
            • Data types
              • Overview of data types
              • Numeric types
                • Overview of numeric types
                • Integer types
                • Fixed-point types
                • Floating-point types
                • BIT-Value type
              • Datetime types
                • Overview of date and time types
                • DATE, DATETIME and TIMESTAMP types
                • TIME type
                • YEAR type
              • String types
                • Character type overview
                • CHAR and VARCHAR
                • BINARY and VARBINARY
              • Large objects and text types
                • Overview of LOB and text types
                • BLOB type
                • TEXT type
                • STRING type
                • LOB types
                • LOB_WRITEAPPEND
              • Enumeration types
              • Collection types
              • JSON data types
                • Overview of the JSON data type
                • Create a JSON value
                • Query and modify JSON values
                • JSON data type conversion
                • Update partial data in a JSON document
                • Semi-structured encoding
              • Spatial data types
                • Overview of spatial data types
                • Spatial Reference System (SRS)
                • Create a spatial column
                • Create a spatial index
                • Spatial data formats
              • Roaring bitmap types
                • Overview of Efficient Compression for Bitmap Data Types
                • Create an efficient compressed bitmap column
              • Array data types
                • Overview of Array Element Types
                • Create an array column
              • Map data types
                • Overview of mapped data types
                • Create a mapped column
            • Expressions
              • Overview of Expressions
              • Syntax of Expressions
              • Simple Expressions
              • Compound Expressions
              • Conditional Expressions
              • Column Expressions
              • Date and time expressions
              • Function Expressions
              • Interval Expressions
              • Scalar subquery expressions
              • List of Expressions
              • Data type conversion rules
            • Character set and collation
              • Overview
              • Character sets
              • Collation
              • Database-level character set and collation
              • Table-level character set and collation
              • Column-level character set and collation
              • Character expression character sets and collations
              • Character set and collation of client connections
            • Literals
              • Overview of Literals
              • String text
              • Numbers
              • Date and time values
              • Bit value
              • Boolean values
              • NULL values
            • Schema object name
            • User-defined variables
            • Annotations
              • Hints
                • Overview of hints
                • Control query optimization using the Query Block Name and QB_NAME hint
                • Hint list
                  • Global hints
                    • Optimizer Stats Hint under Global Hint Types
                    • Transform hint under global hints
                    • Other hints under global hints
                  • Optimizer hints
                    • Access path hints under the Optimized hint type
                    • Join Order Hint under Optimized Hint Type
                    • Join Operation Hint under Optimized Hint Type
                    • Subquery hint under Optimized hint type
                    • Group by hint under optimized hint type
                    • DISTINCT hint under Optimized hint type
                    • Set hint under Optimized hint type
                    • Distributed DML Hints under Optimized Hint Type
                    • Vector Index Hint under Optimized Hint Type
                  • Transform hints
                    • Stmt Transform Hint under the Transform Hint Type
                    • Cost Based Transform Hint under the Transform Hint Type
                    • Transform Hints of the Heuristics Type
                    • Other hints under the Transform hint type
                  • Outline-related hint
            • Comments
          • Operators
            • Operator overview
            • Operator precedence
            • Arithmetic operators
            • Bitwise operators
            • Comparison operators
            • Logical operators
            • Assignment operators
            • Date and time operators
            • Character concatenation operators
            • BINARY conversion operator
            • CASE Conditional Operator
          • Functions
            • Function overview
            • Single-row functions
              • Datetime functions
                • ADDDATE
                • CONVERT_TZ
                • CURDATE
                • CURRENT_DATE
                • CURRENT_TIME
                • CURRENT_TIMESTAMP
                • CURTIME
                • DATE
                • DATE_ADD
                • DATE_FORMAT
                • DATE_SUB
                • DATEDIFF
                • DAYOFMONTH
                • DAYOFWEEK
                • DAYOFYEAR
                • EXTRACT
                • FROM_DAYS
                • FROM_UNIXTIME
                • GET_FORMAT
                • HOUR
                • LAST_DAY
                • LOCALTIME
                • LOCALTIMESTAMP
                • MAKEDATE
                • MAKETIME
                • MICROSECOND
                • MINUTE
                • MONTH
                • MONTHNAME
                • NOW
                • PERIOD_ADD
                • PERIOD_DIFF
                • QUARTER
                • SEC_TO_TIME
                • SECOND
                • STR_TO_DATE
                • SUBDATE
                • SUBTIME
                • SYSDATE
                • TIME
                • TIME_FORMAT
                • TIME_TO_SEC
                • TIME_TO_USEC
                • TIMEDIFF
                • TIMESTAMP
                • TIMESTAMPADD
                • TIMESTAMPDIFF
                • TO_DAYS
                • TO_SECONDS
                • UNIX_TIMESTAMP
                • USEC_TO_TIME
                • UTC_DATE
                • UTC_TIME
                • UTC_TIMESTAMP
                • WEEK
                • WEEKDAY
                • WEEKOFYEAR
                • YEARWEEK
                • YEAR
                • ADDTIME
                • DAYNAME
                • DAY
                • DATE_TRUNC
                • MONTHS_ADD
                • FORMATDATETIME
                • TOUNIXTIMESTAMP
                • parseDateTime
              • String functions
                • ASCII
                • BIN
                • BIT_LENGTH
                • CHAR
                • CHAR_LENGTH
                • CHARACTER_LENGTH
                • CONCAT
                • CONCAT_WS
                • ELT
                • EXPORT_SET
                • FIELD
                • FIND_IN_SET
                • FORMAT
                • HEX
                • INSERT
                • INSTR
                • INT2IP
                • IP2INT
                • KEYVALUE
                • LCASE
                • LEFT
                • LENGTH
                • LOCATE
                • LOWER
                • LPAD
                • LTRIM
                • MAKE_SET
                • MAX_PT
                • MD5_CONCAT_WS
                • MID
                • OCT
                • OCTET_LENGTH
                • ORD
                • POSITION
                • QUOTE
                • REGEXP
                • REGEXP_INSTR
                • REGEXP_LIKE
                • REGEXP_REPLACE
                • REGEXP_SUBSTR
                • REPEAT
                • REPLACE
                • REVERSE
                • RIGHT
                • RLIKE
                • RPAD
                • RTRIM
                • SPACE
                • SPLIT_PART
                • STRCMP
                • SUBSTR
                • SUBSTRING
                • SUBSTRING_INDEX
                • TRIM
                • UCASE
                • UNHEX
                • UPPER
                • URL_DECODE
                • URL_ENCODE
                • WEIGHT_STRING
                • TO_BASE64
                • FROM_BASE64
                • SOUNDEX
                • EDITDISTANCE
              • Conversion functions
                • CAST
                • CONVERT
                • DECODE_TRACE_ID
                • SCN_TO_TIMESTAMP
                • TIMESTAMP_TO_SCN
                • TO_CHAR(character)
                • TO_CHAR(number)
                • TO_CHAR(datetime)
                • TO_DATE
              • Mathematical functions
                • ABS
                • ACOS
                • ASIN
                • ATAN
                • ATAN2
                • BIT_COUNT
                • CEIL
                • CEILING
                • CONV
                • COS
                • COT
                • CRC32
                • DEGREES
                • EXP
                • FLOOR
                • GENERATOR
                • LN
                • LOG
                • LOG10
                • LOG2
                • MOD
                • NEG
                • PI
                • NORMAL
                • POW
                • POWER
                • RADIANS
                • RAND
                • RANDOM
                • RANDSTR
                • ROUND
                • SIGN
                • SIN
                • SQRT
                • TAN
                • TRUNCATE
                • UNIFORM
                • ZIPF
              • Comparison functions
                • GREATEST
                • INTERVAL
                • ISNULL
                • LEAST
              • Process control functions
                • CASE
                • IF
                • IFNULL
                • NULLIF
                • ORA_DECODE
            • Aggregate functions
              • APPROX_COUNT_DISTINCT
              • AVG
              • ARG_MAX
              • ARG_MIN
              • BIT_AND
              • BIT_OR
              • BIT_XOR
              • COUNT
              • GROUP_CONCAT
              • GROUPING
              • MAX
              • MIN
              • STD
              • STDDEV
              • STDDEV_POP
              • STDDEV_SAMP
              • SUM
              • VAR_POP
              • VAR_SAMP
              • VARIANCE
              • STRING_AGG
              • AVG_WEIGHTED
              • ARBITRARY
              • ANY
              • GROUPCONCAT
              • STDDEVSAMP
              • UNIQ
              • VARSAMP
            • Analysis functions
              • APPROX_COUNT_DISTINCT
              • AVG
              • BIT_AND
              • BIT_OR
              • BIT_XOR
              • COUNT
              • CUME_DIST
              • DENSE_RANK
              • FIRST_VALUE
              • LAG
              • LAST_VALUE
              • LEAD
              • MAX
              • MIN
              • NTH_VALUE
              • NTILE
              • PERCENT_RANK
              • PERCENTILE_CONT
              • RANK
              • ROW_NUMBER
              • STD
              • STDDEV
              • STDDEV_POP
              • STDDEV_SAMP
              • SUM
              • VAR_POP
              • VAR_SAMP
              • VARIANCE
              • LAGINFRAME
              • LEADINFRAME
            • Encryption functions
              • AES_DECRYPT
              • AES_ENCRYPT
              • COMPRESS
              • DECODE
              • DES_DECRYPT
              • DES_ENCRYPT
              • ENCODE
              • ENCRYPT
              • ENHANCED_AES_ENCRYPT
              • ENHANCED_AES_DECRYPT
              • MD5
              • PASSWORD
              • UNCOMPRESS
              • UNCOMPRESSED_LENGTH
              • RANDOM_BYTES
              • SHA
              • SHA1
              • SHA2
              • VALIDATE_PASSWORD_STRENGTH
              • SM3
              • SM4_ENCRYPT
              • SM4_DECRYPT
            • Information functions
              • BENCHMARK
              • CATALOG
              • CHARSET
              • COERCIBILITY
              • COLLATION
              • CONNECTION_ID
              • CURRENT_ROLE
              • CURRENT_USER
              • DATABASE
              • FOUND_ROWS
              • LAST_INSERT_ID
              • LAST_INSERT_ID Behavior Description
              • ICU_VERSION
              • OB_TRANSACTION_ID
              • ROW_COUNT
              • SCHEMA
              • SESSION_USER
              • SYSTEM_USER
              • USER
              • VERSION
              • OB_VERSION
            • JSON functions
              • Overview of JSON functions
              • Functions for creating JSON text
                • JSON_ARRAY
                • JSON_OBJECT
                • JSON_QUOTE
              • Functions for searching JSON text
                • JSON_CONTAINS
                • JSON_CONTAINS_PATH
                • JSON_EXTRACT
                • JSON_KEYS
                • JSON_OVERLAPS
                • JSON_SEARCH
                • JSON_VALUE
                • MEMBER OF
              • Functions for modifying JSON text
                • JSON_ARRAY_APPEND
                • JSON_APPEND
                • JSON_ARRAY_INSERT
                • JSON_INSERT
                • JSON_MERGE
                • JSON_MERGE_PATCH
                • JSON_MERGE_PRESERVE
                • JSON_REMOVE
                • JSON_REPLACE
                • JSON_SET
                • JSON_UNQUOTE
              • Functions for returning JSON text properties
                • JSON_DEPTH
                • JSON_LENGTH
                • JSON_TYPE
                • JSON_VALID
              • JSON_TABLE function
              • JSON utility functions
                • JSON_PRETTY
                • JSON_STORAGE_SIZE
              • JSON aggregate functions
                • JSON_ARRAYAGG
                • JSON_OBJECTAGG
              • JSON schema validation functions
                • JSON_SCHEMA_VALID
                • JSON_SCHEMA_VALIDATION_REPORT
            • XML functions
              • Overview of XML functions
              • Functions for querying XML data
                • EXTRACTVALUE
              • Functions for modifying XML data
                • UPDATEXML
            • Table functions
              • Overview of TABLE FUNCTIONS
              • FILES table function
            • Spatial functions
              • Overview of Spatial Functions
              • Create a geometric value function
              • Spatial operators
              • Spatial relationship functions
              • Geometric property functions
              • Geometric format conversion functions
              • Spatial analysis functions
              • Spatial Constructors
              • Spatial accessor functions
              • Spatial format conversion functions
              • Geometric Processing Functions
              • _ST_GeoHash
            • Performance schema functions
              • FORMAT_BYTES
              • FORMAT_PICO_TIME
            • Lock functions
              • Overview of Lock Functions
              • GET_LOCK
              • IS_FREE_LOCK
              • IS_USED_LOCK
              • RELEASE_ALL_LOCKS()
              • RELEASE_LOCK
            • Bitmap functions
              • Overview of bitmap functions
              • Bitmap Constructor
              • Bitmap cardinality functions
              • Bitmap arithmetic functions
              • Bitmap predicate functions
              • Bitmap output functions
              • Bitmap aggregate functions
            • Array functions
              • Overview of array functions
              • Array constructor
              • Array comparison functions
              • Array output functions
              • Array functions
            • Text processing functions
              • TOKENIZE
            • Audit functions
              • Overview of audit functions
              • AUDIT_LOG_FILTER_REMOVE_FILTER
              • AUDIT_LOG_FILTER_REMOVE_USER
              • AUDIT_LOG_FILTER_SET_FILTER
              • AUDIT_LOG_FILTER_SET_USER
            • Map functions
              • Overview of mapping functions
              • Constructor of Map
              • Mapping judgment function
              • Mapping functions
            • Other functions
              • ANY_VALUE
              • BIN_TO_UUID
              • COALESCE
              • DEFAULT
              • NAME_CONST
              • INET_ATON
              • INET_NTOA
              • INET6_ATON
              • INET6_NTOA
              • IS_IPV4
              • IS_IPV4_COMPAT
              • IS_IPV6
              • IS_UUID
              • MATCH AGAINST
              • NVL
              • UUID_TO_BIN
              • SLEEP
              • UUID
              • UUID_SHORT
              • VALUES
              • ISNAN
          • Queries and subqueries
            • Overview
            • Subquery
            • Connections
            • Full-text query
          • SQL statements
            • General syntax
            • Generalized Table Expressions
            • ALTER COMPILE
            • ALTER DATABASE
            • ALTER LOCATION
            • ALTER MATERIALIZED VIEW
            • ALTER MATERIALIZED VIEW LOG
            • ALTER OUTLINE
            • ALTER EXTERNAL TABLE
            • ALTER SENSITIVE RULE
            • ALTER POLICY
            • ALTER SEQUENCE
            • ALTER/CHANGE/MODIFY EXTERNAL_STORAGE_DEST
            • ALTER SYSTEM FLUSH SEQUENCE CACHE
            • MAJOR AND MINOR
            • STORAGE_CACHE_POLICY_EXECUTOR
            • ALTER TABLE
            • ALTER TABLEGROUP
            • ALTER TABLESPACE
            • ALTER USER
            • ALTER VIEW
            • ALTER INSTANCE ROTATE INNODB MASTER KEY
            • ALTER EVENT
            • ANALYZE
            • CACHE INDEX
            • CREATE CONCURRENT_LIMITING_RULE
            • CREATE DATABASE
            • CREATE DATABASE LINK
            • CREATE EXTERNAL CATALOG
            • CREATE EXTERNAL TABLE
            • CREATE INDEX
            • CREATE LOCATION
            • CREATE MATERIALIZED VIEW
            • CREATE MATERIALIZED VIEW LOG
            • CREATE OUTLINE
            • CREATE POLICY
            • CREATE FORMAT OUTLINE
            • CREATE ROLE
            • CREATE SENSITIVE RULE
            • CREATE SEQUENCE
            • CREATE TABLE
            • CREATE TABLEGROUP
            • CREATE TABLESPACE
            • CREATE USER
            • CREATE VIEW
            • CHECKSUM TABLE
            • CREATE EVENT
            • DEALLOCATE PREPARE
            • DROP DATABASE LINK
            • DELETE
            • DESCRIBE
            • DROP CATALOG
            • DROP CONCURRENT_LIMITING_RULE
            • DROP DATABASE
            • DROP EVENT
            • DROP INDEX
            • DROP LOCATION
            • DROP MATERIALIZED VIEW
            • DROP MATERIALIZED VIEW LOG
            • DROP OUTLINE
            • DROP ROLE
            • DROP SENSITIVE RULE
            • DROP POLICY
            • DROP TABLE
            • DROP TABLEGROUP
            • DROP TABLESPACE
            • DROP SEQUENCE
            • DROP USER
            • DROP VIEW
            • EXECUTE
            • EXPLAIN
            • FLASHBACK
            • FLUSH TABLE
            • GRANT
            • HELP
            • INSERT
            • KILL
            • LOAD DATA
            • LOAD_FILE
            • LOAD INDEX INTO CACHE
            • LOCK TABLES
            • OPTIMIZE
            • PREPARE
            • PURGE
            • PURGE RECYCLEBIN
            • RENAME USER
            • RENAME TABLE
            • REPLACE
            • REPAIR TABLE
            • REMOVE
            • REVOKE
            • SAVEPOINT
            • SCHEMA
            • SELECT INTO
            • SET DEFAULT ROLE
            • SELECT
              • SELECT
              • JOIN clause
              • WINDOW clause
              • UNION clause
              • HYBRID_SEARCH
              • PARTITION TIER
            • SET
            • SET CATALOG
            • SET CHARSET
            • SET NAMES
            • SET PASSWORD
            • SET ROLE
            • SET TRANSACTION
            • SHOW
            • SUBMIT JOB
            • SHOW JOB STATUS
            • CANCEL JOB
            • TRANSACTION
            • TRUNCATE TABLE
            • UNLOCK TABLES
            • UPDATE
            • USE
            • VALUES
            • XA TRANSACTION
          • DDL feature
            • Overview of DDL features
            • Online DDL and Offline DDL Operations
            • Index operations
            • Primary key operations
            • Column operations
            • Generate columns
            • Foreign key operations
            • Table operations
            • Partition operations
            • Column type change rules
            • Number type conversion rules
          • Pseudo columns
            • Overview of PseudoColumns
            • PARTITIONID Pseudo Column
            • Sequence Pseudocolumns
          • Conditions
            • Overview of SQL Conditions
            • Condition priorities
            • Comparison conditions
            • Logical conditions
            • Pattern matching conditions
            • Null value conditions
            • BETWEEN condition
            • EXISTS condition
            • IN Condition
            • JSON Member Conditions
            • Boolean test conditions
      • SQL specifications and practices
        • SQL Writing Restrictions
        • SQL writing specifications
          • SELECT statement writing specifications
          • DML statement writing guidelines
          • DDL statement writing guidelines
          • Multi-table association guidelines
          • Table scan method specifications
          • Transaction specifications
          • Usage guidelines for cache
          • Guidelines for Using HINTS
          • Other related specifications
        • SQL statement examples
          • Implicit type conversion related
          • Suggestions on using JOIN tables
          • Weak-consistency read
          • Paginated query
      • Reserved keywords
      • Data type conversion behavior in strict mode
    • PL reference
      • What is PL
        • PL Overview
        • Key features of PL
        • Architecture of PL
      • PL syntax structure
      • PL stored procedures
        • Overview of stored programs
        • Variables of stored programs
        • Stored procedure
        • Stored Procedures and Privilege Management
        • Stored functions
        • External storage functions
        • Trigger
        • EVENT
        • Limitations on stored programs
        • SQL Transpiler
        • PL asynchronous commit optimization
      • PL cursors
        • Cursor overview
        • Cursor execution process
        • Limitations on server-side cursors
      • PL conditional control statements
        • CASE
        • IF
        • ITERATE
        • LEAVE
        • LOOP
        • REPEAT
        • RETURN
        • WHILE
      • PL data manipulation statements
        • CALL
        • DO
      • PL data definition statements
        • ALTER FUNCTION
        • ALTER PROCEDURE
        • CREATE FUNCTION
        • CREATE PROCEDURE
        • CREATE TRIGGER
        • DROP FUNCTION
        • DROP PROCEDURE
        • DROP TRIGGER
      • PL database management statements
        • SHOW CREATE FUNCTION
        • SHOW CREATE PROCEDURE
        • SHOW CREATE TRIGGER
        • SHOW FUNCTION STATUS
        • SHOW PROCEDURE STATUS
        • SHOW TRIGGERS
      • PL related dictionary views
        • INFORMATION_SCHEMA PARAMETERS
        • INFORMATION_SCHEMA ROUTINES
        • INFORMATION_SCHEMA TRIGGERS
      • PL exception handling
        • Overview of exception handling
        • DECLARE ... CONDITION
        • DECLARE ... HANDLER
        • GET DIAGNOSTICS
        • RESIGNAL
        • SIGNAL
        • Scope of handlers
        • Diagnostic section
        • Exception Handling and OUT/INOUT Parameters
        • Limitations on exception handling
      • PL system packages
        • Overview of system packages
        • DBMS_AI_SERVICE
          • Overview of DBMS_AI_SERVICE
          • CREATE_AI_MODEL
          • DROP_AI_MODEL
          • CREATE_AI_MODEL_ENDPOINT
          • ALTER_AI_MODEL_ENDPOINT
          • DROP_AI_MODEL_ENDPOINT
          • REGISTER_PROVIDER
          • ALTER_PROVIDER
          • UNREGISTER_PROVIDER
          • ALTER_MODEL_PROFILE
          • DROP_MODEL_PROFILE
          • CREATE_AI_GATEWAY
          • ALTER_AI_GATEWAY
          • DROP_AI_GATEWAY
        • DBMS_ASYNC_INDEX
          • Overview of DBMS_ASYNC_INDEX
          • FORCEMERGE
        • DBMS_DAILY_MAINTENANCE
          • Overview of DBMS_DAILY_MAINTENANCE
          • TRIGGER_WINDOW_COMPACTION_PROC
          • SET_THREAD_COUNT
        • DBMS_HYBRID_SEARCH
          • Overview of DBMS_HYBRID_SEARCH
          • SEARCH
          • GET_SQL
        • DBMS_MVIEW
          • Overview of DBMS_MVIEW
          • PURGE_LOG
          • REFRESH
          • KILL_REFRESH
          • REFRESH_REPORT
        • DBMS_MVIEW_STATS
          • Overview of DBMS_MVIEW_STATS
          • PURGE_REFRESH_STATS
          • SET_MVREF_STATS_PARAMS
          • SET_SYSTEM_DEFAULT
        • DBMS_PARTITION
          • Overview of DBMS_PARTITION
          • MANAGE_DYNAMIC_PARTITION
        • DBMS_RESOURCE_MANAGER
          • Overview of DBMS_RESOURCE_MANAGER
          • CREATE_CONSUMER_GROUP
          • CREATE_PLAN
          • CREATE_PLAN_DIRECTIVE
          • COPY_PLAN
          • DELETE_CONSUMER_GROUP
          • DELETE_PLAN
          • DELETE_PLAN_DIRECTIVE
          • System Packages
          • UPDATE_PLAN_DIRECTIVE
        • DBMS_STATS
          • Overview of DBMS_STATS
          • ALTER_STATS_HISTORY_RETENTION
          • CREATE_STAT_TABLE
          • DELETE_CATALOG_GLOBAL_PREFS
          • DELETE_CATALOG_TABLE_PREFS
          • DELETE_COLUMN_STATS
          • DELETE_INDEX_STATS
          • DELETE_TABLE_STATS
          • DELETE_SCHEMA_STATS
          • DELETE_SCHEMA_PREFS
          • DELETE_SYSTEM_STATS
          • DELETE_TABLE_PREFS
          • DROP_STAT_TABLE
          • EXPORT_COLUMN_STATS
          • EXPORT_INDEX_STATS
          • EXPORT_TABLE_STATS
          • EXPORT_SCHEMA_STATS
          • FLUSH_DATABASE_MONITORING_INFO
          • GATHER_CATALOG_TABLE_STATS
          • GATHER_INDEX_STATS
          • GATHER_TABLE_STATS
          • GATHER_SCHEMA_STATS
          • GATHER_SYSTEM_STATS
          • GET_CATALOG_GLOBAL_PREFS
          • GET_CATALOG_PREFS
          • GET_STATS_HISTORY_AVAILABILITY
          • GET_STATS_HISTORY_RETENTION
          • GET_PARAM
          • GET_PREFS
          • IMPORT_INDEX_STATS
          • IMPORT_COLUMN_STATS
          • IMPORT_TABLE_STATS
          • IMPORT_SCHEMA_STATS
          • LOCK_CATALOG_PARTITION_STAT
          • LOCK_CATALOG_TABLE_STAT
          • LOCK_PARTITION_STATS
          • LOCK_SCHEMA_STATS
          • LOCK_TABLE_STATS
          • RESTORE_TABLE_STATS
          • RESTORE_SCHEMA_STATS
          • RESET_GLOBAL_PREF_DEFAULTS
          • RESET_PARAM_DEFAULTS
          • PURGE_STATS
          • SET_CATALOG_GLOBAL_PREFS
          • SET_CATALOG_TABLE_PREFS
          • SET_COLUMN_STATS
          • SET_INDEX_STATS
          • SET_TABLE_STATS
          • SET_GLOBAL_PREFS
          • SET_PARAM
          • SET_SCHEMA_PREFS
          • SET_SYSTEM_STATS
          • SET_TABLE_PREFS
          • UNLOCK_CATALOG_PARTITION_STAT
          • UNLOCK_CATALOG_TABLE_STAT
          • UNLOCK_PARTITION_STATS
          • UNLOCK_SCHEMA_STATS
          • UNLOCK_TABLE_STATS
          • CANCEL_GATHER_STATS
          • COPY_TABLE_STATS
        • DBMS_TRUSTED_CERTIFICATE_MANAGER
          • Overview of DBMS_TRUSTED_CERTIFICATE_MANAGER
          • ADD_TRUSTED_CERTIFICATE
          • DELETE_TRUSTED_CERTIFICATE
          • UPDATE_TRUSTED_CERTIFICATE
        • DBMS_UDR
          • Overview of DBMS_UDR
          • CREATE_RULE
          • DISABLE_RULE
          • ENABLE_RULE
          • REMOVE_RULE
        • DBMS_VECTOR
          • Overview of DBMS_VECTOR
          • REBUILD_INDEX
          • INDEX_VECTOR_MEMORY_ESTIMATE
          • INDEX_VECTOR_MEMORY_ADVISOR
          • FLUSH_INDEX
          • COMPACT_INDEX
          • TRIGGER_ASYNC_TASK
          • ALTER_INDEX_PARAMS
        • DBMS_WORKLOAD_REPOSITORY
          • Overview of DBMS_WORKLOAD_REPOSITORY
          • ASH_REPORT
          • CREATE_SNAPSHOT
          • DROP_SNAPSHOT_RANGE
          • MODIFY_SNAPSHOT_SETTINGS
        • DBMS_SESSION
          • Overview of DBMS_SESSION
          • SET_IDENTIFIER
          • CLEAR_IDENTIFIER
        • DBMS_APPLICATION_INFO
          • Overview of DBMS_APPLICATION_INFO
          • READ_CLIENT_INFO
          • READ_MODULE
          • SET_ACTION
          • SET_CLIENT_INFO
          • SET_MODULE
        • DBMS_XPLAN
          • Overview of DBMS_XPLAN
          • DISPLAY_ACTIVE_SESSION_PLAN
          • DISPLAY_CURSOR
          • DISPLAY
          • DISABLE_OPT_TRACE
          • DISPLAY_SQL_PLAN_BASELINE
          • ENABLE_OPT_TRACE
          • SET_OPT_TRACE_PARAMETER
        • DBMS_XPROFILE
          • Overview of DBMS_XPROFILE
          • DISPLAY_PROFILE
        • DBMS_BALANCE
          • Overview of DBMS_BALANCE
          • SET_BALANCE_WEIGHT
          • CLEAR_BALANCE_WEIGHT
          • TRIGGER_PARTITION_BALANCE
          • SET_TABLEGROUP_BALANCE_WEIGHT
          • CLEAR_TABLEGROUP_BALANCE_WEIGHT
        • DBMS_OB_LIMIT_CALCULATOR
          • Overview of DBMS_OB_LIMIT_CALCULATOR
          • CALCULATE_MIN_PHY_RES_NEEDED_BY_UNIT
          • CALCULATE_MIN_PHY_RES_NEEDED_BY_LOGIC_RES
          • CALCULATE_MIN_PHY_RES_NEEDED_BY_STANDBY_TENANT
        • DBMS_EXTERNAL_TABLE
          • Overview of DBMS_EXTERNAL_TABLE
          • AUTO_REFRESH_EXTERNAL_TABLE
        • DBMS_JAVA
          • Overview of DBMS_JAVA
          • LOADJAVA
          • DROPJAVA
          • GRANT_PERMISSION
          • RESTRICT_PERMISSION
          • REVOKE_PERMISSION
          • DISABLE_PERMISSION
          • ENABLE_PERMISSION
          • DELETE_PERMISSION
        • DBMS_PYTHON
          • Overview of DBMS_PYTHON
          • DROPPYTHON
          • LOADPYTHON
        • DBMS_DATA_DICT
          • DBMS_DATA_DICT
      • Reserved and Non-Reserved PL Keywords
    • System views
      • Overview of system views
      • Overview of system views
      • SYS tenant views
        • Dictionary views
          • information_schema.CONNECTION_CONTROL_FAILED_LOGIN_ATTEMPTS
          • information_schema.CHARACTER_SETS
          • information_schema.CHECK_CONSTRAINTS
          • information_schema.COLLATION_CHARACTER_SET_APPLICABILITY
          • information_schema.COLLATIONS
          • information_schema.COLUMN_PRIVILEGES
          • information_schema.COLUMNS
          • information_schema.ENGINES
          • information_schema.events
          • information_schema.GLOBAL_STATUS
          • information_schema.GLOBAL_VARIABLES
          • information_schema.KEY_COLUMN_USAGE
          • information_schema.PARAMETERS
          • information_schema.PARTITIONS
          • information_schema.PROCESSLIST
          • information_schema.QUERY_RESPONSE_TIME
          • information_schema.REFERENTIAL_CONSTRAINTS
          • information_schema.role_table_grants
          • information_schema.role_column_grants
          • information_schema.role_routine_grants
          • information_schema.ROUTINES
          • information_schema.SCHEMA_PRIVILEGES
          • information_schema.SCHEMATA
          • information_schema.SESSION_STATUS
          • information_schema.SESSION_VARIABLES
          • information_schema.STATISTICS
          • information_schema.TABLE_CONSTRAINTS
          • information_schema.TABLE_PRIVILEGES
          • information_schema.TABLES
          • information_schema.TRIGGERS
          • information_schema.USER_PRIVILEGES
          • information_schema.VIEW_TABLE_USAGE
          • information_schema.VIEWS
          • mysql.columns_priv
          • mysql.db
          • mysql.default_roles
          • mysql.help_category
          • mysql.help_keyword
          • mysql.help_relation
          • mysql.help_topic
          • mysql.proc
          • mysql.procs_priv
          • mysql.role_edges
          • mysql.time_zone
          • mysql.time_zone_name
          • mysql.time_zone_transition
          • mysql.time_zone_transition_type
          • mysql.user
          • oceanbase.ALL_OB_EXTERNAL_TABLE_FILES
          • oceanbase.CDB_OB_DATABASE_PRIVILEGE
          • oceanbase.CDB_OB_SHARED_MACRO_BLOCK_GC_STAT
          • oceanbase.CDB_IND_COLUMNS
          • oceanbase.CDB_IND_PARTITIONS
          • oceanbase.CDB_IND_SUBPARTITIONS
          • CDB_INDEX_USAGE
          • oceanbase.CDB_INDEXES
          • CDB_MVIEW_LOGS
          • oceanbase.CDB_MVIEW_RUNNING_JOBS
          • CDB_MVIEWS
          • CDB_MVREF_CHANGE_STATS
          • CDB_MVREF_RUN_STATS
          • CDB_MVREF_STATS
          • CDB_MVREF_STATS_PARAMS
          • CDB_MVREF_STATS_SYS_DEFAULTS
          • CDB_MVREF_STMT_STATS
          • oceanbase.CDB_OB_ACCESS_POINT
          • oceanbase.CDB_OB_AI_BATCH_TASK_HISTORY
          • oceanbase.CDB_OB_AI_BATCH_TASKS
          • oceanbase.CDB_OB_AI_GATEWAY_ENDPOINTS
          • oceanbase.CDB_OB_AI_GATEWAYS
          • oceanbase.CDB_OB_AI_MODEL_ENDPOINTS
          • oceanbase.CDB_OB_AI_MODEL_PROFILES
          • oceanbase.CDB_OB_AI_MODEL_PROVIDERS
          • oceanbase.CDB_OB_AI_MODELS
          • oceanbase.CDB_OB_AGENT_DB_BACKGROUND_TASKS
          • oceanbase.CDB_OB_AGENT_DB_BACKGROUND_TASK_HISTORY
          • oceanbase.CDB_OB_ARCHIVE_DEST
          • oceanbase.CDB_OB_ARCHIVELOG
          • oceanbase.CDB_OB_ARCHIVELOG_PIECE_FILES
          • oceanbase.CDB_OB_ARCHIVELOG_SUMMARY
          • oceanbase.CDB_OB_AUTO_INCREMENT
          • CDB_OB_AUX_STATISTICS
          • oceanbase.CDB_OB_BACKUP_DELETE_JOB_HISTORY
          • oceanbase.CDB_OB_BACKUP_DELETE_JOBS
          • oceanbase.CDB_OB_BACKUP_DELETE_POLICY
          • oceanbase.CDB_OB_BACKUP_DELETE_TASK_HISTORY
          • oceanbase.CDB_OB_BACKUP_DELETE_TASKS
          • oceanbase.CDB_OB_BACKUP_JOB_HISTORY
          • oceanbase.CDB_OB_BACKUP_JOBS
          • oceanbase.CDB_OB_BACKUP_PARAMETER
          • oceanbase.CDB_OB_BACKUP_SET_FILES
          • oceanbase.CDB_OB_BACKUP_STORAGE_INFO
          • oceanbase.CDB_OB_BACKUP_STORAGE_INFO_HISTORY
          • oceanbase.CDB_OB_BACKUP_TASK_HISTORY
          • oceanbase.CDB_OB_BACKUP_TASKS
          • oceanbase.CDB_OB_BALANCE_JOB_HISTORY
          • oceanbase.CDB_OB_BALANCE_JOBS
          • oceanbase.CDB_OB_BALANCE_TASK_HISTORY
          • oceanbase.CDB_OB_BALANCE_TASKS
          • oceanbase.CDB_OB_COLUMN_CHECKSUM_ERROR_INFO
          • oceanbase.CDB_OB_CCL_RULES
          • oceanbase.CDB_OB_CS_REPLICA_STATS
          • oceanbase.CDB_OB_DATA_DICTIONARY_IN_LOG
          • oceanbase.CDB_OB_DATABASES
          • oceanbase.CDB_OB_DEADLOCK_EVENT_HISTORY
          • oceanbase.CDB_OB_DYNAMIC_PARTITION_TABLES
          • oceanbase.CDB_OB_EXTERNAL_TABLE_FILES
          • oceanbase.CDB_OB_FREEZE_INFO
          • oceanbase.CDB_OB_IMPORT_TABLE_JOB_HISTORY
          • oceanbase.CDB_OB_IMPORT_TABLE_JOBS
          • oceanbase.CDB_OB_IMPORT_TABLE_TASK_HISTORY
          • oceanbase.CDB_OB_IMPORT_TABLE_TASKS
          • oceanbase.CDB_OB_KV_TTL_TASK_HISTORY
          • oceanbase.CDB_OB_KV_TTL_TASKS
          • oceanbase.CDB_OB_LOG_RESTORE_SOURCE
          • oceanbase.CDB_OB_LOB_CHECK_EXCEPTION_RESULT
          • oceanbase.CDB_OB_LOB_CHECK_TASKS
          • oceanbase.CDB_OB_LS
          • oceanbase.CDB_OB_LS_HISTORY
          • oceanbase.CDB_OB_LS_LOCATIONS
          • oceanbase.CDB_OB_LS_LOG_ARCHIVE_PROGRESS
          • oceanbase.CDB_OB_LS_REPLICA_TASKS
          • oceanbase.CDB_OB_LS_REPLICA_TASK_HISTORY
          • oceanbase.CDB_OB_MAJOR_COMPACTION
          • oceanbase.CDB_OB_OBJECT_BALANCE_WEIGHT
          • oceanbase.CDB_OB_RECOVER_TABLE_JOB_HISTORY
          • oceanbase.CDB_OB_RECOVER_TABLE_JOBS
          • oceanbase.CDB_OB_SERVICES
          • oceanbase.CDB_OB_RESTORE_HISTORY
          • oceanbase.CDB_OB_RESTORE_PROGRESS
          • oceanbase.CDB_OB_RSRC_DIRECTIVES
          • oceanbase.CDB_OB_SENSITIVE_COLUMNS
          • oceanbase.CDB_OB_SENSITIVE_RULE_PLAINACCESS_USERS
          • oceanbase.CDB_OB_SENSITIVE_RULES
          • oceanbase.CDB_OB_SERVER_SPACE_USAGE
          • oceanbase.CDB_OB_SPACE_USAGE
          • oceanbase.CDB_OB_STORAGE_SPACE_USAGE
          • oceanbase.CDB_OB_SYS_VARIABLES
          • oceanbase.CDB_OB_STORAGE_IO_USAGE
          • oceanbase.CDB_OB_SPM_EVO_RESULT
          • oceanbase.CDB_OB_TABLE_LOCATIONS
          • oceanbase.CDB_OB_TABLEGROUP_PARTITIONS
          • oceanbase.CDB_OB_TABLEGROUP_SUBPARTITIONS
          • oceanbase.CDB_OB_TABLEGROUP_TABLES
          • oceanbase.CDB_OB_TABLEGROUPS
          • oceanbase.CDB_OB_TABLET_CHECKSUM_ERROR_INFO
          • oceanbase.CDB_OB_TABLET_REPLICAS
          • oceanbase.CDB_OB_TABLET_TO_LS
          • oceanbase.CDB_OB_TABLE_SPACE_USAGE
          • oceanbase.CDB_OB_TEMP_FILES
          • oceanbase.CDB_OB_TENANT_EVENT_HISTORY
          • oceanbase.CDB_OB_TENANT_FLASHBACK_LOG_SCN
          • oceanbase.CDB_OB_TRANSFER_PARTITION_TASKS
          • oceanbase.CDB_OB_TRANSFER_PARTITION_TASK_HISTORY
          • oceanbase.CDB_OB_TRANSFER_TASK_HISTORY
          • oceanbase.CDB_OB_TRANSFER_TASKS
          • oceanbase.CDB_OB_TTL_TASKS
          • oceanbase.CDB_OB_TTL_TASK_HISTORY
          • oceanbase.CDB_OB_USERS
          • oceanbase.CDB_OB_VECTOR_INDEX_TASKS
          • oceanbase.CDB_OB_VECTOR_INDEX_TASK_HISTORY
          • oceanbase.CDB_OB_ZONE_MAJOR_COMPACTION
          • oceanbase.CDB_OBJECTS
          • oceanbase.CDB_PART_INDEXES
          • oceanbase.CDB_PART_KEY_COLUMNS
          • oceanbase.CDB_PART_TABLES
          • oceanbase.CDB_SCHEDULER_JOB_RUN_DETAILS
          • oceanbase.CDB_SUBPART_KEY_COLUMNS
          • oceanbase.CDB_SUBPARTITION_TEMPLATES
          • oceanbase.CDB_TAB_COL_STATISTICS
          • oceanbase.CDB_TAB_COLS
          • oceanbase.CDB_TAB_COLS_V$
          • oceanbase.CDB_TAB_PARTITIONS
          • oceanbase.CDB_TAB_SUBPARTITIONS
          • oceanbase.CDB_TABLES
          • oceanbase.CDB_WR_ACTIVE_SESSION_HISTORY
          • oceanbase.CDB_WR_CONTROL
          • oceanbase.CDB_WR_EVENT_NAME
          • oceanbase.CDB_WR_RES_MGR_SYSSTAT
          • oceanbase.CDB_WR_SNAPSHOT
          • oceanbase.CDB_WR_SQL_PLAN
          • oceanbase.CDB_WR_SQLSTAT
          • oceanbase.CDB_WR_SQLTEXT
          • oceanbase.CDB_WR_STATNAME
          • oceanbase.CDB_WR_SYS_TIME_MODEL
          • oceanbase.CDB_WR_SYSSTAT
          • oceanbase.CDB_WR_SYSTEM_EVENT
          • oceanbase.CDB_OB_EXTERNAL_RESOURCES
          • oceanbase.DBA_DB_LINKS
          • oceanbase.DBA_IND_PARTITIONS
          • oceanbase.DBA_IND_STATISTICS
          • oceanbase.DBA_IND_SUBPARTITIONS
          • oceanbase.DBA_INDEX_USAGE
          • oceanbase.DBA_MVIEW_DEPS
          • oceanbase.DBA_MVIEW_LOGS
          • oceanbase.DBA_MVIEW_RUNNING_JOBS
          • oceanbase.DBA_MVIEWS
          • oceanbase.DBA_MVREF_CHANGE_STATS
          • oceanbase.DBA_MVREF_RUN_STATS
          • oceanbase.DBA_MVREF_STATS
          • oceanbase.DBA_MVREF_STATS_PARAMS
          • oceanbase.DBA_MVREF_STATS_SYS_DEFAULTS
          • oceanbase.DBA_MVREF_STMT_STATS
          • oceanbase.DBA_OB_ACCESS_POINT
          • oceanbase.DBA_OB_AI_BATCH_TASK_HISTORY
          • oceanbase.DBA_OB_AI_BATCH_TASKS
          • oceanbase.DBA_OB_AI_GATEWAY_ENDPOINTS
          • oceanbase.DBA_OB_AI_GATEWAYS
          • oceanbase.DBA_OB_AI_MODEL_ENDPOINTS
          • oceanbase.DBA_OB_AI_MODEL_PROFILES
          • oceanbase.DBA_OB_AI_MODEL_PROVIDERS
          • oceanbase.DBA_OB_AI_MODELS
          • oceanbase.DBA_OB_AGENT_DB_BACKGROUND_TASKS
          • oceanbase.DBA_OB_AGENT_DB_BACKGROUND_TASK_HISTORY
          • oceanbase.DBA_OB_ARCHIVE_DEST
          • oceanbase.DBA_OB_ARCHIVELOG
          • oceanbase.DBA_OB_ARCHIVELOG_PIECE_FILES
          • oceanbase.DBA_OB_ARCHIVELOG_SUMMARY
          • oceanbase.DBA_OB_AUTO_INCREMENT
          • DBA_OB_AUX_STATISTICS
          • oceanbase.DBA_OB_BACKUP_DELETE_JOB_HISTORY
          • oceanbase.DBA_OB_BACKUP_DELETE_JOBS
          • oceanbase.DBA_OB_BACKUP_DELETE_POLICY
          • oceanbase.DBA_OB_BACKUP_DELETE_TASK_HISTORY
          • oceanbase.DBA_OB_BACKUP_DELETE_TASKS
          • oceanbase.DBA_OB_BACKUP_JOB_HISTORY
          • oceanbase.DBA_OB_BACKUP_JOBS
          • oceanbase.DBA_OB_BACKUP_PARAMETER
          • oceanbase.DBA_OB_BACKUP_SET_FILES
          • oceanbase.DBA_OB_BACKUP_STORAGE_INFO
          • oceanbase.DBA_OB_BACKUP_STORAGE_INFO_HISTORY
          • oceanbase.DBA_OB_BACKUP_TASK_HISTORY
          • oceanbase.DBA_OB_BACKUP_TASKS
          • oceanbase.DBA_OB_BALANCE_JOB_HISTORY
          • oceanbase.DBA_OB_BALANCE_JOBS
          • oceanbase.DBA_OB_BALANCE_TASK_HISTORY
          • oceanbase.DBA_OB_BALANCE_TASKS
          • oceanbase.DBA_OB_CLUSTER_EVENT_HISTORY
          • oceanbase.DBA_OB_CONCURRENT_LIMIT_SQL
          • oceanbase.DBA_OB_CCL_RULES
          • oceanbase.DBA_OB_CS_REPLICA_STATS
          • oceanbase.DBA_OB_DATA_DICTIONARY_IN_LOG
          • oceanbase.DBA_OB_DATABASE_PRIVILEGE
          • oceanbase.DBA_OB_DATABASES
          • oceanbase.DBA_OB_DEADLOCK_EVENT_HISTORY
          • oceanbase.DBA_OB_DYNAMIC_PARTITION_TABLES
          • oceanbase.DBA_OB_EXTERNAL_PART_COL_STATISTICS
          • oceanbase.DBA_OB_EXTERNAL_TAB_COL_STATISTICS
          • oceanbase.DBA_OB_EXTERNAL_TAB_STATISTICS
          • oceanbase.DBA_OB_EXTERNAL_TABLE_FILES
          • oceanbase.DBA_OB_EXTERNAL_RESOURCES
          • DBA_OB_FORMAT_OUTLINES
          • oceanbase.DBA_OB_FREEZE_INFO
          • oceanbase.DBA_OB_IMPORT_TABLE_JOB_HISTORY
          • oceanbase.DBA_OB_IMPORT_TABLE_JOBS
          • oceanbase.DBA_OB_IMPORT_TABLE_TASK_HISTORY
          • oceanbase.DBA_OB_IMPORT_TABLE_TASKS
          • oceanbase.DBA_OB_KV_TTL_TASK_HISTORY
          • oceanbase.DBA_OB_KV_TTL_TASKS
          • oceanbase.DBA_OB_LOG_RESTORE_SOURCE
          • oceanbase.DBA_OB_LOB_CHECK_EXCEPTION_RESULT
          • oceanbase.DBA_OB_LOB_CHECK_TASKS
          • oceanbase.DBA_OB_LS
          • oceanbase.DBA_OB_LS_HISTORY
          • oceanbase.DBA_OB_LS_LOCATIONS
          • oceanbase.DBA_OB_LS_LOG_ARCHIVE_PROGRESS
          • oceanbase.DBA_OB_LS_REPLICA_TASKS
          • oceanbase.DBA_OB_LS_REPLICA_TASK_HISTORY
          • oceanbase.DBA_OB_MAJOR_COMPACTION
          • oceanbase.DBA_OB_OUTLINE_CONCURRENT_HISTORY
          • oceanbase.DBA_OB_OUTLINES
          • oceanbase.DBA_OB_RECOVER_TABLE_JOB_HISTORY
          • oceanbase.DBA_OB_SERVICES
          • oceanbase.DBA_OB_RECOVER_TABLE_JOBS
          • oceanbase.DBA_OB_RESOURCE_POOLS
          • oceanbase.DBA_OB_RESTORE_HISTORY
          • oceanbase.DBA_OB_RESTORE_PROGRESS
          • oceanbase.DBA_OB_ROOTSERVICE_EVENT_HISTORY
          • oceanbase.DBA_OB_RSRC_IO_DIRECTIVES
          • oceanbase.DBA_OB_RSRC_DIRECTIVES
          • oceanbase.DBA_OB_SEQUENCE_OBJECTS
          • oceanbase.DBA_OB_SERVER_EVENT_HISTORY
          • oceanbase.DBA_OB_SERVER_JOBS
          • oceanbase.DBA_OB_SERVERS
          • oceanbase.DBA_OB_STORAGE_SPACE_USAGE
          • oceanbase.DBA_OB_STORAGE_IO_USAGE
          • oceanbase.DBA_OB_SHARED_MACRO_BLOCK_GC_STAT
          • oceanbase.DBA_OB_SYS_VARIABLES
          • oceanbase.DBA_OB_SPM_EVO_RESULT
          • oceanbase.DBA_OB_TABLE_LOCATIONS
          • oceanbase.DBA_OB_TABLE_OPT_STAT_GATHER_HISTORY
          • oceanbase.DBA_OB_TABLE_STAT_STALE_INFO
          • oceanbase.DBA_OB_TABLEGROUP_PARTITIONS
          • oceanbase.DBA_OB_TABLEGROUP_SUBPARTITIONS
          • oceanbase.DBA_OB_TABLEGROUP_TABLES
          • oceanbase.DBA_OB_TABLEGROUPS
          • oceanbase.DBA_OB_TABLET_REPLICAS
          • oceanbase.DBA_OB_TABLET_TO_LS
          • oceanbase.DBA_OB_TASK_OPT_STAT_GATHER_HISTORY
          • oceanbase.DBA_OB_TEMP_FILES
          • oceanbase.DBA_OB_TENANT_EVENT_HISTORY
          • oceanbase.DBA_OB_TENANT_FLASHBACK_LOG_SCN
          • oceanbase.DBA_OB_TENANT_JOBS
          • oceanbase.DBA_OB_TENANTS
          • oceanbase.DBA_OB_TRANSFER_PARTITION_TASKS
          • oceanbase.DBA_OB_TRANSFER_PARTITION_TASK_HISTORY
          • oceanbase.DBA_OB_TRANSFER_TASK_HISTORY
          • oceanbase.DBA_OB_TRANSFER_TASKS
          • DBA_OB_TRUSTED_ROOT_CERTIFICATE
          • oceanbase.DBA_OB_TTL_TASKS
          • oceanbase.DBA_OB_TTL_TASK_HISTORY
          • oceanbase.DBA_OB_UNIT_CONFIGS
          • oceanbase.DBA_OB_UNIT_JOBS
          • oceanbase.DBA_OB_UNITS
          • oceanbase.DBA_OB_USER_DEFINED_RULES
          • oceanbase.DBA_OB_USERS
          • oceanbase.DBA_OB_VECTOR_INDEX_TASKS
          • oceanbase.DBA_OB_VECTOR_INDEX_TASK_HISTORY
          • oceanbase.DBA_OB_ZONE_MAJOR_COMPACTION
          • oceanbase.DBA_OB_ZONES
          • oceanbase.DBA_OB_ZONE_STORAGE
          • oceanbase.DBA_OBJECTS
          • oceanbase.DBA_PART_COL_STATISTICS
          • oceanbase.DBA_PART_HISTOGRAMS
          • oceanbase.DBA_PART_INDEXES
          • oceanbase.DBA_PART_KEY_COLUMNS
          • oceanbase.DBA_PART_TABLES
          • oceanbase.DBA_RECYCLEBIN
          • oceanbase.DBA_RSRC_CONSUMER_GROUPS
          • oceanbase.DBA_RSRC_GROUP_MAPPINGS
          • oceanbase.DBA_RSRC_PLAN_DIRECTIVES
          • oceanbase.DBA_RSRC_PLANS
          • oceanbase.DBA_SCHEDULER_JOBS
          • oceanbase.DBA_SCHEDULER_JOB_RUN_DETAILS
          • oceanbase.DBA_SCHEDULER_WINDOWS
          • oceanbase.DBA_SEQUENCES
          • oceanbase.DBA_SQL_MANAGEMENT_CONFIG
          • oceanbase.DBA_SQL_PLAN_BASELINES
          • oceanbase.DBA_SUBPART_COL_STATISTICS
          • oceanbase.DBA_SUBPART_HISTOGRAMS
          • oceanbase.DBA_SUBPART_KEY_COLUMNS
          • oceanbase.DBA_SUBPARTITION_TEMPLATES
          • oceanbase.DBA_TAB_COL_STATISTICS
          • oceanbase.DBA_TAB_HISTOGRAMS
          • oceanbase.DBA_TAB_MODIFICATIONS
          • oceanbase.DBA_TAB_PARTITIONS
          • oceanbase.DBA_TAB_STATISTICS
          • oceanbase.DBA_TAB_STATS_HISTORY
          • oceanbase.DBA_TAB_SUBPARTITIONS
          • oceanbase.DBA_TABLES
          • oceanbase.DBA_WR_ACTIVE_SESSION_HISTORY
          • oceanbase.DBA_WR_CONTROL
          • oceanbase.DBA_WR_EVENT_NAME
          • oceanbase.DBA_WR_RES_MGR_SYSSTAT
          • oceanbase.DBA_WR_SNAPSHOT
          • oceanbase.DBA_WR_SQL_PLAN
          • oceanbase.DBA_WR_SQLSTAT
          • oceanbase.DBA_WR_SQLTEXT
          • oceanbase.DBA_WR_STATNAME
          • oceanbase.DBA_WR_SYS_TIME_MODEL
          • oceanbase.DBA_WR_SYSSTAT
          • oceanbase.DBA_WR_SYSTEM_EVENT
        • Performance views
          • GV$ACTIVE_SESSION_HISTORY
          • GV$DML_STATS
          • GV$LATCH
          • GV$OB_ACTIVE_SESSION_HISTORY
          • GV$OB_COMPACTION_DIAGNOSE_INFO
          • GV$OB_COMPACTION_PROGRESS
          • GV$OB_COMPACTION_SUGGESTIONS
          • GV$OB_CGROUP_CONFIG
          • GV$OB_DTL_INTERM_RESULT_MONITOR
          • GV$OB_EXTERNAL_CATALOG_CLIENT_POOL_STAT
          • GV$OB_FLT_TRACE_CONFIG
          • GV$OB_FUNCTION_IO_STAT
          • GV$OB_GROUP_IO_STAT
          • GV$OB_HMS_CLIENT_POOL_STAT
          • GV$OB_HNSW_INDEX_INFO
          • GV$OB_HNSW_INDEX_SEGMENT_INFO
          • GV$OB_IO_BENCHMARK
          • GV$OB_IO_CALIBRATION_STATUS
          • GV$OB_IVF_INDEX_INFO
          • GV$OB_KVCACHE
          • GV$OB_KV_GROUP_COMMIT_STATUS
          • GV$OB_KV_CONNECTIONS
          • GV$OB_LOG_STAT
          • GV$OB_LOG_TRANSPORT_DEST_STAT
          • GV$OB_LS_SNAPSHOTS
          • GV$OB_MEMORY
          • GV$OB_MEMSTORE
          • GV$OB_MEMSTORE_INFO
          • GV$OB_MERGE_INFO
          • GV$OB_NIC_INFO
          • GV$OB_RPC_INCOMING
          • GV$OB_RPC_OUTGOING
          • GV$OB_PARAMETERS
          • GV$OB_PLAN_CACHE_PLAN_EXPLAIN
          • GV$OB_PLAN_CACHE_PLAN_STAT
          • GV$OB_PLAN_CACHE_STAT
          • GV$OB_PLUGINS
          • GV$OB_PROCESSLIST
          • GV$OB_PS_ITEM_INFO
          • GV$OB_PS_STAT
          • GV$OB_PX_P2P_DATAHUB
          • GV$OB_PX_TARGET_MONITOR
          • GV$OB_PX_WORKER_STAT
          • GV$OB_RES_MGR_SYSSTAT
          • GV$OB_QUERY_RESPONSE_TIME_HISTOGRAM
          • GV$OB_SERVER_SCHEMA_INFO
          • GV$OB_SERVERS
          • GV$OB_SERVER_STORAGE
          • GV$OB_SESS_TIME_MODEL
          • GV$OB_SESSION
          • GV$OB_SESSION_PS_INFO
          • GV$OB_SHARED_STORAGE_QUOTA
          • GV$OB_SINDI_INDEX_INFO
          • GV$OB_SQL_AUDIT
          • GV$OB_SQL_CCL_STATUS
          • GV$SQL_JOIN_FILTER
          • GV$OB_SQL_PLAN
          • GV$SQL_PLAN_MONITOR
          • GV$OB_SQL_WORKAREA_MEMORY_INFO
          • GV$OB_SQLSTAT
          • GV$OB_SSTABLES
          • GV$OB_LOCAL_CACHE
          • GV$OB_LOCAL_CACHE_DIAGNOSE
          • GV$OB_OBJECT_TYPE_IO_STAT
          • GV$OB_STORAGE_CACHE_TASKS
          • GV$OB_SYS_TIME_MODEL
          • GV$OB_TABLET_COMPACTION_HISTORY
          • GV$OB_TABLET_COMPACTION_PROGRESS
          • GV$OB_TABLET_LOCAL_CACHE
          • GV$OB_TABLET_REPLICA_INFO
          • GV$OB_TENANT_MEMORY
          • GV$OB_TENANT_RESOURCE_LIMIT
          • GV$OB_TENANT_RESOURCE_LIMIT_DETAIL
          • GV$OB_TENANT_RUNTIME_INFO
          • GV$OB_TRANSACTION_PARTICIPANTS
          • GV$OB_TRANSACTION_SCHEDULERS
          • GV$OB_UNITS
          • GV$OB_VECTOR_MEMORY
          • GV$SESSION_EVENT
          • GV$SESSION_LONGOPS
          • GV$SESSION_WAIT
          • GV$SESSION_WAIT_HISTORY
          • GV$SESSTAT
          • GV$SQL_WORKAREA
          • GV$SQL_WORKAREA_ACTIVE
          • GV$SQL_WORKAREA_HISTOGRAM
          • GV$SYSSTAT
          • GV$SYSTEM_EVENT
          • GV$OB_KV_CLIENT_INFO
          • GV$OB_LOCKS
          • GV$OB_OPT_STAT_GATHER_MONITOR
          • GV$OB_THREAD
          • GV$OB_PL_CACHE_OBJECT
          • V$OB_PL_CACHE_OBJECT
          • V$ACTIVE_SESSION_HISTORY
          • V$DML_STATS
          • V$ENCRYPTED_TABLESPACES
          • V$EVENT_NAME
          • V$LATCH
          • V$OB_ACTIVE_SESSION_HISTORY
          • V$OB_ARCHIVE_DEST_STATUS
          • V$OB_COMPACTION_DIAGNOSE_INFO
          • V$OB_COMPACTION_PROGRESS
          • V$OB_COMPACTION_SUGGESTIONS
          • V$OB_COMPATIBILITY_CONTROL
          • V$OB_CGROUP_CONFIG
          • V$OB_DTL_INTERM_RESULT_MONITOR
          • V$OB_DYNAMIC_PARTITION_TABLES
          • V$OB_ENCRYPTED_TABLES
          • V$OB_EXTERNAL_CATALOG_CLIENT_POOL_STAT
          • V$OB_FUNCTION_IO_STAT
          • V$OB_GROUP_IO_STAT
          • V$OB_HMS_CLIENT_POOL_STAT
          • V$OB_IO_BENCHMARK
          • V$OB_HNSW_INDEX_SEGMENT_INFO
          • V$OB_HNSW_INDEX_INFO
          • V$OB_IO_CALIBRATION_STATUS
          • V$OB_IVF_INDEX_INFO
          • V$OB_KVCACHE
          • V$OB_KV_CLIENT_INFO
          • V$OB_KV_GROUP_COMMIT_STATUS
          • V$OB_KV_CONNECTIONS
          • V$OB_LOG_STAT
          • V$OB_LOG_TRANSPORT_DEST_STAT
          • V$OB_LS_LOG_RESTORE_STATUS
          • V$OB_LS_REPLICA_TASK_PLAN
          • V$OB_LS_SNAPSHOTS
          • V$OB_MEMORY
          • V$OB_MEMSTORE
          • V$OB_MEMSTORE_INFO
          • V$OB_MERGE_INFO
          • V$OB_NIC_INFO
          • V$OB_RPC_INCOMING
          • V$OB_RPC_OUTGOING
          • V$OB_PARAMETERS
          • V$OB_PLAN_CACHE_PLAN_EXPLAIN
          • V$OB_PLAN_CACHE_PLAN_STAT
          • V$OB_PLAN_CACHE_STAT
          • V$OB_PLUGINS
          • V$OB_PROCESSLIST
          • V$OB_PS_ITEM_INFO
          • V$OB_PS_STAT
          • V$OB_PX_P2P_DATAHUB
          • V$OB_PX_TARGET_MONITOR
          • V$OB_PX_WORKER_STAT
          • V$OB_RES_MGR_SYSSTAT
          • V$OB_QUERY_RESPONSE_TIME_HISTOGRAM
          • V$OB_SERVER_SCHEMA_INFO
          • V$OB_SERVERS
          • V$OB_SERVER_STORAGE
          • V$OB_SESS_TIME_MODEL
          • V$OB_SESSION
          • V$SESSION_EVENT
          • V$OB_SESSION_PS_INFO
          • V$OB_SHARED_STORAGE_QUOTA
          • V$OB_SINDI_INDEX_INFO
          • V$OB_SQL_AUDIT
          • V$OB_SQL_CCL_STATUS
          • V$SQL_JOIN_FILTER
          • V$OB_SQL_PLAN
          • V$OB_SQL_WORKAREA_MEMORY_INFO
          • V$OB_SQLSTAT
          • V$OB_SHARED_SSTABLES
          • V$OB_SSTABLES
          • V$OB_LOCAL_CACHE
          • V$OB_LOCAL_CACHE_DIAGNOSE
          • V$OB_OBJECT_TYPE_IO_STAT
          • V$OB_STORAGE_CACHE_TASKS
          • V$OB_SYS_TIME_MODEL
          • V$OB_TABLET_COMPACTION_HISTORY
          • V$OB_TABLET_COMPACTION_PROGRESS
          • V$OB_TABLET_LOCAL_CACHE
          • V$OB_TABLET_REPLICA_INFO
          • V$OB_TENANT_MEMORY
          • V$OB_TENANT_RESOURCE_LIMIT
          • V$OB_TENANT_RESOURCE_LIMIT_DETAIL
          • V$OB_TENANT_RUNTIME_INFO
          • V$OB_TIMESTAMP_SERVICE
          • V$OB_TRANSACTION_PARTICIPANTS
          • V$OB_TRANSACTION_SCHEDULERS
          • V$OB_UNITS
          • V$RSRC_PLAN
          • V$SESSION_LONGOPS
          • V$SESSION_WAIT
          • V$SESSION_WAIT_HISTORY
          • V$SESSTAT
          • V$SQL_MONITOR_STATNAME
          • V$SQL_PLAN_MONITOR
          • V$SQL_WORKAREA
          • V$SQL_WORKAREA_ACTIVE
          • V$SQL_WORKAREA_HISTOGRAM
          • V$STATNAME
          • V$SYSSTAT
          • V$SYSTEM_EVENT
          • V$OB_LOCKS
          • V$OB_OPT_STAT_GATHER_MONITOR
          • V$OB_THREAD
          • V$OB_VECTOR_MEMORY
      • User tenant views
        • Dictionary views
          • information_schema.CONNECTION_CONTROL_FAILED_LOGIN_ATTEMPTS
          • information_schema.CHARACTER_SETS
          • information_schema.CHECK_CONSTRAINTS
          • information_schema.COLLATION_CHARACTER_SET_APPLICABILITY
          • information_schema.COLLATIONS
          • information_schema.COLUMN_PRIVILEGES
          • information_schema.COLUMNS
          • information_schema.ENGINES
          • information_schema.events
          • information_schema.GLOBAL_STATUS
          • information_schema.GLOBAL_VARIABLES
          • information_schema.KEY_COLUMN_USAGE
          • information_schema.PARAMETERS
          • information_schema.PARTITIONS
          • information_schema.PROCESSLIST
          • information_schema.QUERY_RESPONSE_TIME
          • information_schema.REFERENTIAL_CONSTRAINTS
          • information_schema.role_table_grants
          • information_schema.role_column_grants
          • information_schema.role_routine_grants
          • information_schema.ROUTINES
          • information_schema.SCHEMA_PRIVILEGES
          • information_schema.SCHEMATA
          • information_schema.SESSION_STATUS
          • information_schema.SESSION_VARIABLES
          • information_schema.ST_GEOMETRY_COLUMNS
          • information_schema.ST_SPATIAL_REFERENCE_SYSTEMS
          • information_schema.STATISTICS
          • information_schema.TABLE_CONSTRAINTS
          • information_schema.TABLE_PRIVILEGES
          • information_schema.TABLES
          • information_schema.TRIGGERS
          • information_schema.USER_PRIVILEGES
          • information_schema.VIEW_TABLE_USAGE
          • information_schema.VIEWS
          • mysql.audit_log_filter
          • mysql.audit_log_user
          • mysql.columns_priv
          • mysql.db
          • mysql.default_roles
          • mysql.help_category
          • mysql.help_keyword
          • mysql.help_relation
          • mysql.help_topic
          • mysql.proc
          • mysql.procs_priv
          • mysql.role_edges
          • mysql.time_zone
          • mysql.time_zone_name
          • mysql.time_zone_transition
          • mysql.time_zone_transition_type
          • mysql.user
          • oceanbase.ALL_OB_EXTERNAL_TABLE_FILES
          • oceanbase.DBA_DB_LINKS
          • oceanbase.DBA_IND_PARTITIONS
          • oceanbase.DBA_IND_STATISTICS
          • oceanbase.DBA_IND_SUBPARTITIONS
          • oceanbase.DBA_INDEX_USAGE
          • oceanbase.DBA_JAVA_POLICY
          • oceanbase.DBA_MVIEW_DEPS
          • oceanbase.DBA_MVIEW_LOGS
          • oceanbase.DBA_MVIEW_RUNNING_JOBS
          • oceanbase.DBA_MVIEWS
          • oceanbase.DBA_MVREF_CHANGE_STATS
          • oceanbase.DBA_MVREF_RUN_STATS
          • oceanbase.DBA_MVREF_STATS
          • oceanbase.DBA_MVREF_STATS_PARAMS
          • oceanbase.DBA_MVREF_STATS_SYS_DEFAULTS
          • oceanbase.DBA_MVREF_STMT_STATS
          • oceanbase.DBA_OB_ACCESS_POINT
          • oceanbase.DBA_OB_AI_BATCH_TASK_HISTORY
          • oceanbase.DBA_OB_AI_BATCH_TASKS
          • oceanbase.DBA_OB_AI_GATEWAY_ENDPOINTS
          • oceanbase.DBA_OB_AI_GATEWAYS
          • oceanbase.DBA_OB_AI_MODEL_ENDPOINTS
          • oceanbase.DBA_OB_AI_MODEL_PROFILES
          • oceanbase.DBA_OB_AI_MODEL_PROVIDERS
          • oceanbase.DBA_OB_AI_MODELS
          • oceanbase.DBA_OB_AGENT_DB_BACKGROUND_TASKS
          • oceanbase.DBA_OB_AGENT_DB_BACKGROUND_TASK_HISTORY
          • oceanbase.DBA_OB_ARCHIVE_DEST
          • oceanbase.DBA_OB_ARCHIVELOG
          • oceanbase.DBA_OB_ARCHIVELOG_PIECE_FILES
          • oceanbase.DBA_OB_ARCHIVELOG_SUMMARY
          • oceanbase.DBA_OB_AUTO_INCREMENT
          • DBA_OB_AUX_STATISTICS
          • oceanbase.DBA_OB_BACKUP_DELETE_JOB_HISTORY
          • oceanbase.DBA_OB_BACKUP_DELETE_JOBS
          • oceanbase.DBA_OB_BACKUP_DELETE_POLICY
          • oceanbase.DBA_OB_BACKUP_DELETE_TASK_HISTORY
          • oceanbase.DBA_OB_BACKUP_DELETE_TASKS
          • oceanbase.DBA_OB_BACKUP_JOB_HISTORY
          • oceanbase.DBA_OB_BACKUP_JOBS
          • oceanbase.DBA_OB_BACKUP_PARAMETER
          • oceanbase.DBA_OB_BACKUP_SET_FILES
          • oceanbase.DBA_OB_BACKUP_STORAGE_INFO
          • oceanbase.DBA_OB_BACKUP_STORAGE_INFO_HISTORY
          • oceanbase.DBA_OB_BACKUP_TASK_HISTORY
          • oceanbase.DBA_OB_BACKUP_TASKS
          • oceanbase.DBA_OB_BALANCE_JOB_HISTORY
          • oceanbase.DBA_OB_BALANCE_JOBS
          • oceanbase.DBA_OB_BALANCE_TASK_HISTORY
          • oceanbase.DBA_OB_BALANCE_TASKS
          • oceanbase.DBA_OB_CONCURRENT_LIMIT_SQL
          • oceanbase.DBA_OB_CCL_RULES
          • oceanbase.DBA_OB_CS_REPLICA_STATS
          • oceanbase.DBA_OB_DATA_DICTIONARY_IN_LOG
          • oceanbase.DBA_OB_DATABASE_PRIVILEGE
          • oceanbase.DBA_OB_DATABASES
          • oceanbase.DBA_OB_DEADLOCK_EVENT_HISTORY
          • oceanbase.DBA_OB_DYNAMIC_PARTITION_TABLES
          • oceanbase.DBA_OB_EXTERNAL_PART_COL_STATISTICS
          • oceanbase.DBA_OB_EXTERNAL_TAB_COL_STATISTICS
          • oceanbase.DBA_OB_EXTERNAL_TAB_STATISTICS
          • oceanbase.DBA_OB_EXTERNAL_TABLE_FILES
          • oceanbase.DBA_OB_EXTERNAL_RESOURCES
          • DBA_OB_FORMAT_OUTLINES
          • oceanbase.DBA_OB_FREEZE_INFO
          • oceanbase.DBA_OB_IMPORT_TABLE_JOB_HISTORY
          • oceanbase.DBA_OB_IMPORT_TABLE_JOBS
          • oceanbase.DBA_OB_IMPORT_TABLE_TASK_HISTORY
          • oceanbase.DBA_OB_IMPORT_TABLE_TASKS
          • oceanbase.DBA_OB_KV_TTL_TASK_HISTORY
          • oceanbase.DBA_OB_KV_TTL_TASKS
          • oceanbase.DBA_OB_LOG_RESTORE_SOURCE
          • oceanbase.DBA_OB_LOB_CHECK_EXCEPTION_RESULT
          • oceanbase.DBA_OB_LOB_CHECK_TASKS
          • oceanbase.DBA_OB_LS
          • oceanbase.DBA_OB_LS_HISTORY
          • oceanbase.DBA_OB_LS_LOCATIONS
          • oceanbase.DBA_OB_LS_LOG_ARCHIVE_PROGRESS
          • oceanbase.DBA_OB_LS_REPLICA_TASKS
          • oceanbase.DBA_OB_LS_REPLICA_TASK_HISTORY
          • oceanbase.DBA_OB_MAJOR_COMPACTION
          • oceanbase.DBA_OB_OBJECT_BALANCE_WEIGHT
          • oceanbase.DBA_OB_OUTLINE_CONCURRENT_HISTORY
          • oceanbase.DBA_OB_OUTLINES
          • oceanbase.DBA_OB_RECOVER_TABLE_JOB_HISTORY
          • oceanbase.DBA_OB_RECOVER_TABLE_JOBS
          • oceanbase.DBA_OB_SERVICES
          • oceanbase.DBA_OB_RESTORE_HISTORY
          • oceanbase.DBA_OB_RESTORE_PROGRESS
          • oceanbase.DBA_OB_RSRC_IO_DIRECTIVES
          • oceanbase.DBA_OB_RSRC_DIRECTIVES
          • oceanbase.DBA_OB_SENSITIVE_COLUMNS
          • oceanbase.DBA_OB_SENSITIVE_RULE_PLAINACCESS_USERS
          • oceanbase.DBA_OB_SENSITIVE_RULES
          • oceanbase.DBA_OB_SEQUENCE_OBJECTS
          • oceanbase.DBA_OB_SHARED_MACRO_BLOCK_GC_STAT
          • oceanbase.DBA_OB_STORAGE_SPACE_USAGE
          • oceanbase.DBA_OB_STORAGE_IO_USAGE
          • oceanbase.DBA_OB_SYS_VARIABLES
          • oceanbase.DBA_OB_SPM_EVO_RESULT
          • oceanbase.DBA_OB_TABLE_LOCATIONS
          • oceanbase.DBA_OB_TABLE_OPT_STAT_GATHER_HISTORY
          • oceanbase.DBA_OB_TABLE_STAT_STALE_INFO
          • oceanbase.DBA_OB_TABLEGROUP_PARTITIONS
          • oceanbase.DBA_OB_TABLEGROUP_SUBPARTITIONS
          • oceanbase.DBA_OB_TABLEGROUP_TABLES
          • oceanbase.DBA_OB_TABLEGROUPS
          • oceanbase.DBA_OB_TABLET_REPLICAS
          • oceanbase.DBA_OB_TABLE_SPACE_USAGE
          • oceanbase.DBA_OB_TABLET_TO_LS
          • oceanbase.DBA_OB_TASK_OPT_STAT_GATHER_HISTORY
          • oceanbase.DBA_OB_TENANT_EVENT_HISTORY
          • oceanbase.DBA_OB_TENANTS
          • oceanbase.DBA_OB_TEMP_FILES
          • oceanbase.DBA_OB_TRANSFER_PARTITION_TASKS
          • oceanbase.DBA_OB_TRANSFER_PARTITION_TASK_HISTORY
          • oceanbase.DBA_OB_TRANSFER_TASK_HISTORY
          • oceanbase.DBA_OB_TRANSFER_TASKS
          • oceanbase.DBA_OB_USER_DEFINED_RULES
          • oceanbase.DBA_OB_USERS
          • oceanbase.DBA_OB_VECTOR_INDEX_TASKS
          • oceanbase.DBA_OB_VECTOR_INDEX_TASK_HISTORY
          • oceanbase.DBA_OB_ZONE_MAJOR_COMPACTION
          • oceanbase.DBA_OBJECTS
          • oceanbase.DBA_PART_COL_STATISTICS
          • oceanbase.DBA_PART_HISTOGRAMS
          • oceanbase.DBA_PART_INDEXES
          • oceanbase.DBA_PART_KEY_COLUMNS
          • oceanbase.DBA_PART_TABLES
          • oceanbase.DBA_RECYCLEBIN
          • oceanbase.DBA_RLS_POLICIES
          • oceanbase.DBA_RSRC_CONSUMER_GROUPS
          • oceanbase.DBA_RSRC_GROUP_MAPPINGS
          • oceanbase.DBA_RSRC_PLAN_DIRECTIVES
          • oceanbase.DBA_RSRC_PLANS
          • oceanbase.DBA_SCHEDULER_JOBS
          • oceanbase.DBA_SCHEDULER_JOB_RUN_DETAILS
          • oceanbase.DBA_SCHEDULER_WINDOWS
          • oceanbase.DBA_SEQUENCES
          • oceanbase.DBA_SQL_MANAGEMENT_CONFIG
          • oceanbase.DBA_SQL_PLAN_BASELINES
          • oceanbase.DBA_SUBPART_COL_STATISTICS
          • oceanbase.DBA_SUBPART_HISTOGRAMS
          • oceanbase.DBA_SUBPART_KEY_COLUMNS
          • oceanbase.DBA_SUBPARTITION_TEMPLATES
          • oceanbase.DBA_TAB_COL_STATISTICS
          • oceanbase.DBA_TAB_HISTOGRAMS
          • oceanbase.DBA_TAB_MODIFICATIONS
          • oceanbase.DBA_TAB_PARTITIONS
          • oceanbase.DBA_TAB_STATISTICS
          • oceanbase.DBA_TAB_STATS_HISTORY
          • oceanbase.DBA_TAB_SUBPARTITIONS
          • oceanbase.DBA_TABLES
          • oceanbase.DBA_OB_TENANT_FLASHBACK_LOG_SCN
          • oceanbase.DBA_OB_TTL_TASKS
          • oceanbase.DBA_OB_TTL_TASK_HISTORY
          • oceanbase.DBA_WR_ACTIVE_SESSION_HISTORY
          • oceanbase.DBA_WR_CONTROL
          • oceanbase.DBA_WR_EVENT_NAME
          • oceanbase.DBA_WR_RES_MGR_SYSSTAT
          • oceanbase.DBA_WR_SNAPSHOT
          • oceanbase.DBA_WR_SQL_PLAN
          • oceanbase.DBA_WR_SQLSTAT
          • oceanbase.DBA_WR_SQLTEXT
          • oceanbase.DBA_WR_STATNAME
          • oceanbase.DBA_WR_SYS_TIME_MODEL
          • oceanbase.DBA_WR_SYSSTAT
          • oceanbase.DBA_WR_SYSTEM_EVENT
          • oceanbase.USER_JAVA_POLICY
        • Performance views
          • GV$ACTIVE_SESSION_HISTORY
          • GV$DML_STATS
          • GV$LATCH
          • GV$OB_ACTIVE_SESSION_HISTORY
          • GV$OB_COMPACTION_DIAGNOSE_INFO
          • GV$OB_COMPACTION_PROGRESS
          • GV$OB_COMPACTION_SUGGESTIONS
          • GV$OB_CGROUP_CONFIG
          • GV$OB_DTL_INTERM_RESULT_MONITOR
          • GV$OB_EXTERNAL_CATALOG_CLIENT_POOL_STAT
          • GV$OB_FLT_TRACE_CONFIG
          • GV$OB_FUNCTION_IO_STAT
          • GV$OB_GROUP_IO_STAT
          • GV$OB_HNSW_INDEX_INFO
          • GV$OB_HMS_CLIENT_POOL_STAT
          • GV$OB_IVF_INDEX_INFO
          • GV$OB_HNSW_INDEX_SEGMENT_INFO
          • GV$OB_KVCACHE
          • GV$OB_KV_CLIENT_INFO
          • GV$OB_KV_GROUP_COMMIT_STATUS
          • GV$OB_KV_CONNECTIONS
          • GV$OB_LOG_STAT
          • GV$OB_LOG_TRANSPORT_DEST_STAT
          • GV$OB_LS_SNAPSHOTS
          • GV$OB_MEMORY
          • GV$OB_MEMSTORE
          • GV$OB_MEMSTORE_INFO
          • GV$OB_MERGE_INFO
          • GV$OB_NIC_INFO
          • GV$OB_RPC_INCOMING
          • GV$OB_RPC_OUTGOING
          • GV$OB_PARAMETERS
          • GV$OB_PLAN_CACHE_PLAN_EXPLAIN
          • GV$OB_PLAN_CACHE_PLAN_STAT
          • GV$OB_PLAN_CACHE_STAT
          • GV$OB_PROCESSLIST
          • GV$OB_PS_ITEM_INFO
          • GV$OB_PS_STAT
          • GV$OB_PX_P2P_DATAHUB
          • GV$OB_PX_TARGET_MONITOR
          • GV$OB_PX_WORKER_STAT
          • GV$OB_RES_MGR_SYSSTAT
          • GV$OB_QUERY_RESPONSE_TIME_HISTOGRAM
          • GV$OB_SERVER_SCHEMA_INFO
          • GV$OB_SESS_TIME_MODEL
          • GV$OB_SESSION
          • GV$OB_SESSION_PS_INFO
          • GV$OB_SHARED_STORAGE_QUOTA
          • GV$OB_SINDI_INDEX_INFO
          • GV$OB_SQL_AUDIT
          • GV$OB_SQL_CCL_STATUS
          • GV$SQL_JOIN_FILTER
          • GV$OB_SQL_PLAN
          • GV$OB_SQL_WORKAREA_MEMORY_INFO
          • GV$OB_SQLSTAT
          • GV$OB_SSTABLES
          • GV$OB_LOCAL_CACHE
          • GV$OB_LOCAL_CACHE_DIAGNOSE
          • GV$OB_OBJECT_TYPE_IO_STAT
          • GV$OB_STORAGE_CACHE_TASKS
          • GV$OB_SYS_TIME_MODEL
          • GV$OB_TABLET_COMPACTION_HISTORY
          • GV$OB_TABLET_COMPACTION_PROGRESS
          • GV$OB_TABLET_LOCAL_CACHE
          • GV$OB_TABLET_MACRO_CACHE_STAT
          • GV$OB_TENANT_MEMORY
          • GV$OB_TENANT_RESOURCE_LIMIT
          • GV$OB_TENANT_RESOURCE_LIMIT_DETAIL
          • GV$OB_TRANSACTION_PARTICIPANTS
          • GV$OB_TRANSACTION_SCHEDULERS
          • GV$OB_UNITS
          • GV$OB_VECTOR_MEMORY
          • GV$SESSION_EVENT
          • GV$SESSION_LONGOPS
          • GV$SESSION_WAIT
          • GV$SESSION_WAIT_HISTORY
          • GV$SESSTAT
          • GV$SQL_PLAN_MONITOR
          • GV$SQL_WORKAREA
          • GV$SQL_WORKAREA_ACTIVE
          • GV$SQL_WORKAREA_HISTOGRAM
          • GV$SYSSTAT
          • GV$SYSTEM_EVENT
          • GV$OB_LOCKS
          • GV$OB_OPT_STAT_GATHER_MONITOR
          • GV$OB_THREAD
          • GV$OB_PL_CACHE_OBJECT
          • V$OB_PL_CACHE_OBJECT
          • V$ACTIVE_SESSION_HISTORY
          • V$DML_STATS
          • V$EVENT_NAME
          • V$LATCH
          • V$OB_ACTIVE_SESSION_HISTORY
          • V$OB_ARCHIVE_DEST_STATUS
          • V$OB_COMPACTION_DIAGNOSE_INFO
          • V$OB_COMPACTION_PROGRESS
          • V$OB_COMPACTION_SUGGESTIONS
          • V$OB_COMPATIBILITY_CONTROL
          • V$OB_CGROUP_CONFIG
          • V$OB_DTL_INTERM_RESULT_MONITOR
          • V$OB_DYNAMIC_PARTITION_TABLES
          • V$OB_ENCRYPTED_TABLES
          • V$ENCRYPTED_TABLESPACES
          • V$OB_EXTERNAL_CATALOG_CLIENT_POOL_STAT
          • V$OB_FUNCTION_IO_STAT
          • V$OB_GROUP_IO_STAT
          • V$OB_HMS_CLIENT_POOL_STAT
          • V$OB_HNSW_INDEX_INFO
          • V$OB_HNSW_INDEX_SEGMENT_INFO
          • V$OB_IVF_INDEX_INFO
          • V$OB_KVCACHE
          • V$OB_KV_CLIENT_INFO
          • V$OB_KV_GROUP_COMMIT_STATUS
          • V$OB_KV_CONNECTIONS
          • V$OB_LOG_STAT
          • V$OB_LOG_TRANSPORT_DEST_STAT
          • V$OB_LS_LOG_RESTORE_STATUS
          • V$OB_LS_REPLICA_TASK_PLAN
          • V$OB_LS_SNAPSHOTS
          • V$OB_MEMORY
          • V$OB_MEMSTORE
          • V$OB_MEMSTORE_INFO
          • V$OB_MERGE_INFO
          • V$OB_NIC_INFO
          • V$OB_RPC_INCOMING
          • V$OB_RPC_OUTGOING
          • V$OB_PARAMETERS
          • V$OB_PLAN_CACHE_PLAN_EXPLAIN
          • V$OB_PLAN_CACHE_PLAN_STAT
          • V$OB_PLAN_CACHE_STAT
          • V$OB_PROCESSLIST
          • V$OB_PS_ITEM_INFO
          • V$OB_PS_STAT
          • V$OB_PX_P2P_DATAHUB
          • V$OB_PX_TARGET_MONITOR
          • V$OB_PX_WORKER_STAT
          • V$OB_RES_MGR_SYSSTAT
          • V$OB_QUERY_RESPONSE_TIME_HISTOGRAM
          • V$RSRC_PLAN
          • V$OB_SERVER_SCHEMA_INFO
          • V$OB_SESS_TIME_MODEL
          • V$OB_SESSION
          • V$SESSION_EVENT
          • V$OB_SESSION_PS_INFO
          • V$OB_SHARED_STORAGE_QUOTA
          • V$OB_SINDI_INDEX_INFO
          • V$OB_SQL_AUDIT
          • V$OB_SQL_CCL_STATUS
          • V$SQL_JOIN_FILTER
          • V$OB_SQL_PLAN
          • V$OB_SQL_WORKAREA_MEMORY_INFO
          • V$OB_SQLSTAT
          • V$OB_SHARED_SSTABLES
          • V$OB_SSTABLES
          • V$OB_LOCAL_CACHE
          • V$OB_LOCAL_CACHE_DIAGNOSE
          • V$OB_OBJECT_TYPE_IO_STAT
          • V$OB_STORAGE_CACHE_TASKS
          • V$OB_SYS_TIME_MODEL
          • V$OB_TABLET_COMPACTION_HISTORY
          • V$OB_TABLET_COMPACTION_PROGRESS
          • V$OB_TABLET_LOCAL_CACHE
          • V$OB_TABLET_MACRO_CACHE_STAT
          • V$OB_TENANT_MEMORY
          • V$OB_TENANT_RESOURCE_LIMIT
          • V$OB_TENANT_RESOURCE_LIMIT_DETAIL
          • V$OB_TIMESTAMP_SERVICE
          • V$OB_TRANSACTION_PARTICIPANTS
          • V$OB_TRANSACTION_SCHEDULERS
          • V$OB_UNITS
          • V$OB_VECTOR_MEMORY
          • V$RESTORE_POINT
          • V$SESSION_LONGOPS
          • V$SESSION_WAIT
          • V$SESSION_WAIT_HISTORY
          • V$SESSTAT
          • V$SQL_MONITOR_STATNAME
          • V$SQL_PLAN_MONITOR
          • V$SQL_WORKAREA
          • V$SQL_WORKAREA_ACTIVE
          • V$SQL_WORKAREA_HISTOGRAM
          • V$STATNAME
          • V$SYSSTAT
          • V$SYSTEM_EVENT
          • V$OB_LOCKS
          • V$OB_OPT_STAT_GATHER_MONITOR
          • V$OB_THREAD
      • Overview of Metrics
      • Common wait events
    • Parameters and system variables
      • Overview of parameters and system variables
      • Parameters
        • Parameter overview
        • Cluster-level parameters
          • alert_log_level
          • all_cluster_list
          • all_server_list
          • autoinc_cache_refresh_interval
          • async_ps_cursor_max_count
          • balancer_log_interval
          • balancer_task_timeout
          • system_protected_sys_variables
          • system-protected-tenant-parameters
          • balancer_tolerance_percentage
          • bf_cache_miss_count_threshold
          • bf_cache_priority
          • builtin_db_data_verify_cycle
          • cache_wash_threshold
          • clog_io_isolation_mode
          • clog_sync_time_warn_threshold
          • cluster
          • cluster_id
          • config_additional_dir
          • cpu_count
          • data_dir
          • data_disk_usage_limit_percentage
          • data_disk_write_limit_percentage
          • data_storage_error_tolerance_time
          • data_storage_warning_tolerance_time
          • datafile_disk_percentage
          • datafile_maxsize
          • datafile_next
          • datafile_size
          • dead_socket_detection_timeout
          • debug_sync_timeout
          • default_compress_func
          • default_row_format
          • devname
          • diag_syslog_per_error_limit
          • disk_io_thread_count
          • dtl_buffer_size
          • enable_asan_for_memory_context
          • enable_async_syslog
          • enable_cgroup
          • enable_dblink
          • enable_ddl
          • enable_global_background_resource_isolation
          • enable_logservice
          • enable_major_freeze
          • enable_ob_error_msg_style
          • enable_ob_ratelimit
          • enable_perf_event
          • enable_record_trace_id
          • enable_record_trace_log
          • enable_rereplication
          • enable_rich_error_msg
          • enable_rpc_authentication_bypass
          • enable_sql_audit
          • enable_sql_operator_dump
          • enable_sys_table_ddl
          • enable_sys_unit_standalone
          • enable_syslog_recycle
          • enable_syslog_wf
          • enable_tcp_keepalive
          • enable_upgrade_mode
          • ext_plugin_config
          • fuse_row_cache_priority
          • global_background_cpu_quota
          • high_priority_net_thread_count
          • ignore_replay_checksum_error
          • index_block_cache_priority
          • internal_sql_execute_timeout
          • io_scheduler_thread_count
          • large_query_threshold
          • large_query_worker_percentage
          • leak_mod_to_check
          • lease_time
          • local_ip
          • location_cache_cpu_quota
          • location_cache_expire_time
          • location_cache_refresh_min_interval
          • location_cache_refresh_rpc_timeout
          • location_cache_refresh_sql_timeout
          • location_fetch_concurrency
          • location_refresh_thread_count
          • log_disk_percentage
          • log_disk_size
          • logservice_access_point
          • log_storage_warning_trigger_percentage
          • log_storage_warning_tolerance_time
          • ls_meta_table_check_interval
          • max_string_print_length
          • max_syslog_file_count
          • memory_chunk_cache_size
          • memory_limit
          • memory_limit_percentage
          • memory_reserved
          • memstore_limit_percentage
          • micro_block_merge_verify_level
          • migration_disable_time
          • min_observer_version
          • mysql_port
          • net_thread_count
          • ob_event_history_recycle_interval
          • ob_ratelimit_stat_period
          • ob_startup_mode
          • ob_python_home
          • obconfig_url
          • observer_id
          • ob_storage_s3_url_encode_type
          • ob_enable_java_env
          • ob_java_home
          • ob_java_connector_path
          • ob_java_opts
          • ob_enable_java_udf_sandbox
          • ob_enable_utl_http
          • opt_tab_stat_cache_priority
          • plan_cache_evict_interval
          • px_task_size
          • plugins_load
          • recyclebin_object_expire_time
          • resource_hard_limit
          • rest_oauth2_credential_refresh_interval
          • rest_oauth2_credential_evict_time
          • rootservice_async_task_queue_size
          • rootservice_async_task_thread_count
          • rootservice_list
          • rootservice_ready_check_interval
          • row_compaction_update_limit
          • rpc_client_authentication_method
          • rpc_port
          • rpc_server_authentication_method
          • rpc_timeout
          • schema_history_expire_time
          • schema_history_recycle_interval
          • server_balance_cpu_mem_tolerance_percent
          • server_balance_critical_disk_waterlevel
          • server_balance_disk_tolerance_percent
          • server_check_interval
          • server_cpu_quota_max
          • server_cpu_quota_min
          • server_permanent_offline_time
          • sql_login_thread_count
          • sql_net_thread_count
          • sql_protocol_min_tls_version
          • ssl_client_authentication
          • ssl_external_kms_info
          • stack_size
          • standby_fetch_log_bandwidth_limit
          • storage_meta_cache_priority
          • strict_check_os_params
          • sync_io_thread_count
          • sys_bkgd_migration_change_member_list_timeout
          • sys_bkgd_migration_retry_num
          • sys_bkgd_net_percentage
          • sys_ckpt_thread_score
          • syslog_compress_func
          • syslog_disk_size
          • syslog_file_uncompressed_count
          • syslog_io_bandwidth_limit
          • syslog_level
          • system_memory
          • tablet_ls_cache_priority
          • tablet_meta_table_check_interval
          • tablet_meta_table_scan_batch_count
          • tablet_size
          • tcp_keepcnt
          • tcp_keepidle
          • tcp_keepintvl
          • tenant_task_queue_size
          • trace_log_slow_query_watermark
          • trx_2pc_retry_interval
          • unit_gc_wait_time
          • use_large_pages
          • user_block_cache_priority
          • user_row_cache_priority
          • virtual_table_location_cache_expire_time
          • weak_read_version_refresh_interval
          • workers_per_cpu_quota
          • zone
        • Tenant-level parameters
          • agent_db_background_delete_thread_score
          • agent_db_hot_namespace_ttl
          • arbitration_timeout
          • archive_lag_target
          • approx_count_distinct_precision
          • audit_log_buffer_size
          • audit_log_compression
          • attach_shared_sstable_thread_score
          • audit_log_enable
          • audit_log_format
          • audit_log_max_size
          • audit_log_path
          • audit_log_prune_seconds
          • audit_log_query_sql
          • audit_log_rotate_on_size
          • audit_log_strategy
          • audit_sys_operations
          • audit_trail
          • auto_split_tablet_size
          • backup_data_file_size
          • balancer_idle_time
          • catalog_sync_target
          • choose_migration_source_policy
          • compaction_dag_cnt_limit
          • compaction_high_thread_score
          • compaction_low_thread_score
          • compaction_mid_thread_score
          • compaction_schedule_tablet_batch_cnt
          • compatible
          • connection_control_failed_connections_threshold
          • connection_control_max_connection_delay
          • connection_control_min_connection_delay
          • cpu_quota_concurrency
          • ddl_thread_score
          • default_auto_increment_mode
          • default_delta_format
          • default_enable_extended_rowid
          • default_load_mode
          • default_micro_block_format_version
          • default_progressive_merge_num
          • default_skip_index_level
          • default_storage_cache_policy
          • default_table_merge_engine
          • default_table_organization
          • default_table_store_format
          • direct_load_allow_fallback
          • ddl_high_thread_score
          • document_ai_file_max_size
          • dtl_compress_func
          • dump_data_dictionary_to_log_interval
          • enable_agent_db_background_task
          • enable_adaptive_plan_cache
          • enable_auto_split
          • enable_database_sharding_none
          • enable_early_lock_release
          • enable_hbase_rowkey_ttl
          • enable_pl_rich_error_msg
          • enable_gts_standalone
          • enable_kv_group_commit
          • enable_kv_ttl
          • enable_lake_table_parallel_resolving
          • enable_lock_priority
          • enable_manual_storage_cache_policy
          • enable_mlog_auto_maintenance
          • enable_monotonic_weak_read
          • enable_mv_binlog_minimal_mode
          • enable_ls_leader_balance
          • enable_rebalance
          • enable_sql_extension
          • enable_transfer
          • enable_ttl
          • enable_user_defined_rewrite_rules
          • enable_window_compaction
          • enable_ps_parameterize
          • external_kms_info
          • external_table_io_hole_size
          • external_table_io_range_size
          • external_table_csv_max_buffer_size
          • ob_vector_search_strategy
          • freeze_trigger_percentage
          • global_index_auto_split_policy
          • ha_high_thread_score
          • ha_low_thread_score
          • ha_mid_thread_score
          • inc_sstable_upload_thread_score
          • shared_gc_executor_thread_score
          • shared_gc_generator_thread_score
          • json_document_max_depth
          • kv_ttl_duty_duration
          • kv_group_commit_batch_size
          • kv_group_commit_rw_mode
          • kv_hbase_client_scanner_timeout_period
          • kv_ttl_delete_max_ops
          • kv_ttl_history_recycle_interval
          • kv_transport_compress_threshold
          • lake_table_pruning_thread_count
          • load_data_diagnosis_log_compression
          • load_data_diagnosis_log_max_size
          • load_vector_index_on_follower
          • lob_enable_block_cache_threshold
          • log_archive_concurrency
          • log_disk_throttling_maximum_duration
          • log_disk_throttling_percentage
          • log_disk_utilization_limit_threshold
          • log_disk_utilization_threshold
          • log_restore_concurrency
          • log_storage_compress_all
          • log_storage_compress_func
          • log_transport_compress_all
          • log_transport_compress_func
          • ls_gc_delay_time
          • ls_scale_out_factor
          • major_compact_trigger
          • major_freeze_duty_time
          • max_partition_num
          • max_stale_time_for_weak_consistency
          • mds_compaction_high_thread_score
          • mds_compaction_mid_thread_score
          • mds_minor_compact_trigger
          • merger_check_interval
          • minor_compact_trigger
          • mlog_trim_interval
          • model_max_retries
          • model_request_timeout
          • mv_refresh_concurrency
          • ob_compaction_schedule_interval
          • ob_enable_batched_multi_statement
          • ob_encoding_granularity
          • ob_enable_java_udf
          • ob_enable_python_udf
          • ob_proxy_readonly_transaction_routing_policy
          • ob_query_switch_leader_retry_timeout
          • ob_ssl_invited_common_names
          • ob_vector_index_active_segment_max_size
          • ob_vector_index_merge_trigger_percentage
          • ob_vector_memory_limit_percentage
          • open_cursors
          • optimizer_index_cost_adj
          • partition_balance_schedule_interval
          • plsql_code_type
          • plsql_debug
          • px_node_policy
          • package_state_sync_max_size
          • px_target_high_watermark
          • px_target_low_watermark
          • px_target_workers_per_cpu
          • px_workers_per_cpu_quota
          • query_memory_limit_percentage
          • query_response_time_flush
          • query_response_time_range_base
          • query_response_time_stats
          • range_optimizer_max_mem_size
          • recover_table_concurrency
          • recover_table_dop
          • replica_parallel_migration_mode
          • result_cache_max_size
          • result_cache_max_result
          • ob_result_cache_evict_percentage
          • ob_deterministic_udf_cache_max_size
          • rpc_memory_limit_percentage
          • shared_log_retention
          • shared_storage_data_check_thread_score
          • spill_compression_codec
          • sql_func_extension_mode
          • sql_work_area
          • standby_db_fetch_log_rpc_timeout
          • standby_db_preferred_upstream_log_region
          • storage_rowsets_size
          • sts_credential
          • suspend_storage_cache_task
          • kv_transport_compress_func
          • tde_method
          • tenant_sql_login_thread_count
          • tenant_sql_net_thread_count
          • temporary_file_max_disk_size
          • ttl_duty_time
          • ttl_thread_score
          • undo_retention
          • vector_index_memory_saving_mode
          • vector_index_optimization_concurrency
          • vector_index_optimize_duty_time
          • vector_task_thread_limit_percent
          • workarea_size_policy
          • writing_throttling_maximum_duration
          • writing_throttling_trigger_percentage
          • zone_deploy_mode
      • System variables
        • Overview of system variables
        • Global variables
          • ap_query_cost_threshold
          • ap_query_route_policy
          • ap_query_replica_fallback
          • activate_all_roles_on_login
          • auto_increment_cache_size
          • auto_increment_increment
          • auto_increment_offset
          • autocommit
          • automatic_sp_privileges
          • binlog_row_image
          • block_encryption_mode
          • character_set_client
          • character_set_connection
          • cardinality_estimation_model
          • character_set_database
          • character_set_filesystem
          • character_set_results
          • character_set_server
          • character_set_system
          • collation_connection
          • collation_database
          • collation_server
          • connect_timeout
          • cte_max_recursion_depth
          • cursor_sharing
          • datadir
          • default_authentication_plugin
          • default_password_lifetime
          • default_storage_engine
          • div_precision_increment
          • error_on_overlap_time
          • event_scheduler
          • explicit_defaults_for_timestamp
          • enable_optimizer_rowgoal
          • foreign_key_checks
          • group_concat_max_len
          • init_connect
          • innodb_stats_persistent
          • innodb_strict_mode
          • interactive_timeout
          • license
          • lc_time_names
          • log_row_value_options
          • long_query_time
          • lower_case_table_names
          • max_allowed_packet
          • max_connections
          • max_sp_recursion_depth
          • max_user_connections
          • mview_refresh_dop
          • net_buffer_length
          • net_read_timeout
          • net_write_timeout
          • ob_bnl_join_cache_size
          • ob_compatibility_mode
          • ob_compatibility_control
          • ob_compatibility_version
          • ob_default_lob_inrow_threshold
          • ob_early_lock_release
          • ob_enable_ps_parameter_anonymous_block
          • ob_enable_pl_async_commit
          • ob_enable_aggregation_pushdown
          • ob_enable_index_direct_select
          • ob_enable_jit
          • ob_enable_pl_cache
          • ob_enable_plan_cache
          • ob_enable_rich_error_msg
          • ob_enable_sql_audit
          • ob_enable_transformation
          • ob_enable_transmission_checksum
          • ob_enable_truncate_flashback
          • ob_log_level
          • ob_max_read_stale_time
          • ob_pl_block_timeout
          • ob_plan_cache_evict_high_percentage
          • ob_plan_cache_evict_low_percentage
          • ob_plan_cache_percentage
          • ob_query_timeout
          • ob_read_consistency
          • ob_reserved_meta_memory_percentage
          • ob_route_policy
          • ob_sql_audit_percentage
          • ob_sql_work_area_percentage
          • ob_table_access_policy
          • ob_tcp_invited_nodes
          • ob_temp_tablespace_size_percentage
          • ob_trx_idle_timeout
          • ob_trx_lock_timeout
          • ob_trx_timeout
          • optimizer_capture_sql_plan_baselines
          • ob_security_version
          • optimizer_dynamic_sampling
          • optimizer_features_enable
          • optimizer_use_sql_plan_baselines
          • parallel_degree_limit
          • parallel_degree_policy
          • parallel_min_scan_time_threshold
          • parallel_servers_target
          • partition_index_dive_limit
          • performance_schema
          • plugin_dir
          • pid_file
          • query_cache_size
          • plsql_optimize_level
          • plsql_can_transform_sql_to_assign
          • port
          • query_cache_type
          • query_rewrite_enabled
          • query_rewrite_integrity
          • read_only
          • recyclebin
          • regexp_stack_limit
          • regexp_time_limit
          • resource_manager_plan
          • socket
          • range_index_dive_limit
          • runtime_bloom_filter_max_size
          • runtime_filter_max_in_num
          • runtime_filter_type
          • runtime_filter_wait_time_ms
          • secure_file_priv
          • server_uuid
          • sql_auto_is_null
          • sql_mode
          • sql_quote_show_create
          • sql_safe_updates
          • sql_select_limit
          • sql_throttle_current_priority
          • sql_throttle_network
          • sql_throttle_priority
          • sql_throttle_rt
          • sql_transpiler
          • sql_warnings
          • system_time_zone
          • time_zone
          • transaction_isolation
          • transaction_read_only
          • tx_isolation
          • tx_read_only
          • validate_password_check_user_name
          • validate_password_length
          • validate_password_mixed_case_count
          • validate_password_number_count
          • validate_password_policy
          • validate_password_special_char_count
          • version
          • version_comment
          • wait_timeout
        • Session variables
          • enable_sql_plan_monitor
          • is_result_accurate
          • identity
          • last_insert_id
          • ob_capability_flag
          • ob_enable_show_trace
          • ob_global_debug_sync
          • ob_hnsw_ef_search
          • ob_ivf_nprobes
          • ob_last_schema_version
          • ob_org_cluster_id
          • ob_proxy_global_variables_version
          • ob_sparse_drop_ratio_search
          • ob_proxy_partition_hit
          • ob_proxy_set_trx_executed
          • ob_trace_info
          • partition_index_dive_limit
          • range_index_dive_limit
          • timestamp
          • tracefile_identifier
    • Error codes
      • Overview of error messages
      • 0001 ~ 3999
      • 4000 ~ 4499
      • 4500 ~ 4999
      • 5000 ~ 5999
      • 6000 ~ 6999
      • 7000 ~ 7999
      • 8000 ~ 8999
      • 9000 ~ 9499
      • 9500 ~ 9999
      • 10000 ~ 12000
      • 22998, 30926, 38104, 38105
    • LogService reference
      • LogService commands
        • Overview of LS-CTRL
        • LS-CTRL commands
          • bootstrap
          • show az
          • show ln
          • show meta
          • show ap
          • show parameter
          • show v-table
          • add ln
          • delete ln
          • set param
          • check
          • upgrade
          • fetch
          • migrate replica
          • rotate-ak
          • param-version-status
      • LogService parameters
        • Overview of Log Service parameters
        • Cluster parameters
          • min_oblogservice_version
          • node_permanent_offline_time_sec
          • stream_replica_task_history_retention_sec
          • object_store_url
          • log_local_target_retention_sec
          • retained_remote_log_blocks
          • log_local_disk_utilization_threshold
          • max_syslog_file_count
          • enable_rebalance
          • load_balance_policy
          • rebalance_interval_sec
          • metric_sample_save_interval_sec
          • max_utilization_threshold
          • min_utilization_threshold
          • log_disk_throttling_percentage
          • log_disk_throttling_maximum_duration
          • rebuild_log_lag_threshold
        • Server parameters
          • cluster_id
          • region
          • az
          • local_ip
          • rpc_port
          • log_disk_size
          • io_worker_count
          • http_port
          • status_thread_pool_size
          • stack_size
          • net_thread_count
          • enable_heap_profile
          • log_disk_percentage
          • memory_limit
          • log_level
          • max_syslog_file_size
          • disk_max_iops
          • disk_max_bandwidth
          • upload_block_concurrency
          • log_cache_memory_percentage
          • log_cache_evict_scan_budget
          • log_cache_enable_write
          • log_cache_enable_read
          • log_cache_metrics_dump_interval_sec
          • ln_id
          • local_storage_dir
      • LogService views
        • Overview of LogService views
        • List of LogService views
        • Virtual views
          • node_load
          • az_load
          • stream_replica_io
        • Internal tables
          • t_stream_upload_mapping
          • t_resource_event
    • OBKV
      • OBKV overview
      • OBKV architecture
      • OBKV-Table
        • OBKV-Table overview
          • OBKV-Table overview
          • Core features of OBKV-Table
          • OBKV-Table deployment overview
        • Quick start with simple key-value storage (Java)
        • Use the OBKV-Table client
          • Java development guide for OBKV-Table
          • Prepare for development with OBKV-Table
          • Connect to a cluster by using the OBKV-Table Java client
          • OBKV-Table examples
            • Write data to OBKV-Table
            • Query data in OBKV-Table
            • Update data in OBKV-Table
            • Delete data from OBKV-Table
          • Set parameters for the OBKV-Table Java client
        • OBKV-Table management
          • OBKV-Table management overview
          • High availability of OBKV-Table
          • Security permissions of OBKV-Table
          • OBKV-Table monitoring metrics
        • OBKV-Table reference
          • Data model of OBKV-Table
          • OBKV-Table operations
          • Data types supported by OBKV-Table
          • Full-text indexes in OBKV-Table
          • Scope of use and examples of global indexes in OBKV-Table
          • Delete expired data from OBKV-Table
          • Group commit in OBKV-Table
          • Weak-consistency reads and near reads in OBKV-Table
          • OBKV-Table related views
        • OBKV-Table FAQ
      • OBKV-HBase
        • Overview of OBKV-HBase
        • Core features of OBKV-HBase
        • OBKV-HBase deployment
        • OBKV-HBase development
          • Overview of OBKV-HBase application development
          • Connect to a cluster by using the OBKV-HBase Java client
          • Migrate HBase business code to OBKV-HBase
          • Data operation examples
        • OBKV-HBase migration guide
        • OBKV-HBase management
          • Overview of OBKV-HBase management
          • High availability of OBKV-HBase
          • Security and permissions in OBKV-HBase
          • OBKV-HBase monitoring metrics
        • Query optimization in OBKV-HBase
        • Performance testing of OBKV-HBase
        • OBKV-HBase reference
          • OBKV-HBase data model
          • OBKV-HBase data model
          • HBase-compatible interfaces
          • HBase-compatible filters
          • Automatic partition splitting in OBKV-HBase
          • Delete expired data in OBKV-HBase
          • OBKV-HBase weak-consistency reads and near reads
          • OBKV-HBase views
        • OBKV-HBase integrations
          • Flink integration
            • Synchronize data to OBKV-HBase by using the Flink connector
            • Access OBKV-HBase by using native Flink
          • Access OBKV-HBase by using Hive
          • Access OBKV-HBase by using Spark
    • Performance tuning
      • Overview
      • Performance related tools
        • System tools
          • Top general purpose tool
          • CPU tools
          • Memory tools
          • Disk I/O tools
          • Network tools
        • Internal tables
          • GV$SYSSTAT
          • GV$OB_SQL_AUDIT
          • GV$OB_TRANSACTION_PARTICIPANTS
        • Logs
          • slow trans
          • tenant dump info
          • trace log
        • OCP
      • System tuning
        • Operating system parameter tuning
        • Database parameter tuning
          • CPU parameters
          • I/O parameters
          • Memory-related parameters
          • Network transmission parameters
        • ODP parameter tuning
          • CPU-related parameters
          • Network transmission parameters
          • Node routing parameters
      • Performance diagnosis
        • Monitor and diagnose cluster performance
        • Diagnose tenant performance
        • Monitor OBProxy performance
        • Monitor host performance
        • WR management
          • Overview of WR
          • Manage WR
          • Monitor historical session performance
          • Clean up WR data
        • Diagnostic practice: Use TRACE_ID to diagnose materialized view refresh performance issues
        • ASH report
          • Introduction to ASH
          • Generate an ASH report
          • Analyze an ASH report
          • ASH best practices
      • Business model tuning
        • Load balancing
        • SQL diagnostics
        • Distributed transactions
      • SQL tuning
        • SQL request execution process
        • SQL execution plans
          • Introduction to SQL execution plans
          • Execution plan operators
            • TABLE SCAN
            • JOIN
            • GROUP BY
            • WINDOW FUNCTION
            • SUBPLAN FILTER
            • DISTINCT
            • SEQUENCE
            • MATERIAL
            • SORT
            • LIMIT
            • FOR UPDATE
            • SELECT INTO
            • SUBPLAN SCAN
            • UNION
            • INTERSECT
            • EXCEPT/MINUS
            • INSERT
            • DELETE
            • UPDATE
            • EXCHANGE
            • GI
          • Plan cache
          • Fast parameterization
          • Real-time execution plan display
          • SQL optimization practice with EXPLAIN
        • Distributed execution plans
          • Distributed execution and parallel query
          • Distributed plan generation
          • Distributed execution plan scheduling
          • Distributed execution plan management
          • Parallel execution enabling methods and their priority
          • Auto DOP
          • Execution of parallel queries
          • Perform parameter tuning for a parallel query
          • Parallel DML
          • Parallel DDL
        • Parallel execution plans
          • Introduction to parallel execution
          • Classification and optimization of parallel execution
          • Set concurrent execution
            • Concurrency control and queuing
            • Set the degree of parallelism for parallel execution
            • Set parallel execution parameters
          • Diagnose parallel execution issues
          • Tips for parallel execution tuning
          • Quick start of parallel execution
        • SQL tuning
          • Overview of SQL tuning
          • Basic SQL tuning process
          • SQL execution performance monitoring
            • GV$OB_SQL_AUDIT
            • SQL Trace
            • Plan cache views
            • SQL performance analysis example
              • Analyze wait events in queries by using SQL Audit
              • Analyze SQL queries that cause an abrupt RT jitter
              • View and analyze the shape of an execution plan
              • Analyze slow SQL queries
              • Query SQL traffic distribution and QPS
              • Check whether SQL queries are balanced across servers in a cluster
              • Find the TOP N SQL queries
              • Analyze whether an unusually large number of remote execution requests exist in the system or the execution of an SQL statement
              • Find full table scan SQL statements in a tenant
              • Find the TOP N queries with the longest execution time within a certain period
              • Analyze queries related to distributed plans
              • Check whether the RPC execution count of a distributed subplan is balanced across servers in a cluster
          • Optimizer statistics
            • Overview of statistics
            • Statistics collection methods
              • Overview of statistics collection methods
              • Introduction to histograms
              • Collect statistics manually
              • Automatic statistics collection
              • Online statistics collection
              • Dynamic sampling by the optimizer
            • Statistics management
              • Overview of statistics management
              • Delete statistics
              • Set statistics
              • Import and export statistics
              • Lock and unlock statistics
              • Manage statistics history
              • Manage statistics collection strategies (Prefs)
            • Partitioned table statistics collection and update strategy
            • Monitoring and diagnostics for statistics collection
            • Comprehensive example
          • Query rewrite
            • Overview
            • Rule-based query rewriting
            • Cost-based query rewriting
          • Query optimization
            • Access path
              • Overview
              • Rule-based path selection
              • Cost-based path selection
            • Join algorithm
              • Overview
              • Join algorithms
              • Runtime filter
              • Join order
          • Manage execution plans
            • Optimizer hint
            • Plan binding
            • Execution plan management
        • Related terms
        • FAQ on SQL tuning
    • Database proxy
      • Database connection and routing overview
      • OceanBase Database Proxy (ODP)
      • ODP
        • ODP management overview
        • Manage ODP clusters
          • Create an OBProxy cluster
          • Manage parameters of an OBProxy cluster
          • Delete an OBProxy cluster
          • Upgrade all OBProxies in an OBProxy cluster
          • Restart all OBProxies in an OBProxy cluster
          • Manage OceanBase AI Database clusters connected to OBProxy
          • Monitor the performance of an OBProxy cluster
        • Manage ODP
          • Add an OBProxy
          • Start OBProxy
          • Refresh OBProxy configuration
          • Stop OBProxy
          • Restart OBProxy
          • Delete an OBProxy
          • Upgrade OBProxy
        • OBProxy parameters
      • Physical connections
      • Logical connection
        • Query all sessions
        • Query the details of a session
        • Query the statistics of a session
        • Query session variables
        • Terminate a server session
      • Route management
        • Table-based routing of ODP
        • LDC-based routing
        • ODP routing policy
          • Read/write splitting
          • Follower-first read
          • Blocklist mechanism
          • Transaction routing
      • View tenant sessions
      • Terminate a tenant session
      • Set the maximum number of connections for a tenant
    • Drivers
      • OceanBase Call Interface (OBCI)
      • OceanBase Connector/J
      • OceanBase Connector/C
      • OceanBase Connector/ODBC
    • Platforms
      • OceanBase Migration Assessment (OMA)
      • OceanBase Migration Service (OMS)
      • OceanBase Cloud Platform (OCP)
      • OceanBase Developer Center (ODC)
      • OceanBase Admin Toolkit (OAT)
    • Components & tools
      • ob_error
      • Data integration
        • obloader/obdumper
        • OceanBase Binlog Service
        • obcdc
          • Overview of obcdc
          • obcdc parameters
            • Sample configuration file
            • Common obcdc parameters
            • obcdc parameters
          • obcdc development instructions
          • obcdc_tailf
          • Throttling
          • obcdc allowlist and blocklist
          • obcdc supports incremental direct load
          • obcdc supports synchronizing from a standby database
          • Data dictionary support in obcdc
          • FAQ
    • OceanBase AI Database plugins
      • Overview of OceanBase AI Database plugins
      • Tokenizer plugin
      • MySQL external table plugin
  • Release Notes
    • Version number guidelines
    • OceanBase AI Database V4.6.3
    • OceanBase AI Database V4.6.2

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase AI Database
  3. V4.6.3

Sample application for connecting to OceanBase AI Database using SpringBatch

Last Updated:2026-11-17 06:52:47

Prerequisites
Procedure
Step 1: Obtain the OceanBase AI Database connection string
Step 2: Import the java-oceanbase-springbatch project into IntelliJ IDEA
Step 3: Modify the database connection information in the java-oceanbase-springbatch project
Step 4: Run the java-oceanbase-springbatch project
Project code
Code in pom.xml
Code in application.properties
Code in BatchApplication.java
Code in BatchConfig.java
Code in People.java
Code in PeopleDESC.java
Code in AddPeopleDescProcessor.java
Code in AddDescPeopleWriter.java
Code in AddPeopleWriter.java
Code in BatchConfigTest.java
Code in AddPeopleDescProcessorTest.java
Code in AddDescPeopleWriterTest.java
Code in AddPeopleWriterTest.java
Complete code examples
References

This topic describes how to build an application using the Spring Batch framework and OceanBase AI Database. It also covers the use of the application for fundamental database operations, including table creation, data insertion, and data query.

Download the java-oceanbase-springbatch sample project

Prerequisites

  • You have installed OceanBase AI Database.
  • You have installed Java Development Kit (JDK) 1.8 and Maven.
  • You have installed IntelliJ IDEA.

Note

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

Procedure

Note

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

  1. Obtain the connection string for OceanBase AI Database.
  2. Import the java-oceanbase-springbatch project into IntelliJ IDEA.
  3. Modify the database connection information in the java-oceanbase-springbatch project.
  4. Run the java-oceanbase-springbatch project.

Step 1: Obtain the OceanBase AI Database connection string

  1. Contact the deployment personnel or administrator of OceanBase AI Database to obtain the corresponding database connection string.

    obclient -hxx.xx.xx.xx -P2883 -uroot@sys#cluster -p**** -A
    
  2. Fill in the corresponding information in the URL below based on the deployed OceanBase AI Database.

    Note

    This URL information is required in the application.properties file.

    jdbc:oceanbase://host:port/schema_name?user=$user_name&password=$password&characterEncoding=utf-8
    

    Parameter description:

    • host: The IP address for connecting to OceanBase AI Database. For an ODP connection, this is an ODP address; for a direct connection, this is the IP address of an OBServer node.
    • port: The port for connecting to OceanBase AI Database. For an ODP connection, the default port is 2883, which can be customized during ODP deployment. For a direct connection, the default port is 2881, which can be customized during OceanBase AI Database deployment.
    • schema_name: The name of the schema to access.
    • user_name: Specified using the -u parameter, in the format user@tenant#cluster_name or username@SERVICE:service_name. When using the user@tenant#cluster_name format, the default tenant is sys and the administrator user is root. The cluster name can be omitted when directly connecting to the database, but is required for an ODP connection.
    • password: The account password.
    • characterEncoding: The character encoding.

For more information about URL parameters, see Database URL.

Step 2: Import the java-oceanbase-springbatch project into IntelliJ IDEA

  1. Start IntelliJ IDEA and choose File > Open....

    file

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

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

    Note

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

  4. View the project.

springbatch

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

Modify the database connection information in the application.properties file based on the information obtained in Step 1: Obtain the OceanBase AI Database connection string.

Here is a connection information example:

  • The name of the database driver is com.mysql.cj.jdbc.Driver.
  • The IP address of the OBServer node is 10.10.10.1.
  • The access port is 2881.
  • The name of the schema to be accessed is test.
  • The tenant account is root@mysql001. mysql001 is a user tenant created in OceanBase AI Database, and root is the username of the mysql001 tenant.
  • The password is ******.

The sample code is as follows:

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:oceanbase://10.10.10.1:2881/test?characterEncoding=utf-8
spring.datasource.username=root@mysql001
spring.datasource.password=******

spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update

spring.batch.job.enabled=false

logging.level.org.springframework=INFO
logging.level.com.example=DEBUG

Step 4: Run the java-oceanbase-springbatch project

  • Run the AddDescPeopleWriterTest.java file.

    1. Locate the AddDescPeopleWriterTest.java file in the project structure under src > test > java.
    2. In the tool menu bar, select Run > Run... > AddDescPeopleWriterTest.testWrite, or directly click the green triangle in the upper-right corner to run it.
    3. View the project's log information and output results through IDEA's console.
    Data in the people_desc table:
    PeopleDESC [name=John, age=25, desc=This is John with age 25]
    PeopleDESC [name=Alice, age=30, desc=This is Alice with age 30]
    Batch Job execution completed.
    
  • Run the AddPeopleWriterTest.java file.

    1. Locate the AddPeopleWriterTest.java file in the project structure under src > test > java.
    2. In the tool menu bar, select Run > Run... > AddPeopleWriterTest.testWrite, or directly click the green triangle in the upper-right corner to run it.
    3. View the project's log information and output results through IDEA's console.
    Data in the people table:
    People [name=zhangsan, age=27]
    People [name=lisi, age=35]
    Batch Job execution completed.
    

Project code

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

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

│  pom.xml
│
├─.idea
│
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─oceanbase
│  │  │          └─example
│  │  │              └─batch
│  │  │                  │──BatchApplication.java
│  │  │                  │
│  │  │                  ├─config
│  │  │                  │   └─BatchConfig.java
│  │  │                  │
│  │  │                  ├─model
│  │  │                  │   ├─People.java
│  │  │                  │   └─PeopleDESC.java
│  │  │                  │
│  │  │                  ├─processor
│  │  │                  │   └─AddPeopleDescProcessor.java
│  │  │                  │
│  │  │                  └─writer
│  │  │                      ├─AddDescPeopleWriter.java
│  │  │                      └─AddPeopleWriter.java
│  │  │
│  │  └─resources
│  │      └─application.properties
│  │
│  └─test
│      └─java
│          └─com
│              └─oceanbase
│                  └─example
│                      └─batch
│                          ├─config
│                          │   └─BatchConfigTest.java
│                          │
│                          ├─processor
│                          │   └─AddPeopleDescProcessorTest.java
│                          │
│                          └─writer
│                              ├─AddDescPeopleWriterTest.java
│                              └─AddPeopleWriterTest.java
│
└─target

The files and directories are described as follows:

  • pom.xml: The configuration file for the Maven project, containing information such as dependencies, plugins, and builds.
  • .idea: A directory used by the IDE (Integrated Development Environment) to store project-related configuration information.
  • src: Typically denotes the directory that holds the source code of the project.
  • main: The directory for storing the main source code and resource files.
  • java: The directory for storing Java source code.
  • com.oceanbase.example.batch: The package name.
  • BatchApplication.java: The entry class of the application, containing the main method.
  • config: The folder for configuration classes, containing the application's configuration classes.
  • BatchConfig.java: The application's configuration class, used to configure some properties and behaviors of the application.
  • model: The folder for model classes, containing the application's data model classes.
  • People.java: A personnel data model class.
  • PeopleDESC.java: A personnel DESC data model class.
  • processor: The folder for processor classes, containing the application's processor classes.
  • AddPeopleDescProcessor.java: A processor class for adding personnel DESC information.
  • writer: The folder for writer classes, containing the application's writer classes.
  • AddDescPeopleWriter.java: A writer class for writing personnel DESC information.
  • AddPeopleWriter.java: A writer class for writing personnel information.
  • resources: The resource folder, containing the application's configuration files and other static resource files.
  • application.properties: The application's configuration file, used to configure application properties.
  • test: The directory for storing test code and resource files.
  • BatchConfigTest.java: The test class for the application's configuration class.
  • AddPeopleDescProcessorTest.java: The test class for the add-personnel-DESC processor.
  • AddDescPeopleWriterTest.java: The test class for the writer that writes personnel DESC information.
  • AddPeopleWriterTest.java: The test class for the writer that writes personnel information.
  • target: The directory for storing compiled class files, JAR packages, and other files.

Code in pom.xml

Note

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

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

  1. The document declaration statement.

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

    The sample code is as follows:

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

    1. xmlns: the default XML namespace for the POM, which is set to http://maven.apache.org/POM/4.0.0.
    2. xmlns:xsi: the XML namespace for XML elements prefixed with xsi, which is set to http://www.w3.org/2001/XMLSchema-instance.
    3. xsi:schemaLocation: the location of an XML schema definition (XSD) file. The value consists of two parts: the default XML namespace (http://maven.apache.org/POM/4.0.0) and the URI of the XSD file (https://maven.apache.org/xsd/maven-4.0.0.xsd).
    4. <modelVersion>: the POM model version used by the POM file, which is set to 4.0.0.

    The sample code is as follows:

     <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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
         <modelVersion>4.0.0</modelVersion>
    </project>
    
  3. Configure parent project information.

    1. <groupId>: the ID of the parent project group, which is set to org.springframework.boot.
    2. <artifactId>: the name of the parent project, which is set to spring-boot-starter-parent.
    3. <version>: the version of the parent project, which is set to 2.7.11.
    4. <relativePath>: an empty path for the parent project.

    The sample code is as follows:

     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
         <version>2.7.11</version>
         <relativePath/>
     </parent>
    
  4. Configure basic information.

    1. <groupId>: the ID of the project group, which is set to com.oceanbase.
    2. <artifactId>: the name of the project, which is set to java-oceanbase-springboot.
    3. <version>: the version of the project, which is set to 0.0.1-SNAPSHOT.
    4. <description>: the project information, which is set to Demo project for Spring Batch.

    The sample code is as follows:

     <groupId>com.oceanbase</groupId>
     <artifactId>java-oceanbase-springboot</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <name>java-oceanbase-springbatch</name>
     <description>Demo project for Spring Batch</description>
    
  5. Configure the Java version.

    Specify to use Java 1.8 for the project.

    The sample code is as follows:

      <properties>
          <java.version>1.8</java.version>
      </properties>
    
  6. Configure core dependencies.

    1. Define a dependency named spring-boot-starter that belongs to the org.springframework.boot group. This dependency contains default features provided by Spring Boot, such as web, data processing, security, and testing.

      The sample code is as follows:

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter</artifactId>
      </dependency>
      
    2. Define a dependency named spring-boot-starter-jdbc that belongs to the org.springframework.boot group. This dependency contains Java Database Connectivity (JDBC) features provided by Spring Boot, such as connection pool and data source configuration.

      The sample code is as follows:

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-jdbc</artifactId>
      </dependency>
      
    3. Define a dependency named spring-boot-starter-test that belongs to the org.springframework.boot group. This dependency takes effect in the test scope and provides test frameworks and tools of Spring Boot, such as JUnit, Mockito, and Hamcrest.

      The sample code is as follows:

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
      </dependency>
      
    4. Define a dependency named oceanbase-client that belongs to the com.oceanbase group and whose version is 2.4.12. With this dependency, you can use the features of OceanBase Command-Line Client (OBClient), such as connections, queries, and transactions.

      The sample code is as follows:

          <dependency>
              <groupId>com.oceanbase</groupId>
              <artifactId>oceanbase-client</artifactId>
              <version>2.4.12</version>
          </dependency>
      
    5. Define a dependency named spring-boot-starter-batch that belongs to the org.springframework.boot group. This dependency contains the batch processing feature provided by Spring Boot.

      The sample code is as follows:

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-batch</artifactId>
      </dependency>
      
    6. Define a dependency named spring-boot-starter-data-jpa that belongs to the org.springframework.boot group. This dependency contains necessary dependencies and configurations for Java Persistence API (JPA)-based data accesses, and is a Spring Boot starter.

      The sample code is as follows:

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-jpa</artifactId>
      </dependency>
      
    7. Define a dependency named tomcat-jdbc that belongs to the org.apache.tomcat group. This dependency allows the application to use JDBC connection pool features provided by Tomcat, including connection pool configuration, connection acquisition and release, and connection management.

      The sample code is as follows:

      <dependency>
          <groupId>org.apache.tomcat</groupId>
          <artifactId>tomcat-jdbc</artifactId>
      </dependency>
      
    8. Define a dependency named junit that belongs to the junit group and whose version is 4.10 and effective scope is test. This dependency allows the application to use JUnit.

      The sample code is as follows:

      <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>4.10</version>
          <scope>test</scope>
      </dependency>
      
    9. Define a dependency named javax.activation-api that belongs to the javax.activation group and whose version is 1.2.0. This dependency provides the Java Activation Framework (JAF) API.

      The sample code is as follows:

      <dependency>
          <groupId>javax.activation</groupId>
          <artifactId>javax.activation-api</artifactId>
          <version>1.2.0</version>
      </dependency>
      
    10. Define a dependency named jakarta.persistence-api that belongs to the jakarta.persistence group and whose version is 2.2.3. This dependency provides the Jakarta Persistence API. The sample code is as follows:

      <dependency>
          <groupId>jakarta.persistence</groupId>
          <artifactId>jakarta.persistence-api</artifactId>
          <version>2.2.3</version>
      </dependency>
      
  7. Configure the Maven plugin.

    Define a plugin named spring-boot-maven-plugin that belongs to the org.springframework.boot group. This plugin can be used to package Spring Boot applications as executable JAR packages or WAR packages, or directly run Spring Boot applications.

    The sample code is as follows:

     <build>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
             </plugin>
         </plugins>
     </build>
    

Code in application.properties

The application.properties file contains database connection configurations, such as the database driver, URL, username, and password. It also contains configurations related to JPA, Spring Batch, and the log level.

  1. Configure the database connection.

    • spring.datasource.driver-class-name: the database driver used to establish a connection with OceanBase AI Database, which is set to com.mysql.cj.jdbc.Driver.
    • spring.datasource.url: the URL for connecting to the database.
    • spring.datasource.username: the username for connecting to the database.
    • spring.datasource.password: the password for connecting to the database.

    The sample code is as follows:

    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.url=jdbc:oceanbase://host:port/schema_name?characterEncoding=utf-8
    spring.datasource.username=user_name
    spring.datasource.password=******
    
  2. Configure the JPA.

    • spring.jpa.show-sql: specifies whether to display SQL statements in logs. The value true here indicates that SQL statements are displayed in logs.
    • spring.jpa.hibernate.ddl-auto: the DDL operation performed by Hibernate. The value update here indicates that Hibernate automatically updates the database schema when the application starts.

    The sample code is as follows:

    spring.jpa.show-sql=true
    spring.jpa.hibernate.ddl-auto=update
    
  3. Configure Spring Batch.

    spring.batch.job.enabled: specifies whether to enable Spring Batch jobs. The value false here indicates that Spring Batch jobs are disabled.

    The sample code is as follows:

    spring.batch.job.enabled=false
    

    Note

    In Spring Batch, the spring.batch.job.enabled property controls the execution behavior of batch processing jobs.

    • spring.batch.job.enabled=true (default): Indicates that all defined batch processing jobs are automatically run when the Spring Boot application starts. This means Spring Batch automatically discovers and executes all defined jobs upon application startup.
    • spring.batch.job.enabled=false: Indicates that automatic execution of batch processing jobs is disabled. This is typically used in development or test environments, or when you want to manually control job execution. After setting it to false, jobs will not be automatically executed upon application startup. You can trigger jobs manually through other methods (such as REST interfaces or the command line).
    In summary, setting spring.batch.job.enabled=false helps you avoid automatic job execution at application startup, providing greater flexibility to control when batch processing jobs are executed.

  4. Configure the log level.

    • logging.level.org.springframework: the log level of the Spring framework, which is set to INFO.
    • logging.level.com.example: the log level for the custom code of the application, which is set to DEBUG.

    The sample code is as follows:

    logging.level.org.springframework=INFO
    logging.level.com.example=DEBUG
    

Code in BatchApplication.java

The BatchApplication.java file is the entry point for the Spring Boot application.

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

  1. Reference other classes and interfaces.

    Declare this file to contain the following interfaces and classes:

    • SpringApplication class: launches a Spring Boot application.
    • SpringBootApplication annotation: marks the class as the entry to the Spring Boot application.

    The sample code is as follows:

        import org.springframework.boot.SpringApplication;
        import org.springframework.boot.autoconfigure.SpringBootApplication;
    
  2. Define the BatchApplication class.

    Use the @SpringBootApplication annotation to mark the BatchApplication class as the entry point of a Spring Boot application. Define a static main method in the BatchApplication class as the application's entry point. In this method, use the SpringApplication.run method to start the Spring Boot application. Also define a method named runBatchJob to run the batch processing job.

    The sample code is as follows:

    
    
        @SpringBootApplication
        public class BatchApplication {
            public static void main(String[] args) {
                SpringApplication.run(BatchApplication.class, args);
            }
    
            public void runBatchJob() {
            }
        }
    

Code in BatchConfig.java

The BatchConfig.java file is used to configure components such as the steps, readers, processors, and writers for a batch processing job.

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

  1. References to other classes and interfaces.

    Declare that this file contains the following interfaces and classes:

    • People class: used to store personnel information read from the database.
    • PeopleDESC class: used to store descriptive information after converting or processing personnel information.
    • AddPeopleDescProcessor class: implements the ItemProcessor interface and converts the read People objects into PeopleDESC objects.
    • AddDescPeopleWriter class: implements the ItemWriter interface and writes PeopleDESC objects to the target location.
    • Job interface: represents a batch processing job.
    • Step interface: represents a step within a job.
    • EnableBatchProcessing annotation: a Spring Batch configuration annotation used to enable and configure Spring Batch processing features.
    • JobBuilderFactory class: used to create and configure jobs.
    • StepBuilderFactory class: used to create and configure steps.
    • RunIdIncrementer class: an auto-incrementer for the Spring Batch run ID (Run ID), used to increase the run ID each time a job is executed.
    • ItemProcessor interface: used to process or convert the read items.
    • ItemReader interface: used to read items from a data source.
    • ItemWriter interface: used to write processed or converted items to a specified target location.
    • JdbcCursorItemReader class: used to read data from the database and return a cursor result set.
    • Autowired annotation: used for dependency injection.
    • Bean annotation: used to create and configure beans.
    • ComponentScan annotation: used to specify the package or class for component scanning.
    • Configuration annotation: used to mark a class as a configuration class.
    • EnableAutoConfiguration annotation: used to enable automatic configuration for Spring Boot.
    • SpringBootApplication annotation: used to mark this class as the entry point of a Spring Boot application.
    • DataSource interface: used to represent a database connection.

    The sample code is as follows:

    import com.oceanbase.example.batch.model.People;
    import com.oceanbase.example.batch.model.PeopleDESC;
    import com.oceanbase.example.batch.processor.AddPeopleDescProcessor;
    import com.oceanbase.example.batch.writer.AddDescPeopleWriter;
    import org.springframework.batch.core.Job;
    import org.springframework.batch.core.Step;
    import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
    import org.springframework.batch.core.configuration.annotation.JobBuilderFactory;
    import org.springframework.batch.core.configuration.annotation.StepBuilderFactory;
    import org.springframework.batch.core.launch.support.RunIdIncrementer;
    import org.springframework.batch.item.ItemProcessor;
    import org.springframework.batch.item.ItemReader;
    import org.springframework.batch.item.ItemWriter;
    import org.springframework.batch.item.database.JdbcCursorItemReader;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.jdbc.core.BeanPropertyRowMapper;
    
    import javax.sql.DataSource;
    
  2. Define the BatchConfig class.

    This is a simple Spring Batch job. It defines how data is read, processed, and written, and encapsulates these steps into a job. Using Spring Batch annotations and auto-configuration, you can create corresponding component instances through various @Bean methods in the configuration class, and use these components in step1 to complete data reading, processing, and writing.

    • The @Configuration annotation indicates that this class is a configuration class.
    • The @EnableBatchProcessing annotation enables Spring Batch's processing features. It automatically creates necessary beans, such as JobRepository and JobLauncher.
    • The @SpringBootApplication annotation is used for the main class of a Spring Boot application and serves as the application's startup point.
    • The @ComponentScan annotation specifies the package for component scanning, telling Spring to scan and register all components in this package and its subpackages.
    • The @EnableAutoConfiguration annotation enables automatic configuration for the Spring Boot application infrastructure.

    The sample code is as follows:

     @Configuration
     @EnableBatchProcessing
     @SpringBootApplication
     @ComponentScan("com.oceanbase.example.batch.writer")
     @EnableAutoConfiguration
     public class BatchConfig {
     }
    
    1. Define the @Autowired annotation.

      Use the @Autowired annotation to inject JobBuilderFactory, StepBuilderFactory, and DataSource into the member variables of the BatchConfig class. JobBuilderFactory is a factory class for creating and configuring jobs, StepBuilderFactory is a factory class for creating and configuring steps, and DataSource is an interface for obtaining database connections.

      The sample code is as follows:

      @Autowired
      private JobBuilderFactory jobBuilderFactory;
      
      @Autowired
      private StepBuilderFactory stepBuilderFactory;
      
      @Autowired
      private DataSource dataSource;
      
    2. Define the @Bean annotation.

      Use the @Bean annotation to define several methods for creating readers, processors, writers, steps, and jobs for the batch processing job.

      • The peopleReader method creates an instance of the ItemReader component, which uses JdbcCursorItemReader to read People object data from the database. Set the data source dataSource, configure the RowMapper to map database rows to People objects, and set the SQL query statement to SELECT * FROM people.

      • The addPeopleDescProcessor method creates an instance of the ItemProcessor component, which uses AddPeopleDescProcessor to process People objects and returns them as PeopleDESC objects.

      • The addDescPeopleWriter method creates an instance of the ItemWriter component, which uses AddDescPeopleWriter to write PeopleDESC objects to the target location.

      • The step1 method creates an instance of the Step component with the name step1. Obtain the step builder through stepBuilderFactory.get, set the reader as the ItemReader component, set the processor as the ItemProcessor component, set the writer as the ItemWriter component, set the chunk size to 10, and finally call build to construct and return the configured Step.

      • The importJob method creates an instance of the Job component with the name importJob. Obtain the job builder through jobBuilderFactory.get, set the incrementer as RunIdIncrementer, set the initial step of the job's flow as Step, and finally call build to construct and return the configured Job.

        The sample code is as follows:

        @Bean
        public ItemReader<People> peopleReader() {
            JdbcCursorItemReader<People> reader = new JdbcCursorItemReader<>();
            reader.setDataSource((javax.sql.DataSource) dataSource);
            reader.setRowMapper(new BeanPropertyRowMapper<>(People.class));
            reader.setSql("SELECT * FROM people");
            return reader;
        }
        
        @Bean
        public ItemProcessor<People, PeopleDESC> addPeopleDescProcessor() {
            return new AddPeopleDescProcessor();
        }
        
        @Bean
        public ItemWriter<PeopleDESC> addDescPeopleWriter() {
            return new AddDescPeopleWriter();
        }
        
        @Bean
        public Step step1(ItemReader<People> reader, ItemProcessor<People, PeopleDESC> processor,
                        ItemWriter<PeopleDESC> writer) {
            return stepBuilderFactory.get("step1")
                    .<People, PeopleDESC>chunk(10)
                    .reader(reader)
                    .processor(processor)
                    .writer(writer)
                    .build();
        }
        
        @Bean
        public Job importJob(Step step1) {
            return jobBuilderFactory.get("importJob")
                    .incrementer(new RunIdIncrementer())
                    .flow(step1)
                    .end()
                    .build();
        }
        

Code in People.java

The People.java file defines a data model for the People class, representing a person's information. This class includes two private member variables name and age, along with their corresponding getter and setter methods. Finally, the toString method is overridden to print the object's information. Here, name represents the person's name, and age represents the person's age. The values of these attributes can be obtained and set using the getter and setter methods.

The purpose of this class is to provide a way to store and pass data for input and output in the batch processing program. In batch processing read and write operations, People objects are used to store data, set data using the setter method, and retrieve data using the getter method.

The sample code is as follows:

    public class People {
        private String name;
        private int age;

            // getters and setters

        public String getName() {
            return name;
        }

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

        public int getAge() {
            return age;
        }

        public void setAge(int age) {
            this.age = age;
        }
        @Override
        public String toString() {
            return "People [name=" + name + ", age=" + age + "]";
        }
        // Getters and setters
    }

Code in PeopleDESC.java

The PeopleDESC.java file defines a data model for the PeopleDESC class, representing personnel information. The PeopleDESC class has four attributes: name, age, desc, and id, representing a person's name, age, description, and identifier, respectively. This class includes corresponding getter and setter methods to access and set the values of these attributes. The toString method is overridden to return a string representation of the class, including the name, age, and description.

Similar to the People class, the PeopleDESC class is also used to store and pass data in the input and output of the batch processing program.

The sample code is as follows:

    public class PeopleDESC {
        private String name;
        private int age;
        private String desc;
        private int id;

        public String getName() {
            return name;
        }

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

        public int getAge() {
            return age;
        }

        public void setAge(int age) {
            this.age = age;
        }

        public String getDesc() {
            return desc;
        }

        public void setDesc(String desc) {
            this.desc = desc;
        }

        public int getId() {
            return id;
        }

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

        @Override
        public String toString() {
            return "PeopleDESC [name=" + name + ", age=" + age + ", desc=" + desc + "]";
        }
    }

Code in AddPeopleDescProcessor.java

The AddPeopleDescProcessor.java file defines a class named AddPeopleDescProcessor, implementing the ItemProcessor interface, to convert People objects into PeopleDESC objects.

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

  1. References to other classes and interfaces.

    Declare that this file contains the following interfaces and classes:

    • People class: Stores personnel information read from the database.
    • PeopleDESC class: Stores descriptive information obtained by converting or processing personnel information.
    • ItemProcessor interface: Processes or converts the read items.

    The sample code is as follows:

    import com.oceanbase.example.batch.model.People;
    import com.oceanbase.example.batch.model.PeopleDESC;
    import org.springframework.batch.item.ItemProcessor;
    
  2. Define the AddPeopleDescProcessor class.

    The AddPeopleDescProcessor class implements the ItemProcessor interface. It converts People objects into PeopleDESC objects, implementing the processing logic for input data during batch processing.

    In the process method of this class, first create a PeopleDESC object named desc. Then, obtain the attributes (name and age) of the People object through the item parameter and set these attributes to the desc object. Also, assign a value to the desc attribute of the desc object. The assignment logic generates a descriptive string based on the attributes of the People object. Finally, return the processed PeopleDESC object.

    The sample code is as follows:

    public class AddPeopleDescProcessor implements ItemProcessor<People, PeopleDESC> {
        @Override
        public PeopleDESC process(People item) throws Exception {
            PeopleDESC desc = new PeopleDESC();
            desc.setName(item.getName());
            desc.setAge(item.getAge());
            desc.setDesc("This is " + item.getName() + " with age " + item.getAge());
            return desc;
        }
    }
    

Code in AddDescPeopleWriter.java

The AddDescPeopleWriter.java file implements the ItemWriter interface and defines the AddDescPeopleWriter class, which writes People objects to a database.

The code in the AddDescPeopleWriter.java file consists of the following main parts:

  1. References to other classes and interfaces.

    Declare that this file contains the following interfaces and classes:

    • PeopleDESC class: stores description information obtained by converting or processing personnel information.
    • ItemWriter interface: writes processed or converted items to a specified target location.
    • Autowired annotation: enables dependency injection.
    • JdbcTemplate class: provides methods for executing SQL statements.
    • List interface: operates on query result sets.

    The sample code is as follows:

    import com.oceanbase.example.batch.model.PeopleDESC;
    import org.springframework.batch.item.ItemWriter;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.jdbc.core.JdbcTemplate;
    
    import java.util.List;
    
  2. Definition of the AddDescPeopleWriter class.

    1. Use the @Autowired annotation to automatically inject a JdbcTemplate instance, which is used to perform database operations when writing data.

      The sample code is as follows:

          @Autowired
          private JdbcTemplate jdbcTemplate;
      
    2. In the write method, iterate through the passed List<? extends PeopleDESC> and retrieve each PeopleDESC object. First, execute the SQL statement DROP TABLE people_desc to drop any existing table named people_desc. Then, execute the SQL statement CREATE TABLE people_desc (id INT PRIMARY KEY, name VARCHAR2(255), age INT, description VARCHAR2(255)) to create a table named people_desc with four columns: id, name, age, and description. Next, use the SQL statement INSERT INTO people_desc (id, name, age, description) VALUES (?, ?, ?, ?) to insert the attribute values of each PeopleDESC object into the people_desc table.

      The sample code is as follows:

          @Override
          public void write(List<? extends PeopleDESC> items) throws Exception {
              // Delete any existing tables first.
              jdbcTemplate.execute("DROP TABLE people_desc");
              // CREATE TABLE Statement
              String createTableSql = "CREATE TABLE people_desc (id INT PRIMARY KEY, name VARCHAR2(255), age INT, description VARCHAR2(255))";
              jdbcTemplate.execute(createTableSql);
              for (PeopleDESC item : items) {
                  String sql = "INSERT INTO people_desc (id, name, age, description) VALUES (?, ?, ?, ?)";
                  jdbcTemplate.update(sql, item.getId(), item.getName(), item.getAge(), item.getDesc());
              }
          }
      

Code in AddPeopleWriter.java

The AddPeopleWriter.java file implements the ItemWriter interface and defines the AddPeopleWriter class, which writes PeopleDESC objects to a database.

The code in the AddPeopleWriter.java file consists of the following main parts:

  1. References to other classes and interfaces.

    Declare that this file contains the following interfaces and classes:

    • People class: stores personnel information read from the database.
    • ItemWriter interface: writes processed or converted items to a specified target location.
    • Autowired annotation: enables dependency injection.
    • JdbcTemplate class: provides methods for executing SQL statements.
    • Component annotation: marks this class as a Spring component.
    • List interface: operates on query result sets.

    The sample code is as follows:

    import com.oceanbase.example.batch.model.People;
    import org.springframework.batch.item.ItemWriter;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.jdbc.core.JdbcTemplate;
    import org.springframework.stereotype.Component;
    
    import java.util.List;
    
  2. Define the AddPeopleWriter class.

    1. Use the @Autowired annotation to automatically inject a JdbcTemplate instance for performing database operations during data writes.

      The sample code is as follows:

          @Autowired
          private JdbcTemplate jdbcTemplate;
      
    2. In the write method, iterate through the passed List<? extends People> and extract each People object. First, execute the SQL statement DROP TABLE people to drop any existing table named people. Then, execute the SQL statement CREATE TABLE people (name VARCHAR2(255), age INT) to create a table named people with two columns: name and age. Next, use the SQL statement INSERT INTO people (name, age) VALUES (?, ?) to insert the attribute values of each People object into the people table.

      The sample code is as follows:

      @Override
      public void write(List<? extends People> items) throws Exception {
          // Delete any existing tables first.
          jdbcTemplate.execute("DROP TABLE people");
          // CREATE TABLE Statement
          String createTableSql = "CREATE TABLE people (name VARCHAR2(255), age INT)";
          jdbcTemplate.execute(createTableSql);
          for (People item : items) {
              String sql = "INSERT INTO people (name, age) VALUES (?, ?)";
              jdbcTemplate.update(sql, item.getName(), item.getAge());
          }
      }
      

Code in BatchConfigTest.java

The BatchConfigTest.java file is a test class using JUnit to test job configurations in Spring Batch.

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

  1. References to other classes and interfaces.

    Declare that this file contains the following interfaces and classes:

    • The Assert class: used to assert test results.
    • The Test annotation: used to mark test methods.
    • The RunWith annotation: used to specify the test runner.
    • The Job interface: represents a batch processing job.
    • The JobExecution class: represents the execution of a batch processing job.
    • The JobParameters class: represents the parameters of a batch processing job.
    • The JobParametersBuilder class: used to build parameters for a batch processing job.
    • The JobLauncher interface: used to start a batch processing job.
    • The Autowired annotation: used for dependency injection.
    • The SpringBootTest annotation: used to specify the test class as a Spring Boot test.
    • The SpringRunner class: used to specify the test runner as SpringRunner.

    The sample code is as follows:

    import org.junit.Assert;
    import org.junit.jupiter.api.Test;
    import org.junit.runner.RunWith;
    import org.springframework.batch.core.Job;
    import org.springframework.batch.core.JobExecution;
    import org.springframework.batch.core.JobParameters;
    import org.springframework.batch.core.JobParametersBuilder;
    import org.springframework.batch.core.launch.JobLauncher;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import javax.batch.runtime.BatchStatus;
    import java.util.UUID;
    
  2. Define the BatchConfigTest class.

    Using the SpringBootTest annotation and the SpringRunner runner allows for integrated testing of Spring Boot. In the testJob method, use the JobLauncherTestUtils utility class to start a batch processing job and use assertions to verify the job's execution status.

    1. Use the @Autowired annotation to automatically inject an instance of JobLauncherTestUtils.

      The sample code is as follows:

      @Autowired
      private JobLauncherTestUtils jobLauncherTestUtils;
      
    2. Annotate the testJob method with the @Test annotation to mark it as a test method. In this method, first create a JobParameters object, then use the jobLauncherTestUtils.launchJob method to start the batch processing job, and use the Assert.assertEquals method to assert that the job execution status is COMPLETED.

      The sample code is as follows:

      @Test
      public void testJob() throws Exception {
          JobParameters jobParameters = new JobParametersBuilder()
                  .addString("jobParam", "paramValue")
                  .toJobParameters();
      
          JobExecution jobExecution = jobLauncherTestUtils.launchJob(jobParameters);
      
          Assert.assertEquals(BatchStatus.COMPLETED, jobExecution.getStatus());
      }
      
    3. Use the @Autowired annotation to automatically inject an instance of JobLauncher.

      The sample code is as follows:

      @Autowired
      private JobLauncher jobLauncher;
      
    4. Use the @Autowired annotation to automatically inject an instance of Job.

      The sample code is as follows:

      @Autowired
      private Job job;
      
    5. Define an inner class named JobLauncherTestUtils to assist in starting batch processing jobs. In this class, define a launchJob method for starting a batch processing job. In this method, use the jobLauncher.run method to start the job and return the job execution result.

      The sample code is as follows:

      private class JobLauncherTestUtils {
          public JobExecution launchJob(JobParameters jobParameters) throws Exception {
              return jobLauncher.run(job, jobParameters);
          }
      }
      

Code in AddPeopleDescProcessorTest.java

The AddPeopleDescProcessorTest.java file is a test class that uses JUnit to test job configurations in Spring Batch.

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

  1. References to other classes and interfaces.

    Declare that this file contains the following interfaces and classes:

    • The People class: used to store personnel information read from the database.
    • The PeopleDESC class: used to store descriptive information after converting or processing personnel information.
    • The Assert class: used to verify whether the expected result and the actual result in the test are consistent.
    • The Test annotation: used to mark test methods.
    • The RunWith annotation: used to specify the test runner.
    • The Autowired annotation: used for dependency injection.
    • The SpringBootTest annotation: used to specify the test class as a Spring Boot test.
    • The SpringRunner class: used to specify the test runner as SpringRunner.

    The sample code is as follows:

    import com.oceanbase.example.batch.model.People;
    import com.oceanbase.example.batch.model.PeopleDESC;
    import org.junit.Assert;
    import org.junit.jupiter.api.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
  2. Definition of the AddPeopleDescProcessorTest class.

    Perform integrated testing for Spring Boot by using the SpringBootTest annotation and the SpringRunner runner.

    1. Use the @Autowired annotation to automatically inject an instance of AddPeopleDescProcessor.

      The sample code is as follows:

      @Autowired
      private AddPeopleDescProcessor processor;
      
    2. Use the @Test annotation to mark the testProcess method as a test method. In this method, first create a People object, then use the processor.process method to process this object, and assign the result to a PeopleDESC object.

      The sample code is as follows:

      @Test
      public void testProcess() throws Exception {
      People people = new People();
      people.setName("John");
      people.setAge(25);
      
      PeopleDESC desc = processor.process(people);
      }
      

Code in AddDescPeopleWriterTest.java

The AddDescPeopleWriterTest.java file is a test class that uses JUnit to test the write logic of AddDescPeopleWriter.

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

  1. References to other classes and interfaces.

    Declare that this file contains the following interfaces and classes:

    • The PeopleDESC class: used to store descriptive information after converting or processing personnel information.
    • Assert class: used to assert test results.
    • Test annotation: used to mark a test method.
    • RunWith annotation: used to specify the test runner.
    • Autowired annotation: used for dependency injection.
    • SpringBootTest annotation: used to specify that the test class is a Spring Boot test.
    • JdbcTemplate class: provides methods for executing SQL statements.
    • SpringRunner class: used to specify the test runner as SpringRunner.
    • ArrayList class, used to create an empty list.
    • List interface: used to operate on query result sets.

    The sample code is as follows:

    import com.oceanbase.example.batch.model.PeopleDESC;
    import org.junit.Assert;
    import org.junit.jupiter.api.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.jdbc.core.JdbcTemplate;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.util.ArrayList;
    import java.util.List;
    
  2. Define the AddDescPeopleWriterTest class.

    Use the SpringBootTest annotation and the SpringRunner runner to perform integrated testing for Spring Boot.

    1. Inject instances using @Autowired. Use the @Autowired annotation to automatically inject instances of AddPeopleDescProcessor and JdbcTemplate.

      The sample code is as follows:

      @Autowired
      private AddDescPeopleWriter writer;
      @Autowired
      private JdbcTemplate jdbcTemplate;
      
    2. Use @Test to test data insertion and output. Use the @Test annotation to mark the testWrite method as a test method. In this method, first create an empty peopleDescList list and add two PeopleDESC objects to it. Then use the writer.write method to write the data in the list to the database. Next, use jdbcTemplate to execute a query statement, retrieve data from the people_desc table, and use assertion statements to verify the correctness of the data. Finally, output the query result to the console and print information indicating the job has completed.

      1. Insert data into the people_desc table. First, create an empty PeopleDESC object list named peopleDescList. Then create two PeopleDESC objects named desc1 and desc2, and set their attribute values respectively. Add desc1 and desc2 to the peopleDescList list. Next, call the write method of writer to write the objects in peopleDescList to the people_desc table in the database. Then use JdbcTemplate to execute a query statement SELECT COUNT(*) FROM people_desc to get the number of records in the people_desc table and assign the result to the variable count. Finally, use the Assert.assertEquals method to assert whether the value of count equals 2.

        The sample code is as follows:

           List<PeopleDESC> peopleDescList = new ArrayList<>();
           PeopleDESC desc1 = new PeopleDESC();
           desc1.setId(1);
           desc1.setName("John");
           desc1.setAge(25);
           desc1.setDesc("This is John with age 25");
           peopleDescList.add(desc1);
           PeopleDESC desc2 = new PeopleDESC();
           desc2.setId(2);
           desc2.setName("Alice");
           desc2.setAge(30);
           desc2.setDesc("This is Alice with age 30");
           peopleDescList.add(desc2);
           writer.write(peopleDescList);
        
           String selectSql = "SELECT COUNT(*) FROM people_desc";
           int count = jdbcTemplate.queryForObject(selectSql, Integer.class);
           Assert.assertEquals(2, count);
        
      2. Output data from the people_desc table. First, use JdbcTemplate to execute a query statement SELECT * FROM people_desc and process the query result using a lambda expression. In the lambda expression, use methods like rs.getInt and rs.getString to retrieve field values from the query result set and set them into a newly created PeopleDESC object. Add each newly created PeopleDESC object to a result list named resultDesc. Then print a prompt line Data from the people_desc table:. Next, use a for loop to iterate through each PeopleDESC object in the resultDesc list and use System.out.println to print the content of each object. Finally, print a message indicating the job has completed.

        The sample code is as follows:

        List<PeopleDESC> resultDesc = jdbcTemplate.query("SELECT * FROM people_desc", (rs, rowNum) -> {
           PeopleDESC desc = new PeopleDESC();
           desc.setId(rs.getInt("id"));
           desc.setName(rs.getString("name"));
           desc.setAge(rs.getInt("age"));
           desc.setDesc(rs.getString("description"));
           return desc;
        });
        
        System.out.println("Data in the people_desc table:");
        for (PeopleDESC desc : resultDesc) {
           System.out.println(desc);
        }
        
        // Output information after the job is completed
        System.out.println("Batch Job execution completed.");
        

Code in AddPeopleWriterTest.java

The AddPeopleWriterTest.java file is a class for testing using JUnit, used to test the write logic of AddPeopleWriterTest.

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

  1. References to other classes and interfaces.

    Declares that this file contains the following interfaces and classes:

    • People class: used to store personnel information read from the database.
    • Test annotation: used to mark test methods.
    • RunWith annotation: used to specify the test runner.
    • Autowired annotation: used for dependency injection.
    • SpringBootApplication annotation: used to mark this class as the entry point of the Spring Boot application.
    • SpringBootTest annotation: used to specify the test class as a Spring Boot test.
    • ComponentScan annotation: used to specify the package or class to scan for components.
    • JdbcTemplate class: provides methods for executing SQL statements.
    • SpringRunner class: used to specify the test runner as SpringRunner.
    • ArrayList class, used to create an empty list.
    • List interface: used to operate on query result sets.

    The sample code is as follows:

    import com.oceanbase.example.batch.model.People;
    import org.junit.jupiter.api.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.jdbc.core.JdbcTemplate;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.util.ArrayList;
    import java.util.List;
    
  2. Definition of the AddPeopleWriterTest class.

    Uses the SpringBootTest annotation and the SpringRunner runner to perform integrated testing with Spring Boot, and uses the @ComponentScan annotation to specify the package path to scan.

    1. Inject instances using @Autowired. Uses the @Autowired annotation to automatically inject instances of addPeopleWriter and JdbcTemplate.

      The sample code is as follows:

      @Autowired
      private AddPeopleWriter addPeopleWriter;
      @Autowired
      private JdbcTemplate jdbcTemplate;
      
    2. Use @Test to test data insertion and output.

      1. Insert data into the people table. First, create an empty People object list named peopleList. Then, create two People objects named person1 and person2, and set their name and age attributes. Next, add these two People objects to the peopleList list. After that, call the write method of addPeopleWriter, passing peopleList as a parameter to write these People objects to the database.

        The sample code is as follows:

           List<People> peopleList = new ArrayList<>();
           People person1 = new People();
           person1.setName("zhangsan");
           person1.setAge(27);
           peopleList.add(person1);
           People person2 = new People();
           person2.setName("lisi");
           person2.setAge(35);
           peopleList.add(person2);
           addPeopleWriter.write(peopleList);
        
      2. Output the data from the people table. First, use JdbcTemplate to execute a query statement SELECT * FROM people and process the query results using a lambda expression. In the lambda expression, use the rs.getString and rs.getInt methods to retrieve field values from the query result set and set them into a newly created People object. Add each newly created People object to a result list named result. Then, print a prompt line Data from the people table:. Next, use a for loop to iterate through each People object in the result list and print the content of each object using System.out.println. Finally, print a message indicating the job has completed.

        The sample code is as follows:

           List<People> result = jdbcTemplate.query("SELECT * FROM people", (rs, rowNum) -> {
               People person = new People();
               person.setName(rs.getString("name"));
               person.setAge(rs.getInt("age"));
               return person;
           });
        
           System.out.println("Data in the people table:");
           for (People person : result) {
               System.out.println(person);
           }
        
           // Output information after the job is completed
           System.out.println("Batch Job execution completed.");
        

Complete code examples

pom.xml
application.properties
BatchApplication.java
BatchConfig.java
People.java
PeopleDESC.java
AddPeopleDescProcessor.java
AddDescPeopleWriter.java
AddPeopleWriter.java
BatchConfigTest.java
AddPeopleDescProcessorTest.java
AddDescPeopleWriterTest.java
AddPeopleWriterTest.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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.11</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.oceanbase</groupId>
    <artifactId>java-oceanbase-springboot</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>java-oceanbase-springbatch</name>
    <description>Demo project for Spring Batch</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.oceanbase</groupId>
            <artifactId>oceanbase-client</artifactId>
            <version>2.4.3</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-batch</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.tomcat</groupId>
            <artifactId>tomcat-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>javax.activation</groupId>
            <artifactId>javax.activation-api</artifactId>
            <version>1.2.0</version>
        </dependency>
        <dependency>
            <groupId>jakarta.persistence</groupId>
            <artifactId>jakarta.persistence-api</artifactId>
            <version>2.2.3</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

#configuration database

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:oceanbase://host:port/schema_name?characterEncoding=utf-8
spring.datasource.username=user_name
spring.datasource.password=

# JPA
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update

# Spring Batch
spring.batch.job.enabled=false

#
logging.level.org.springframework=INFO
logging.level.com.example=DEBUG
package com.oceanbase.example.batch;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class BatchApplication {
    public static void main(String[] args) {
        SpringApplication.run(BatchApplication.class, args);
    }

    public void runBatchJob() {
    }
}

package com.oceanbase.example.batch.config;

import com.oceanbase.example.batch.model.People;
import com.oceanbase.example.batch.model.PeopleDESC;
import com.oceanbase.example.batch.processor.AddPeopleDescProcessor;
import com.oceanbase.example.batch.writer.AddDescPeopleWriter;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.batch.core.configuration.annotation.JobBuilderFactory;
import org.springframework.batch.core.configuration.annotation.StepBuilderFactory;
import org.springframework.batch.core.launch.support.RunIdIncrementer;
import org.springframework.batch.item.ItemProcessor;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.database.JdbcCursorItemReader;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.core.BeanPropertyRowMapper;

import javax.sql.DataSource;
//import javax.activation.DataSource;

@Configuration
@EnableBatchProcessing
@SpringBootApplication
@ComponentScan("com.oceanbase.example.batch.writer")
@EnableAutoConfiguration
public class BatchConfig {
    @Autowired
    private JobBuilderFactory jobBuilderFactory;

    @Autowired
    private StepBuilderFactory stepBuilderFactory;

    @Autowired
    private DataSource dataSource;// Use the default dataSource provided by Spring Boot's automatic configuration.



    @Bean
    public ItemReader<People> peopleReader() {
        JdbcCursorItemReader<People> reader = new JdbcCursorItemReader<>();
        reader.setDataSource((javax.sql.DataSource) dataSource);
        reader.setRowMapper(new BeanPropertyRowMapper<>(People.class));
        reader.setSql("SELECT * FROM people");
        return reader;
    }

    @Bean
    public ItemProcessor<People, PeopleDESC> addPeopleDescProcessor() {
        return new AddPeopleDescProcessor();
    }

    @Bean
    public ItemWriter<PeopleDESC> addDescPeopleWriter() {
        return new AddDescPeopleWriter();
    }

    @Bean
    public Step step1(ItemReader<People> reader, ItemProcessor<People, PeopleDESC> processor,
                      ItemWriter<PeopleDESC> writer) {
        return stepBuilderFactory.get("step1")
                .<People, PeopleDESC>chunk(10)
                .reader(reader)
                .processor(processor)
                .writer(writer)
                .build();
    }

    @Bean
    public Job importJob(Step step1) {
        return jobBuilderFactory.get("importJob")
                .incrementer(new RunIdIncrementer())
                .flow(step1)
                .end()
                .build();
    }
}
package com.oceanbase.example.batch.model;

public class People {
    private String name;
    private int age;

        // getters and setters

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
    @Override
    public String toString() {
        return "People [name=" + name + ", age=" + age + "]";
    }
    // Getters and setters
}
package com.oceanbase.example.batch.model;

public class PeopleDESC {
    private String name;
    private int age;
    private String desc;
    private int id;

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

    public int getId() {
        return id;
    }

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

    @Override
    public String toString() {
        return "PeopleDESC [name=" + name + ", age=" + age + ", desc=" + desc + "]";
    }
}
package com.oceanbase.example.batch.processor;

import com.oceanbase.example.batch.model.People;
import com.oceanbase.example.batch.model.PeopleDESC;
import org.springframework.batch.item.ItemProcessor;


public class AddPeopleDescProcessor implements ItemProcessor<People, PeopleDESC> {
    @Override
    public PeopleDESC process(People item) throws Exception {
        PeopleDESC desc = new PeopleDESC();
        desc.setName(item.getName());
        desc.setAge(item.getAge());
        desc.setDesc("This is " + item.getName() + " with age " + item.getAge());
        return desc;
    }
}
package com.oceanbase.example.batch.writer;

import com.oceanbase.example.batch.model.PeopleDESC;
import org.springframework.batch.item.ItemWriter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;

import java.util.List;

public class AddDescPeopleWriter implements ItemWriter<PeopleDESC> {
    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Override
    public void write(List<? extends PeopleDESC> items) throws Exception {
        // Delete any existing tables first.
        jdbcTemplate.execute("DROP TABLE people_desc");
        // CREATE TABLE Statement
        String createTableSql = "CREATE TABLE people_desc (id INT PRIMARY KEY, name VARCHAR2(255), age INT, description VARCHAR2(255))";
        jdbcTemplate.execute(createTableSql);
        for (PeopleDESC item : items) {
            String sql = "INSERT INTO people_desc (id, name, age, description) VALUES (?, ?, ?, ?)";
            jdbcTemplate.update(sql, item.getId(), item.getName(), item.getAge(), item.getDesc());
        }
    }
}
package com.oceanbase.example.batch.writer;

import com.oceanbase.example.batch.model.People;
import org.springframework.batch.item.ItemWriter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;

import java.util.List;

@Component
public class AddPeopleWriter implements ItemWriter<People> {
    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Override
    public void write(List<? extends People> items) throws Exception {
        // Delete any existing tables first.
        jdbcTemplate.execute("DROP TABLE people");
        // CREATE TABLE Statement
        String createTableSql = "CREATE TABLE people (name VARCHAR2(255), age INT)";
        jdbcTemplate.execute(createTableSql);
        for (People item : items) {
            String sql = "INSERT INTO people (name, age) VALUES (?, ?)";
            jdbcTemplate.update(sql, item.getName(), item.getAge());
        }
    }
}

package com.oceanbase.example.batch.config;

import com.oceanbase.example.batch.writer.AddDescPeopleWriter;
import org.junit.Assert;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.JobParametersBuilder;
import org.springframework.batch.core.launch.JobLauncher;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;
import javax.batch.runtime.BatchStatus;
import java.util.UUID;

@RunWith(SpringRunner.class)
@SpringBootTest
public class BatchConfigTest {

    @Test
    public void testJob() throws Exception {
        JobParameters jobParameters = new JobParametersBuilder()
                .addString("jobParam", UUID.randomUUID().toString())
                .toJobParameters();

        JobLauncherTestUtils jobLauncherTestUtils = new JobLauncherTestUtils();
        JobExecution jobExecution = jobLauncherTestUtils.launchJob(jobParameters);
        Assert.assertEquals(BatchStatus.COMPLETED.toString(), jobExecution.getStatus().toString());
    }

    @Autowired
    private JobLauncher jobLauncher;

    @Autowired
    private Job job;

    private class JobLauncherTestUtils {

        public JobExecution launchJob(JobParameters jobParameters) throws Exception {
            return jobLauncher.run(job, jobParameters);
        }
    }
}

package com.oceanbase.example.batch.processor;

import com.oceanbase.example.batch.model.People;
import com.oceanbase.example.batch.model.PeopleDESC;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class AddPeopleDescProcessorTest {
    @Autowired
    private AddPeopleDescProcessor processor;

    @Test
    public void testProcess() throws Exception {
        People people = new People();
  //      people.setName("John");
  //      people.setAge(25);

        PeopleDESC desc = processor.process(people);

//      Assert.assertEquals("John", desc.getName());
//        Assert.assertEquals(25, desc.getAge());
 //       Assert.assertEquals("This is John with age 25", desc.getDesc());
    }
}

package com.oceanbase.example.batch.writer;

import com.oceanbase.example.batch.model.PeopleDESC;
import org.junit.Assert;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.ArrayList;
import java.util.List;

@RunWith(SpringRunner.class)
@SpringBootTest
public class AddDescPeopleWriterTest {
    @Autowired
    private AddDescPeopleWriter writer;
    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Test
    public void testWrite() throws Exception {


        // Insert data into the people_desc table.
        List<PeopleDESC> peopleDescList = new ArrayList<>();
        PeopleDESC desc1 = new PeopleDESC();
        desc1.setId(1);
        desc1.setName("John");
        desc1.setAge(25);
        desc1.setDesc("This is John with age 25");
        peopleDescList.add(desc1);
        PeopleDESC desc2 = new PeopleDESC();
        desc2.setId(2);
        desc2.setName("Alice");
        desc2.setAge(30);
        desc2.setDesc("This is Alice with age 30");
        peopleDescList.add(desc2);
        writer.write(peopleDescList);

        String selectSql = "SELECT COUNT(*) FROM people_desc";
        int count = jdbcTemplate.queryForObject(selectSql, Integer.class);
        Assert.assertEquals(2, count);

        // Output the data from the people_desc table.
        List<PeopleDESC> resultDesc = jdbcTemplate.query("SELECT * FROM people_desc", (rs, rowNum) -> {
            PeopleDESC desc = new PeopleDESC();
            desc.setId(rs.getInt("id"));
            desc.setName(rs.getString("name"));
            desc.setAge(rs.getInt("age"));
            desc.setDesc(rs.getString("description"));
            return desc;
        });

        System.out.println("Data in the people_desc table:");
        for (PeopleDESC desc : resultDesc) {
            System.out.println(desc);
        }

        // Output information after the job is completed
        System.out.println("Batch Job execution completed.");
    }
}
package com.oceanbase.example.batch.writer;

import com.oceanbase.example.batch.model.People;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.ArrayList;
import java.util.List;

@RunWith(SpringRunner.class)
@SpringBootTest
@SpringBootApplication
@ComponentScan("com.oceanbase.example.batch.writer")
public class AddPeopleWriterTest {

    @Autowired
    private AddPeopleWriter addPeopleWriter;
    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Test
    public void testWrite() throws Exception {
        // Insert data into the people table
        List<People> peopleList = new ArrayList<>();
        People person1 = new People();
        person1.setName("zhangsan");
        person1.setAge(27);
        peopleList.add(person1);
        People person2 = new People();
        person2.setName("lisi");
        person2.setAge(35);
        peopleList.add(person2);
        addPeopleWriter.write(peopleList);

        // Query and output the results
        List<People> result = jdbcTemplate.query("SELECT * FROM people", (rs, rowNum) -> {
            People person = new People();
            person.setName(rs.getString("name"));
            person.setAge(rs.getInt("age"));
            return person;
        });

        System.out.println("Data in the people table:");
        for (People person : result) {
            System.out.println(person);
        }

        // Output information after the job is completed
        System.out.println("Batch Job execution completed.");
    }
}

References

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

Previous topic

SpringBoot
Last

Next topic

SpringDataJPA
Next
on this page
Prerequisites
Procedure
Step 1: Obtain the OceanBase AI Database connection string
Step 2: Import the java-oceanbase-springbatch project into IntelliJ IDEA
Step 3: Modify the database connection information in the java-oceanbase-springbatch project
Step 4: Run the java-oceanbase-springbatch project
Project code
Code in pom.xml
Code in application.properties
Code in BatchApplication.java
Code in BatchConfig.java
Code in People.java
Code in PeopleDESC.java
Code in AddPeopleDescProcessor.java
Code in AddDescPeopleWriter.java
Code in AddPeopleWriter.java
Code in BatchConfigTest.java
Code in AddPeopleDescProcessorTest.java
Code in AddDescPeopleWriterTest.java
Code in AddPeopleWriterTest.java
Complete code examples
References