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

Create an index

Last Updated:2026-11-16 14:00:05

Background information
Considerations
Create a normal index
Create a normal index by using the CREATE TABLE statement
Create a normal index by using the CREATE INDEX statement
Create a normal index by using the ALTER TABLE statement
Create a spatial index
Limitations on using spatial indexes
Create a spatial index using the CREATE TABLE statement
Create a spatial index by using the CREATE INDEX statement
Create a spatial index by using the ALTER TABLE statement
Create a function-based index
Limitations on function-based indexes
Create a function-based index using the CREATE TABLE statement
Create a function-based index by using the CREATE INDEX statement
Create a function-based index by using the ALTER TABLE statement
Create a columnstore index
Create a columnstore index by using the CREATE TABLE statement
Create a columnstore index by using the CREATE INDEX statement
Create a columnar index using the ALTER TABLE statement
Create a multi-valued index
Limitations on multi-valued indexes
Create a multi-valued index using the CREATE TABLE statement
Support for complex DML
Add a multi-value index afterward
Use multi-value indexes in queries
Create a full-text index
Limitations and considerations for full-text indexes
Create a full-text index by using the CREATE TABLE statement
Create a full-text index by using the CREATE FULLTEXT INDEX statement
Create a full-text index by using the ALTER TABLE statement
Create a full-text index by using an analyzer (Analyzer)
Create a search index (Search Index)
Create a search index using the CREATE SEARCH INDEX statement
Create a search index using the CREATE TABLE statement
Create a search index by using the ALTER TABLE statement
Create an asynchronous index
Create an asynchronous full-text index
Create an asynchronous search index
References

This topic describes how to create an index.

Background information

OceanBase AI Database supports creating indexes on non-partitioned tables and partitioned tables. Indexes can be local or global, unique or non-unique, spatial or functional. For a unique index on a partitioned table, the local unique index must include the partitioning key of the table partition. For more information about indexes, see Indexes.

This section describes how to create indexes on non-partitioned tables. For information about creating indexes on partitioned tables, see Local index.

Considerations

When creating an index, note that in OceanBase AI Database, index names must be unique within the database.

Create a normal index

You can use the CREATE TABLE statement, CREATE INDEX statement, or ALTER TABLE statement to create a normal index.

Create a normal index by using the CREATE TABLE statement

You can use the CREATE TABLE statement to create an index for a table when you create the table.

The syntax is as follows:

CREATE TABLE table_name(column_name column_definition,[column_name column_definition,...] [UNIQUE] INDEX|KEY [index_name](column_name));

The relevant parameters are described as follows:

  • table_name: The name of the table to be created.

  • column_name: The column in the table.

  • column_definition: Defines the data type corresponding to each column in the table.

  • UNIQUE: Optional. Indicates a unique index. This keyword is required when creating a unique index.

  • INDEX|KEY: Indicates that the index keyword can be INDEX or KEY in this statement.

  • index_name: Optional. The name of the index to be created. If not specified, the default index name is the same as the specified column name.

The following example creates table tbl1 and index tbl1_idx1 at the same time:

CREATE TABLE tbl1(id INT,name VARCHAR(18),date DATE,PRIMARY KEY (id),INDEX tbl1_idx1 (date));

Create a normal index by using the CREATE INDEX statement

You can use the CREATE INDEX statement to create an index for an existing table.

The syntax is as follows:

CREATE [UNIQUE] INDEX index_name ON table_name (column_name);

The relevant parameters are described as follows:

  • UNIQUE: Optional. Indicates a unique index. This keyword is required when creating a unique index.

  • index_name: The name of the index to be added.

  • table_name: The name of the table for which the index is to be created.

  • column_name: Specifies which columns to index. When specifying multiple columns, separate them with commas.

The following example creates table tbl2 and then creates index tbl2_idx1:

  1. Create table tbl2.

    CREATE TABLE tbl2(id INT,name VARCHAR(20));
    
  2. Create index tbl2_idx1 on table tbl2.

    CREATE INDEX tbl2_idx1 ON tbl2(id);
    

Create a normal index by using the ALTER TABLE statement

You can use the ALTER TABLE statement to create an index for an existing table. This statement also supports adding multiple indexes at once.

The syntax is as follows:

ALTER TABLE table_name ADD [UNIQUE] INDEX|KEY [index_name](column_name);

The relevant parameters are described as follows:

  • table_name: The name of the table for which you want to create an index.

  • UNIQUE: Optional. Indicates a unique index. Add this keyword when creating a unique index.

  • INDEX|KEY: Indicates that you can use either INDEX or KEY as the index keyword in this statement.

  • index_name: Optional. The name of the index to be created. If not specified, the default index name is the same as the specified column name.

  • column_name: Specifies the columns to be indexed. When specifying multiple columns, separate them with commas.

After creating table tbl3, the following example shows how to create index tbl3_idx1:

  1. Create table tbl3.

    CREATE TABLE tbl3(id INT,name VARCHAR(20));
    
  2. Create index tbl3_idx1 for table tbl3.

    ALTER TABLE tbl3 ADD INDEX tbl3_idx1(id);
    

Create a spatial index

OceanBase AI Database supports creating spatial indexes. A spatial index describes the location information of data stored on media and can improve the system's efficiency in retrieving data.

The syntax for creating a spatial index is essentially the same as that for creating a regular index, using the CREATE TABLE statement, CREATE INDEX statement, or ALTER TABLE statement. The difference is that a spatial index must use the SPATIAL keyword, and the column in the spatial index must be defined as NOT NULL.

Limitations on using spatial indexes

Before creating a spatial index, note the following limitations:

  • Spatial indexes support only local indexes; global indexes are not supported.

  • The column used to create the spatial index must be defined with the SRID attribute. Otherwise, the spatial index created on that column will not take effect in subsequent queries. This is because when using a spatial index for comparison, the coordinate system corresponding to the SRID in the column definition is required. Spatial indexes are built using the Minimum Bounding Rectangle (MBR) of geometric objects, and the comparison of MBRs also depends on the SRID.

    For more information about SRIDs, see Spatial Reference System (SRS).

  • You can create a spatial index only on columns with spatial data types. For information about the spatial data types supported by OceanBase AI Database, see Overview of spatial data types.

  • The column attribute for the column used to create the spatial index must be NOT NULL.

    If it is not NOT NULL, you can also first modify the column attribute to NOT NULL using the ALTER TABLE statement, and then add the spatial index. For specific operations on modifying column attributes, see Define column constraints.

Create a spatial index using the CREATE TABLE statement

The syntax is as follows:

CREATE TABLE table_name(column_g_name GEOMETRY NOT NULL SRID 4326,[column_name column_definition,...] SPATIAL INDEX|KEY [index_name](column_g_name));

The relevant parameters are described as follows:

  • table_name: Specifies the name of the table to be created.

  • column_g_name, column_name: Define the column names of the table.

  • SRID 4326: Explicitly specifies the SRID of the spatial column.

  • column_definition: Defines the data type corresponding to each column in the table. The column type for the column where the spatial index is to be added must be a spatial data type. For information about the spatial data types supported by OceanBase AI Database, see Overview of spatial data types.

  • INDEX|KEY: Indicates that either INDEX or KEY can be used as the index keyword in this statement.

  • index_name: Specifies the name of the index to be added. If not specified, the default index name is the same as the specified column name.

The following example creates the tbl1_g table and adds the spatial index tbl1_g_idx1:

CREATE TABLE tbl1_g (id INT,name VARCHAR(18),g GEOMETRY NOT NULL SRID 4326,SPATIAL INDEX tbl1_g_idx1(g));

After creation, you can use the SHOW INDEX statement to view index information.

SHOW INDEX FROM tbl1_g;

The query result is as follows:

+--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
| Table  | Non_unique | Key_name    | Seq_in_index | Column_name | Collation | Cardinality | Sub_part | Packed | Null | Index_type | Comment   | Index_comment | Visible |
+--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
| tbl1_g |          1 | tbl1_g_idx1 |            1 | g           | A         |        NULL | NULL     | NULL   |      | SPATIAL    | available |               | YES     |
+--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
1 row in set

