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

Databases

OceanBase 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 Service

Connectors and Middleware

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

Databases

OceanBase 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 Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Diagnostic Tool

V2.5.0
  • Overview
  • Install obdiag
  • Configure obdiag
  • One-click Cluster Inspection
    • Use obdiag to inspect an OceanBase cluster
    • Inspection metrics
  • One-click Information Collection
    • One-click General Information Collection
      • obdiag gather log
      • obdiag gather sysstat
      • obdiag gather plan_monitor
      • obdiag gather stack
      • obdiag gather perf
      • obdiag gather ash
      • obdiag gather tabledump
      • obdiag gather parameter
      • obdiag gather variable
      • obdiag gather clog/obdiag gather slog
      • obdiag gather obproxy_log
      • obdiag gather all
    • One-click Scenario-based Information Collection
      • Overview
      • observer.base
      • observer.backup
      • observer.backup_clean
      • observer.clog_disk_full
      • observer.cluster_down
      • observer.compaction
      • observer.cpu_high
      • observer.delay_of_primary_and_backup
      • observer.io
      • observer.log_archive
      • observer.long_transaction
      • observer.memory
      • observer.perf_sql
      • observer.px_collect_log
      • observer.recovery
      • observer.restart
      • observer.rootservice_switch
      • observer.suspend_transaction
      • observer.unit_data_imbalance
      • observer.perf_sql
      • other.application_error
      • obproxy.restart
      • observer.unknown
  • One-click Diagnostic Analysis
    • obdiag analyze log
    • obdiag analyze flt_trace
    • obdiag analyze parameter default
    • obdiag analyze parameter diff
    • obdiag analyze variable diff
    • obdiag analyze index_space
  • One-click Root Cause Analysis
    • Use obdiag for root cause analysis
    • disconnection
    • major_hold
    • lock_conflict
    • ddl_disk_full
    • clog_disk_full
    • log_error
    • ddl_failure
    • index_ddl_error
    • transaction_disconnection
    • transaction_execute_timeout
    • transaction_not_ending
    • transaction_other_error
    • transaction_rollback
    • transaction_wait_timeout
  • One-click Display information
    • Overview
    • Basic information of a cluster
    • Information about nodes in a cluster
    • Information about units in a cluster
    • Information about zones in a cluster
    • RootService information of a cluster
    • Information about tenants in a cluster
    • Information about events in a cluster
    • Information about locks in a cluster
    • Information about top SQL statements in a cluster
    • Information about slow SQL statements in a cluster
    • Information about tables in a cluster
    • Information about the process list of a cluster
    • Information about execution plans of an SQL statement
  • Upgrade obdiag by using add-on files
  • Upgrade and uninstall obdiag
  • Telemetry Mode
  • FAQ
  • Release Notes
    • obdiag V2.5.0
    • obdiag V2.4.0
    • obdiag V2.3.0
    • obdiag V2.2.0
    • obdiag V2.1.0
    • obdiag V2.0.0
    • obdiag V1.6.2
    • obdiag V1.6.1
    • obdiag V1.6.0
    • obdiag V1.5.2
    • obdiag V1.5.1
    • obdiag V1.5.0
    • obdiag V1.4.0
    • obdiag V1.3.0

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Diagnostic Tool
  3. V2.5.0

obdiag analyze index_space

Last Updated:2026-09-04 08:22:11

Syntax
Examples

You can run this command to analyze the space size of an existing index or an index to be created. Before you create an index, you can analyze its required space size based on the indexed column to avoid insufficient disk space.

Syntax

obdiag analyze index_space [option]

The following table describes the options.

Option
Required?
Data type
Default value
Description
--tenant_name Yes string Empty The name of the tenant.
--table_name Yes string Empty The name of the table.
--index_name No string Empty The name of the index.
--column_names No string Empty The name of the column. You can specify multiple column names separated with commas (,), for example, col1,col2,col3.

Examples

  • Analyze the space size of an existing index

    $ obdiag analyze index_space --tenant_name=test --table_name=student --index_name=name_index
    

    The output is as follows:

    analyze_index_space start ...
    start query estimated_table_data_size, please wait some minutes... ok
    +--------------------------------------------------------------------+
    |                    estimated-index-space-report                    |
    +--------------+------+-----------------------+----------------------+
    |      ip      | port | estimated_index_space | available_disk_space |
    +--------------+------+-----------------------+----------------------+
    | 10.10.10.1   | 2882 |        2.57 KB        |       55.07 GB       |
    | 10.10.10.3   | 2882 |        2.57 KB        |       55.07 GB       |
    | 10.10.10.2   | 2882 |        3.50 KB        |       54.98 GB       |
    +--------------+------+-----------------------+----------------------+
    Trace ID: 9cbf48b0-6a9f-11ef-82ec-000c2934fb31
    If you want to view detailed obdiag logs, please run: main.py display-trace 9cbf48b0-6a9f-11ef-82ec-000c2934fb31
    
  • Analyze the space size of an index to be created based on the specified indexed column

    $ obdiag analyze index_space --tenant_name=CHAT_BI --table_name=student --column_names=name
    

    The output is as follows:

    analyze_index_space start ...
    start query estimated_table_data_size, please wait some minutes... ok
    +--------------------------------------------------------------------+
    |                    estimated-index-space-report                    |
    +--------------+------+-----------------------+----------------------+
    |      ip      | port | estimated_index_space | available_disk_space |
    +--------------+------+-----------------------+----------------------+
    | 10.10.10.1   | 2882 |        2.57 KB        |       55.07 GB       |
    | 10.10.10.2   | 2882 |        3.50 KB        |       54.98 GB       |
    | 10.10.10.3   | 2882 |        2.57 KB        |       55.07 GB       |
    +--------------+------+-----------------------+----------------------+
    Trace ID: e71c5cc2-6a9f-11ef-9373-000c2934fb31
    If you want to view detailed obdiag logs, please run: main.py display-trace e71c5cc2-6a9f-11ef-9373-000c2934fb31
    

Previous topic

obdiag analyze variable diff
Last

Next topic

Use obdiag for root cause analysis
Next
on this page
Syntax
Examples