Create a spatial index by using the CREATE INDEX statement

The syntax is as follows:

CREATE SPATIAL INDEX index_name ON table_name(column_g_name);

The related parameters are described as follows:

  • table_name: Specifies the name of the table for which you want to create an index.

  • index_name: Specifies the name of the index to be added.

  • column_g_name: Specifies the columns to be indexed. When specifying multiple columns, separate them with commas. The column types of the columns for which you want to add a spatial index must be spatial data types. For information about the spatial data types supported by OceanBase AI Database, see Overview of spatial data types.

The following example shows how to create the tbl2_g table and then create the spatial index tbl2_g_idx1:

  1. Create the tbl2_g table.

    CREATE TABLE tbl2_g(id INT,name VARCHAR(20),g GEOMETRY NOT NULL SRID 4326);
    
  2. Create the spatial index tbl2_g_idx1 for the table.

    CREATE SPATIAL INDEX tbl2_g_idx1 ON tbl2_g(g);
    
  3. After successful creation, view the index information.

    SHOW INDEX FROM tbl2_g;
    

    The query result is as follows:

    +--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
    | Table  | Non_unique | Key_name    | Seq_in_index | Column_name | Collation | Cardinality | Sub_part | Packed | Null | Index_type | Comment   | Index_comment | Visible |
    +--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
    | tbl2_g |          1 | tbl2_g_idx1 |            1 | g           | A         |        NULL | NULL     | NULL   |      | SPATIAL    | available |               | YES     |
    +--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
    1 row in set
    

Create a spatial index by using the ALTER TABLE statement

ALTER TABLE table_name ADD SPATIAL INDEX|KEY [index_name](column_g_name);

The related parameters are described as follows:

  • table_name: Specifies the name of the table for which you want to create an index.

  • INDEX|KEY: Indicates that you can use either INDEX or KEY as the index keyword in this statement.

  • index_name: Optional. Specifies the name of the index to be added. If not specified, the default index name is the same as the specified column name.

  • column_g_name: Specifies the columns to be indexed. When specifying multiple columns, separate them with commas. The column types of the columns for which you want to add a spatial index must be spatial data types. For information about the spatial data types supported by OceanBase AI Database, see Overview of spatial data types.

The following example shows how to create the table tbl3_g and then create a spatial index tbl3_g_idx1 on it:

  1. Create the table tbl3_g.

    CREATE TABLE tbl3_g(id INT,name VARCHAR(20),g GEOMETRY NOT NULL SRID 4326);
    
  2. Create a spatial index on the table.

    ALTER TABLE tbl3_g ADD SPATIAL INDEX tbl3_g_idx1(g);
    
  3. View the index information.

    SHOW INDEX FROM tbl3_g;
    

    The query result is as follows:

    +--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
    | Table  | Non_unique | Key_name    | Seq_in_index | Column_name | Collation | Cardinality | Sub_part | Packed | Null | Index_type | Comment   | Index_comment | Visible |
    +--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
    | tbl3_g |          1 | tbl3_g_idx1 |            1 | g           | A         |        NULL | NULL     | NULL   |      | SPATIAL    | available |               | YES     |
    +--------+------------+-------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+
    1 row in set
    

Create a function-based index

A function-based index is an index created on the result of a calculation based on one or more columns in a table. Function-based indexing is an optimization technique that allows you to quickly locate matching function values during queries, thereby avoiding repeated calculations and improving query efficiency.

Assume you have a table named sale with a column named date_col of data type date:

CREATE TABLE sale(date_col date, sales_col int, name_col varchar(10));

If you need to retrieve data for March, you can use the Month() function to query the data:

SELECT * FROM sale WHERE month(date_col) = 3;

In this scenario, the database needs to calculate month(date_col) for each row in the table and filter out rows that do not meet the condition month(date_col) = 3. If you frequently need to filter data using month information, recalculating month(date_col) every time would incur significant overhead. Therefore, you can create a function-based index on date_col to store month(date_col) in the index table, accelerating queries.

CREATE INDEX idx1 ON sale((month(date_col)));

You can use the CREATE TABLE statement, CREATE INDEX statement, or ALTER TABLE statement to create a function-based index. A function-based index can also be a unique index or a spatial index.

Limitations on function-based indexes

In OceanBase AI Database, expressions for function-based indexes are restricted. Expressions that use certain system functions are prohibited. For details about the specific functions, see List of system functions supported for function-based indexes and List of system functions not supported for function-based indexes.

Create a function-based index using the CREATE TABLE statement

You can create a function-based index for a table when you create the table. The syntax is as follows:

CREATE TABLE table_name({column_name column_definition,[column_name column_definition,...]} [UNIQUE| SPATIAL] {INDEX|KEY} [index_name](expr));

The relevant parameters are described as follows:

  • table_name: Specifies the name of the table for which you want to create the index.

  • column_definition: Defines the data types of the columns in the table.

  • [UNIQUE | SPATIAL]: Optional. UNIQUE indicates a unique index; SPATIAL indicates a spatial index. Add the corresponding keyword when creating a unique index or a spatial index.

  • INDEX|KEY: Indicates that you can use either INDEX or KEY for the index keyword in this statement.

  • index_name: Optional. The name of the function-based index to be created. If not specified, the system automatically generates a name in the format functional_index_xx, where xx is the index number.

  • expr: A valid function-based index expression, which can be a boolean expression, such as c1=c1.

The following example shows how to create a function-based index named tbl1_func_idx1:

CREATE TABLE tbl1_func (c1 int, c2 int, index tbl1_func_idx1 ((c1+1)), UNIQUE KEY ((c1+c2)));

After successful creation, you can use the SHOW CREATE TABLE statement to view the table creation statement, which is as follows:

SHOW CREATE TABLE tbl1_func;

The query result is as follows:

+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Table     | Create Table                                                                                                                                                                                                                                                                                                                                                                                        |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tbl1_func | CREATE TABLE `tbl1_func` (
  `c1` int(11) DEFAULT NULL,
  `c2` int(11) DEFAULT NULL,
  UNIQUE KEY `functional_index` ((`c1` + `c2`)) BLOCK_SIZE 16384 LOCAL,
  KEY `tbl1_func_idx1` ((`c1` + 1)) BLOCK_SIZE 16384 LOCAL
) DEFAULT CHARSET = utf8mb4 ROW_FORMAT = DYNAMIC COMPRESSION = 'zstd_1.3.8' REPLICA_NUM = 1 BLOCK_SIZE = 16384 USE_BLOOM_FILTER = FALSE TABLET_SIZE = 134217728 PCTFREE = 0 |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set

Create a function-based index by using the CREATE INDEX statement

After a table is created, you can create a function-based index on it. The syntax is as follows:

CREATE [UNIQUE | SPATIAL] INDEX index_name ON table_name (expr);

The relevant parameters are described as follows:

  • [UNIQUE | SPATIAL]: Optional. UNIQUE indicates a unique index; SPATIAL indicates a spatial index. Add the corresponding keyword when creating a unique or spatial index.

  • index_name: The name of the function-based index to be created.

  • table_name: The table on which to create the index.

  • expr: A valid function-based index expression, which can be a Boolean expression, such as c1=c1.

Create a function-based index named tbl2_func_idx1 on the table with the definition c1+c2 < 1, as shown in the following example:

  1. Create the table tbl2_func.

    CREATE TABLE tbl2_func(c1 int, c2 int);
    
  2. Create the function-based index tbl2_func_idx1.

    CREATE INDEX tbl2_func_idx1 on tbl2_func ((c1+c2 < 1));
    
  3. After successful creation, you can view the created function-based index.

    SHOW INDEX FROM tbl2_func;
    

    The result is as follows:

    +-----------+------------+----------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+---------------------+
    | Table     | Non_unique | Key_name       | Seq_in_index | Column_name | Collation | Cardinality | Sub_part | Packed | Null | Index_type | Comment   | Index_comment | Visible | Expression          |
    +-----------+------------+----------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+---------------------+
    | tbl2_func |          1 | tbl2_func_idx1 |            1 | SYS_NC18$   | A         |        NULL | NULL     | NULL   | YES  | BTREE      | available |               | YES     | ((`c1` + `c2`) < 1) |
    +-----------+------------+----------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+---------------------+
    1 row in set
    

Create a function-based index by using the ALTER TABLE statement

The syntax is as follows:

ALTER TABLE table_name ADD [UNIQUE | SPATIAL] {INDEX | KEY} [index_name](expr);

The relevant parameters are described as follows:

  • table_name: The table on which to create the index.

  • [UNIQUE | SPATIAL]: Optional. UNIQUE indicates a unique index; SPATIAL indicates a spatial index. Add the corresponding keyword when creating a unique or spatial index.

  • INDEX|KEY: Indicates that in this statement, the index keyword can be used as either INDEX or KEY.

  • index_name: Optional. The name of the function index to be created. If not specified, the system will automatically generate a name in the format functional_index followed by a number.

  • expr: A valid function index expression, which can be a boolean expression, for example, c1=c1.

  1. Create table tbl3_func.

    CREATE TABLE tbl3_func(c1 int, c2 int);
    
  2. Create two function indexes for the table.

    ALTER TABLE tbl3_func ADD INDEX ((c1+1));
    
    ALTER TABLE tbl3_func ADD INDEX ((concat(c1,'a')));
    
  3. View index information.

    SHOW INDEX FROM tbl3_func;
    

    The query result is as follows:

    +-----------+------------+--------------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+------------------+
    | Table     | Non_unique | Key_name           | Seq_in_index | Column_name | Collation | Cardinality | Sub_part | Packed | Null | Index_type | Comment   | Index_comment | Visible | Expression       |
    +-----------+------------+--------------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+------------------+
    | tbl3_func |          1 | functional_index   |            1 | SYS_NC18$   | A         |        NULL | NULL     | NULL   | YES  | BTREE      | available |               | YES     | (`c1` + 1)       |
    | tbl3_func |          1 | functional_index_2 |            1 | SYS_NC19$   | A         |        NULL | NULL     | NULL   | YES  | BTREE      | available |               | YES     | concat(`c1`,'a') |
    +-----------+------------+--------------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+-----------+---------------+---------+------------------+
    2 rows in set
    

Create a columnstore index

You can use the CREATE TABLE statement, CREATE INDEX statement, or ALTER TABLE statement to create a columnstore index.

Create a columnstore index by using the CREATE TABLE statement

You can use the CREATE TABLE statement to create a columnstore index for a table when you create the table.

The syntax is as follows:

CREATE TABLE table_name(column_name column_definition,[column_name column_definition,...] [UNIQUE] INDEX|KEY [index_name](column_name) [STORING(column_name, ...)] WITH COLUMN GROUP([all columns, ]each column));

The related parameters are described as follows:

  • table_name: The name of the table to be created.

  • column_name: The name of a column in the table.

  • column_definition: The data type of each column in the table.

  • UNIQUE: Optional. Indicates a unique index. This keyword is required when creating a unique index.

  • INDEX|KEY: Indicates that the index keyword can be INDEX or KEY in this statement.

  • index_name: Optional. The name of the index to be created. If not specified, the default index name is the same as the specified column name.

  • STORING(column_name, ...) : Optional. Specifies redundant columns on the index table. Even if the column_name column is not an index field, it will be redundantly stored in columnstore format.

  • WITH COLUMN GROUP([all columns, ]each column) : Specifies the columnstore attribute of the index.

    • WITH COLUMN GROUP(all columns, each column) : Specifies to create a hybrid rowstore-columnstore index.
    • WITH COLUMN GROUP(all columns) : Specifies to create a rowstore index.
    • WITH COLUMN GROUP(each column) : Specifies to create a columnstore index.

Examples:

  • Create table tbl4 and create a hybrid rowstore-columnstore index idx1_tbl4_cg at the same time.

    CREATE TABLE tbl4(id INT, name VARCHAR(18), date DATE, PRIMARY KEY (id), INDEX idx1_tbl4_cg (date) WITH COLUMN GROUP(all columns, each column));
    
  • Create table tbl5, create a columnstore index idx1_tbl5_cg at the same time, and store redundant data of the id column on the index table.

    CREATE TABLE tbl5(id INT, name VARCHAR(18), date DATE, INDEX idx1_tbl5_cg (date) STORING(id) WITH COLUMN GROUP(each column));
    

Create a columnstore index by using the CREATE INDEX statement

You can use the CREATE INDEX statement to create a columnstore index for an existing table.

The syntax is as follows:

CREATE [UNIQUE] INDEX index_name ON table_name (column_name) [STORING(column_name, ...)] WITH COLUMN GROUP([all columns, ]each column);

The relevant parameters are described as follows:

  • UNIQUE: Optional. Indicates a unique index. This keyword is required when creating a unique index.

  • index_name: Specifies the name of the index to be created.

  • table_name: Specifies the name of the table on which to create the index.

  • column_name: Specifies the columns to be indexed. When specifying multiple columns, separate them with commas.

  • STORING(column_name, ...): Optional. Specifies redundant columns on the index table. Even if a column_name column is not an index field, it will be redundantly stored in columnar format.

  • WITH COLUMN GROUP([all columns, ]each column): Specifies the columnar storage attributes of the index.

    • WITH COLUMN GROUP(all columns, each column): Specifies to create an index that is redundant for both row and column storage.
    • WITH COLUMN GROUP(all columns): Specifies to create a row-based index.
    • WITH COLUMN GROUP(each column): Specifies to create a columnar index.

Example:

After creating the tbl6 table, create a columnar index named idx1_tbl6_cg.

  1. Create the tbl6 table.

    CREATE TABLE tbl6(id INT, name VARCHAR(20), age INT);
    
  2. Create a columnar index named idx1_tbl6_cg on the tbl6 table, and store redundant data for the age column on the index table.

    CREATE INDEX idx1_tbl6_cg ON tbl6(id) STORING(age) WITH COLUMN GROUP(each column);
    

Create a columnar index using the ALTER TABLE statement

You can use the ALTER TABLE statement to create a columnar index for an existing table.

The syntax is as follows:

ALTER TABLE table_name ADD [UNIQUE] INDEX|KEY [index_name](column_name) [STORING(column_name, ...)] WITH COLUMN GROUP([all columns, ]each column);

The relevant parameters are described as follows:

  • table_name: Specifies the name of the table on which to create the index.

  • UNIQUE: Optional. Indicates a unique index. This keyword is required when creating a unique index.

  • INDEX|KEY: Indicates that you can use either INDEX or KEY as the index keyword in this statement.

  • index_name: Optional. Specifies the name of the index to be created. If not specified, the default index name is the same as the specified column name.

  • column_name: Specifies which columns to index. When specifying multiple columns, separate them with commas.

  • STORING(column_name, ...): Optional. Specifies redundant columns on the index table. Even if a column_name column is not an index field, it will be redundantly stored in columnar format.

  • WITH COLUMN GROUP([all columns, ]each column): Specifies the columnar attributes of the index.

    • WITH COLUMN GROUP(all columns, each column): Specifies to create a hybrid row-column storage index.
    • WITH COLUMN GROUP(all columns): Specifies to create a row storage index.
    • WITH COLUMN GROUP(each column): Specifies to create a columnar index.

Example:

After creating table tbl7, create a columnar index idx1_tbl6_cg.

  1. Create table tbl7.

    CREATE TABLE tbl7(id INT, name VARCHAR(20), age INT);
    
  2. Create a columnar index idx1_tbl7_cg for table tbl7 and store redundant data for the age column on the index table.

    ALTER TABLE tbl7 ADD INDEX idx1_tbl7_cg(id) STORING(age) WITH COLUMN GROUP(each column);
    

Create a multi-valued index

OceanBase AI Database supports creating multi-valued indexes in advance when you create a table (CREATE TABLE). Currently, you cannot add a multi-valued index after the table is created, but you can drop an existing index using the ALTER TABLE statement. Complex DML operations are supported on primary tables that have multi-valued indexes created.

Limitations on multi-valued indexes

  • Each multi-valued index allows only one multi-valued key part. However, the CAST(... AS ... ARRAY) expression can reference multiple arrays in a JSON document, as shown below:

    CAST(data->'$.arr[*][*]' AS UNSIGNED ARRAY)
    

    In this case, all values that match the JSON expression are stored in the index as a single flat array.

  • A multi-valued index cannot be a covering index.

  • The only type of expression allowed in the multi-valued key part is a JSON expression. The expression does not have to reference existing elements in the JSON documents inserted into the index columns, but it must be syntactically valid.

  • Because index records for the same clustered index are scattered across multiple entries in a multi-valued index, range scans or index-only scans are not supported.

  • Multi-valued indexes are not allowed in foreign key specifications.

  • You cannot define an index prefix for a multi-valued index.

  • You cannot define a multi-valued index on data of the Binary type.

  • For information about the support of offline DDL for multi-valued indexes, see Online DDL and Offline DDL Operations.

Create a multi-valued index using the CREATE TABLE statement

The simplified syntax for creating a multi-valued index using the CREATE TABLE statement is as follows:

Create a multi-valued index:

CREATE TABLE table_name(column_name column_definition, [column_name column_definition, ...],
    json_column_name JSON, 
    [UNIQUE] INDEX idx_json_name((CAST(json_column_name->'$.json_field_name' AS UNSIGNED ARRAY)))
);

Create a composite multi-valued index:

CREATE TABLE table_name(column_name column_definition, [column_name column_definition, ...],
    json_column_name JSON,
    INDEX idx_json_name(column_name, [column_name, ...] (CAST(json_column_name->'$.json_field_name' AS CHAR(n) ARRAY)))
);                   

The related parameters are described as follows:

  • table_name: Specifies the name of the table to be created.

  • column_name: Specifies the name of a column with a data type other than JSON in the table.

  • column_definition: Defines the data type corresponding to each column in the table.

  • json_column_name: Specifies the name of the JSON data type column in the table.

  • UNIQUE: Optional. Indicates that a unique multi-valued index is to be created. In a unique multi-valued index, the index keys must not be repeated.

    Notice

    A multi-valued index can be defined as a unique index. If defined as a unique index, attempting to insert a value already present in the multi-valued index will return a duplicate key error. If duplicate values already exist, attempting to add a unique multi-valued index will fail.

  • idx_json_name: Specifies the name of the multi-valued index to be created.

  • json_field_name: The name of the field in the JSON column for which you want to create an index.

For more information about table creation syntax, see CREATE TABLE.

Example of creating a multi-valued index:

  1. Create the json_tbl1 table and the idx1_json_tbl1 multi-valued index.

    CREATE TABLE json_tbl1(col1 INT, col2 VARCHAR(18), col3 JSON,
       INDEX idx1_json_tbl1((CAST(col3->'$.ipcode' AS UNSIGNED ARRAY)))
    );
    
  2. Use the following statement to insert test data into the json_tbl1 table.

    INSERT INTO json_tbl1 VALUES(1, 'a1', '{"user":"Jk001","user_id":37,"ipcode":[94582,94536]}'),
       (2, 'a2', '{"user":"Jk002","user_id":22,"ipcode":[94568,94507,94582]}'),
       (3, 'a3', '{"user":"Jk003","user_id":31,"ipcode":[94477,94507]}'),
       (4, 'a4', '{"user":"Jk004","user_id":72,"ipcode":[94536]}'),
       (5, 'a5', '{"user":"Jk005","user_id":56,"ipcode":[94507,94582]}');
    

Example of creating a multi-valued index:

Create the json_tbl2 table and the composite multi-valued index idx1_json_tbl2.

CREATE TABLE json_tbl2(col1 INT, col2 VARCHAR(18), col3 JSON,
      INDEX idx1_json_tbl2(col1, (CAST(col3->'$.ipcode' AS UNSIGNED ARRAY)))
);

Support for complex DML

For a primary table that contains a multi-valued index, complex DML operations are supported. Examples:

  • INSERT INTO ON DUPLICATE KEY

    CREATE TABLE customers(id INT PRIMARY KEY, uid INT, j JSON);
    
    INSERT INTO customers VALUES (10, 21, '{"user":"Jack","user_id":37,"zipcode":[94582,94536]}');
    
    CREATE INDEX zips ON customers((CAST(j->'$.zipcode' AS UNSIGNED ARRAY)));
    
    INSERT INTO customers 
    VALUES (10, 22, '{"user":"Jack","user_id":37,"zipcode":[24582,34536]}') 
    ON DUPLICATE KEY 
    UPDATE j = '{"user":"Jack","user_id":37,"zipcode":[34582,44536]}';
    
  • REPLACE INTO

    CREATE TABLE test_array(id int,a varchar(50),j json,INDEX index_1( (CAST(j->'$.key' AS UNSIGNED ARRAY))) );
    
    INSERT INTO test_array VALUES(1,'test','{"key":[1,2,3,4]}');
    
    REPLACE INTO test_array VALUES(1,'test','{"key":[8,9,13,43]}');
    
  • Multi-table UPDATE and DELETE

    Prepare the sample tables as follows:

    CREATE TABLE table_1(a int PRIMARY KEY, b json, INDEX index_1( (CAST(b->'$.key' AS UNSIGNED ARRAY))) );
    CREATE TABLE table_2(a int PRIMARY KEY, b json);
    
    INSERT INTO table_1 values(1, '{"key":[1,2,3,4]}');
    INSERT INTO table_2 values(1, '{"key":[1,2,3,4]}');
    

    Example of UPDATE:

    UPDATE table_1 JOIN table_2 ON table_1.a = table_2.a 
    SET table_1.b = '{"key":[11,12,13,14]}', table_2.b = '{"key":[21,22,23,24]}';
    
    UPDATE  table_1 JOIN table_2 ON table_1.a = table_2.a SET table_1.b = '{"key":[31,32,33,34]}';
    UPDATE table_1 JOIN table_2 ON table_1.a = table_2.a SET table_2.b = table_1.b;
    

    Example of DELETE:

    DELETE table_1, table_2 FROM table_1 JOIN table_2 ON table_1.a = table_2.a;
    DELETE table_1 FROM table_1 JOIN table_2 ON table_1.a = table_2.a;
    DELETE table_1 FROM table_1 JOIN table_2 ON table_1.a = table_2.a;
    
  • Updatable views

    CREATE TABLE test(id int,a varchar(50),j json,INDEX index_1( (CAST(j->'$.key' AS UNSIGNED ARRAY))) );
    
    INSERT INTO test values(1,'test','{"key":[1,2,3,4]}');
    
    CREATE VIEW vtest AS SELECT * FROM test;
    
    UPDATE vtest SET j='{"key":[1,2]}';
    

Add a multi-value index afterward

To add a multi-value index afterward, you must first enable the _enable_add_fulltext_index_to_existing_table parameter.

ALTER SYSTEM SET _enable_add_fulltext_index_to_existing_table = true;

Multi-value indexes added afterward can be classified as follows:

Category
Description
Multi-valued index A multi-valued index created by using the ADD INDEX or ALTER TABLE statement.
Composite multi-valued index A non-unique composite multi-valued index created by using the ADD INDEX or ALTER TABLE statement. A composite multi-valued index allows only one column to be a multi-valued index, while the other columns are regular columns.
Unique multi-valued index A unique multi-valued index created by using the ADD INDEX or ALTER TABLE statement.
Unique composite multi-valued index A unique composite multi-valued index created by using the ADD INDEX or ALTER TABLE statement. A composite multi-valued index allows only one column to be a multi-valued index, while the other columns are regular columns.

Examples are as follows:

  1. Create table json_tbl1 and create a non-unique multi-value index idx1_json_tbl1 at the same time.

    CREATE TABLE json_tbl1(id INT PRIMARY KEY, uid INT, j JSON);
    
    INSERT INTO json_tbl1 VALUES 
    (10, 21, '{"user":"Jack","user_id":37,"zipcode":[94582,94536]}'),
    (11, 22, '{"user":"Jill","user_id":22,"zipcode":[94568,94507,94582]}'),
    (12, 23, '{"user":"Bob","user_id":31,"zipcode":[94477,94507]}'),
    (13, 24, '{"user":"Mary","user_id":72,"zipcode":[94536]}'),
    (14, 25, '{"user":"Ted","user_id":56,"zipcode":[94507,94582]}');
    
    CREATE INDEX idx1_json_tbl1 ON json_tbl1((CAST(j->'$.zipcode' AS UNSIGNED ARRAY)));
    
  2. Create a unique multi-value index idx1_json_tbl2.

    CREATE TABLE json_tbl2(id INT PRIMARY KEY, uid INT, j JSON);
    
    INSERT INTO json_tbl2 VALUES 
    (10, 21, '{"user":"Jack","user_id":37,"zipcode":[94507,94536]}'),
    (11, 22, '{"user":"Jill","user_id":22,"zipcode":[94568,94582]}'),
    (12, 23, '{"user":"Bob","user_id":31,"zipcode":[94477]}');
    
    CREATE UNIQUE INDEX idx1_json_tbl2 ON json_tbl2((CAST(j->'$.zipcode' AS UNSIGNED ARRAY)));
    
  3. Create a composite multi-value index idx1_json_tbl3.

    CREATE TABLE json_tbl3 (
     id BIGINT NOT NULL PRIMARY KEY,
     c1 BIGINT NOT NULL,
     modified  BIGINT NOT NULL,
     custinfo JSON
    );
    
    INSERT INTO json_tbl3 VALUES 
    (10, 21, 101, '{"user":"Jack","user_id":37,"zipcode":[94582,94536]}'),
    (11, 22, 102, '{"user":"Jill","user_id":22,"zipcode":[94568,94507,94582]}'),
    (12, 23, 103, '{"user":"Bob","user_id":31,"zipcode":[94477,94507]}'),
    (13, 24, 104, '{"user":"Mary","user_id":72,"zipcode":[94536]}'),
    (14, 25, 105, '{"user":"Ted","user_id":56,"zipcode":[94507,94582]}');
    
    CREATE INDEX idx1_json_tbl3 ON json_tbl3 (c1, modified,
         (CAST(custinfo->'$.zipcode' AS UNSIGNED ARRAY)) );
    
  4. Create a unique composite multi-value index idx1_json_tbl4.

    CREATE TABLE json_tbl4 (
     id BIGINT NOT NULL PRIMARY KEY,
     c1 BIGINT NOT NULL,
     modified  BIGINT NOT NULL,
     custinfo JSON
    );
    
    INSERT INTO json_tbl4 VALUES 
    (10, 21, 101, '{"user":"Jack","user_id":37,"zipcode":[94582,94536]}'),
    (11, 22, 102, '{"user":"Jill","user_id":22,"zipcode":[94568,94507,94582]}'),
    (12, 23, 103, '{"user":"Bob","user_id":31,"zipcode":[94477,94507]}'),
    (13, 24, 104, '{"user":"Mary","user_id":72,"zipcode":[94536]}'),
    (14, 25, 105, '{"user":"Ted","user_id":56,"zipcode":[94507,94582]}');
    
    CREATE UNIQUE INDEX idx1_json_tbl4 ON json_tbl4 (c1, modified,
         (CAST(custinfo->'$.zipcode' AS UNSIGNED ARRAY)) );
    

Use multi-value indexes in queries

The optimizer uses multi-value indexes for queries when the following functions are specified in the WHERE clause:

  • MEMBER OF
  • JSON_CONTAINS
  • JSON_OVERLAPS

Example:

  • Example query using MEMBER OF().

    SELECT *
       FROM json_tbl1
       WHERE 94507 MEMBER OF(col3->'$.ipcode');
    

    The result is as follows:

    +------+------+-------------------------------------------------------------------+
    | col1 | col2 | col3                                                              |
    +------+------+-------------------------------------------------------------------+
    |    2 | a2   | {"user": "Jk002", "ipcode": [94568, 94507, 94582], "user_id": 22} |
    |    3 | a3   | {"user": "Jk003", "ipcode": [94477, 94507], "user_id": 31}        |
    |    5 | a5   | {"user": "Jk005", "ipcode": [94507, 94582], "user_id": 56}        |
    +------+------+-------------------------------------------------------------------+
    3 rows in set
    
  • Execute a query on table json_tbl1 to filter out rows where the ipcode field in the JSON data of column col3 contains the value 94507. Use the EXPLAIN command to view the query execution plan.

    EXPLAIN SELECT *
       FROM json_tbl1
       WHERE 94507 MEMBER OF(col3->'$.ipcode');
    

    The query result is as follows:

    +-------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Query Plan                                                                                                                                            |
    +-------------------------------------------------------------------------------------------------------------------------------------------------------+
    | =====================================================================                                                                                 |
    | |ID|OPERATOR        |NAME                     |EST.ROWS|EST.TIME(us)|                                                                                 |
    | ---------------------------------------------------------------------                                                                                 |
    | |0 |TABLE RANGE SCAN|json_tbl1(idx1_json_tbl1)|3       |13          |                                                                                 |
    | =====================================================================                                                                                 |
    | Outputs & filters:                                                                                                                                    |
    | -------------------------------------                                                                                                                 |
    |   0 - output([json_tbl1.col1], [json_tbl1.col2], [json_tbl1.col3]), filter(nil)                                                                       |
    |       access([json_tbl1.__pk_increment], [json_tbl1.col3], [json_tbl1.col1], [json_tbl1.col2]), partitions(p0)                                        |
    |       is_index_back=true, is_global_index=false,                                                                                                      |
    |       range_key([json_tbl1.SYS_NC_mvi_19], [json_tbl1.__pk_increment], [json_tbl1.__doc_id_1715756608129539]), range(94507,MIN,MIN ; 94507,MAX,MAX),  |
    |       range_cond([JSON_MEMBER_OF(94507, json_tbl1.SYS_NC_mvi_19)])                                                                                    |
    +-------------------------------------------------------------------------------------------------------------------------------------------------------+
    12 rows in set
    
  • Example of using JSON_CONTAINS().

    SELECT *
       FROM json_tbl1
       WHERE JSON_CONTAINS(col3->'$.ipcode', CAST('[94507,94582]' AS JSON));
    

    The query result is as follows:

    +------+------+-------------------------------------------------------------------+
    | col1 | col2 | col3                                                              |
    +------+------+-------------------------------------------------------------------+
    |    2 | a2   | {"user": "Jk002", "ipcode": [94568, 94507, 94582], "user_id": 22} |
    |    5 | a5   | {"user": "Jk005", "ipcode": [94507, 94582], "user_id": 56}        |
    +------+------+-------------------------------------------------------------------+
    2 rows in set
    
  • Example of using JSON_OVERLAPS().

    SELECT *
       FROM json_tbl1
       WHERE JSON_OVERLAPS(col3->'$.ipcode', CAST('[94507,94582]' AS JSON));
    

    The query result is as follows:

    +------+------+-------------------------------------------------------------------+
    | col1 | col2 | col3                                                              |
    +------+------+-------------------------------------------------------------------+
    |    1 | a1   | {"user": "Jk001", "ipcode": [94582, 94536], "user_id": 37}        |
    |    2 | a2   | {"user": "Jk002", "ipcode": [94568, 94507, 94582], "user_id": 22} |
    |    3 | a3   | {"user": "Jk003", "ipcode": [94477, 94507], "user_id": 31}        |
    |    5 | a5   | {"user": "Jk005", "ipcode": [94507, 94582], "user_id": 56}        |
    +------+------+-------------------------------------------------------------------+
    4 rows in set
    

Create a full-text index

In the current version of OceanBase AI Database, you can use the CREATE TABLE statement, CREATE FULLTEXT INDEX statement, or ALTER TABLE statement to create a full-text index.

For more information about full-text indexes, see Full-text search.

For information about querying data using a full-text index, see Full-text query.

Limitations and considerations for full-text indexes

You can create a full-text index on a non-partitioned table or a partitioned table with or without a primary key. The limitations are as follows:

  • Full-text indexes are supported only on columns of the CHAR, VARCHAR, and TEXT types.
  • The current version supports only creating local (LOCAL) full-text indexes.
  • You cannot specify the UNIQUE keyword when creating a full-text index.
  • To create a full-text index on multiple columns, ensure these columns have the same character set.
  • For information about the support of offline DDL operations for full-text indexes, see Online DDL and Offline DDL Operations.

Create a full-text index by using the CREATE TABLE statement

You can create a full-text index for a table when you create the table using the CREATE TABLE statement. The simplified syntax is as follows:

CREATE TABLE table_name(column_name column_definition,[column_name column_definition,...]
    FULLTEXT [INDEX | KEY] [index_name](column_name)
    [WITH PARSER tokenizer_option]
    [PARSER_PROPERTIES[=](parser_properties_list)]
    [LOCAL]);

tokenizer_option:
    SPACE
    | NGRAM
    | BENG
    | IK
    | NGRAM2
    | analyzer

parser_properties_list:
    parser_properties, [parser_properties]

parser_properties:
    min_token_size = int_value
    | max_token_size = int_value
    | ngram_token_size = int_value
    | ik_mode = 'char_value'
    | min_ngram_size = int_value
    | max_ngram_size = int_value
    | analysis = json_string

For more information about the CREATE TABLE syntax, see CREATE TABLE.

The relevant parameters are described as follows:

  • table_name: The name of the table to be created.

  • column_name: The column in the table.

  • column_definition: Defines the data type corresponding to each column in the table.

  • FULLTEXT: Specifies to create a full-text index.

    Notice

    The current version supports only creating local full-text indexes.

  • INDEX | KEY: Indicates that you can use either INDEX or KEY as the index keyword in this statement.

  • index_name: Optional. Specifies the name of the index to be created. If not specified, the default index name is the same as the specified column name.

  • WITH PARSER tokenizer_option: Optional. Specifies the tokenizer for the full-text index. Valid values:

    • SPACE: The default value. Indicates to tokenize by spaces. The following attributes can be specified:

      Attribute
      Value range
      min_token_size [1, 16]
      max_token_size [10, 84]
    • NGRAM: Indicates to tokenize based on N-grams (for Chinese). The following attributes can be specified:

      Attribute
      Value range
      ngram_token_size [1, 10]
    • NGRAM2: Indicates that the text will be split into consecutive characters within the range of min_ngram_size to max_ngram_size.

      Attribute
      Value range
      min_ngram_size [1, 16]
      max_ngram_size [1, 16]
    • BENG: A word segmentation method based on Beng (Basic English). The following attributes can be specified:

      Attribute
      Value range
      min_token_size [1, 16]
      max_token_size [10, 84]
    • IK: Indicates a word segmentation method based on IK (Chinese). Currently, only the utf-8 character set is supported. The following attributes can be specified:

      Attribute
      Value range
      ik_mode
      • smart
      • max_word

    You can use the TOKENIZE function to view the word segmentation result of a text using the specified tokenizer and JSON-formatted parameters.

  • PARSER_PROPERTIES[=](parser_properties_list): Optional. Specifies the properties of the tokenizer. Valid values are as follows:

    • min_token_size: Indicates the minimum token length. Default value is 3. Value range is 1 to 16.

    • max_token_size: Indicates the maximum token length. Default value is 84. Value range is 10 to 84.

    • ngram_token_size: Indicates the segmentation length for NGRAM. This parameter is valid only for the NGRAM tokenizer. Default value is 2. Value range is 1 to 10.

    • ik_mode: Indicates the segmentation mode for the IK tokenizer. Valid values are as follows:

      • smart: Default value. Indicates that dictionary words will be used to improve segmentation accuracy. Dictionary word boundaries will be prioritized, which may reduce unnecessary expansions.
      • max_word: Indicates that dictionary-defined words will be recognized, but it will not affect the maximization of segmentation expansions. Even if a word is defined in the dictionary, the max_word mode will still attempt to split the text into more words.
  • LOCAL: Optional. Specifies to create a local index.

Example:

  • Create table tbl1 and a full-text index full_idx1_tbl1 at the same time.

    CREATE TABLE tbl1(id INT, name VARCHAR(18), date DATE, PRIMARY KEY (id), FULLTEXT INDEX full_idx1_tbl1(name));
    
  • Create table tbl2, a full-text index full_idx1_tbl2, specify the NGRAM tokenizer for the full-text index, and set the tokenizer properties using PARSER_PROPERTIES.

    CREATE TABLE tbl2(id INT, name VARCHAR(18), doc TEXT, 
        FULLTEXT INDEX full_idx1_tbl2(name, doc)
          WITH PARSER NGRAM
          PARSER_PROPERTIES=(ngram_token_size=3));
    

Create a full-text index by using the CREATE FULLTEXT INDEX statement

You can execute the CREATE FULLTEXT INDEX statement to create a full-text index for an existing table. The syntax is as follows:

CREATE FULLTEXT INDEX index_name ON table_name (column_name, [column_name ...])
    [WITH PARSER tokenizer_option]
    [PARSER_PROPERTIES[=](parser_properties_list)]
    [LOCAL];

tokenizer_option:
    SPACE
    | NGRAM
    | BENG
    | IK
    | NGRAM2
    | analyzer

parser_properties_list:
    parser_properties, [parser_properties]

parser_properties:
    min_token_size = int_value
    | max_token_size = int_value
    | ngram_token_size = int_value
    | ik_mode = 'char_value'
    | min_ngram_size = int_value
    | max_ngram_size = int_value
    | analysis = json_string

For more information about the CREATE INDEX syntax, see CREATE INDEX.

The relevant parameters are described as follows:

  • index_name: The name of the index to be created.

  • table_name: The name of the table on which to create the index.

  • column_name: The columns to be indexed. When specifying multiple columns, separate them with commas.

  • WITH PARSER tokenizer_option: Optional. Specifies the tokenizer for the full-text index. Valid values:

    • SPACE: The default value, which specifies to tokenize by spaces. You can specify the following attributes:

      Attribute
      Value range
      min_token_size [1, 16]
      max_token_size [10, 84]
    • NGRAM: Specifies to tokenize based on N-Grams (Chinese). You can specify the following attributes:

      Attribute
      Value range
      ngram_token_size [1, 10]
    • NGRAM2: Splits text into consecutive characters within the range of min_ngram_size to max_ngram_size. You can specify the following attributes:

      Attribute
      Value range
      min_ngram_size [1, 16]
      max_ngram_size [1, 16]
    • BENG: Specifies to tokenize based on Beng (Basic English). You can specify the following attributes:

      Attribute
      Value range
      min_token_size [1, 16]
      max_token_size [10, 84]
    • IK: Specifies to tokenize based on IK (Chinese). Currently, only the utf-8 character set is supported. You can specify the following attributes:

      Attribute
      Value range
      ik_mode
      • smart
      • max_word

    You can use the TOKENIZE function to view the tokenization result of a text using the specified tokenizer and JSON-formatted parameters.

  • PARSER_PROPERTIES[=](parser_properties_list): Optional. Specifies the properties of the tokenizer. Valid values:

    • min_token_size: The minimum token length. Default value: 3. Value range: 1 to 16.

    • max_token_size: The maximum token length. Default value: 84. Value range: 10 to 84.

    • ngram_token_size: The token length for NGRAM. This parameter is valid only for the NGRAM tokenizer. The default value is 2, and the valid range is 1 to 10.

    • ik_mode: The tokenization mode for the IK tokenizer. Valid values:

      • smart: The default value. In this mode, dictionary words are used to improve tokenization accuracy. Dictionary word boundaries are prioritized, which may reduce unnecessary expansions.
      • max_word: In this mode, dictionary-defined words are recognized, but it does not affect the maximization of token expansions. Even if a word is defined in the dictionary, the max_word mode still attempts to split the text into more words.
  • LOCAL: Optional. Specifies to create a local index.

Example:

After creating table tbl3, create a full-text index named ft_idx1_tbl3.

  1. Create table tbl3.

    CREATE TABLE tbl3(col1 INT, col2 VARCHAR(4096));
    
  2. Create a full-text index named ft_idx1_tbl3 on table tbl3. Specify the tokenizer for the full-text index as IK and set the tokenizer properties using PARSER_PROPERTIES.

    CREATE FULLTEXT INDEX ft_idx1_tbl3 ON tbl3(col2)
        WITH PARSER IK
        PARSER_PROPERTIES=(ik_mode='max_word');
    

Create a full-text index by using the ALTER TABLE statement

You can execute the ALTER TABLE statement to add a full-text index to an existing table. The syntax is as follows:

ALTER TABLE table_name ADD FULLTEXT [INDEX | KEY] [index_name](column_name, [column_name ...])
    [WITH PARSER tokenizer_option]
    [PARSER_PROPERTIES[=](parser_properties_list)]
    [LOCAL];

tokenizer_option:
    SPACE
    | NGRAM
    | BENG
    | IK
    | NGRAM2
    | analyzer

parser_properties_list:
    parser_properties, [parser_properties]

parser_properties:
    min_token_size = int_value
    | max_token_size = int_value
    | ngram_token_size = int_value
    | ik_mode = 'char_value'
    | min_ngram_size = int_value
    | max_ngram_size = int_value
    | analysis = json_string

For more information about the syntax for adding a full-text index to an existing table by using the ALTER TABLE statement, see ALTER TABLE.

The relevant parameters are described as follows:

  • table_name: The name of the table for which you want to create the index.

  • INDEX | KEY: Optional. In this statement, you can use either INDEX or KEY as the index keyword. The default value is KEY.

  • index_name: Optional. The name of the index to be created. If not specified, the default index name is the same as the specified column name.

  • column_name: Specifies the columns to be indexed. When specifying multiple columns, separate them with commas.

  • WITH PARSER tokenizer_option: Optional. Specifies the tokenizer for the full-text index. Valid values:

    • SPACE: The default value. Indicates that tokens are separated by spaces. You can specify the following attributes:

      Attribute
      Value range
      min_token_size [1, 16]
      max_token_size [10, 84]
    • NGRAM: Indicates that tokens are separated based on N-grams (Chinese). You can specify the following attributes:

      Attribute
      Value range
      ngram_token_size [1, 10]
    • NGRAM2: Indicates that text is split into consecutive characters within the range of min_ngram_size to max_ngram_size. You can specify the following attributes:

      Attribute
      Value range
      min_ngram_size [1, 16]
      max_ngram_size [1, 16]
    • BENG: Indicates that tokens are separated based on Beng (basic English). You can specify the following attributes:

      Attribute
      Value range
      min_token_size [1, 16]
      max_token_size [10, 84]
    • IK: Indicates that tokens are separated based on IK (Chinese). Currently, only the utf-8 character set is supported. You can specify the following attributes:

      Attribute
      Value range
      ik_mode
      • smart
      • max_word

    You can use the TOKENIZE function to view the tokenization result of text using the specified tokenizer and JSON-formatted parameters.

  • PARSER_PROPERTIES[=](parser_properties_list) : Optional. Specifies the properties of the tokenizer. Valid values:

    • min_token_size: The minimum token length. Default value: 3. Value range: 1 to 16.

    • max_token_size: The maximum token length. Default value: 84. Value range: 10 to 84.

    • ngram_token_size: The token length for NGRAM. This parameter is valid only for the NGRAM tokenizer. Default value: 2. Value range: 1 to 10.

    • ik_mode: The segmentation mode for the IK tokenizer. Valid values:

      • smart: The default value. Lexical terms in the dictionary are used to improve tokenization accuracy. Dictionary boundaries are prioritized, which may reduce unnecessary expansions.
      • max_word: Defined terms in the dictionary are recognized, but this does not affect the maximization of token expansions. Even if a term is defined in the dictionary, the max_word mode still attempts to split the text into more words.
  • LOCAL: Optional. Specifies to create a local index.

Example:

After creating table tbl4, add a full-text index ft_idx1_tbl4.

  1. Create table tbl4.

    CREATE TABLE tbl4(col1 INT, col2 TEXT);
    
  2. Add a full-text index ft_idx1_tbl4 to table tbl4. Specify the tokenizer for the full-text index as BENG, and set tokenizer properties using PARSER_PROPERTIES.

    ALTER TABLE tbl4 ADD FULLTEXT INDEX ft_idx1_tbl4(col2)
        WITH PARSER BENG
        PARSER_PROPERTIES=(min_token_size=2, max_token_size=64);
    

Create a full-text index by using an analyzer (Analyzer)

Note

This feature is supported starting with V4.6.2.1.

The full-text index of OceanBase AI Database introduces an analyzer (Analyzer), allowing users to flexibly define text analysis pipelines (pipelines) using declarative JSON syntax, covering multiple stages such as character-level preprocessing (CharFilter), tokenization (Tokenizer), and post-tokenization processing (TokenFilter). You can select the tokenization method using the WITH PARSER keyword: specifying analyzer uses the Analyzer, while other tokenizer names follow the traditional plugin path, enabling compatibility with various text analysis requirements.

Syntax (applicable to table creation, index creation after table creation, and ALTER TABLE to add an index):

-- During table creation
CREATE TABLE docs (
    id BIGINT PRIMARY KEY,
    content TEXT,
    FULLTEXT INDEX ft_idx_content(content)
        WITH PARSER analyzer
        PARSER_PROPERTIES=(analysis='{"analyzer": "standard"}')
);

-- Create an index afterward
CREATE FULLTEXT INDEX ft_idx_body ON articles(body)
    WITH PARSER analyzer
    PARSER_PROPERTIES=(analysis='{"analyzer": "english"}');

-- ALTER TABLE ADD
ALTER TABLE articles ADD FULLTEXT INDEX ft_idx_title(title)
    WITH PARSER analyzer
    PARSER_PROPERTIES=(analysis='{"analyzer": "indonesian"}');

Constraints:

  • One full-text index corresponds to one Analyzer definition. Multiple full-text indexes can be created on the same column, each using a different Analyzer.
  • The index column type must be a character or large object type (CHAR, VARCHAR, TINYTEXT, TEXT, MEDIUMTEXT, LONGTEXT, STRING).
  • Modifying the Analyzer definition requires rebuilding the index.
  • If WITH PARSER does not match any registered tokenizer, an error is returned.
  • By default, the Analyzer uniformly encodes input as utf8mb4_bin to avoid encoding limitations of some tokenizers (Tokenizer) and token filters (TokenFilter).
  • The Analyzer performs tokenization based on ICU BreakIterator, supporting multi-language Unicode and emoji recognition; output tokens are automatically converted to lowercase.

You can use TOKENIZE to preview the tokenization results before creating the index.

Create a search index (Search Index)

Notice

  • WITH (...) applies only to JSON columns.
  • INCLUDE_PATHS and EXCLUDE_PATHS cannot be specified at the same time.
  • NESTED_PATHS forces indexing for all fields under the specified path, with a higher priority than EXCLUDE_PATHS.

Create a search index using the CREATE SEARCH INDEX statement

You can execute the CREATE SEARCH INDEX statement to create a search index on an existing table. The syntax is as follows:

CREATE SEARCH INDEX index_name ON table_name (
    search_index_column
    [, search_index_column ...]
) [LOCAL];

search_index_column:
    column_name [WITH (search_col_option_list)]

search_col_option_list:
    [INCLUDE_PATHS = ('path1'[, 'path2']...)]
    [| EXCLUDE_PATHS = ('path1'[, 'path2']...)]
    [| INCLUDE_TYPES = (type1[, type2]...)]
    [| NESTED_PATHS = ('path1'[, 'path2']...)]

For more information about the syntax and supported data types of CREATE SEARCH INDEX, see CREATE INDEX.

The parameters are described as follows:

  • index_name: The name of the search index to be created.
  • table_name: The name of the table on which to create the index.
  • search_index_column: The definition of the search index column. You can specify one or more columns. For each column, you can use WITH (...) to specify column-level path and type options.
  • INCLUDE_PATHS / EXCLUDE_PATHS: Column-level path allowlist/blocklist. Choose one of these two options to control the JSON paths of the column used in index construction.
  • INCLUDE_TYPES: Column-level type filtering. Only indexes the specified JSON scalar types (currently JSON_STRING and JSON_NUMBER are supported).
  • NESTED_PATHS: Declares nested paths within JSON (must start with $. and cannot contain column names). This forces indexing for all fields under the path, used for nested queries in hybrid searches. For more information, see Search index.
  • LOCAL: Optional. Used to create a local search index on a partitioned table. Currently, only local search indexes are supported for partitioned tables.

Example:

After creating the table tbl_search_1, create a search index named search_idx_1.

  1. Create the table tbl_search_1.

    CREATE TABLE tbl_search_1 (
      id INT,
      doc JSON,
      c2 VARCHAR(64)
    ) ORGANIZATION = HEAP;
    
  2. Create the search index search_idx_1 on the table tbl_search_1 and configure path allowlists and type filtering for the JSON column.

    CREATE SEARCH INDEX search_idx_1 ON tbl_search_1(
      doc WITH (
        INCLUDE_PATHS = ('$.name', '$.score'),
        INCLUDE_TYPES = (JSON_STRING, JSON_NUMBER)
      ),
      c2
    );
    

Create a search index using the CREATE TABLE statement

You can execute the CREATE TABLE statement to create a search index when creating a table. The syntax is as follows:

CREATE TABLE table_name (
    ...,
    SEARCH INDEX index_name (
        search_index_column
        [, search_index_column ...]
    )
) ORGANIZATION = HEAP;

For more information about the syntax and supported data types of CREATE TABLE, see CREATE TABLE.

The parameters are described as follows:

  • table_name: The name of the table for which you want to create an index.
  • index_name: The name of the search index to be created.
  • search_index_column: The definition of the columns for the search index. You can specify one or more columns. For each column, you can use WITH (...) to specify column-level path and type options.

Example:

Create a table named tbl_search_3 and create a search index named search_idx_3 in the same operation.

CREATE TABLE tbl_search_3 (
  id INT,
  profile JSON,
  tag VARCHAR(32),
  SEARCH INDEX search_idx_3 (
    profile WITH (EXCLUDE_PATHS = ('$.debug')),
    tag
  )
) ORGANIZATION = HEAP;

Create a search index by using the ALTER TABLE statement

You can execute the ALTER TABLE statement to add a search index to an existing table. The syntax is as follows:

ALTER TABLE table_name
ADD SEARCH INDEX [index_name] (
    search_index_column
    [, search_index_column ...]
);

search_index_column:
    column_name [WITH (search_col_option_list)]

search_col_option_list:
    [INCLUDE_PATHS = ('path1'[, 'path2']...)]
    [| EXCLUDE_PATHS = ('path1'[, 'path2']...)]
    [| INCLUDE_TYPES = (type1[, type2]...)]
    [| NESTED_PATHS = ('path1'[, 'path2']...)]

For more information about the syntax for adding a search index to an existing table by using the ALTER TABLE statement, see ALTER TABLE.

The related parameters are described as follows:

  • table_name: The name of the table to which you want to add a search index.
  • index_name: Optional. The name of the search index. If you do not specify this parameter, the system generates a default index name based on the rules.
  • search_index_column: The definition of the columns for the search index. You can specify one or more columns. For each column, you can use WITH (...) to specify column-level path and type options.
  • INCLUDE_PATHS / EXCLUDE_PATHS: Either allowlist or blocklist of column-level paths. You must specify one of these two options to control the JSON paths of the columns involved in index construction.
  • INCLUDE_TYPES: Column-level type filtering. Only indexes the specified JSON scalar types (currently JSON_STRING and JSON_NUMBER).
  • NESTED_PATHS: Declares nested paths in JSON for nested queries in hybrid searches.

Example:

After creating a table named tbl_search_2, add a search index named search_idx_2 by using the ALTER TABLE statement.

  1. Create a table named tbl_search_2.

    CREATE TABLE tbl_search_2 (
      id INT,
      profile JSON,
      tag VARCHAR(32)
    ) ORGANIZATION = HEAP;
    
  2. Add a search index named search_idx_2 to the table tbl_search_2.

    ALTER TABLE tbl_search_2
    ADD SEARCH INDEX search_idx_2 (
      profile WITH (EXCLUDE_PATHS = ('$.debug')),
      tag
    );
    

Create an asynchronous index

Asynchronous indexes support full-text indexes and search indexes. By adding the ASYNC keyword before FULLTEXT or SEARCH, you can create them either at the same time as a table or after the table is created. For complete descriptions and examples, see the "Asynchronous Full-Text Indexes" section in Full-text search and the "Asynchronous Search Indexes" section in Search index.

Create an asynchronous full-text index

Note

Asynchronous full-text indexes are supported starting from V4.6.2.1.

For complete descriptions and examples, see the "Asynchronous Full-Text Indexes" section in Full-text search.

CREATE TABLE t_async_params (
  c1 INT,
  c2 TEXT,
  ASYNC FULLTEXT INDEX idx_ft (c2)
) ORGANIZATION HEAP ASYNC_INDEX_PARAMS = 'ASYNC_REFRESH_INTERVAL=10';

ALTER TABLE t_async_params SET ASYNC_INDEX_PARAMS = 'REFRESH_ON_ERROR=SKIP, ASYNC_REFRESH_INTERVAL=30';

Create an asynchronous search index

Note

Asynchronous search indexes are supported starting from V4.6.2.1.

The table-level refresh parameters for asynchronous search indexes, ASYNC_INDEX_PARAMS (including ASYNC_REFRESH_INTERVAL and REFRESH_ON_ERROR), are shared with asynchronous full-text indexes. For complete descriptions and examples, see the "Asynchronous Search Indexes" section in Search index.

CREATE TABLE t (
  id BIGINT,
  doc JSON,
  ASYNC SEARCH INDEX idx_search (doc)
) ORGANIZATION HEAP;

CREATE ASYNC SEARCH INDEX idx_search ON t(doc);

ALTER TABLE t ADD ASYNC SEARCH INDEX idx_search(doc);

References

For more information about indexes in MySQL-compatible mode, see the following topics:

  • Indexes

  • Local index

  • View indexes

  • Drop an index

Previous topic

About indexes
Last

Next topic

View indexes
Next
on this page
Background information
Considerations
Create a normal index
Create a normal index by using the CREATE TABLE statement
Create a normal index by using the CREATE INDEX statement
Create a normal index by using the ALTER TABLE statement
Create a spatial index
Limitations on using spatial indexes
Create a spatial index using the CREATE TABLE statement
Create a spatial index by using the CREATE INDEX statement
Create a spatial index by using the ALTER TABLE statement
Create a function-based index
Limitations on function-based indexes
Create a function-based index using the CREATE TABLE statement
Create a function-based index by using the CREATE INDEX statement
Create a function-based index by using the ALTER TABLE statement
Create a columnstore index
Create a columnstore index by using the CREATE TABLE statement
Create a columnstore index by using the CREATE INDEX statement
Create a columnar index using the ALTER TABLE statement
Create a multi-valued index
Limitations on multi-valued indexes
Create a multi-valued index using the CREATE TABLE statement
Support for complex DML
Add a multi-value index afterward
Use multi-value indexes in queries
Create a full-text index
Limitations and considerations for full-text indexes
Create a full-text index by using the CREATE TABLE statement
Create a full-text index by using the CREATE FULLTEXT INDEX statement
Create a full-text index by using the ALTER TABLE statement
Create a full-text index by using an analyzer (Analyzer)
Create a search index (Search Index)
Create a search index using the CREATE SEARCH INDEX statement
Create a search index using the CREATE TABLE statement
Create a search index by using the ALTER TABLE statement
Create an asynchronous index
Create an asynchronous full-text index
Create an asynchronous search index
References