hcq/oceanbase
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Move the docs folder

Browse Source
This commit is contained in:
LINxiansheng
2022-02-10 14:51:49 +08:00
committed by LINxiansheng
parent 7c6dcc6712
commit d42f317422
1160 changed files with 0 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
docs/docs-cn/13.reference-guide/1.system-view/1.overview-4.md Normal file
View File

@ -0,0 +1,109 @@
概述
=======================
**内部表定义**
OceanBase 数据库内部表包含了以下几类：
* 核心系统表（简称核心表）
* 普通系统表
* 虚拟表
* `Information_Schema` 表
**多租户**
OceanBase 数据库为多租户架构，租户分为两种类型：普通租户以及 `sys` 租户。OceanBase 数据库系统表都存储在 `sys` 租户，且主键中存储租户号（`tenant_id`），区分每个租户的内容。每个租户内部创建一个该租户数据的只读视图。
引入多租户后，系统表格命名如下：
* 所有以 `__all `开头的表格包含所有租户的数据，所有以` __tenant` 开头的表格仅包含单个租户内部的数据。
* 虚拟表的前缀分别为 `__all_virtual `以及 `__tenant_virtual`。
例如，`__all_virtual_session_variable` 包含所有租户的 Session 变量信息，且内部实现为虚拟表；而`__tenant_virtual_session_variable` 只包含单个租户的 Session 变量信息，内部实现为虚拟表。
`s``ys` 租户和普通租户包含的系统表说明如下：
* sys 租户
* 核心表
包括 `__all_core_table`、`__all_root_table`、`__all_table`、`__all_column`、`__all_database`、 `__all_tablegroup`、`__all_tenant`、以及 `__all_ddl_operation`。
* 模式及用户权限表
除了 `__all_table`、`__all_column`，还包括` __all_part`、`__all_database`、`__all_tablegroup` 以及 `__all_user`、`__all_table_privilege`、`__all_database_privilege`。
* 分表位置信息表
分为两级，第一级为 `__all_root_table`，不可分区；第二级为 `__all_meta_table`。
所有系统表的位置信息都记录在 `__all_root_table` 中。
* 租户、Resource Pool、Unit 相关的系统表
* Zone 和服务器等部署相关的系统表
* 系统配置相关的表：`__all_sys_parameter`
* 系统变量及系统状态相关的表：`__all_sys_variable`、`__all_sys_stat`
* DDL 操作相关的表：` __all_ddl_operation`
* 其它表，例如各种统计信息以及为了实现某个功能而加入的系统表
* 普通租户
* 以 `__tenant` 作为表名前缀的只读视图，表示租户内信息
* `Information_schema`：SQL 标准定义的 `information_schema` 视图，是其它系统表的视图。

44
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/1.mysql-help_topic.md Normal file
View File

@ -0,0 +1,44 @@
mysql.help_topic
=====================================
**功能**
---------------------------
与其他三个表 mysql.help_category、mysql.help_relation、mysql.help_keyword 合作生成 help 命令。
**相关表/视图**
-------------------------------
* mysql.help_category
* mysql.help_relation
* mysql.help_keyword
字段说明
-------------------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------|----------------|----------------|--------|
| help_topic_id | bigint(20) | NO | 主题 ID |
| name | varchar(64) | NO | 主题名 |
| help_category_id | bigint(20) | NO | 类目 ID |
| description | varchar(65535) | NO | 描述 |
| example | varchar(65535) | NO | 示例 |
| url | varchar(65535) | NO | url 地址 |

30
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/10.mysql-time_zone_transition_type.md Normal file
View File

@ -0,0 +1,30 @@
mysql.time_zone_transition_type
====================================================
功能
-----------
用于记录时区转换类型（SYSTEM_VIEW）。
相关表/视图
---------------
__all_time_zone_transition_type
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------|------------|----------------|-----------|
| Time_zone_id | bigint(20) | NO | 时区 ID |
| Transition_type_id | bigint(20) | NO | 时区转换类型 ID |
| Offset | bigint(20) | NO | 时区偏移 |
| Is_DST | bigint(20) | NO | 是否为夏令时 |
| Abbreviation | varchar(8) | NO | 缩写 |

67
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/11.mysql-user.md Normal file
View File

@ -0,0 +1,67 @@
mysql.user
===============================
功能
-----------
用于记录用户级别的权限信息（VIRTUAL_TABLE）。
相关表/视图
---------------
无
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------------|---------------|----------------|---------------------------------------------------|
| host | varchar(128) | NO | 主机名 |
| user | varchar(128) | NO | 用户名 |
| password | varchar(128) | NO | 用户密码 |
| select_priv | varchar(1) | NO | 是否可执行 select 语句 |
| insert_priv | varchar(1) | NO | 是否可执行 insert 语句 |
| update_priv | varchar(1) | NO | 是否可执行 update 语句 |
| delete_priv | varchar(1) | NO | 是否可执行 delete 语句 |
| create_priv | varchar(1) | NO | 是否可执行 create 语句 |
| drop_priv | varchar(1) | NO | 是否可执行 drop 语句 |
| reload_priv | varchar(1) | NO | 是否可执行 flush 语句。目前暂未使用该字段 |
| shutdown_priv | varchar(1) | NO | 是否可执行 shutdown 命令。目前暂未使用该字段 |
| process_priv | varchar(1) | NO | 是否可查询活跃线程信息 |
| file_priv | varchar(1) | NO | 是否具有文件读写权限。目前暂未使用该字段 |
| grant_priv | varchar(1) | NO | 是否可执行授权语句 |
| reference_priv | varchar(1) | NO | 暂未使用 |
| index_priv | varchar(1) | NO | 是否可创建索引 |
| alter_priv | varchar(1) | NO | 是否可执行 alter 语句 |
| show_db_priv | varchar(1) | NO | 是否可执行 `show database `语句 |
| super_priv | varchar(1) | NO | 是否可执行超级用户语句 |
| create_tmp_table_priv | varchar(1) | NO | 是否可创建临时表（未使用） |
| lock_tables_priv | varchar(1) | NO | 是否可执行` lock tables ` 语句。目前暂未使用该字段 |
| execute_priv | varchar(1) | NO | 是否可执行存储过程。目前暂未使用该字段 |
| repl_slave_priv | varchar(1) | NO | 暂未使用 |
| repl_client_priv | varchar(1) | NO | 暂未使用 |
| create_view_priv | varchar(1) | NO | 是否可创建视图 |
| show_view_priv | varchar(1) | NO | 是否可执行 `show create view` 语句 |
| create_routine_priv | varchar(1) | NO | 是否可创建存储过程。目前暂未使用该字段 |
| alter_routine_priv | varchar(1) | NO | 是否可更改存储过程。目前暂未使用该字段 |
| create_user_priv | varchar(1) | NO | 是否可执行` create user` 语句 |
| event_priv | varchar(1) | NO | 是否可创建更改删除 event。目前暂未使用该字段 |
| trigger_priv | varchar(1) | NO | 是否具有操作 trigger 的权限。目前暂未使用该字段 |
| create_tablespace_priv | varchar(1) | NO | 是否可创建 tablespace。目前暂未使用该字段 |
| ssl_type | varchar(10) | NO | 目前暂未使用该字段 |
| ssl_cipher | varchar(1024) | NO | 目前暂未使用该字段 |
| x509_issuer | varchar(1024) | NO | 目前暂未使用该字段 |
| x509_subject | varchar(1024) | NO | 目前暂未使用该字段 |
| max_questions | bigint(20) | NO | 用户每小时可执行的最大查询数（未使用） |
| max_updates | bigint(20) | NO | 用户每小时可执行的最大更新数。目前暂未使用该字段 |
| max_connections | bigint(20) | NO | 用户每小时可接收的最大连接数。目前暂未使用该字段 |
| max_user_connections | bigint(20) | NO | 同时请求的最大连接数。目前暂未使用该字段 |
| plugin | varchar(1024) | NO | 目前暂未使用该字段 |
| authentication_string | varchar(1024) | NO | 目前暂未使用该字段 |
| password_expired | varchar(1) | NO | 用户密码是否过期。目前暂未使用该字段 |

28
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/12.information_schema-character_sets.md Normal file
View File

@ -0,0 +1,28 @@
information_schema.CHARACTER_SETS
======================================================
功能
-----------
记录 OceanBase 数据库的字符集信息。
相关表/视图
---------------
__all_charset
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------------|--------------|----------------|---------|
| CHARACTER_SET_NAME | varchar(128) | NO | 字符集名称 |
| DEFAULT_COLLATE_NAME | varchar(128) | NO | 字符集比对方法 |
| DESCRIPTION | varchar(64) | NO | 字符集描述描述 |
| MAXLEN | bigint(20) | NO | 字符集最大长度 |

31
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/13.information_schema-collations.md Normal file
View File

@ -0,0 +1,31 @@
information_schema.COLLATIONS
==================================================
功能
-----------
记录每个字符集的比对方法信息。
相关表/视图
---------------
__all_collation
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | |
|--------------------|--------------|----------------|---------------------------|
| COLLATION_NAME | varchar(128) | NO | 比对方法名称 |
| CHARACTER_SET_NAME | varchar(128) | NO | 和 collation 关联的字符集名称 |
| ID | bigint(20) | NO | collation 的 ID |
| IS_DEFAULT | varchar(4) | NO | collation 是否是对应字符集的默认比对方法 |
| IS_COMPILED | varchar(4) | NO | 字符集是否被编译到服务器中 |
| SORTLEN | bigint(20) | NO | 排序字符集需要用到的内存大小 |

21
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/14.information_schema-collation_character_set_applicability.md Normal file
View File

@ -0,0 +1,21 @@
information_schema.COLLATION_CHARACTER_SET_APPLICABILITY
=============================================================================
功能
-----------
记录 character 和 collation 之间的对应关系。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------|--------------|----------------|--------|
| COLLATION_NAME | varchar(128) | NO | 比对方法名称 |
| CHARACTER_SET_NAME | varchar(128) | NO | 字符集名称 |

58
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/15.information_schema-columns.md Normal file
View File

@ -0,0 +1,58 @@
information_schema.COLUMNS
===============================================
功能
-----------
记录列信息。
相关表/视图
---------------
* __all_column
* __all_column_statistic
* __all_column_history
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------------|---------------------|----------------|--------------------------------|
| TABLE_CATALOG | varchar(4096) | NO | 固定值（def） |
| TABLE_SCHEMA | varchar(128) | NO | Column 对应的表所属的库 |
| TABLE_NAME | varchar(128) | NO | Column 对应的表名 |
| COLUMN_NAME | varchar(128) | NO | 列名 |
| ORDINAL_POSITION | bigint(20) unsigned | NO | 列编号 |
| COLUMN_DEFAULT | varchar(262144) | YES | 列默认值 |
| IS_NULLABLE | varchar(4) | NO | 列值是否可以为 NULL |
| DATA_TYPE | varchar(64) | NO | 列中数据类型 |
| CHARACTER_MAXIMUM_LENGTH | bigint(20) unsigned | YES | 列的最大字符数 |
| CHARACTER_OCTET_LENGTH | bigint(20) unsigned | YES | 列的最大字节数 |
| NUMERIC_PRECISION | bigint(20) unsigned | YES | 数字精度 |
| NUMERIC_SCALE | bigint(20) unsigned | YES | 小数位数 |
| DATETIME_PRECISION | bigint(20) unsigned | YES | datetime 类型精度 |
| CHARACTER_SET_NAME | varchar(128) | YES | 列对应字符集名称 |
| COLLATION_NAME | varchar(128) | YES | 字符集比对方法 |
| COLUMN_TYPE | varchar(64) | NO | 字段类型 |
| COLUMN_KEY | varchar(3) | NO | 索引或者主键列 |
| EXTRA | varchar(4096) | NO | 其它信息 |
| PRIVILEGES | varchar(200) | NO | 权限信息 |
| COLUMN_COMMENT | varchar(2048) | NO | 注释 |
| GENERATION_EXPRESSION | varchar(262144) | NO | 对于生成的列，显示用于计算列值的表达式。 对于非生成列为空。 |

35
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/16.information_schema-dba_outlines.md Normal file
View File

@ -0,0 +1,35 @@
information_schema.DBA_OUTLINES
====================================================
功能
-----------
记录 outline相关信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------|------------------|----------------|-------------|
| NAME | varchar(128) | NO | Outline 名称 |
| OWNER | varchar(32) | NO | 所属用户 |
| DB_NAME | varchar(128) | NO | 数据库名称 |
| CATEGORY | null | NO | 分类 |
| USED | bigint(20) | NO | 是否使用 |
| TIMESTAMP | timestamp(6) | YES | 时间戳 |
| VERSION | varchar(256) | NO | 版本 |
| SQL_TEXT | varchar(65536) | NO | SQL 文本 |
| SIGNATURE | varbinary(65536) | NO | 标识符 |
| COMPATIBLE | bigint(20) | NO | 兼容性 |
| ENABLED | bigint(20) | NO | 是否可用 |
| FORMAT | bigint(20) | NO | 格式 |
| OUTLINE_CONTENT | varchar(65536) | NO | Outline 内容 |
| OUTLINE_TARGET | varchar(65536) | NO | 目标 SQL |
| OWNER_ID | bigint(20) | YES | 所属用户 ID |

26
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/17.information_schema-engines.md Normal file
View File

@ -0,0 +1,26 @@
information_schema.ENGINES
===============================================
功能
-----------
记录存储引擎相关信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------|---------------|----------------|-----------------|
| Engine | varchar(64) | NO | 引擎类型 |
| Support | varchar(4) | NO | 是否支持当前存储引擎 |
| Comment | varchar(2048) | NO | 注释 |
| Transactions | varchar(4) | NO | 事务相关内容 |
| XA | varchar(4) | NO | 分布式事务 XA 相关内容 |
| Savepoints | varchar(4) | NO | Savepoints 相关内容 |

22
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/18.information_schema-global_status.md Normal file
View File

@ -0,0 +1,22 @@
information_schema.GLOBAL_STATUS
=====================================================
功能
-----------
记录 OceanBase 数据库的全局状态信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|---------------|----------------|-------------|
| VARIABLE_NAME | varchar(128) | NO | 全局状态对应的变量名称 |
| VARIABLE_VALUE | varchar(1024) | YES | 全局状态对应的变量内容 |

21
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/19.information_schema-global_variables.md Normal file
View File

@ -0,0 +1,21 @@
information_schema.GLOBAL_VARIABLES
========================================================
功能
-----------
记录全局变量信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|----------------|----------------|--------|
| VARIABLE_NAME | varchar(128) | NO | 变量名 |
| VARIABLE_VALUE | varchar(65536) | YES | 变量值 |

42
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/2.mysql-help_category.md Normal file
View File

@ -0,0 +1,42 @@
mysql.help_category
========================================
**功能**
---------------------------
与其他三个表 mysql.help_relation、mysql.help_topic、mysql.help_keyword 合作生成 help 命令。
**相关表/视图**
-------------------------------
* mysql.help_relation
* mysql.help_topic
* mysql.help_keyword
**字段说明**
-----------------------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------|----------------|----------------|--------|
| help_category_id | bigint(20) | NO | 类目 ID |
| name | varchar(64) | NO | 类目名 |
| parent_category_id | bigint(20) | YES | 父类目 ID |
| url | varchar(65535) | NO | url 地址 |

46
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/20.information_schema-key_column_usage.md Normal file
View File

@ -0,0 +1,46 @@
information_schema.KEY_COLUMN_USAGE
========================================================
功能
-----------
记录 column 中 key 的约束信息。
相关表/视图
---------------
* __all_foreign_key_column
* __all_foreign_key_column_history
字段说明
-------------
| **字段名称** | **类型** | **是否可以为空** | **描述** |
|-------------------------------|--------------|------------|-----------------------------------------------------------------------------------------|
| | | | |
| CONSTRAINT_CATALOG | varchar(3) | NO | 固定值（def） |
| CONSTRAINT_SCHEMA | varchar(128) | NO | 数据库名 |
| CONSTRAINT_NAME | varchar(256) | NO | 约束名，为 PRIMARY 或列名或外键名 |
| TABLE_CATALOG | varchar(3) | NO | 表目录 |
| TABLE_SCHEMA | varchar(128) | NO | 数据库名 |
| TABLE_NAME | varchar(256) | NO | 表名 |
| COLUMN_NAME | varchar(128) | NO | 列名 |
| ORDINAL_POSITION | bigint(20) | NO | 该列在表中的编号 |
| POSITION_IN_UNIQUE_CONSTRAINT | null | NO | 对于唯一和主键约束，POSITION_IN_UNIQUE_CONSTRAINT 的值为 NULL。 对于外键约束，它是所引用表内键中的顺序位置 |
| REFERENCED_TABLE_SCHEMA | null | NO | 参考的数据库 |
| REFERENCED_TABLE_NAME | null | NO | 参考的表 |
| REFERENCED_COLUMN_NAME | null | NO | 参考的列 |

35
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/21.information_schema-parameters.md Normal file
View File

@ -0,0 +1,35 @@
information_schema.PARAMETERS
==================================================
功能
-----------
提供存储过程参数和返回值相关信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------------|----------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| SPECIFIC_CATALOG | VARCHAR(4096) | NO | 固定值（def） |
| SPECIFIC_SCHEMA | VARCHAR(128) | NO | 数据库名 |
| SPECIFIC_NAME | VARCHAR(128) | NO | 存储过程名 |
| ORDINAL_POSITION | BIGINT(20) | NO | 参数位置（对于函数的返回值该值是 0） |
| PARAMETER_MODE | VARCHAR(128) | YES | 参数类型： * IN * OUT * INOUT * NULL |
| PARAMETER_NAME | VARCHAR(262144) | YES | 参数名 |
| DATA_TYPE | VARCHAR(128) | NO | 参数数据类型 |
| CHARACTER_MAXIMUM_LENGTH | BIGINT(20) UNSIGNED | YES | 对于 String 类型的参数，记录字符最大长度 |
| CHARACTER_OCTET_LENGTH | BIGINT(20) UNSIGNED | YES | 对于 String 类型的参数，记录字节的最大长度 |
| NUMERIC_PRECISION | BIGINT(20) UNSIGNED | YES | 对于数值类型的参数，记录 Precision |
| NUMERIC_SCALE | BIGINT(20) UNSIGNED | YES | 对于数值类型的参数，记录 Scale |
| DATETIME_PRECISION | BIGINT(20) UNSIGNED | YES | 对于日期类型，记录日期类型的精度 |
| CHARACTER_SET_NAME | VARCHAR(128) | YES | 对于 String 类型的参数，记录字符集 |
| COLLATION_NAME | VARCHAR(128) | YES | 对于 String 类型的参数，记录字符排序规则 |
| DTD_IDENTIFIER | VARCHAR(128) | NO | 字符形式记录数据类型的详细信息 |
| ROUTINE_TYPE | VARCHAR(9) | NO | 存储过程的类型（过程/函数） |

58
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/22.information_schema-partitions.md Normal file
View File

@ -0,0 +1,58 @@
information_schema.PARTITIONS
==================================================
功能
-----------
记录 partition 信息。
相关表/视图
---------------
* gv$partition
* v$partition
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------------------------|---------------------|----------------|-------------------------|
| TABLE_CATALOG | varchar(4096) | NO | 固定值（def） |
| TABLE_SCHEMA | varchar(128) | NO | 数据库名 |
| TABLE_NAME | varchar(256) | NO | 表名 |
| PARTITION_NAME | varchar(64) | YES | 分区名 |
| SUBPARTITION_NAME | varchar(64) | YES | 子分区名 |
| PARTITION_ORDINAL_POSITION | bigint(20) unsigned | YES | 当前分区在所有分区中的位置 |
| SUBPARTITION_ORDINAL_POSITION | bigint(20) unsigned | YES | 当前子分区在所有子分区中的位置 |
| PARTITION_METHOD | varchar(18) | YES | 分区类型 |
| SUBPARTITION_METHOD | varchar(18) | YES | 子分区类型 |
| PARTITION_EXPRESSION | varchar(4096) | YES | 分区函数表达式 |
| SUBPARTITION_EXPRESSION | varchar(4096) | YES | 子分区函数表达式 |
| PARTITION_DESCRIPTION | varchar(1024) | YES | 适用于 range 和 list 分区的描述 |
| TABLE_ROWS | bigint(20) unsigned | NO | 目前暂不支持该字段，当前该字段默认为 0 |
| AVG_ROW_LENGTH | bigint(20) unsigned | NO | 目前暂不支持该字段，当前该字段默认为 0 |
| DATA_LENGTH | bigint(20) unsigned | NO | 目前暂不支持该字段，当前该字段默认为 0 |
| MAX_DATA_LENGTH | bigint(20) unsigned | YES | 目前暂不支持该字段，当前该字段默认为 0 |
| INDEX_LENGTH | bigint(20) unsigned | NO | 目前暂不支持该字段，当前该字段默认为 0 |
| DATA_FREE | bigint(20) unsigned | NO | 目前暂不支持该字段，当前该字段默认为 0 |
| CREATE_TIME | timestamp(6) | YES | 目前暂不支持该字段，当前该字段默认为 NULL |
| UPDATE_TIME | timestamp(6) | YES | 目前暂不支持该字段，当前该字段默认为 NULL |
| CHECK_TIME | timestamp(6) | YES | 目前暂不支持该字段，当前该字段默认为 NULL |
| CHECKSUM | bigint(20) | YES | 目前暂不支持该字段，当前该字段默认为 NULL |
| PARTITION_COMMENT | varchar(1024) | NO | 分区注释 |
| NODEGROUP | varchar(12) | NO | 分区所属的 nodegroup |
| TABLESPACE_NAME | varchar(128) | YES | 分区所属的 tablespace 名称 |

27
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/23.information_schema-processlist.md Normal file
View File

@ -0,0 +1,27 @@
information_schema.PROCESSLIST
===================================================
功能
-----------
提供运行中的线程信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------|---------------------|----------------|--------------|
| ID | bigint(20) unsigned | NO | 连接标识符 |
| USER | varchar(32) | NO | 用户名 |
| HOST | varchar(128) | NO | 客户端主机名称 |
| DB | varchar(128) | YES | 数据库名称 |
| COMMAND | varchar(4096) | NO | 线程执行的命令类型 |
| TIME | bigint(20) | NO | 线程在当前状态的持续时间 |
| STATE | varchar(128) | YES | 表示线程正在做的任务标识 |
| INFO | varchar(262143) | YES | 当前线程正在执行的语句 |

31
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/24.information_schema-referential_constraints.md Normal file
View File

@ -0,0 +1,31 @@
information_schema.REFERENTIAL_CONSTRAINTS
===============================================================
功能
-----------
用于展示外键约束的元数据。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------------------|-----------------------------------------|----------------|--------------------------------------------------------------|
| CONSTRAINT_CATALOG | varchar(4096) | NO | 该值始终为 def |
| CONSTRAINT_SCHEMA | varchar(128) | NO | 约束所属库的名称 |
| CONSTRAINT_NAME | varchar(128) | NO | 约束名称 |
| UNIQUE_CONSTRAINT_CATALOG | varchar(4096) | NO | 该值始终为 def |
| UNIQUE_CONSTRAINT_SCHEMA | ``` varchar(128) ``` | NO | 约束引用的唯一约束或主键所在库的名称 |
| UNIQUE_CONSTRAINT_NAME | varchar(128) | YES | 约束引用的唯一约束或主键的名称 |
| MATCH_OPTION | varchar(64) | NO | 约束 MATCH 属性的值。 此时唯一有效的值是 NONE |
| UPDATE_RULE | varchar(64) | NO | 约束 ON UPDATE 属性的值。 可能的值是CASCADE、SET NULL、RESTRICT、NO ACTION |
| DELETE_RULE | varchar(64) | NO | 约束 ON DELETE 属性的值。 可能的值是 CASCADE、SET NULL、RESTRICT、NO ACTION |
| TABLE_NAME | varchar(256) | NO | 约束所在子表的名称 |
| REFERENCED_TABLE_NAME | varchar(256) | NO | 约束所引用父表的名称 |

51
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/25.information_schema-routines.md Normal file
View File

@ -0,0 +1,51 @@
information_schema.ROUTINES
================================================
功能
-----------
提供存储过程相关的信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------------|------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| SPECIFIC_NAME | varchar(64) | NO | 存储过程的名称。 |
| ROUTINE_CATALOG | varchar(3) | NO | 存储过程所属的目录的名称。目前该字段暂未使用，当前值为 def。 |
| ROUTINE_SCHEMA | varchar(128) | NO | 存储过程所属的模式的名称。 |
| ROUTINE_NAME | varchar(128) | NO | 存储过程名称，与 SPECIFIC_NAME 相同。 |
| ROUTINE_TYPE | varchar(10) | NO | 过程类型： * PROCEDURE：用于存储过程 * FUNCTION：用于存储函数 |
| DATA_TYPE | varchar(0) | NO | 如果过程是存储函数，则返回值为数据类型；如果过程为存储过程，则该值为空。 目前该字段暂未使用。 |
| CHARACTER_MAXIMUM_LENGTH | null | NO | 存储函数的字符串返回值的最大长度，以字符为单位。 如果过程为存储过程，则该值为 NULL。 目前该字段暂未使用。 |
| CHARACTER_OCTET_LENGTH | null | NO | 存储函数的字符串返回值的最大长度，单位：字节。 如果过程为存储过程，则该值为 NULL 目前该字段暂未使用。 |
| NUMERIC_PRECISION | null | NO | 存储函数的数字返回值的数字精度。 如果过程为存储过程，则该值为 NULL。 目前该字段暂未使用。 |
| NUMERIC_SCALE | null | NO | 存储函数的数字返回值的数字刻度。 如果过程为存储过程，则该值为 NULL。 目前该字段暂未使用。 |
| DATETIME_PRECISION | null | NO | 存储函数的时间返回值的秒精度。 如果过程为存储过程，则该值为 NULL。 目前该字段暂未使用。 |
| CHARACTER_SET_NAME | null | NO | 存储函数的字符串返回值的字符集名称。如果过程为存储过程，则该值为 NULL。 目前该字段暂未使用 |
| COLLATION_NAME | null | NO | 存储函数的字符串返回值的归类名称。 如果例程为存储过程，则该值为 NULL。 目前该字段暂未使用。 |
| DTD_IDENTIFIER | null | NO | 未使用。如果过程是存储函数，则返回值为数据类型。如果过程是存储过程，则此值为空。 `DATA_TYPE` 值仅为类型名称，无其他信息；而 `DTD_IDENTIFIER` 值包含类型名称以及可能的其他信息，例如精度或长度。 |
| ROUTINE_BODY | varchar(3) | NO | 过程定义所使用的语言。此值始终为 SQL。 |
| ROUTINE_DEFINITION | varchar(1048576) | NO | 存储过程定义的文本信息。 |
| EXTERNAL_NAME | null | NO | 此值始终为 NULL。 |
| EXTERNAL_LANGUAGE | null | NO | 存储过程的语言。目前该字段暂未使用。 |
| PARAMETER_STYLE | varchar(3) | NO | 此值始终为 SQL。 |
| IS_DETERMINISTIC | varchar(4) | NO | YES 或 NO，取决于存储过程是否用 `DETERMINISTIC` 特性定义 。目前该字段暂未使用。 |
| SQL_DATA_ACCESS | varchar(32) | NO | 未使用。存储过程的数据访问特征。 |
| SQL_PATH | null | NO | 此值始终为 NULL |
| SECURITY_TYPE | varchar(10) | NO | SQL 安全类型： * DEFINER * INVOKER 目前该字段暂未使用。 |
| CREATED | timestamp(6) | NO | 创建存储过程的日期和时间。 |
| LAST_ALTERED | timestamp(6) | NO | 存储过程的最后修改日期和时间。 如果过程自创建以来尚未修改，则该值与 `CREATED`值相同。 |
| SQL_MODE | varchar(32) | NO | 创建或更改过程时有效的 SQL 模式，在该模式下执行过程。 |
| ROUTINE_COMMENT | varchar(1048576) | NO | 注释文本 |
| DEFINER | varchar(77) | NO | 在 DEFINER 子句中命名的帐户（通常是创建过程的用户）。 |
| CHARACTER_SET_CLIENT | varchar(128) | NO | 创建或更改存储过程时系统变量 `CHARACTER_SET_CLIENT` 的会话值。 |
| COLLATION_CONNECTION | varchar(128) | NO | 创建或更改存储过程时系统变量 `COLLATION_CONNECTION` 的会话值。 |
| DATABASE_COLLATION | varchar(128) | NO | 创建或更改存储过程时系统变量 `DATABASE_COLLATION `的会话值。 |

24
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/26.information_schema-schemata.md Normal file
View File

@ -0,0 +1,24 @@
information_schema.SCHEMATA
================================================
功能
-----------
记录数据库元信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------------------|--------------|----------------|---------|
| CATALOG_NAME | varchar(3) | NO | 固定值 def |
| SCHEMA_NAME | varchar(128) | NO | 数据库名 |
| DEFAULT_CHARACTER_SET_NAME | varchar(7) | NO | 默认字符集 |
| DEFAULT_COLLATION_NAME | varchar(18) | NO | 默认比对规则 |
| SQL_PATH | null | NO | NULL |

24
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/27.information_schema-schema_privileges.md Normal file
View File

@ -0,0 +1,24 @@
information_schema.SCHEMA_PRIVILEGES
=========================================================
功能
-----------
描述数据库权限信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|---------------|----------------|----------|
| GRANTEE | varchar(81) | NO | 权限描述 |
| TABLE_CATALOG | varchar(4096) | NO | 固定值（def） |
| TABLE_SCHEMA | varchar(128) | NO | 数据库名 |
| PRIVILEGE_TYPE | varchar(64) | NO | 权限类型 |
| IS_GRANTABLE | varchar(3) | NO | 是否授权 |

22
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/28.information_schema-session_status.md Normal file
View File

@ -0,0 +1,22 @@
information_schema.SESSION_STATUS
======================================================
功能
-----------
记录 Session 的状态信息，如当前活跃连接数，数据库活跃时间（Uptime）等。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|---------------|----------------|-------------|
| VARIABLE_NAME | varchar(128) | NO | Session 状态名 |
| VARIABLE_VALUE | varchar(1024) | YES | Session 状态值 |

24
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/29.information_schema-session_variables.md Normal file
View File

@ -0,0 +1,24 @@
information_schema.SESSION_VARIABLES
=========================================================
功能
-----------
记录 session 的变量信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|---------------|----------------|-------------|
| VARIABLE_NAME | varchar(128) | NO | Session 变量名 |
| VARIABLE_VALUE | varchar(1024) | YES | Session 变量值 |

39
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/3.mysql-help_keyword.md Normal file
View File

@ -0,0 +1,39 @@
mysql.help_keyword
=======================================
**功能**
---------------------------
与其他三个表 mysql.help_relation、mysql.help_topic、mysql.help_category 合作生成 help 命令。
**相关表/视图**
-------------------------------
* mysql.help_relation
* mysql.help_topic
* mysql.help_category
**字段说明**
-----------------------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------|-------------|----------------|--------|
| help_keyword_id | bigint(20) | NO | 关键词 ID |
| name | varchar(64) | NO | 关键词 |

36
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/30.information_schema-statistics.md Normal file
View File

@ -0,0 +1,36 @@
information_schema.STATISTICS
==================================================
功能
-----------
记录表索引信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------|---------------|----------------|-----------------------------------------------|
| TABLE_CATALOG | varchar(3) | NO | 固定值（def） |
| TABLE_SCHEMA | varchar(128) | NO | 数据库名 |
| TABLE_NAME | varchar(128) | NO | 表名 |
| NON_UNIQUE | bigint(20) | NO | 是否是唯一索引 |
| INDEX_SCHEMA | varchar(128) | NO | 数据库名 |
| INDEX_NAME | varchar(128) | NO | 索引类型 |
| SEQ_IN_INDEX | bigint(20) | NO | 索引编号 |
| COLUMN_NAME | varchar(128) | NO | 列名 |
| COLLATION | varchar(128) | YES | 比对方法 |
| CARDINALITY | bigint(20) | YES | 索引中唯一值的数目估计值 |
| SUB_PART | varchar(256) | YES | 如果列只是被部分地编入索引，则为被编入索引的字符的数目。如果整列被编入索引，则为 NULL |
| PACKED | varchar(256) | YES | 指示关键字如何被压缩 |
| NULLABLE | varchar(128) | NO | 是否可以为 NULL |
| INDEX_TYPE | varchar(128) | NO | 索引使用的数据结构类型 |
| COMMENT | varchar(4096) | YES | 注释 |
| INDEX_COMMENT | varchar(4096) | NO | 索引注释 |
| IS_VISIBLE | varchar(3) | NO | 索引是否可见 |

55
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/31.information_schema-tables.md Normal file
View File

@ -0,0 +1,55 @@
information_schema.TABLES
==============================================
功能
-----------
记录表的信息。
相关表/视图
---------------
* __all_table
* __all_table_history
字段说明
-------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|-----------------|--------------------|------------|-----------|
| TABLE_CATALOG | varchar(3) | NO | 表目录 |
| TABLE_SCHEMA | varchar(128) | NO | 数据库名称 |
| TABLE_NAME | varchar(256) | NO | 表名 |
| TABLE_TYPE | varchar(12) | NO | 表类型 |
| ENGINE | null | NO | 使用的存储引擎类型 |
| VERSION | null | NO | 版本 |
| ROW_FORMAT | null | NO | 行格式 |
| TABLE_ROWS | decimal(20,0) | NO | 表的行数 |
| AVG_ROW_LENGTH | decimal(24,4) | NO | 平均行长度 |
| DATA_LENGTH | decimal(20,0) | NO | 数据长度 |
| MAX_DATA_LENGTH | null | NO | 最大数据长度 |
| INDEX_LENGTH | null | NO | 索引长度 |
| DATA_FREE | null | NO | 剩余空间大小 |
| AUTO_INCREMENT | null | NO | 当前的自增值 |
| CREATE_TIME | timestamp(6) | NO | 表的创建时间 |
| UPDATE_TIME | timestamp(6) | NO | 表的最近更新时间 |
| CHECK_TIME | null | NO | 表的最近检查时间 |
| TABLE_COLLATION | varchar(128) | NO | 表的字符集比对方法 |
| CHECKSUM | bigint(0) unsigned | NO | 校验和 |
| CREATE_OPTIONS | null | NO | 创建选项 |
| TABLE_COMMENT | varchar(4096) | NO | 表的备注 |

26
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/32.information_schema-table_constraints.md Normal file
View File

@ -0,0 +1,26 @@
information_schema.TABLE_CONSTRAINTS
=========================================================
功能
-----------
描述表约束信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------|---------------|----------------|--------|
| CONSTRAINT_CATALOG | varchar(4096) | NO | 约束目录 |
| CONSTRAINT_SCHEMA | varchar(128) | NO | 数据库名 |
| CONSTRAINT_NAME | varchar(128) | NO | 约束名称 |
| TABLE_SCHEMA | varchar(128) | NO | 数据库名 |
| TABLE_NAME | varchar(256) | NO | 表名 |
| CONSTRAINT_TYPE | varchar(128) | NO | 约束类型 |

39
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/33.information_schema-table_privileges.md Normal file
View File

@ -0,0 +1,39 @@
information_schema.TABLE_PRIVILEGES
========================================================
功能
-----------
记录表权限信息。
相关表/视图
---------------
* __all_table_privilege
* __all_table_privilege_history
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|---------------|----------------|--------|
| GRANTEE | varchar(81) | NO | 权限描述 |
| TABLE_CATALOG | varchar(4096) | NO | 表目录 |
| TABLE_SCHEMA | varchar(128) | NO | 数据库名 |
| TABLE_NAME | varchar(64) | NO | 表名 |
| PRIVILEGE_TYPE | varchar(64) | NO | 权限类型 |
| IS_GRANTABLE | varchar(3) | NO | 是否授权 |

26
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/34.information_schema-user_privileges.md Normal file
View File

@ -0,0 +1,26 @@
information_schema.USER_PRIVILEGES
=======================================================
功能
-----------
记录用户权限信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|---------------|----------------|--------|
| GRANTEE | varchar(81) | NO | 权限描述 |
| TABLE_CATALOG | varchar(4096) | NO | 表目录 |
| PRIVILEGE_TYPE | varchar(64) | NO | 权限类型 |
| IS_GRANTABLE | varchar(3) | NO | 是否授权 |

29
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/35.information_schema-user_recyclebin.md Normal file
View File

@ -0,0 +1,29 @@
information_schema.USER_RECYCLEBIN
=======================================================
功能
-----------
记录回收站信息。
相关表/视图
---------------
__all_recyclebin
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------|--------------|----------------|------------------|
| OBJECT_NAME | varchar(128) | NO | Object 名称 |
| ORIGINAL_NAME | varchar(256) | NO | Object 对应对象的原始名称 |
| TYPE | varchar(8) | NO | Object 类型 |
| CREATETIME | timestamp(6) | NO | 创建时间 |

29
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/36.information_schema-views.md Normal file
View File

@ -0,0 +1,29 @@
information_schema.VIEWS
=============================================
功能
-----------
记录视图信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为空** | **描述** |
|----------------------|----------------|------------|---------------------------------------------|
| TABLE_CATALOG | varchar(3) | NO | 表目录 |
| TABLE_SCHEMA | varchar(128) | NO | 数据库名称 |
| TABLE_NAME | varchar(256) | NO | 表名称 |
| VIEW_DEFINITION | varchar(65536) | NO | 视图定义 |
| CHECK_OPTION | varchar(4) | NO | 检查选项 |
| IS_UPDATABLE | varchar(3) | NO | 是否可更新 |
| DEFINER | varchar(130) | NO | 创建视图的用户名 |
| SECURITY_TYPE | varchar(4) | NO | 安全类型 |
| CHARACTER_SET_CLIENT | varchar(7) | NO | 视图创建时对应的 Session 变量 character_set_client 的值 |
| COLLATION_CONNECTION | varchar(18) | NO | 视图创建时对应的 session 变量 collation_connection 的值 |

31
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/37.oceanbase-cdb_ob_backup_archivelog_summary.md Normal file
View File

@ -0,0 +1,31 @@
oceanbase.CDB_OB_BACKUP_ARCHIVELOG_SUMMARY
===============================================================
功能
-----------
展示日志备份任务信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------------|---------------|----------------|---------------------------------|
| INCARNATION | bigint(20) | NO | 数据库的分身编号。 |
| LOG_ARCHIVE_ROUND | bigint(20) | NO | 用于标识第几轮完整的 clog 备份数据流 |
| TENANT_ID | bigint(20) | NO | 租户 id |
| STATUS | varchar(64) | NO | 备份任务的状态 |
| MIN_FIRST_TIME | timestamp(6) | NO | 起始的 logts |
| MAX_NEXT_TIME | timestamp(6) | NO | 目前已经备份最大的 log 的时间戳。 |
| INPUT_BYTES | bigint(20) | NO | 读取的数据量 |
| OUTPUT_BYTES | bigint(20) | NO | 输出的数据量 |
| COMPRESSION_RATIO | decimal(23,2) | NO | 压缩率 |
| INPUT_BYTES_DISPLAY | varchar(27) | NO | 带单位的读取数据量，例如：798.01 M 或 5.25 G。 |
| OUTPUT_BYTES_DISPLAY | varchar(27) | NO | 带单位的输出数据量，例如：798.01 M 或 5.25 G。 |

40
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/38.oceanbase-cdb_ob_backup_job_details.md Normal file
View File

@ -0,0 +1,40 @@
oceanbase.CDB_OB_BACKUP_JOB_DETAILS
========================================================
功能
-----------
展示备份任务的详细信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------------------|---------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| INCARNATION | bigint(20) | NO | 数据库的分身编号。 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| BS_KEY | bigint(20) | NO | 备份集 ID |
| BACKUP_TYPE | VARCHAR（1） | NO | * D：表示全量备份 * I：表示增量备份 |
| ENCRYPTION_MODE | varchar(64) | NO | * None：表示不加密 * Password：表示只使用密码保护 * Password encryption：表示加密，并且通过密码保护. * Transparent encryption：表示加使用了tde 加密 * Dual mode encryption：表示通过tde加密，并且通过密码保护 当前版本仅支持 None 和 Password |
| START_TIME | timestamp(6) | NO | 起始时间 |
| END_TIME | timestamp(6) | NO | 结束时间 |
| INPUT_BYTES | bigint(20) | NO | 输入字节数 |
| OUTPUT_BYTES | bigint(20) | NO | 输出字节数 |
| OUTPUT_DEVICE_TYPE | varchar(64) | NO | 备份的介质 |
| ELAPSED_SECONDS | decimal(21,0) | NO | 耗时 |
| COMPRESSION_RATIO | decimal(23,2) | NO | 压缩率 |
| INPUT_BYTES_PER_SEC | decimal(34,4) | NO | 每秒输入字节数 |
| OUTPUT_BYTES_PER_SEC | decimal(34,4) | NO | 每秒输出字节数 |
| STATUS | varchar(9) | NO | 备份的状态： * RUNNING * COMPLETED * FAILED |
| INPUT_BYTES_DISPLAY | varchar(27) | NO | 输入字节数 |
| OUTPUT_BYTES_DISPLAY | varchar(27) | NO | 输出字节数 |
| INPUT_BYTES_PER_SEC_DISPLAY | varchar(39) | NO | 每秒输入速度 |
| OUTPUT_BYTES_PER_SEC_DISPLAY | varchar(39) | NO | 每秒输出速度 |
| TIME_TAKEN_DISPLAY | time(6) | NO | 耗时 hh:mm:ss |

39
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/39.oceanbase-cdb_ob_backup_set_details.md Normal file
View File

@ -0,0 +1,39 @@
oceanbase.CDB_OB_BACKUP_SET_DETAILS
========================================================
功能
-----------
展示备份集的详细信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------------------|---------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| INCARNATION | bigint(20) | NO | 数据库的分身编号。 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| BS_KEY | bigint(20) | NO | 备份集 ID |
| BACKUP_TYPE | varchar(1) | NO | * D：表示全量备份 * I：表示增量备份 |
| ENCRYPTION_MODE | varchar(64) | NO | * None：表示不加密 * Password：表示只使用密码保护 * Password encryption：表示加密，并且通过密码保护. * Transparent encryption：表示加使用了tde 加密 * Dual mode encryption：表示通过tde加密，并且通过密码保护 当前版本仅支持 None 和 Password |
| START_TIME | timestamp(6) | NO | 起始时间 |
| COMPLETION_TIME | timestamp(6) | NO | 完成时间 |
| ELAPSED_SECONDES | decimal(21,0) | NO | 耗时 |
| KEEP | varchar(2) | NO | * YES：表示永久保留 * NO：表示根据保留时间过期 |
| KEEP_UNTIL | varchar(0) | NO | 保留的时间 |
| DEVICE_TYPE | varchar(64) | NO | 备份介质 |
| COMPRESSED | varchar(2) | NO | 是否压缩： * YES：表示压缩 * NO：表示不压缩 |
| OUTPUT_BYTES | bigint(20) | NO | 输出字节数 |
| OUTPUT_RATE_BYTES | decimal(34,4) | NO | 每秒输出字节数 |
| COMPRESSION_RATIO | decimal(23,2) | NO | 压缩率 |
| OUTPUT_BYTES_DISPLAY | varchar(27) | NO | 带单位的输出数据量，例如：798.01 M 或5.25 G。 |
| OUTPUT_RATE_BYTES_DISPLAY | varchar(39) | NO | 输出速度 |
| TIME_TAKEN_DISPLAY | time(6) | NO | 耗时 hh:mm:ss |
| STATUS | varchar(64) | NO | * COMPELETED：表示 backup_set 备份成功 * FAILED：表示 backup_set 备份失败 * DELETING：表示 backup_set 正在清理 |

40
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/4.mysql-help_relation.md Normal file
View File

@ -0,0 +1,40 @@
mysql.help_relation
========================================
功能
-----------
与其他三个表 mysql.help_category、mysql.help_topic、mysql.help_keyword 合作生成 help 命令。
相关表/视图
---------------
* mysql.help_category
* mysql.help_topic
* mysql.help_keyword
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------|------------|----------------|--------|
| help_topic_id | bigint(20) | NO | 主题 ID |
| help_keyword_id | bigint(20) | NO | 关键词 ID |

33
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/40.oceanbase-cdb_ob_backup_progress.md Normal file
View File

@ -0,0 +1,33 @@
oceanbase.CDB_OB_BACKUP_PROGRESS
=====================================================
功能
-----------
展示数据库备份任务的进度。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------------|--------------|----------------|---------------------------------------------------------------------------------------------------------------|
| INCARNATION | bigint(20) | NO | 数据库的分身编号 |
| BS_KEY | bigint(20) | NO | 备份集的 ID |
| BACKUP_TYPE | VARCHAR（1） | NO | * D：表示全量备份 * I：表示增量备份 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| PARTITION_COUNT | bigint(20) | YES | Partition Group 的个数 |
| MACRO_BLOCK_COUNT | bigint(20) | NO | 宏块的个数 |
| FINISH_PARTITION_COUNT | bigint(20) | YES | 完成的 Partition Group 的个数 |
| FINISH_MACRO_BLOCK_COUNT | bigint(20) | NO | 完成的宏块个数 |
| INPUT_BYTES | bigint(20) | NO | 输入字节数 |
| OUTPUT_BYTES | bigint(20) | NO | 输出字节数 |
| START_TIME | timestamp(6) | NO | 起始时间 |
| COMPLETION_TIME | timestamp(6) | NO | 完成时间 |
| STATUS | varchar(9) | NO | 备份任务的状态 |

38
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/41.oceanbase-cdb_ob_backup_set_expired.md Normal file
View File

@ -0,0 +1,38 @@
oceanbase.CDB_OB_BACKUP_SET_EXPIRED
========================================================
功能
-----------
用于展示哪些备份集的数据已过期。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------------------|---------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| INCARNATION | bigint(20) | NO | 数据库的分身编号。 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| BS_KEY | bigint(20) | NO | 备份集 ID |
| BACKUP_TYPE | varchar(1) | NO | * D：表示全量备份 * I：表示增量备份 |
| ENCRYPTION_MODE | varchar(64) | NO | * None：表示不加密 * Password：表示只使用密码保护 * Password encryption：表示加密，并且通过密码保护. * Transparent encryption：表示加使用了tde 加密 * Dual mode encryption：表示通过tde加密，并且通过密码保护 当前版本仅支持 None 和 Password |
| START_TIME | timestamp(6) | NO | 起始时间 |
| COMPLETION_TIME | timestamp(6) | NO | 完成时间 |
| ELAPSED_SECONDES | decimal(21,0) | NO | 耗时 |
| KEEP | varchar(2) | NO | * YES：表示永久保留 * NO：表示根据保留时间过期 |
| KEEP_UNTIL | varchar(0) | NO | 保留的时间 |
| DEVICE_TYPE | varchar(64) | NO | 备份介质 |
| COMPRESSED | varchar(2) | NO | 是否压缩： * YES：表示压缩 * NO：表示不压缩 |
| OUTPUT_BYTES | bigint(20) | NO | 输出字节数 |
| OUTPUT_RATE_BYTES | decimal(34,4) | NO | 每秒输出字节数 |
| COMPRESSION_RATIO | decimal(23,2) | NO | 压缩率 |
| OUTPUT_BYTES_DISPLAY | varchar(27) | NO | 带单位的输出数据量，例如：798.01 M 或5.25 G。 |
| OUTPUT_RATE_BYTES_DISPLAY | varchar(39) | NO | 输出速度 |
| TIME_TAKEN_DISPLAY | timestamp(6) | NO | 耗时 hh:mm:ss |

30
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/42.oceanbase-cdb_ob_backup_archivelog_progress.md Normal file
View File

@ -0,0 +1,30 @@
oceanbase.CDB_OB_BACKUP_ARCHIVELOG_PROGRESS
================================================================
功能
-----------
展示单个 Partition Group 的备份进度信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------------|--------------|----------------|-----------------------|
| INCARNATION | bigint(20) | NO | 数据库的分身编号。 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| LOG_ARCHIVE_ROUND | bigint(20) | NO | 用于标识第几轮完整的 clog 备份数据流 |
| SVR_IP | varchar(32) | NO | 服务器 IP |
| SVR_PORT | bigint(20) | NO | 服务器端口号 |
| TABLE_ID | bigint(20) | NO | 表 ID |
| PARTITION_ID | bigint(20) | NO | 分区 ID |
| MIN_FIRST_TIME | timestamp(6) | NO | 起始的 logts |
| MAX_NEXT_TIME | timestamp(6) | NO | 目前已经备份最大的 logts |
| STATUS | varchar(11) | NO | 备份任务的状态 |

29
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/43.oceanbase-cdb_ob_backup_clean_history.md Normal file
View File

@ -0,0 +1,29 @@
oceanbase.CDB_OB_BACKUP_CLEAN_HISTORY
==========================================================
功能
-----------
租户级别备份数据清理的历史信息表。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------|---------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| BS_KEY | bigint(20) | NO | 备份集的 ID |
| START_TIME | timestamp(6) | NO | 开始恢复时间 |
| END_TIME | timestamp(6) | NO | 结束恢复时间 |
| INCARNATION | bigint(20) | NO | 数据库的分身编号。 |
| TYPE | varchar(64) | NO | 表示清理的类型：过期清理或指定 backup_set |
| STATUS | varchar(64) | NO | 备份清理的状态类型： * STOP * PREPARE * DOING |
| PARAMETER | varchar(256) | NO | 根据不同的 Type 表示不同的含义。 如果是过期清理，则 parameters 表示过期的时间；如果是 backup_set 清理，则表示 backup_set_id |
| ERROR_MSG | varchar(512) | NO | 错误信息 |
| COMMENT | varchar(4096) | NO | 记录一些清理相关信息 |

33
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/44.oceanbase-cdb_ob_backup_task_clean_history.md Normal file
View File

@ -0,0 +1,33 @@
oceanbase.CDB_OB_BACKUP_TASK_CLEAN_HISTORY
===============================================================
功能
-----------
用于记录被清理掉的备份信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------------|--------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| INCARNATION | bigint(20) | NO | 数据库的分身编号。 |
| BS_KEY | bigint(20) | NO | 备份集 ID |
| BACKUP_TYPE | varchar(1) | NO | * D：表示全量备份 * I：表示增量备份 |
| PARTITION_COUNT | bigint(20) | NO | Partition Group 的个数 |
| MACRO_BLOCK_COUNT | bigint(20) | NO | 宏块的个数 |
| FINISH_PARTITION_COUNT | bigint(20) | NO | 完成的 Partition Group 的个数 |
| FINISH_MACRO_BLOCK_COUNT | bigint(20) | NO | 完成的宏块个数 |
| INPUT_BYTES | bigint(20) | NO | 输入字节数 |
| OUTPUT_BYTES | bigint(20) | NO | 输出字节数 |
| START_TIME | timestamp(6) | NO | 起始时间 |
| COMPLETION_TIME | timestamp(6) | NO | 完成时间 |
| STATUS | varchar(64) | NO | 备份清理的状态： * SUCCESS * FAILED |

38
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/45.oceanbase-cdb_ob_restore_progress.md Normal file
View File

@ -0,0 +1,38 @@
oceanbase.CDB_OB_RESTORE_PROGRESS
======================================================
功能
-----------
展示物理恢复任务当前的执行进度。
字段说明
-------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|---------------------------|---------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| JOB_ID | bigint(20) | NO | 物理恢复任务唯一标识 |
| EXTERNAL_JOB_ID | bigint(20) | NO | 物理恢复任务外部标识，不保证唯一性；在恢复命令中传入，缺省为 -1 |
| TENANT_ID | bigint(20) | NO | 当前恢复的租户 ID，缺省值 -1 |
| TENANT_NAME | varchar(128) | NO | 当前恢复的租户名，缺省值为空 |
| BACKUP_TENANT_ID | bigint(20) | NO | 原备份的租户 ID |
| BACKUP_TENANT_NAME | varchar(128) | NO | 原备份的租户名 |
| BACKUP_CLUSTER_ID | bigint(20) | NO | 原备份的集群 ID |
| BACKUP_CLUSTER_NAME | varchar(128) | NO | 原备份的集群名 |
| STATUS | varchar(64) | NO | 物理恢复所处阶段： * CREATE_TENANT：创建租户阶段 * RESTORE_SYS_REPLICA：租户系统表恢复阶段 * MODIFY_SCHEMA：租户元信息修正阶段 * CREATE_USER_PARTITIONS：租户用户表创建阶段 * RESTORE_USER_REPLICA：租户用户表恢复阶段 * REBUILD_INDEX：索引重建阶段 * POST_CHECK：校验阶段 * RESTORE_SUCCESS：恢复成功 * RESTORE_FAIL：恢复失败 |
| START_TIME | timestamp(6) | YES | 恢复开始时间 |
| COMPLETION_TIME | timestamp(6) | YES | 恢复完成时间 |
| PARTITION_COUNT | bigint(20) | NO | * RESTORE_SYS_REPLICA 阶段：待恢复系统表分区数 * RESTORE_USER_REPLICA 阶段：待恢复用户表分区数 * 其余阶段无意义，缺省值为 0 |
| MACRO_BLOCK_COUNT | bigint(20) | NO | 待恢复宏块个数，暂未实现，该值无意义 |
| FINISH_PARTITION_COUNT | bigint(20) | NO | * RESTORE_SYS_REPLICA 阶段：已完成基线恢复的系统表分区数 * RESTORE_USER_REPLICA 阶段：已完成基线恢复的用户表分区数 * 其余阶段无意义，缺省值为 0 |
| FINISH_MACRO_BLOCK_COUNT | bigint(20) | NO | 已恢复宏块个数，暂未实现，该值无意义，缺省值为 0 |
| RESTORE_START_TIMESTAMP | timestamp(6) | YES | 增量恢复起始位点，由备份数据决定 |
| RESTORE_FINISH_TIMESTAMP | timestamp(6) | YES | 增量恢复结束位点，由恢复命令中指定 |
| RESTORE_CURRENT_TIMESTAMP | timestamp(6) | YES | 当前增量恢复的位点。目前该字段暂未使用，该值无意义 |
| INFO | varchar(4096) | NO | 恢复过程中的运行信息，主要是恢复失败时的失败模块及错误码，缺省值为空 |

39
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/46.oceanbase-cdb_ob_restore_history.md Normal file
View File

@ -0,0 +1,39 @@
oceanbase.CDB_OB_RESTORE_HISTORY
=====================================================
功能
-----------
展示物理恢复任务完成时的状态，是恢复任务结束时，对应任务在 CDB_OB_RESTORE_PROGRESS 对应记录的快照。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| JOB_ID | bigint(20) | NO | 物理恢复任务唯一标识 |
| EXTERNAL_JOB_ID | bigint(20) | NO | 物理恢复任务外部标识，不保证唯一性；在恢复命令中传入，缺省为 -1 |
| TENANT_ID | bigint(20) | NO | 恢复的租户 ID，缺省值 -1 |
| TENANT_NAME | varchar(128) | NO | 恢复的租户名，缺省值为空 |
| BACKUP_TENANT_ID | bigint(20) | NO | 原备份的租户 ID |
| BACKUP_TENANT_NAME | varchar(128) | NO | 原备份的租户名 |
| BACKUP_CLUSTER_ID | bigint(20) | NO | 原备份的集群 ID |
| BACKUP_CLUSTER_NAME | varchar(128) | NO | 原备份的集群名 |
| STATUS | varchar(64) | NO | 物理恢复所处阶段 * CREATE_TENANT：创建租户阶段 * RESTORE_SYS_REPLICA：租户系统表恢复阶段 * MODIFY_SCHEMA：租户元信息修正阶段 * CREATE_USER_PARTITIONS：租户用户表创建阶段 * RESTORE_USER_REPLICA：租户用户表恢复阶段 * REBUILD_INDEX：索引重建阶段 * POST_CHECK：校验阶段 * RESTORE_SUCCESS：恢复成功 * RESTORE_FAIL：恢复失败 |
| START_TIME | timestamp(6) | YES | 恢复开始时间 |
| COMPLETION_TIME | timestamp(6) | YES | 恢复完成时间 |
| PARTITION_COUNT | bigint(20) | NO | * RESTORE_SYS_REPLICA 阶段：待恢复系统表分区数 * RESTORE_USER_REPLICA 阶段：待恢复用户表分区数 * 其余阶段无意义，缺省值为 0 |
| MACRO_BLOCK_COUNT | bigint(20) | NO | 待恢复宏块个数，暂未实现，该值无意义 |
| FINISH_PARTITION_COUNT | bigint(20) | NO | * RESTORE_SYS_REPLICA 阶段：已完成基线恢复的系统表分区数 * RESTORE_USER_REPLICA 阶段：已完成基线恢复的用户表分区数 * 其余阶段无意义，缺省值为 0 |
| FINISH_MACRO_BLOCK_COUNT | bigint(20) | NO | 已恢复宏块个数，暂未实现，该值无意义，缺省值为 0 |
| RESTORE_START_TIMESTAMP | timestamp(6) | YES | 增量恢复起始位点，由备份数据决定 |
| RESTORE_FINISH_TIMESTAMP | timestamp(6) | YES | 增量恢复结束位点，由恢复命令中指定 |
| RESTORE_CURRENT_TIMESTAMP | timestamp(6) | YES | 当前增量恢复的位点，暂未实现，该值无意义 |
| INFO | varchar(4096) | NO | 恢复过程中的运行信息，主要是恢复失败时的失败模块及错误码，缺省值为空 |

27
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/47.oceanbase-cdb_ckpt_history.md Normal file
View File

@ -0,0 +1,27 @@
oceanbase.CDB_CKPT_HISTORY
===============================================
功能
-----------
oceanbase.CDB_CKPT_HISTORY 用于展示系统中每个租户执行 Checkpoint 的相关信息，包括类型、版本号、集群版本和起止时间。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为空** | **描述** |
|----------------------------|--------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| SVR_IP | varchar(32) | NO | Server 的 IP 地址 |
| SVR_PORT | bigint(20) | NO | Server 的端口号 |
| TENANT_ID | varchar(256) | NO | 租户 ID |
| CHECKPOINT_SNAPSHOT | longtext | NO | 表示写 Checkpoint 的 Snaphost 版本号 |
| CHECKPOINT_TYPE | varchar(256) | NO | CheckPoint 的类型： * META_CKPT：Major Compaction * DATA_CKPT：Mini Compaction |
| CHECKPOINT_CLUSTER_VERSION | varchar(256) | NO | 表示写 Checkpoint 的 OceanBase 集群的版本号 |
| START_TIME | timestamp(6) | NO | 写 Checkpoint 的开始时间 |
| FINISH_TIME | varchar(32) | NO | 写 Checkpoint 的结束时间 |

36
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/48.oceanbase-cdb_ob_backup_validation_job.md Normal file
View File

@ -0,0 +1,36 @@
oceanbase.CDB_OB_BACKUP_VALIDATION_JOB
===========================================================
功能
-----------
展示备份校验进度，用于在 OCP 上展示备份校验的情况，只保留正在执行的任务。
相关视图
-------------
* CDB_OB_BACKUP_VALIDATION_JOB_HISTORY
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------|--------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------|
| JOB_ID | bigint(20) | NO | Job ID |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| TENANT_NAME | varchar(128) | NO | 租户名 |
| INCARNATION | bigint(20) | NO | 与 Oracle 中的 incarnation 含义相关，表示 flashback database 后的第几次分身 |
| BACKUP_SET_ID | bigint(20) | NO | 备份集的 ID |
| PROGRESS_PERCENT | bigint(20) | NO | 备份校验进度 |
| STATUS | varchar(64) | NO | 备份校验的状态类型： * SUCCESS * FAILED |

27
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/49.oceanbase-cdb_ob_backup_validation_job_history.md Normal file
View File

@ -0,0 +1,27 @@
oceanbase.CDB_OB_BACKUP_VALIDATION_JOB_HISTORY
===================================================================
功能
-----------
展示备份校验进度，用于在 OCP 上展示备份校验的情况，保留所有历史任务。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------|--------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------|
| JOB_ID | bigint(20) | NO | 备份校验的 Job ID |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| TENANT_NAME | varchar(128) | NO | 租户名，缺省值为空 |
| INCARNATION | bigint(20) | NO | 数据库的分身编号 |
| BACKUP_SET_ID | bigint(20) | NO | 备份集的 ID |
| PROGRESS_PERCENT | bigint(20) | NO | 备份校验进度 |
| STATUS | varchar(64) | NO | 备份校验的状态类型： * SUCCESS * FAILED |

47
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/5.mysql-db.md Normal file
View File

@ -0,0 +1,47 @@
mysql.db
=============================
功能
-----------
用于展示数据库级别的权限信息（VIRTUAL_TABLE）。
相关表/视图
---------------
无
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------------|--------------|----------------|------------------------------------------------------------------------|
| host | varchar(128) | NO | 主机名 |
| db | varchar(128) | NO | 数据库名 |
| user | varchar(128) | NO | 用户名 |
| select_priv | varchar(1) | NO | 是否可执行 select 语句 |
| insert_priv | varchar(1) | NO | 是否可执行 insert 语句 |
| update_priv | varchar(1) | NO | 是否可执行 update 语句 |
| delete_priv | varchar(1) | NO | 是可可执行 delete 语句 |
| create_priv | varchar(1) | NO | 是否可执行 create 语句 |
| drop_priv | varchar(1) | NO | 是否可执行 drop 语句 |
| grant_priv | varchar(1) | NO | 是否可进行授权操作 |
| reference_priv | varchar(1) | NO | 暂未使用 |
| index_priv | varchar(1) | NO | 是否可创建 index |
| alter_priv | varchar(1) | NO | 是否可执行` alter table` 语句 |
| create_tmp_table_priv | varchar(1) | NO | 是否可创建临时表。目前暂未使用该字段 |
| lock_tables_priv | varchar(1) | NO | 是否可执行` LOCK TABLES 语` 句，用户同时需要有表上的 select 权限。目前暂未使用该字段 |
| create_view_priv | varchar(1) | NO | 是否可执行` create view `语句 |
| show_view_priv | varchar(1) | NO | 是否可执行` show create view `语句 |
| create_routine_priv | varchar(1) | NO | 是否可创建存储过程（暂未使用） |
| alter_routine_priv | varchar(1) | NO | 是否可执行`alter function` 语句（暂未使用） |
| execute_priv | varchar(1) | NO | 是否可执行存储过程（暂未使用） |
| event_priv | varchar(1) | NO | 是否可创建删除或者更改 event（暂未使用） |
| trigger_priv | varchar(1) | NO | 是否可执行` create trigger` 或` drop trigger` 语句。目前暂未使用该字段 |

41
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/50.oceanbase-cdb_ob_tenant_backup_validation_task.md Normal file
View File

@ -0,0 +1,41 @@
oceanbase.CDB_OB_TENANT_BACKUP_VALIDATION_TASK
===================================================================
功能
-----------
展示租户级别的备份校验任务。
相关视图
-------------
CDB_OB_BACKUP_VALIDATION_TASK_HISTORY
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------------|---------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------|
| JOB_ID | bigint(20) | NO | Job ID |
| TASK_ID | bigint(20) | NO | Task ID |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| INCARNATION | bigint(20) | NO | 与 Oracle 中的 incarnation 含义相关，表示 flashback database 后的第几次分身 |
| BACKUP_SET_ID | bigint(20) | NO | 备份集的 ID |
| STATUS | varchar(64) | NO | 备份校验的状态类型： * SUCCESS * FAILED |
| BACKUP_DEST | varchar(2048) | YES | 原备份的位置，即备份校验需要读取数据的位置 |
| START_TIME | timestamp(6) | NO | 起始时间 |
| END_TIME | timestamp(6) | NO | 结束时间 |
| TOTAL_PG_COUNT | bigint(20) | NO | 全部 Partition Group 个数 |
| FINISH_PG_COUNT | bigint(20) | NO | 校验完成的 Partition Group 个数 |
| TOTAL_PARTITION_COUNT | bigint(20) | NO | 全部 Partition 个数 |
| FINISH_PARTITION_COUNT | bigint(20) | NO | 校验完成的 Partition个数 |
| TOTAL_MACRO_BLOCK_COUNT | bigint(20) | NO | 全部宏块个数 |
| FINISH_MACRO_BLOCK_COUNT | bigint(20) | NO | 校验完成宏块个数 |
| LOG_SIZE | bigint(20) | NO | 需要校验的日志大小 |

46
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/51.oceanbase-cdb_ob_backup_validation_task_history.md Normal file
View File

@ -0,0 +1,46 @@
oceanbase.CDB_OB_BACKUP_VALIDATION_TASK_HISTORY
====================================================================
功能
-----------
CDB_OB_TENANT_BACKUP_VALIDATION_TASK 的历史表。
相关视图
-------------
* CDB_OB_TENANT_BACKUP_VALIDATION_TASK
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------------|---------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------|
| JOB_ID | bigint(20) | NO | 备份校验的 Job ID |
| TASK_ID | bigint(20) | NO | Task ID |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| INCARNATION | bigint(20) | NO | 与 Oracle 中的 incarnation 含义相关，表示 flashback database 后的第几次分身 |
| BACKUP_SET_ID | bigint(20) | NO | 备份集的 ID |
| STATUS | varchar(64) | NO | 备份校验的状态类型： * SUCCESS * FAILED |
| BACKUP_DEST | varchar(2048) | YES | 原备份的位置，即备份校验需要读取数据的位置 |
| START_TIME | timestamp(6) | NO | 起始时间 |
| END_TIME | timestamp(6) | NO | 结束时间 |
| TOTAL_PG_COUNT | bigint(20) | NO | 全部 Partition Group 个数 |
| FINISH_PG_COUNT | bigint(20) | NO | 校验完成的 Partition Group 个数 |
| TOTAL_PARTITION_COUNT | bigint(20) | NO | 全部 Partition 个数 |
| FINISH_PARTITION_COUNT | bigint(20) | NO | 校验完成的 Partition 个数 |
| TOTAL_MACRO_BLOCK_COUNT | bigint(20) | NO | 全部宏块个数 |
| FINISH_MACRO_BLOCK_COUNT | bigint(20) | NO | 校验完成宏块个数 |
| LOG_SIZE | bigint(20) | NO | 需要校验的日志大小 |

31
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/52.oceanbase-cdb_ob_backup_backup_archivelog_summary.md Normal file
View File

@ -0,0 +1,31 @@
oceanbase.CDB_OB_BACKUP_BACKUP_ARCHIVELOG_SUMMARY
======================================================================
功能
-----------------------
展示正在进行的备份备份日志归档任务的信息。
字段说明
-------------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|----------------------|---------------|------------|----------------------------------------------------------------|
| INCARNATION | bigint(20) | NO | 与 Oracle 数据库中的 incarnation 含义相关，表示 flashback database 后的第几次分身。 |
| LOG_ARCHIVE_ROUND | bigint(20) | NO | 用于标识第几轮完整的 clog 备份数据流 |
| COPY_ID | bigint(20) | NO | 第几份拷贝 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| STATUS | varchar(64) | NO | 备份备份归档的状态 |
| MIN_FIRST_TIME | timestamp(6) | NO | 起始的 logts |
| MAX_NEXT_TIME | timestamp(6) | NO | 目前已经备份最大的 logts |
| INPUT_BYTES | bigint(20) | NO | 读取的数据量 |
| OUTPUT_BYTES | bigint(20) | NO | 输出的数据量 |
| COMPRESSION_RATIO | decimal(23,2) | NO | 压缩比 |
| INPUT_BYTES_DISPLAY | varchar(27) | NO | 读取的数据量的展示值 |
| OUTPUT_BYTES_DISPLAY | varchar(27) | NO | 输出的数据量的展示值 |

40
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/53.oceanbase-cdb_ob_backup_backupset_task_history.md Normal file
View File

@ -0,0 +1,40 @@
oceanbase.CDB_OB_BACKUP_BACKUPSET_TASK_HISTORY
===================================================================
功能
-----------------------
展示已完成的备份备份基线任务的信息。
字段说明
-------------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|---------------------------|---------------|------------|----------------------------------------------------------------|
| INCARNATION | bigint(20) | NO | 与 Oracle 数据库中的 incarnation 含义相关，表示 flashback database 后的第几次分身。 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| BS_KEY | bigint(20) | NO | 备份集的值 |
| COPY_ID | bigint(20) | NO | 第几份拷贝 |
| BACKUP_TYPE | varchar(1) | NO | 备份类型 |
| ENCRYPTION_MODE | varchar(64) | NO | 加密模式 |
| START_TIME | timestamp(6) | NO | 备份集备份的开始时间 |
| COMPLETION_TIME | timestamp(6) | NO | 备份集备份的结束时间 |
| ELAPSED_SECONDES | decimal(21,0) | NO | 备份集备份的使用时间 |
| KEEP | varchar(2) | NO | 是否保留 |
| KEEP_UNTIL | varchar(0) | NO | 保留时间 |
| SRC_DEVICE_TYPE | varchar(64) | NO | 源端设备类型 |
| DST_DEVICE_TYPE | varchar(64) | NO | 目的端设备类型 |
| COMPRESSED | varchar(2) | NO | 是否压缩 |
| OUTPUT_BYTES | bigint(20) | NO | 输出的数据量 |
| OUTPUT_RATE_BYTES | decimal(34,4) | NO | 输出数据量的字节 |
| COMPRESSION_RATIO | decimal(23,2) | NO | 压缩比 |
| OUTPUT_BYTES_DISPLAY | varchar(27) | NO | 输出的数据量的展示值 |
| OUTPUT_RATE_BYTES_DISPLAY | varchar(39) | NO | 输出数据量的字节展示值 |
| TIME_TAKEN_DISPLAY | time(6) | NO | 所用时间的展示值 |
| STATUS | varchar(9) | NO | 状态 |

35
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/54.oceanbase-cdb_ob_backup_backupset_task.md Normal file
View File

@ -0,0 +1,35 @@
oceanbase.CDB_OB_BACKUP_BACKUPSET_TASK
===========================================================
功能
-----------------------
展示正常进行的备份备份基线任务的信息，按 Job 展示对应的 Task。
字段说明
-------------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|--------------------------|--------------|------------|---------------------------------------------------------------|
| INCARNATION | bigint(20) | NO | 与 Oracle 数据库中的 incarnation 含义相关，表示 flashback database 后的第几次分身 |
| BS_KEY | bigint(20) | NO | 备份集的值 |
| COPY_ID | bigint(20) | NO | 第几份拷贝 |
| BACKUP_TYPE | varchar(1) | NO | 备份类型 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| TOTAL_PG_COUNT | bigint(20) | NO | 所有 Partition Group 的个数 |
| FINISH_PG_COUNT | bigint(20) | NO | 完成 Partition Group 的个数 |
| TOTAL_PARTITION_COUNT | bigint(20) | NO | 所有分区的个数 |
| TOTAL_MACRO_BLOCK_COUNT | bigint(20) | NO | 所有宏块的个数 |
| FINISH_PARTITION_COUNT | bigint(20) | NO | 完成分区的个数 |
| FINISH_MACRO_BLOCK_COUNT | bigint(20) | NO | 完成宏块的个数 |
| INPUT_BYTES | bigint(20) | NO | 读取的数据量 |
| OUTPUT_BYTES | bigint(20) | NO | 输出的数据量 |
| START_TIME | timestamp(6) | NO | 开始时间 |
| COMPLETION_TIME | timestamp(6) | NO | 结束时间 |
| STATUS | varchar(9) | NO | 状态 |

26
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/55.oceanbase-cdb_ob_backup_backupset_job_history.md Normal file
View File

@ -0,0 +1,26 @@
oceanbase.CDB_OB_BACKUP_BACKUPSET_JOB_HISTORY
==================================================================
功能
-----------------------
展示发起过备份备份基线的 Job 的历史信息。
字段说明
-------------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|---------------|--------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| JOB_ID | bigint(20) | NO | Job ID |
| TENANT_ID | bigint(20) | NO | 租户 ID，系统租户为 1，表示所有备份集 |
| INCARNATION | bigint(20) | NO | 与 Oracle 数据库中的 incarnation 含义相关，表示 flashback database 后的第几次分身 |
| BACKUP_SET_ID | bigint(20) | NO | 备份集的 ID |
| TYPE | varchar(17) | NO | 标记为备份单个备份集还是全部备份集的集合： * S：表示单个备份集 * A：表示全部备份集 |
| TENANT_NAME | varchar(128) | NO | 租户的名称 |
| STATUS | varchar(64) | NO | 备份的状态： * schedule * doing * finished * canceling |

26
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/56.oceanbase-cdb_ob_backup_backupset_job.md Normal file
View File

@ -0,0 +1,26 @@
oceanbase.CDB_OB_BACKUP_BACKUPSET_JOB
==========================================================
功能
-----------------------
展示备份备份基线任务的信息，一条 SQL 即对应一个 Job。
字段说明
-------------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|---------------|--------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| JOB_ID | bigint(20) | NO | Job ID |
| TENANT_ID | bigint(20) | NO | 租户 ID，系统租户为 1，表示所有备份集 |
| INCARNATION | bigint(20) | NO | 与 Oracle 数据库中的 incarnation 含义相关，表示 flashback database 后的第几次分身 |
| BACKUP_SET_ID | bigint(20) | NO | 备份集的 ID |
| TYPE | varchar(17) | NO | 标记为备份单个备份集还是全部备份集的集合： * S：表示单个备份集 * A：表示全部备份集 |
| TENANT_NAME | varchar(128) | NO | 租户的名称 |
| STATUS | varchar(64) | NO | 备份的状态： * schedule * doing * finished * canceling |

40
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/57.oceanbase-cdb_ob_backup_set_obsolete.md Normal file
View File

@ -0,0 +1,40 @@
oceanbase.CDB_OB_BACKUP_SET_OBSOLETE
=========================================================
功能
-----------------------
展示哪些备份集已过期。
字段说明
-------------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|---------------------------|---------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| INCARNATION | bigint(20) | NO | 与 Oracle 数据库中的incarnation 的含义相关，表示 Flashback Database 后的第几次分身 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| BS_KEY | bigint(20) | NO | 备份集的 ID |
| COPY_ID | varchar(1) | NO | 备份集的第几份拷贝 |
| BACKUP_TYPE | | NO | * D：表示全量备份 * I：表示增量备份 |
| ENCRYPTION_MODE | varchar(64) | NO | 加密模式： * NONE：表示不加密 * PASSWORD：表示仅使用密码保护 * PASSWORD ENCRYPTION：表示加密，并且通过密码保护 * TRANSPARENT ENCRYPTION：表示使用了 TDE 加密 * DUAL MODE ENCRYPTION：表示通过 TDE 加密，并且通过密码保护 **说明** 当前版本仅支持 NONE 和 PASSWORD。 |
| START_TIME | timestamp(6) | NO | 起始时间 |
| COMPLETION_TIME | timestamp(6) | NO | 完成时间 |
| ELAPSED_SECONDS | decimal(21,0) | NO | 备份耗时 |
| KEEP | varchar(2) | NO | * YES：表示永久保留 * NO：表示根据保留时间过期 目前仅支持 NO |
| KEEP_UNTIL | varchar(0) | NO | 保留的时间 |
| DEVICE_TYPE | varchar(64) | NO | 备份介质 |
| COMPRESSED | varchar(2) | NO | 是否压缩： * YES：表示压缩 * NO：表示不压缩 |
| OUTPUT_BYTES | bigint(20) | NO | 输出字节数 |
| OUTPUT_RATE_BYTES | decimal(34,4) | NO | 每秒输出字节数 |
| COMPRESSION_RATIO | decimal(23,2) | NO | 压缩率 |
| OUTPUT_BYTES_DISPLAY | varchar(27) | NO | 输出数据量 |
| OUTPUT_RATE_BYTES_DISPLAY | varchar(39) | NO | 输出速度 |
| TIME_TAKEN_DISPLAY | time(6) | NO | 耗时 hh:mm:ss |
| STATUS | varchar(9) | NO | 表示备份集的状态属性，目前的状态有： * COMPLETED：表示备份集备份成功 * FAILED：表示备份集备份失败 * DELETING：表示备份集正在清理 |

39
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/6.mysql-proc.md Normal file
View File

@ -0,0 +1,39 @@
mysql.proc
===============================
功能
-----------
用于展示存储过程的信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------------|------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| db | varchar(128) | NO | 数据库名 |
| name | varchar(128) | NO | 存储过程的名称 |
| type | varchar(10) | NO | 存储过程的类型： * PROCEDURE：存储过程 * FUNCTION：存储函数 |
| specific_name | varchar(64) | NO | 同name字段 |
| language | varchar(4) | NO | 未使用，当前为固定值SQL |
| sql_data_access | varchar(32) | NO | 未使用，当前为固定值CONTAINS_SQL |
| is_deterministic | varchar(4) | NO | 未使用，标识存储过程是否使`DETERMINISTIC` 特性定义： * YES * NO |
| security_type | varchar(10) | NO | 未使用，标识 SQL 的访问属性： * DEFINER * INVOKER |
| param_list | varchar(1048576) | NO | 存储过程的参数列表信息 |
| returns | varchar(1048576) | NO | 存储过程的返回值信息 |
| body | varchar(1048576) | NO | 存储过程定义的文本信息 |
| definer | varchar(77) | NO | 创建存储过程的用户 |
| created | timestamp(6) | NO | 创建存储过程的日期和时间 |
| modified | timestamp(6) | NO | 存储过程的最后修改日期和时间 |
| sql_mode | varchar(32) | NO | 创建或更改存储过程时有效的 SQL 模式，在该模式下执行存储过程 |
| comment | varchar(1048576) | NO | 注释文本 |
| character_set_client | varchar(128) | NO | 创建或更改存储过程时 character_set_client 系统变量的会话值 |
| collation_connection | varchar(128) | NO | 创建或更改存储过程时 collation_connection 系统变量的会话值 |
| collation_database | varchar(128) | NO | 创建或更改存储过程时 collation_database 系统变量的会话值 |
| body_utf8 | varchar(1048576) | NO | 过程定义，与 body 字段相同 |

27
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/7.mysql-time_zone.md Normal file
View File

@ -0,0 +1,27 @@
mysql.time_zone
====================================
功能
-----------
用于展示时区相关的信息（SYSTEM_VIEW）。
相关表/视图
---------------
__all_time_zone
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------|------------|-----------------|--------|
| Time_zone_id | bigint(20) | NO | 时区 ID |
| Use_leap_seconds | varchar(8) | NO | 是否使用闰秒 |

29
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/8.mysql-time_zone_name.md Normal file
View File

@ -0,0 +1,29 @@
mysql.time_zone_name
=========================================
功能
--------------------
用于记录 timezone 名称信息（SYSTEM_VIEW）。
相关表/视图
------------------------
__all_time_zone_name
字段说明
----------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|--------------|-------------|------------|-------|
| Name | varchar(64) | NO | 时区名称 |
| Time_zone_id | bigint(20) | NO | 时区 ID |

27
docs/docs-cn/13.reference-guide/1.system-view/2.dictionary-view/9.mysql-time_zone_transition.md Normal file
View File

@ -0,0 +1,27 @@
mysql.time_zone_transition
===============================================
功能
-----------
mysql.time_zone_transition 是用于记录时区转换信息的系统视图。
相关表/视图
---------------
__all_time_zone_transition
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------|------------|----------------|-----------|
| Time_zone_id | bigint(20) | NO | 时区 ID |
| Transition_time | bigint(20) | NO | 时区转换时间 |
| Transition_type_id | bigint(20) | NO | 时区转换类型 ID |

37
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/1.gv-plan_cache_stat.md Normal file
View File

@ -0,0 +1,37 @@
gv$plan_cache_stat
=======================================
功能
-----------
该视图记录当前租户在所有 Server 上的每个计划缓存整体的状态。
相关表/视图
---------------
oceanbase.__all_virtual_plan_cache_stat
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------|-------------|----------------|-----------------------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| svr_ip | varchar(32) | NO | 服务器的 IP 地址 |
| svr_port | bigint(20) | NO | 端口号 |
| sql_num | bigint(20) | NO | plan_cache 涉及 SQL 条数 |
| mem_used | bigint(20) | NO | plan_cache 已经使用的内存 |
| mem_hold | bigint(20) | NO | plan_cache 持有的内存 |
| access_count | bigint(20) | NO | 进行 plan_cache 的次数 |
| hit_count | bigint(20) | NO | 命中 plan_cache 的次数 |
| hit_rate | bigint(20) | NO | plan_cache 的命中率 |
| plan_num | bigint(20) | NO | plan 的个数 |
| mem_limit | bigint(20) | NO | plan_cache 的内存上限 |
| hash_bucket | bigint(20) | NO | plan_cache hash map 中的 Bucket 的个数 |
| stmtkey_num | bigint(20) | NO | plan_cache 中 stmt_key 的个数 |

40
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/10.gv-latch.md Normal file
View File

@ -0,0 +1,40 @@
gv$latch
=============================
功能
-----------
集群所有 OBServer 的 latch 信息视图。
相关表/视图
---------------
oceanbase.__all_virtual_latch
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------|--------------|----------------|--------------------|
| CON_ID | bigint(20) | NO | 租户 ID |
| SVR_IP | varchar(32) | NO | IP 地址 |
| SVR_PORT | bigint(20) | NO | 端口号 |
| ADDR | varchar(256) | NO | 目前为 NULL |
| LATCH# | bigint(20) | NO | latch 所属 class 的下标 |
| LEVEL# | bigint(20) | NO | latch 所属 level 的下标 |
| NAME | varchar(256) | NO | latch 的名称 |
| HASH | bigint(20) | NO | 该值目前为 0 |
| GETS | bigint(20) | NO | lock 成功次数 |
| MISSES | bigint(20) | NO | lock 进入等待的次数 |
| SLEEPS | bigint(20) | NO | 总共 yield 的次数 |
| IMMEDIATE_GETS | bigint(20) | NO | try_lock 成功次数 |
| IMMEDIATE_MISSES | bigint(20) | NO | try_lock 失败次数 |
| SPIN_GETS | bigint(20) | NO | 总共 spin 次数 |
| WAIT_TIME | bigint(20) | NO | 等待 sleep 时间 |

32
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/11.gv-memory.md Normal file
View File

@ -0,0 +1,32 @@
gv$memory
==============================
功能
-----------
gv$memory 视图用于展示租户级别的内存统计信息。
相关表/视图
---------------
oceanbase.__all_virtual_memory_info
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------|--------------|----------------|--------------------------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| IP | varchar(32) | NO | IP 地址 |
| PORT | bigint(20) | NO | 端口号 |
| CONTEXT | varchar(256) | NO | 内存所属 Mod 名称 |
| COUNT | bigint(20) | NO | 内存分配与释放的差值，即当前该 Mod 使用中的内存单元个数 |
| USED | bigint(20) | NO | 该 Mod 当前使用的内存数值，单位：Byte |
| ALLOC_COUNT | bigint(20) | NO | 该 Mod 申请的内存总个数 |
| FREE_COUNT | bigint(20) | NO | 该 Mod 释放的内存总个数 |

32
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/12.gv-memstore.md Normal file
View File

@ -0,0 +1,32 @@
gv$memstore
================================
功能
-----------
该视图用于展示所有服务器上所有租户的 Memtable 的内存使用状况。
相关表/视图
---------------
oceanbase.__all_virtual_tenant_memstore_info
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|-------------|----------------|------------------------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| IP | varchar(32) | NO | 服务器的 IP |
| PORT | bigint(20) | NO | 服务器端口 |
| ACTIVE | bigint(20) | NO | 当前活跃的 Memtable 的内存占用大小，单位为字节 |
| TOTAL | bigint(20) | NO | 当前所有 Memtable 的内存占用大小，单位为字节 |
| FREEZE_TRIGGER | bigint(20) | NO | 触发 Memtable 冻结的内存大小，单位为字节 |
| MEM_LIMIT | bigint(20) | NO | Memtable 的内存大小限制，单位：字节 |
| FREEZE_CNT | bigint(20) | NO | Memtable 的冻结次数 |

37
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/13.gv-memstore_info.md Normal file
View File

@ -0,0 +1,37 @@
gv$memstore_info
=====================================
功能
-----------
`gv$memstore_info` 视图用于展示所有服务器上所有租户的所有分区的 Memtable 的详细信息。
相关表/视图
---------------
oceanbase.__all_virtual_memstore_info
字段说明
-------------
| **字段名称** | **类型** | **是否可以为空** | **描述** |
|---------------------|--------------|------------|----------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| IP | varchar(32) | NO | 服务器的 IP |
| PORT | bigint(20) | NO | 服务器端口 |
| TABLE_ID | bigint(20) | NO | 表 ID |
| PARTITION_ID | bigint(20) | NO | 分区 ID |
| VERSION | varchar(128) | NO | 冻结版本号 |
| BASE_VERSION | bigint(20) | NO | 数据的快照版本号的左边界 |
| MULTI_VERSION_START | bigint(20) | NO | 最小的老版本数据的快照版本号 |
| SNAPSHOT_VERSION | bigint(20) | NO | 数据的快照版本号的右边界 |
| IS_ACTIVE | bigint(20) | NO | 是否是活跃的 |
| USED | bigint(20) | NO | 使用的内存大小，单位为字节 |
| HASH_ITEMS | bigint(20) | NO | Hash 索引中记录的行数 |
| BTREE_ITEMS | bigint(20) | NO | Btree 索引中记录的行数 |

40
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/14.gv-plan_cache_plan_explain.md Normal file
View File

@ -0,0 +1,40 @@
gv$plan_cache_plan_explain
===============================================
功能
-----------
该视图用于展示缓存在全部的 Server 中的计划缓存中的物理执行计划。
**说明**
该视图仅支持 get 操作，查询时需要指定 IP、PORT、TENANT_ID、PLAN_ID 字段。
相关表/视图
---------------
oceanbase.__all_virtual_plan_cache_plan_explain
字段说明
-------------
| **字段名称** | **类型** | **是否可以为空** | **描述** |
|--------------|--------------|------------|------------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| IP | varchar(32) | NO | IP 地址 |
| PORT | bigint(20) | NO | 端口号 |
| PLAN_ID | bigint(20) | NO | 计划的 ID |
| PLAN_DEPTH | bigint(20) | NO | Operator 在展示时的深度 |
| PLAN_LINE_ID | bigint(20) | NO | Operator 的编号 |
| OPERATOR | varchar(128) | NO | Operator 的名称 |
| NAME | varchar(128) | NO | 表的名称 |
| ROWS | bigint(20) | NO | 预估的结果行数 |
| COST | bigint(20) | NO | 预估的代价 |
| PROPERTY | varchar(256) | NO | 对应 Operator 的信息 |

37
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/15.gv-obrpc_outgoing.md Normal file
View File

@ -0,0 +1,37 @@
gv$obrpc_outgoing
======================================
功能
-----------
所有 OBServer 的 RPC 的发送统计信息。
相关表/视图
---------------
oceanbase.__all_virtual_obrpc_stat
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|--------------|----------------|-----------------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| IP | varchar(32) | NO | IP 地址 |
| PORT | bigint(20) | NO | 端口号 |
| PCODE | bigint(20) | NO | RPC Packet Code |
| PCODE_NAME | varchar(256) | NO | RPC Packet Code 对应的名称 |
| COUNT | bigint(20) | NO | 使用次数 |
| TOTAL_TIME | bigint(20) | NO | 总共花费时间 |
| TOTAL_SIZE | bigint(20) | NO | 总共发送数据量大小 |
| FAILURE | bigint(20) | NO | 发送失败次数 |
| TIMEOUT | bigint(20) | NO | 发送超时次数 |
| SYNC | bigint(20) | NO | 同步等待 RPC 请求个数 |
| ASYNC | bigint(20) | NO | 异步回调 RPC 请求个数 |
| LAST_TIMESTAMP | timestamp(6) | NO | 最后更新统计信息时间 |

36
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/16.gv-obrpc_incoming.md Normal file
View File

@ -0,0 +1,36 @@
gv$obrpc_incoming
======================================
功能
-----------
gv$obrpc_incoming 视图用于展示所有 OBServer 收到 RPC 请求的统计信息。
相关表/视图
---------------
v$obrpc_incoming
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|--------------|----------------|-----------------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| IP | varchar(32) | NO | IP 地址 |
| PORT | bigint(20) | NO | 端口号 |
| PCODE | bigint(20) | NO | RPC Packet Code |
| PCODE_NAME | varchar(256) | NO | RPC Packet Code 对应的名称 |
| COUNT | bigint(20) | NO | 已接收到的该类型的 RPC 请求的个数 |
| TOTAL_SIZE | bigint(20) | NO | 总共接收数据量 |
| NET_TIME | bigint(20) | NO | 网络时间 |
| WAIT_TIME | bigint(20) | NO | 接收时间到请求被放入队列的时间 |
| QUEUE_TIME | bigint(20) | NO | 在队列中等待的时间 |
| PROCESS_TIME | bigint(20) | NO | 实际处理消耗的时间 |
| LAST_TIMESTAMP | timestamp(6) | NO | 上次更新的时间 |

51
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/17.gv-sql.md Normal file
View File

@ -0,0 +1,51 @@
gv$sql
===========================
功能
-----------
所有热更新的 SQL 相关统计信息，记录每个 Plan 上的统计信息，汇总单个 Plan 多次执行的统计信息；每个 Plan 都会在表中有一行。
相关表/视图
---------------
__all_virtual_plan_stat
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------------|---------------------|----------------|--------------------------------|
| CON_ID | bigint(20) | NO | 租户 ID |
| SVR_IP | varchar(32) | NO | IP 地址 |
| SVR_PORT | bigint(20) | NO | 端口号 |
| PLAN_ID | bigint(20) | NO | 执行计划的 ID |
| SQL_ID | varchar(32) | NO | SQL 的标识符 |
| TYPE | bigint(20) | NO | SQL 类型，local remote distribute |
| SQL_TEXT | varchar(4096) | NO | SQL 语句文本 |
| PLAN_HASH_VALUE | bigint(20) | NO | 执行计划的 Hash 值 |
| FIRST_LOAD_TIME | timestamp(6) | NO | 第一次执行时间 |
| LAST_ACTIVE_TIME | timestamp(6) | NO | 上一次执行时间 |
| AVG_EXE_USEC | bigint(20) | NO | 平均执行耗时 |
| SLOWEST_EXE_TIME | timestamp(6) | NO | 最慢执行开始时间点 |
| SLOWEST_EXE_USEC | bigint(20) | NO | 最慢执行消耗时间 |
| SLOW_COUNT | bigint(20) | NO | 慢查询次数统计 |
| HIT_COUNT | bigint(20) | NO | 命中 Plan Cache 的统计 |
| PLAN_SIZE | bigint(20) | NO | 物理计划占用的内存 |
| EXECUTIONS | bigint(20) | NO | 执行次数 |
| DISK_READS | bigint(20) | NO | 多盘次数 |
| DIRECT_WRITES | bigint(20) | NO | 写盘次数 |
| BUFFER_GETS | bigint(20) | NO | 逻辑读次数 |
| APPLICATION_WAIT_TIME | bigint(20) unsigned | NO | application 类事件等待时间 |
| CONCURRENCY_WAIT_TIME | bigint(20) unsigned | NO | concurrentcy 类事件等待时间 |
| USER_IO_WAIT_TIME | bigint(20) unsigned | NO | 所有 IO 类事件等待时间 |
| ROWS_PROCESSED | bigint(20) | NO | 所有 Schedule 类事件等待事件 |
| ELAPSED_TIME | bigint(20) unsigned | NO | 接收到处理完成总消耗时间 |
| CPU_TIME | bigint(20) unsigned | NO | 消耗的 CPU 时间 |

105
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/18.gv-sql_plan_monitor.md Normal file
View File

@ -0,0 +1,105 @@
gv$sql_plan_monitor
========================================
功能
-----------
展示所有 OBServer 慢查询的 Plan 层面的统计，每个慢查询都会有一条统计信息，同时记录该 Plan 的 Trace 信息。
相关表/视图
---------------
__all_virtual_sql_plan_monitor
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------------------|--------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CON_ID | bigint(20) | NO | 租户 ID |
| KEY | null | NO | 外键，用于和 SQL_MONITOR 相关虚拟表做连接查询 |
| STATUS | null | NO | 算子执行状态： * EXECUTING：执行中 * DONE(ERROR)：执行出错 * DONE(FIRST N ROWS)：执行成功 * DONE(ALL ROWS)：执行成功 * DONE： 执行中断 |
| SVR_IP | varchar(32) | NO | 算子所在机器的 IP |
| SVR_PORT | bigint(20) | NO | 算子所在机器的端口号 |
| TRACE_ID | varchar(64) | NO | 算子的 Trace ID |
| FIRST_REFRESH_TIME | timestamp(6) | NO | 算子开始监控时间 |
| LAST_REFRESH_TIME | timestamp(6) | NO | 算子结束监控时间 |
| FIRST_CHANGE_TIME | timestamp(6) | NO | 算子吐出首行数据时间 |
| LAST_CHANGE_TIME | timestamp(6) | NO | 算子吐出最后一行数据时间 |
| REFRESH_COUNT | null | NO | 统计数据刷新次数 |
| SID | null | NO | Session 的 ID |
| PROCESS_NAME | bigint(20) | NO | 执行线程 ID |
| SQL_ID | null | NO | SQL ID |
| SQL_EXEC_START | null | NO | SQL 开始执行时间 |
| SQL_EXEC_ID | null | NO | SQL 执行 ID |
| SQL_PLAN_HASH_VALUE | null | NO | SQL 计划的 HASH 值 |
| SQL_CHILD_ADDRESS | null | NO | 默认为 NULL |
| PLAN_PARENT_ID | null | NO | 父算子 ID |
| PLAN_LINE_ID | bigint(20) | NO | 默认为 NULL |
| PLAN_OPERATION | varchar(128) | NO | 算子名称 |
| PLAN_OPTIONS | null | NO | 默认为 NULL |
| PLAN_OBJECT_OWNER | null | NO | 默认为 NULL |
| PLAN_OBJECT_NAME | null | NO | 默认为 NULL |
| PLAN_OBJECT_TYPE | null | NO | 默认为 NULL |
| PLAN_DEPTH | bigint(20) | NO | 算子在计划树中的深度 |
| PLAN_POSITION | null | NO | 算子是父节点的第几个孩子 |
| PLAN_COST | null | NO | 优化器计算出的算子代价 |
| PLAN_CARDINALITY | null | NO | 优化器计算出的算子输出数据行数 |
| PLAN_BYTES | null | NO | 优化器估算出的算子输出数据字节数 |
| PLAN_TIME | null | NO | 优化器计算出的算子执行时间 |
| PLAN_PARTITION_START | null | NO | 默认为 NULL |
| PLAN_PARTITION_STOP | null | NO | 默认为 NULL |
| PLAN_CPU_COST | null | NO | 优化器估算出的算子 CPU 代价 |
| PLAN_IO_COST | null | NO | 优化器估算出的算子 IO 代价 |
| PLAN_TEMP_SPACE | null | NO | 优化器估算出的算子空间占用大小 |
| STARTS | bigint(20) | NO | 算子被 rescan 的次数 |
| OUTPUT_ROWS | bigint(20) | NO | 算子输出的总行数（所有本算子的执行实例行数累加值） |
| IO_INTERCONNECT_BYTES | null | NO | 算子与储存层之间交换的数据字节数 |
| PHYSICAL_READ_REQUESTS | null | NO | 算子发出的 I/O 读请求次数 |
| PHYSICAL_READ_BYTES | null | NO | 算子发出的 I/O 读请求字节数 |
| PHYSICAL_WRITE_REQUESTS | null | NO | 算子发出的 I/O 写请求次数 |
| PHYSICAL_WRITE_BYTES | null | NO | 算子发出的 I/O 写请求字节数 |
| WORKAREA_MEM | null | NO | 算子占用的 work area 内存量 |
| WORKAREA_MAX_MEM | null | NO | 算子可占用的 work area 内存上限 |
| WORKAREA_TEMPSEG | null | NO | 算子占用的磁盘 dump 空间 |
| WORKAREA_MAX_TEMPSEG | null | NO | 算子可占用的最大磁盘 dump 空间 |
| OTHERSTAT_GROUP_ID | null | NO | 默认为 NULL |
| OTHERSTAT_1_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_1_TYPE | null | NO | 预留 |
| OTHERSTAT_1_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_2_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_2_TYPE | null | NO | 预留 |
| OTHERSTAT_2_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_3_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_3_TYPE | null | NO | 预留 |
| OTHERSTAT_3_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_4_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_4_TYPE | null | NO | 预留 |
| OTHERSTAT_4_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_5_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_5_TYPE | null | NO | 预留 |
| OTHERSTAT_5_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_6_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_6_TYPE | null | NO | 预留 |
| OTHERSTAT_6_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_7_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_7_TYPE | null | NO | 预留 |
| OTHERSTAT_7_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_8_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_8_TYPE | null | NO | 预留 |
| OTHERSTAT_8_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_9_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_9_TYPE | null | NO | 预留 |
| OTHERSTAT_9_VALUE | bigint(20) | NO | 预留 |
| OTHERSTAT_10_ID | bigint(20) | NO | 预留 |
| OTHERSTAT_10_TYPE | null | NO | 预留 |
| OTHERSTAT_10_VALUE | bigint(20) | NO | 预留 |
| OTHER_XML | null | NO | 其它无法写入预留项中，但需要提供给外部使用的结构化数据。由外部工具负责解析 |
| PLAN_OPERATION_INACTIVE | null | NO | 默认为 NULL |

33
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/19.gv-outline.md Normal file
View File

@ -0,0 +1,33 @@
gv$outline
===============================
功能
-----------
展示当前租户的 outline 信息，主要用于 outline 的迁移。
相关表/视图
---------------
oceanbase.__tenant_virtual_outline
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------------|----------------|----------------|---------------------------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| database_id | bigint(20) | NO | 数据库 ID |
| outline_id | bigint(20) | NO | outline ID |
| database_name | varchar(128) | NO | 数据库名称 |
| outline_name | varchar(128) | NO | outline 名称 |
| visible_signature | varchar(32768) | NO | signature 的反序列化结果，为了便于查看signature 的信息 |
| sql_text | varchar(32768) | NO | 创建 outline 时，在 on clause 中指定的 SQL |
| outline_target | varchar(32768) | NO | 创建 outline 时，在 to clause 中指定的 SQL |
| outline_sql | varchar(32768) | NO | 具有完整 outline 信息的 SQL |

85
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/2.gv-plan_cache_plan_stat.md Normal file
View File

@ -0,0 +1,85 @@
gv$plan_cache_plan_stat
============================================
功能
-----------
gv$plan_cache_plan_stat 视图记录了当前租户在所有 Server 上的计划缓存中缓存的每一个缓存对象的状态。
**注意**
该表不仅缓存了 SQL 计划对象，也缓存了 PL 对象（如匿名块、PL Package 以及 PL Function），某些字段只在特定对象下有效。
相关表/视图
---------------
oceanbase.__all_virtual_plan_stat
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------------|---------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| tenant_id | bigint(20) | NO | 租户 ID。 |
| svr_ip | varchar(32) | NO | 服务器的 IP 地址。 |
| svr_port | bigint(20) | NO | 机器端口号。 |
| plan_id | bigint(20) | NO | 缓存对象的 ID。 |
| sql_id | varchar(32) | NO | 缓存对象对应的 SQL ID，如果是 PL 对象，则该字段为 NULL。 |
| type | bigint(20) | NO | 对于 SQL 计划的缓存，该字段表示计划的类型： * 1：表示 Local Plan * 2：表示 Remote Plan * 3：表示 Distribute Plan 对于 PL 对象缓存，该字段表示 PL 对象的类型： * 1：表示 Procedure * 2：表示 Function * 3：表示 Package * 4：表示 Anonymous Block |
| is_bind_sensitive | bigint(20) | NO | 该计划是否需要打开 ACS。 |
| is_bind_aware | bigint(20) | NO | 该计划已经打开了 ACS。 |
| db_id | bigint(20) unsigned | NO | 数据库 ID。 |
| statement | varchar(4096) | NO | 对于 SQL 计划，该字段为参数化后的 SQL 语句；对于匿名块对象，该字段为参数化后的匿名块语句；其他对象该字段无效。 |
| query_sql | varchar(65536) | NO | 对于 SQL 计划，字段为第一次加载计划时查询的原始 SQL 语句；对于匿名块字段，该字段为参数化后的匿名块语句。 |
| special_params | varchar(4096) | NO | 表示不可参数化的参数值。 |
| param_infos | varchar(65536) | NO | 表示参数化信息。 |
| sys_vars | varchar(4096) | NO | 影响计划的系统变量的值。 |
| plan_hash | bigint(20) unsigned | NO | SQL 计划的 Hash 值。 |
| first_load_time | timestamp(6) | NO | 第一次被加载时间。 |
| schema_version | bigint(20) | NO | Schema 版本号。 |
| merged_version | bigint(20) | NO | 当前缓存的计划对应的合并版本号。 |
| last_active_time | timestamp(6) | NO | 上一次被执行时间。 |
| avg_exe_usec | bigint(20) | NO | 平均执行时间。 |
| slowest_exe_time | timestamp(6) | NO | 最慢执行时间戳。 |
| slowest_exe_usec | bigint(20) | NO | 最慢一次执行的耗时。 |
| slow_count | bigint(20) | NO | 当前 SQL 计划成为慢查询的次数。 |
| hit_count | bigint(20) | NO | 被命中次数。 |
| plan_size | bigint(20) | NO | 缓存对象占用的内存大小。 |
| executions | bigint(20) | NO | 执行次数。 |
| disk_reads | bigint(20) | NO | 所有执行物理读的次数。 |
| direct_writes | bigint(20) | NO | 所有执行物理写的次数。 |
| buffer_gets | bigint(20) | NO | 所有执行逻辑读的次数。 |
| application_wait_time | bigint(20) unsigned | NO | 所有 Application 类事件的总时间。 |
| concurrency_wait_time | bigint(20) unsigned | NO | 所有 Concurrency 类事件的总时间。 |
| user_io_wait_time | bigint(20) unsigned | NO | 所有 user_io 类事件的总时间。 |
| rows_processed | bigint(20) | NO | 所有 Schedule 类事件的时间。 |
| elapsed_time | bigint(20) unsigned | NO | 接收到请求到执行结束所消耗的时间。 |
| cpu_time | bigint(20) unsigned | NO | 所有执行消耗的 CPU 时间。 |
| large_querys | bigint(20) | NO | 被判断为大查询的次数。 |
| delayed_large_querys | bigint(20) | NO | 被判断为大查询且被丢入大查询队列的次数。 |
| delayed_px_querys | bigint(20) | NO | 并行查询被丢回队列重试的次数。 |
| outline_version | bigint(20) | NO | Outline 版本号。 |
| outline_id | bigint(20) | NO | Outline 的 ID，为 -1 表示不是通过绑定 Outline 生成的计划。 |
| outline_data | varchar(65536) | NO | 计划对应的 Outline 信息。 |
| acs_sel_info | varchar(65536) | NO | 当前 ACS 计划对应的选择率空间。 |
| table_scan | tinyint(4) | NO | 表示该查询是否为主键扫描。 |
| evolution | tinyint(4) | NO | 表示该执行计划是否在演进中。 |
| evo_executions | bigint(20) | NO | 演进次数。 |
| evo_cpu_time | bigint(20) unsigned | NO | 演进过程中总的执行 CPU 时间。 |
| timeout_count | bigint(20) | NO | 超时的次数。 |
| ps_stmt_id | bigint(20) | NO | PreparedStatement 的 ID。 |
| sessid | bigint(20) unsigned | NO | 缓存对象所在的 Session ID. |
| temp_tables | varchar(65536) | NO | SQL 计划中包含的临时表表名，如果没有临时表，字段为空. |
| is_use_jit | tinyint(4) | NO | SQL 计划是否开启了表达式编译执行。 |
| object_type | varchar(65536) | NO | 缓存对象的类型： * SQL_PLAN * PROCEDURE * FUNCTION * PACKAGE * ANONYMOUS |
| hints_info | varchar(65536) | NO | SQL 计划的 Hint 信息。 |
| hints_all_worked | tinyint(4) | NO | SQL 计划中的 Hint 是否都已经生效 |
| pl_schema_id | bigint(20) unsigned | NO | 对于非匿名块的 PL 对象，字段为缓存对象的 Schema ID；对于匿名块，字段与 `ps_stmt_id` 相同；对于 SQL 计划，该字段无意义。 |
| is_batched_multi_stmt | tinyint(4) | NO | 表示是否为 Batched Multistmt 优化的计划。 |

34
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/20.gv-concurrent_limit_sql.md Normal file
View File

@ -0,0 +1,34 @@
gv$concurrent_limit_sql
============================================
功能
-----------
展示当前租户的所有限流信息。
相关表/视图
---------------
oceanbase.__tenant_virtual_concurrent_limit_sql
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------------|----------------|----------------|---------------------------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| database_id | bigint(20) | NO | 数据库 ID |
| outline_id | bigint(20) | NO | 限流对应的 outline ID |
| database_name | varchar(128) | NO | 数据库名称 |
| outline_name | varchar(128) | NO | 限流对应的 outline 名称 |
| outline_content | varchar(65536) | NO | 限流对应的 outline 内容，可以为 empty |
| visible_signature | varchar(65536) | NO | signature 的反序列化结果，为了便于查看signature 的信息 |
| sql_text | varchar(65536) | NO | 创建 outline 时，在 on clause 中指定的 SQL |
| concurrent_num | bigint(20) | NO | 当前 SQL 限制的并发数 |
| limit_target | varchar(65536) | NO | 被限流的 SQL |

39
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/21.gv-sql_plan_statistics.md Normal file
View File

@ -0,0 +1,39 @@
gv$sql_plan_statistics
===========================================
功能
-----------
展示整个集群中物理执行计划的统计信息。
相关表/视图
---------------
oceanbase.__all_virtual_sql_plan_statistics
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------|----------------|----------------|---------------|
| CON_ID | bigint(20) | NO | 租户 ID |
| SVR_IP | varchar(32) | NO | IP 地址 |
| SVR_PORT | bigint(20) | NO | 端口地址 |
| PLAN_ID | bigint(20) | NO | 物理计划 ID |
| OPERATION_ID | bigint(20) | N | 物理算子 ID |
| EXECUTIONS | bigint(20) | NO | 累计执行次数 |
| OUTPUT_ROWS | bigint(20) | NO | 累计算子输出行数 |
| INPUT_ROWS | bigint(20) | NO | 累计算子输入行数 |
| RESCAN_TIMES | bigint(20) | NO | 累计 Rescan 的次数 |
| BUFFER_GETS | bigint(20) | NO | Buffer 命中次数 |
| DISK_READS | bigint(20) | NO | 累计物理度盘次数 |
| DISK_WRITES | bigint(20) | NO | 累计物理写盘次数 |
| ELAPSED_TIME | bigint(20) | NO | 累计算子消耗时间 |
| EXTEND_INFO1 | varchar(65535) | NO | 暂未使用 |
| EXTEND_INFO2 | varchar(65535) | NO | 暂未使用 |

30
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/22.gv-server_memstore.md Normal file
View File

@ -0,0 +1,30 @@
gv$server_memstore
=======================================
功能
-----------
展示集群中每个 Server 中 memstore 的内存使用情况。
相关表/视图
---------------
oceanbase.__all_virtual_server_memory_info
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|-------------|----------------|--------------------|
| IP | varchar(32) | NO | 服务器的 IP |
| PORT | bigint(20) | NO | 服务器的端口 |
| ACTIVE | bigint(20) | NO | 当前活跃 Memstore 所占内存 |
| TOTAL | bigint(20) | NO | Memstore 一共使用了多少内存 |
| FREEZE_TRIGGER | bigint(20) | NO | 触发冻结的阈值 |
| MEM_LIMIT | bigint(20) | NO | Memstore 的内存限制 |

42
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/23.gv-unit_load_balance_event_history.md Normal file
View File

@ -0,0 +1,42 @@
gv$unit_load_balance_event_history
=======================================================
功能
-----------
记录整个集群中副本迁移的结果。
相关表/视图
---------------
oceanbase.__all_rootservice_event_history
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------|--------------|----------------|-----------------------|
| gmt_create | timestamp(6) | NO | 副本迁移发生的时间 |
| zone | varchar(256) | NO | 发生迁移的 Zone |
| table_id | varchar(256) | NO | 表 ID |
| partition_id | varchar(256) | NO | 分区 ID |
| data_size | varchar(256) | NO | 数据大小 |
| replica_type | varchar(256) | NO | 副本类型 |
| src_ip | varchar(256) | NO | 副本原 OBServer 的IP地址 |
| src_port | varchar(256) | NO | 副本原 OBServer 的端口 |
| dest_unit_id | varchar(256) | NO | 目的单元 ID |
| dest_ip | varchar(256) | NO | 副本目标 OBServer 的 IP 地址 |
| dest_port | varchar(256) | NO | 副本目标 OBServer 的断开 |
| data_src_ip | varchar(256) | NO | 静态数据来源 IP |
| data_src_port | varchar(256) | NO | 静态数据数据来源端口 |
| result_code | varchar(256) | YES | 迁移结果错误码 |
| result_str | varchar(27) | YES | 迁移结果信息 |
| comment | varchar(256) | YES | 备注 |
| rs_svr_ip | varchar(32) | YES | RS 的 IP 地址 |
| rs_svr_port | bigint(20) | YES | RS 的端口 |

32
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/24.gv-tenant.md Normal file
View File

@ -0,0 +1,32 @@
gv$tenant
==============================
功能
-----------
展示系统租户整个集群的信息。
相关表/视图
---------------
无
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------|---------------|----------------|------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| tenant_name | varchar(128) | NO | 租户的名称 |
| zone_list | varchar(8192) | NO | 租户的 Zone 集合 |
| primary_zone | varchar(128) | YES | 租户的 Primary Zone |
| collation_type | bigint(20) | NO | 租户的 Collation 信息 |
| info | varchar(4096) | NO | 租户的信息 |
| read_only | bigint(20) | NO | 租户是否为只读模式，该值已被废弃 |
| locality | varchar(256) | NO | 租户的副本分布方式 |

45
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/25.gv-database.md Normal file
View File

@ -0,0 +1,45 @@
gv$database
================================
功能
-----------
展示集群中所有数据库的 Meta 信息。
相关表/视图
---------------
* oceanbase.__all_database
* oceanbase.__all_tenant
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------------|---------------|----------------|-----------------------------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| tenant_name | varchar(128) | NO | 租户名称 |
| database_id | bigint(20) | NO | 数据库的 ID |
| database_name | varchar(128) | NO | 数据库的名称 |
| zone_list | varchar(8192) | NO | 数据库的 Locality 的 Zone 集合 |
| primary_zone | varchar(128) | YES | 数据库的 primary_zone |
| collation_type | bigint(20) | NO | 数据库的 collation 类型 |
| comment | varchar(2048) | NO | 注释 |
| read_only | bigint(20) | NO | 是否为只读模式 |
| default_tablegroup_id | bigint(20) | NO | 数据库缺省的表组 ID，若该值为 -1，则该数据库下不指定表组，建表会使用该值 |
| in_recyclebin | bigint(20) | NO | 表示数据库是否在回收站中 |

68
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/26.gv-table.md Normal file
View File

@ -0,0 +1,68 @@
gv$table
=============================
功能
-----------
展示整个集群中所有表的 Meta 信息。
相关表/视图
---------------
* oceanbase.__all_table
* oceanbase.__all_tenant
* oceanbase.__all_database
* oceanbase.__all_tablegroup
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------|---------------|----------------|--------------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| tenant_name | varchar(128) | NO | 租户名称 |
| table_id | bigint(20) | NO | 表ID |
| table_name | varchar(128) | NO | 表名 |
| database_id | bigint(20) | NO | 数据库ID |
| database_name | varchar(128) | NO | 数据库名称 |
| tablegroup_id | bigint(20) | NO | 表格组ID |
| tablegroup_name | varchar(128) | NO | 表格组名称 |
| table_type | bigint(20) | NO | 表类型 |
| zone_list | varchar(8192) | NO | 表的 Locality 所涉及的 Zone 集合 |
| primary_zone | varchar(128) | YES | 表的 primary_zone |
| collation_type | bigint(20) | NO | collation 的类型 |
| locality | varchar(256) | NO | 表的副本分布方式 |
| schema_version | bigint(20) | NO | Schema 的版本号 |
| read_only | bigint(20) | NO | 表是否只读 |
| comment | varchar(4096) | NO | 注释 |
| index_status | bigint(20) | NO | 索引状态 |
| index_type | bigint(20) | NO | 索引类型 |
| part_level | bigint(20) | NO | 分区表类型 |
| part_func_type | bigint(20) | NO | 一级分区的类型 |
| part_func_expr | varchar(4096) | NO | 一级分区的表达式 |
| part_num | bigint(20) | NO | 一级分区的个数 |
| sub_part_func_type | bigint(20) | NO | 二级分区的类型 |
| sub_part_func_expr | varchar(4096) | NO | 二级分区的表达式 |
| sub_part_num | bigint(20) | NO | 二级分区的个数 |
| dop | bigint(20) | NO | 查询的并行度 |

62
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/27.gv-unit.md Normal file
View File

@ -0,0 +1,62 @@
gv$unit
============================
功能
-----------
gv$unit 视图用于展示集群中所有 Unit 的 Meta 信息。
相关表/视图
---------------
* oceanbase.__all_unit
* oceanbase.__all_unit_config
* oceanbase.__all_resource_pool
* oceanbase.__all_tenant
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------------|--------------|----------------|------------------------|
| unit_id | bigint(20) | NO | 单元 ID |
| unit_config_id | bigint(20) | NO | 单元规格 ID |
| unit_config_name | varchar(128) | NO | 单元规格名 |
| resource_pool_id | bigint(20) | NO | 资源池 ID |
| resource_pool_name | varchar(128) | NO | 资源池名 |
| zone | varchar(128) | NO | 所属 zone |
| tenant_id | bigint(20) | NO | 租户 ID |
| tenant_name | varchar(128) | NO | 租户名称 |
| svr_ip | varchar(32) | NO | IP 地址 |
| svr_port | bigint(20) | NO | 端口 |
| migrate_from_svr_ip | varchar(32) | NO | Unit 的迁移来源 Server 的 IP |
| migrate_from_svr_port | bigint(20) | NO | Unit 的迁移来源 Server 的端口号 |
| max_cpu | double | NO | 最大虚拟 CPU 个数 |
| min_cpu | double | NO | 最小虚拟 CPU 个数 |
| max_memory | bigint(20) | NO | 最大内存使用量 |
| min_memory | bigint(20) | NO | 最小内存使用量 |
| max_iops | bigint(20) | NO | 最大 IOPS |
| min_iops | bigint(20) | NO | 最小 IOPS |
| max_disk_size | bigint(20) | NO | 最大磁盘使用量 |
| max_session_num | bigint(20) | NO | 最大 Session 个数 |

58
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/28.gv-partition.md Normal file
View File

@ -0,0 +1,58 @@
gv$partition
=================================
功能
-----------
展示集群中所有的 partition meta 信息。
相关表/视图
---------------
* oceanbase.__all_virtual_partition_table
* oceanbase.gv$table
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------------|---------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| table_id | bigint(20) | NO | 表 ID |
| tablegroup_id | bigint(20) | NO | 表组 ID |
| partition_id | bigint(20) | NO | 分区 ID |
| svr_ip | varchar(32) | NO | OBServer 的IP 地址 |
| svr_port | bigint(20) | NO | OBServer 的端口 |
| sql_port | bigint(20) | NO | OBServer SQL 端口 |
| unit_id | bigint(20) | NO | 单元 ID |
| partition_cnt | bigint(20) | NO | 分区个数，该值已被废弃，无意义 |
| zone | varchar(128) | NO | 副本所在的 Zone |
| role | bigint(20) | NO | 副本角色 * 1 ：leader * 2：follower |
| member_list | varchar(3520) | NO | Paxos 组中的成员列表 |
| row_count | bigint(20) | NO | 行数 |
| data_size | bigint(20) | NO | 数据大小 |
| data_version | bigint(20) | NO | 数据版本号 |
| partition_checksum | bigint(20) | NO | 分区校验码 |
| data_checksum | bigint(20) | NO | 数据校验码 |
| row_checksum | bigint(20) | NO | 行校验码 |
| column_checksum | varchar(8192) | NO | 列校验码 |
| rebuild | bigint(20) | NO | 是否处于 rebuild 状态 |
| replica_type | bigint(20) | NO | 副本类型 |
| required_size | bigint(20) | NO | 迁移所需的 size |
| status | varchar(64) | NO | 副本状态 |
| is_restore | bigint(20) | NO | 区分是否为正在逻辑/物理恢复的副本 |
| quorum | bigint(20) | NO | 仅` role=1` 的行的该值有效，表示 Paxos 组应有的成员数，用于计算多数派。 |

37
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/29.gv-lock_wait_stat.md Normal file
View File

@ -0,0 +1,37 @@
gv$lock_wait_stat
======================================
功能
-----------
整个集群中行锁的状态。
相关表/视图
---------------
oceanbase.__all_virtual_lock_wait_stat
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------|--------------|----------------|--------------|
| TENANT_ID | bigint(20) | NO | 租户 ID |
| TABLE_ID | bigint(20) | NO | 表 ID |
| TABLE_NAME | varchar(128) | NO | 表名 |
| ROWKEY | varchar(512) | NO | 主键 |
| SVR_IP | varchar(32) | NO | IP 地址 |
| SVR_PORT | bigint(20) | NO | 端口号 |
| SESSION_ID | bigint(20) | NO | 会话 ID |
| NEED_WAIT | tinyint(4) | NO | 是否需要等锁 |
| RECV_TS | bigint(20) | NO | 收到请求时间戳 |
| LOCK_TS | bigint(20) | NO | 最近一次上锁的时间戳 |
| ABS_TIMEOUT | bigint(20) | NO | 请求超时时刻 |
| TRY_LOCK_TIMES | bigint(20) | NO | 尝试上锁的次数 |
| TIME_AFTER_RECV | bigint(20) | NO | 收到请求到当前的时间间隔 |

40
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/3.gv-session_event.md Normal file
View File

@ -0,0 +1,40 @@
gv$session_event
=====================================
功能
-----------
gv$session_event 视图用于展示集群内所有 OBServer 的 Session 级别等待事件。
相关表/视图
---------------
oceanbase.__all_virtual_session_event
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------------|-------------|----------------|----------------------|
| SID | bigint(20) | NO | Session 的 ID |
| CON_ID | bigint(20) | NO | 租户 ID |
| SVR_IP | varchar(32) | NO | IP 地址 |
| SVR_PORT | bigint(20) | NO | 端口号 |
| EVENT_ID | bigint(20) | NO | 等待事件的 ID |
| EVENT | varchar(64) | NO | 等待事件的描述 |
| WAIT_CLASS_ID | bigint(20) | NO | 等待事件所属类型的 ID |
| WAIT_CLASS# | bigint(20) | NO | 等待事件所属类型的下标 |
| WAIT_CLASS | varchar(64) | NO | 等待事件所属类型的名称 |
| TOTAL_WAITS | bigint(20) | NO | 等待事件的总等待次数 |
| TOTAL_TIMEOUTS | bigint(20) | NO | 等待事件的总等待超时次数 |
| TIME_WAITED | double | NO | 等待事件的总等待时间，单位为百分之一秒 |
| MAX_WAIT | double | NO | 等待事件的最长等待时间，单位为百分之一秒 |
| AVERAGE_WAIT | double | NO | 等待事件的平均等待时间，单位为百分之一秒 |
| TIME_WAITED_MICRO | bigint(20) | NO | 等待事件的总等待时间（微秒） |

34
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/30.gv-session_longops.md Normal file
View File

@ -0,0 +1,34 @@
gv$session_longops
=======================================
功能
-----------
展示集群索引构建的进度。
相关表/视图
---------------
oceanbase.__all_virtual_long_ops_status
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------|---------------|----------------|-----------|
| SID | bigint(20) | NO | 会话 ID |
| OPNAME | varchar(128) | NO | 操作名称 |
| TARGET | varchar(128) | NO | 操作对象 |
| SVR_IP | varchar(32) | NO | 操作所在机器 IP |
| SVR_PORT | bigint(20) | NO | 操作所在机器端口号 |
| START_TIME | bigint(20) | NO | 开始时间 |
| ELAPSED_SECONDS | decimal(24,4) | NO | 已经消耗时间 |
| TIME_REMAINING | bigint(20) | NO | 预估剩余需要时间 |
| LAST_UPDATE_TIME | bigint(20) | NO | 统计信息更新时间 |
| MESSAGE | varchar(500) | NO | 备注信息 |

29
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/31.gv-tenant_memstore_allocator_info.md Normal file
View File

@ -0,0 +1,29 @@
gv$tenant_memstore_allocator_info
======================================================
功能
-----------
该视图展示了所连接 OBServer 上的 Memtable 的若干信息，主要用于排查租户 Memstore 内存长时间未释放的问题。每行记录对应单个 Memtable 的信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------------|-------------|----------------|-------------------------------------------|
| SVR_IP | varchar（32） | NO | OBServer 的 IP 地址 |
| SVR_PORT | bigint(20) | NO | OBServer 的端口 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| TABLE_ID | bigint(20) | NO | 表 ID |
| PARTITION_ID | bigint(20) | NO | 分区 ID |
| MT_BASE_VERSION | bigint(20) | NO | 该 Memtable 对应的起始事务版本 |
| RETIRE_CLOCK | bigint(20) | NO | 该 Memtable 所属的租户当前 Memstore 已分配内存总量 |
| MT_IS_FROZEN | bigint(20) | NO | 该 Memtable 是否已经冻结 |
| MT_PROTECTION_CLOCK | bigint(20) | NO | 该 Memtable 第一次分配内存时，所属租户 Memstore 已分配内存量。 |
| MT_SNAPSHOT_VERSION | bigint(20) | NO | 该 Memtable 的快照版本 |

25
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/32.gv-minor_merge_info.md Normal file
View File

@ -0,0 +1,25 @@
gv$minor_merge_info
========================================
功能
-----------
展示集群内部每个 Server 中不同租户级的转储起始时间
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-----------------|--------------|----------------|-----------|
| SVR_IP | varchar(32) | NO | 服务器 IP 地址 |
| SVR_PORT | bigint(20) | NO | 服务器端口号 |
| TENANT_ID | varchar(256) | NO | 租户 ID |
| FREEZE_SNAPSHOT | longtext | NO | 转储冻结时间戳 |
| START_TIME | timestamp(6) | NO | 转储开始时间 |
| FINISH_TIME | timestamp(6) | NO | 转储结束时间 |

30
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/33.gv-tenant_px_worker_stat.md Normal file
View File

@ -0,0 +1,30 @@
gv$tenant_px_worker_stat
=============================================
功能
-----------
在并行执行场景中，查看每个线程的执行信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------|--------------|----------------|--------------------|
| session_id | bigint(20) | NO | Session 的 ID |
| tenant_id | bigint(20) | NO | 租户 ID |
| svr_ip | varchar(32) | NO | OBServer 的机器 IP |
| svr_port | bigint(20) | NO | OBServe 机器 IP 下的端口 |
| trace_id | varchar(128) | NO | SQL 的 trace_id |
| qc_id | bigint(20) | NO | px 中的 qc_id |
| sqc_id | bigint(20) | NO | px 中的 sqc_id |
| worker_id | bigint(20) | NO | 线程 ID |
| dfo_id | bigint(20) | NO | px 中的 dfo_id |
| start_time | timestamp(6) | NO | 线程开始运行的时间 |

44
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/34.gv-partition_audit.md Normal file
View File

@ -0,0 +1,44 @@
gv$partition_audit
=======================================
功能
-----------
提供分区级别的统计信息，用于分区的性能统计。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------------------|-------------|----------------|-------------------------------|
| svr_ip | varchar(32) | NO | 服务器 IP。 |
| svr_port | bigint(20) | NO | 服务器端口。 |
| tenant_id | bigint(20) | NO | 租户 ID。 |
| table_id | bigint(20) | NO | 表 ID。 |
| partition_id | bigint(20) | NO | 分区 ID。 |
| partition_status | bigint(20) | NO | 分区状态。 |
| base_row_count | bigint(20) | NO | 基线数据行数，暂不可用。 |
| insert_row_count | bigint(20) | NO | 在表或分区上插入的行数。 |
| delete_row_count | bigint(20) | NO | 在表或分区上删除的行数。 |
| update_row_count | bigint(20) | NO | 在表或分区上更新的行数。 |
| query_row_count | bigint(20) | NO | 在表或分区上查询的行数，暂不可用。 |
| insert_sql_count | bigint(20) | NO | 在表或分区上执行的 SQL 插入操作的次数。 |
| delete_sql_count | bigint(20) | NO | 在表或分区上执行的 SQL 删除操作的次数。 |
| update_sql_count | bigint(20) | NO | 在表或分区上执行的 SQL 更新操作的次数。 |
| query_sql_count | bigint(20) | NO | 在表或分区上执行的 SQL 查询操作的次数，暂不可用。 |
| trans_count | bigint(20) | NO | 在表或分区上执行的事务操作的次数。 |
| sql_count | bigint(20) | NO | 在表或分区上执行的所有 SQL 操作的次数。 |
| rollback_insert_row_count | bigint(20) | NO | 在表或分区上执行的插入回滚的行数，暂不可用。 |
| rollback_delete_row_count | bigint(20) | NO | 在表或分区上执行的删除回滚的行数，暂不可用。 |
| rollback_update_row_count | bigint(20) | NO | 在表或分区上执行的更新回滚的行数，暂不可用。 |
| rollback_insert_sql_count | bigint(20) | NO | 在表或分区上执行的回滚 SQL 插入操作的次数，暂不可用。 |
| rollback_delete_sql_count | bigint(20) | NO | 在表或分区上执行的回滚 SQL 删除操作的次数，暂不可用。 |
| rollback_update_sql_count | bigint(20) | NO | 在表或分区上执行的回滚 SQL 更新操作的次数，暂不可用。 |
| rollback_trans_count | bigint(20) | NO | 在表或分区上执行的回滚事务操作的次数，暂不可用。 |
| rollback_sql_count | bigint(20) | NO | 在表或分区上执行的所有回滚 SQL 操作的次数，暂不可用。 |

26
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/35.gv-ps_stat.md Normal file
View File

@ -0,0 +1,26 @@
gv$ps_stat
===============================
功能
-----------
监控 PS Cache 的整体状态，包括命中率、内存占用、缓存的 item 数目。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------|-------------|----------------|---------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| svr_ip | varchar(32) | NO | 机器 IP |
| svr_port | bigint(20) | NO | 机器端口号 |
| stmt_count | bigint(20) | NO | PS Cache 中目前缓存了多少语句 |
| hit_count | bigint(20) | NO | PS Cache 总的命中次数 |
| access_count | bigint(20) | NO | 访问 PS Cache 的总次数 |
| mem_hold | bigint(20) | NO | PS Cache 占用了多少内存 |

32
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/36.gv-ps_item_info.md Normal file
View File

@ -0,0 +1,32 @@
gv$ps_item_info
====================================
功能
-----------
用于给 prepared statement 提供监控功能，包含 PS Cache 中所有 prepare statement 的基本信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------------|----------------|----------------|----------------------------|
| tenant_id | bigint(20) | NO | 租户 ID |
| svr_ip | varchar(32) | NO | 机器 IP |
| svr_port | bigint(20) | NO | 机器端口号 |
| stmt_id | bigint(20) | NO | PS Cache 中对应语句的 stmt_id 信息 |
| db_id | bigint(20) | NO | prepare 语句涉及到的数据库 ID |
| ps_sql | varchar(65536) | NO | prepare 的 SQL 信息 |
| param_count | bigint(20) | NO | prepare 的参数个数信息 |
| stmt_item_ref_count | bigint(20) | NO | stmt_item 的引用计数信息 |
| stmt_info_ref_count | bigint(20) | NO | stmt_info 的引用计数信息 |
| mem_hold | bigint(20) | NO | 该 prepare stmt 占用的内存大小 |
| stmt_type | bigint(20) | NO | 该 prepare stmt 的类型信息 |
| checksum | bigint(20) | NO | 该 prepare stmt 的 checksum |

41
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/37.gv-sql_workarea.md Normal file
View File

@ -0,0 +1,41 @@
gv$sql_workarea
====================================
功能
-----------
之前受 SQL 自动内存管理负责执行的所有 Operator 的 workarea 统计信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------------|--------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------|
| address | varbinary(8) | NO | SQL 对应的 Handle 地址，目前未指定值 |
| hash_value | bigint(0) | NO | 语句的 Hash Value 的值 |
| sql_id | varchar(32) | NO | SQL 语句的 SQL 唯一标示 |
| child_number | bigint(0) | NO | 该 cursor 的数量 |
| workarea_address | varbinary(8) | NO | workarea 地址 |
| operation_type | varchar(40) | NO | workarea 操作符类型，例如 Sort、Hash Join、Group by 等 |
| operation_id | bigint(20) | NO | 计划树中识别操作符的唯一标示 |
| policy | varchar(10) | NO | workarea 的策略： * MANUAL * AUTO |
| estimated_optimal_size | bigint(20) | NO | 在最优情况下执行操作符的估算内存大小，单位：bytes |
| estimated_onepass_size | bigint(20) | NO | 在 one pass 场景下，执行操作符估算内存大小，单位：bytes |
| last_memory_used | bigint(20) | NO | 游标在上次执行使用的内存大小，单位：bytes |
| last_execution | varchar(10) | NO | 上次执行时 workarea 选择的是 optimal、one pass 还是 multi passes |
| last_degree | bigint(20) | NO | 上次执行并行度 |
| total_executions | bigint(20) | NO | 总共执行使用 workarea 的次数 |
| optimal_executions | bigint(20) | NO | 最优场景下执行的次数 |
| onepass_executions | bigint(20) | NO | One Pass 场景执行的次数 |
| multipasses_executions | bigint(20) | NO | Multi Passes 场景执行的次数 |
| active_time | bigint(20) | NO | workarea 活跃时的平均时间，单位：s |
| max_tempseg_size | bigint(20) | NO | workarea 使用时最大的临时磁盘空间，单位：bytes；如果是 NULL，则表示未使用临时空间 |
| last_tempseg_size | bigint(20) | NO | workarea 上次执行时使用的临时磁盘空间；如果是 NULL，表示未使用临时空间 |
| con_id | bigint(20) | NO | 租户 ID |

27
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/38.gv-sql_workarea_histogram.md Normal file
View File

@ -0,0 +1,27 @@
gv$sql_workarea_histogram
==============================================
功能
-----------
展示之前所有 workarea执行的统计信息，如在区间 1 M～2 M 之间全 in-memory 处理的次数、one-pass 次数等。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------------|------------|----------------|------------------------------------------|
| low_optimal_size | bigint(20) | NO | workarea 在 optimal 模式下的最低内存量 |
| high_optimal_size | bigint(20) | NO | workarea 在 optimal 模式下的最高内存量 |
| optimal_executions | bigint(20) | NO | workarea 在最低和最高区间的最优模式下执行的次数 |
| onepass_executions | bigint(20) | NO | workarea 在最低和最高区间的 one pass 模式下执行的次数 |
| multipasses_executions | bigint(20) | NO | workarea 在最低和最高区间的 multi passes 模式下执行的次数 |
| total_executions | bigint(20) | NO | workarea 总共执行的次数 |
| con_id | bigint(20) | NO | 租户 ID |

27
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/39.gv-ob_sql_workarea_memory_info.md Normal file
View File

@ -0,0 +1,27 @@
gv$ob_sql_workarea_memory_info
===================================================
功能
-----------
用于查询 SQL workarea 总体的一些信息，如最大可用内存、当前使用内存、当前 hold 内存等。通过该视图可以知道当前租户下，workarea 的使用情况，包括内存利用率等。
**字段说明**
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|------------------------|------------|----------------|------------------------------------------------------------------------------------------------------------------------|
| max_workarea_size | bigint(20) | NO | 最大 workarea 内存，由参数决定可以使用多少内存 |
| workarea_hold_size | bigint(20) | NO | workarea 当前 hold 内存大小。 **说明** 由于具体的使用量无法从内存管理模块获取到，故只能获取 hold 值。 |
| max_auto_workarea_size | bigint(20) | NO | auto 时，预计最大可用内存大小可以简单认为最大可用内存会根据公式`max_work_area_size - hold + total_mem_used` 进行计算得到，表示当前 workarea 情况下，auto 管理的最大内存大小 |
| mem_target | bigint(20) | NO | 当前 workarea 可用内存的目标大小。与 max_auto_work_area 的区别在于该值是 max_auto_work_area 值的一定比例 |
| total_mem_used | bigint(20) | NO | 当前 auto 内存使用大小，这里是由 SQL 自动内存管理模块统计的大小，不是真正使用大小 |
| global_mem_bound | bigint(20) | NO | auto 模式下，全局最大可用内存大小 |
| drift_size | bigint(20) | NO | 当前需求内存变化大小，主要用来当波动一定范围，会自动触发重新计算 global bound size |
| workarea_count | bigint(20) | NO | 注册的 operator profile 个数 |
| manual_calc_count | bigint(20) | NO | 非定时触发的计算 global bound size 次数 |

42
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/4.gv-session_wait.md Normal file
View File

@ -0,0 +1,42 @@
gv$session_wait
====================================
功能
-----------
该视图用于展示所有服务器上所有 Session 的当前或者上一次等待事件的一些信息，包括等待事件名称、等待耗时等。
相关表/视图
---------------
__all_virtual_session_event
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------------------|---------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| SID | bigint(20) | NO | Session ID |
| CON_ID | bigint(20) | NO | 租户 ID |
| SVR_IP | varchar(32) | NO | 服务器的 IP |
| SVR_PORT | bigint(20) | NO | 服务器端口 |
| EVENT | varchar(64) | NO | 等待事件名称 |
| P1TEXT | varchar(64) | NO | 等待事件的第一个参数的描述 |
| P1 | bigint(20) unsigned | NO | 等待事件的第一个参数的值 |
| P2TEXT | varchar(64) | NO | 等待事件的第二个参数的描述 |
| P2 | bigint(20) unsigned | NO | 等待事件的第二个参数的值 |
| P3TEXT | varchar(64) | NO | 等待事件的第三个参数的描述 |
| P3 | bigint(20) unsigned | NO | 等待事件的第三个参数的值 |
| WAIT_CLASS_ID | bigint(20) | NO | 等待事件的类别 ID |
| WAIT_CLASS# | bigint(20) | NOT NULL | 等待事件的类别序号 |
| WAIT_CLASS | varchar(64) | NO | 等待事件的类别名称 |
| STATE | varchar(19) | NO | 当前等待事件的状态，包含四种状态： * Waiting：Session 正等待这个事件。 * Waited unknown time：由于设置了 timed_statistics 值为 false，导致不能得到时间信息。表示发生了等待，但时间很短。 * Wait short time：表示发生了等待，但由于时间非常短不超过一个时间单位，所以没有记录。 * Waited knnow time：如果 Session 等待然后得到了所需资源，那么将从 waiting 进入本状态。 |
| WAIT_TIME_MICRO | bigint(20) | NO | 等待时间，单位为微秒。如果当前正在等待，表示已经等待的时长；如果当前没有等待，表示最后一次等待的总等待时长。 |
| TIME_REMAINING_MICRO | bigint(20) | NO | * 值\> 0：最后一次等待时间（单位：毫秒），当前未在等待状态。 * 值为 0：Session 正在等待当前的事件。 * 值为 -1：最后一次等待时间小于 1 个统计单位，当前未在等待状态。 * 值为 -2：时间统计状态未置为可用，当前未在等待状态。 |
| TIME_SINCE_LAST_WAIT_MICRO | bigint(20) | NO | 上一次等待结束到现在的时间，单位为毫秒，如果当前正在等待，其值为 0。 |

28
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/40.gv-server_schema_info.md Normal file
View File

@ -0,0 +1,28 @@
gv$server_schema_info
==========================================
功能
-----------
展示所有 Server 上的 Schema 信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------------------------|-------------|----------------|---------------------------------|
| SVR_IP | varchar(32) | NO | Server 的 IP 地址 |
| SVR_PORT | int | NO | Server 的端口号 |
| TENANT_ID | int | NO | 租户 ID |
| REFRESHED_SCHEMA_VERSION | int | NO | 租户已刷新的 Schema 版本 |
| RECEIVED_SCHEMA_VERSION | int | NO | 租户应该要刷新的 Schema 版本 |
| SCHEMA_COUNT | int | NO | 租户的 Schema 数量 |
| SCHEMA_SIZE | int | NO | 租户的 Schema 大小 |
| MIN_SSTABLE_SCHEMA_VERSION | int | NO | 租户 Sstable 上记录的最小schema_version |

33
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/41.gv-merge_info.md Normal file
View File

@ -0,0 +1,33 @@
gv$merge_info
==================================
功能
-----------
展示 OceanBase 集群已经完成的合并或转储相关的统计信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------------|---------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| svr_ip | varchar(32) | NO | 服务器 IP 地址 |
| svr_port | bigint(20) | NO | 服务器端口号 |
| tenant_id | bigint(20) | NO | 租户 ID |
| table_id | bigint(20) | NO | 表 ID |
| partition_id | bigint(20) | NO | 分区 ID |
| type | varchar(5) | NO | 合并或转储类型： * minor * major |
| action | varchar(64) | NO | 合并或转储具体动作： * mini * mini minor * buffer minor * minor |
| version | varchar(64) | NO | 合并或转储版本号 |
| start_time | timestamp(6) | NO | 合并或转储开始时间 |
| end_time | timestamp | NO | 合并或转储结束时间 |
| macro_block_count | bigint(20) | NO | 合并或转储宏块总数 |
| reuse_pct | decimal(26,2) | NO | 合并或转储宏块重用率 |
| parallel_degree | bigint(20) | NO | 合并或转储并行度 |

31
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/42.gv-lock.md Normal file
View File

@ -0,0 +1,31 @@
gv$lock
============================
功能
-----------
展示 OceanBase 数据库的行锁信息。
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|----------|---------------------|----------------|-------------------|
| SVR_IP | varchar(32) | NO | 服务器 IP |
| SVR_PORT | bigint(20) | NO | 服务器端口号 |
| TABLE_ID | bigint(20) | NO | 表 ID |
| ADDR | varchar(512) | NO | 被锁对象的地址 |
| KADDR | bigint(20) unsigned | NO | 锁地址 |
| SID | bigint(20) | NO | 会话持有的 ID |
| TYPE | bigint(20) | NO | 0（行锁） |
| LMODE | bigint(20) | NO | 0（写锁） |
| REQUEST | bigint(0) | YES | NULL |
| CTIME | bigint(21) | NO | 加锁耗时 |
| BLOCK | bigint(20) | NO | 最早被阻塞的 session_id |
| CON_ID | bigint(20) unsigned | NO | 租户ID |

43
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/43.gv-sstable.md Normal file
View File

@ -0,0 +1,43 @@
gv$sstable
===============================
功能
-----------------------
gv$sstable 视图用于展示租户的 SSTable 信息。
字段说明
-------------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|--------------------------------|---------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| SVR_IP | varchar(46) | NO | 服务器的 IP 地址 |
| SVR_PORT | bigint(20) | NO | 服务器的端口号 |
| TABLE_TYPE | bigint(20) | NO | 表的类型 |
| TABLE_ID | bigint(20) | NO | 表 ID |
| TABLE_NAME | varchar(256) | NO | 表名 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| PARTITION_ID | bigint(20) | NO | 分区 ID |
| INDEX_ID | bigint(20) | NO | 主表或索引表的 ID |
| BASE_VERSION | bigint(20) | NO | 该表中存储数据的 `trans_version` 范围的最小值 |
| MULTI_VERSION_START | bigint(20) | NO | 该表中多版本数据的起始 `trans_version` |
| SNAPSHOT_VERSION | bigint(20) | NO | 该表中存储数据的 `trans_version` 范围的最大值 |
| START_LOG_TS | bigint(20) unsigned | NO | 该表中数据的日志时间戳范围的左边界 |
| END_LOG_TS | bigint(20) unsigned | NO | 该表中数据的日志时间戳范围的右边界 |
| MAX_LOG_TS | bigint(20) unsigned | NO | 该表中数据的日志时间戳范围的最大值 |
| VERSION | bigint(20) | NO | 该表的版本 |
| LOGICAL_DATA_VERSION | bigint(20) | NO | 该表的逻辑数据版本 |
| SIZE | bigint(20) | NO | 该表的大小 |
| IS_ACTIVE | bigint(20) | NO | 该表是否处于活跃状态 |
| REF | bigint(20) | NO | 该表引用的计数 |
| WRITE_REF | bigint(20) | NO | 该表写引用的计数 |
| TRX_COUNT | bigint(20) | NO | 该表上活跃事务的数量 |
| PENDING_LOG_PERSISTING_ROW_CNT | bigint(20) | NO | 持久化 Redo Log 的回收数量 |
| UPPER_TRANS_VERSION | bigint(20) | NO | 该表中存储数据的 `trans_version` 的上限 |
| CONTAIN_UNCOMMITTED_ROW | tinyint(4) | NO | 该表中是否包含未提交的事务行： * 0：表示该表中不包含未提交的事务行 * 1：表示该表中包含未提交的事务行 |

28
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/44.gv-ob_trans_table_status.md Normal file
View File

@ -0,0 +1,28 @@
gv$ob_trans_table_status
=============================================
功能
-----------------------
从 OceanBase 数据库 V3.0.0 版本开始，系统开始支持转储未提交的事务，而未提交事务中的数据可能会转储到 SSTable 中，故将这些未提交的事务称为脏事务，一般比较大的事务容易成为脏事务。
`gv$ob_trans_table_status` 视图用于展示每次冻结后产生的脏事务的详细信息。
字段说明
-------------------------
| 字段名称 | 类型 | 是否可以为 NULL | 描述 |
|--------------|-------------|------------|---------------|
| SVR_IP | varchar(46) | NO | 对应服务器的 IP 地址 |
| SVR_PORT | bigint(20) | NO | 对应服务器的端口号 |
| TENANT_ID | bigint(20) | NO | 租户 ID |
| TABLE_ID | bigint(20) | NO | 表 ID |
| PARTITION_ID | bigint(20) | NO | 分区 ID |
| END_LOG_ID | bigint(20) | NO | 已持久化的事务日志的 ID |
| TRANS_CNT | bigint(20) | NO | 脏事务的数量 |

30
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/45.v-statname.md Normal file
View File

@ -0,0 +1,30 @@
v$statname
===============================
功能
-----------
用于展示所有统计事件的相关定义。
相关表/视图
---------------
__tenant_virtual_staname
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|--------------|-------------|----------------|-------------|
| CON_ID | bigint(20) | NO | 租户的 ID |
| STAT_ID | bigint(20) | NO | 统计事件的 ID |
| STATISTICS# | bigint(20) | NO | 统计事件的下标 |
| NAME | varchar(64) | NO | 统计事件的名称 |
| DISPLAY_NAME | varchar(64) | NO | 统计事件的别名 |
| CLASS | bigint(20) | NO | 统计事件所属类型别名称 |

35
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/46.v-event_name.md Normal file
View File

@ -0,0 +1,35 @@
v$event_name
=================================
功能
-----------
当前 OBServer 上所有统计事件的相关定义。
相关表/视图
---------------
__tenant_virtual_event_name
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|---------------|-------------|----------------|--------------|
| CON_ID | bigint(20) | NO | 租户的 ID |
| EVENT_ID | bigint(20) | NO | 等待事件的 ID |
| EVENT# | bigint(20) | NO | 等待事件的下标 |
| NAME | varchar(64) | NO | 等待事件的名称 |
| DISPLAY_NAME | varchar(64) | NO | 等待事件的别名 |
| PARAMETER1 | varchar(64) | NO | 等待事件的参数 1 |
| PARAMETER2 | varchar(64) | NO | 等待事件的参数 2 |
| PARAMETER3 | varchar(64) | NO | 等待事件的参数 3 |
| WAIT_CLASS_ID | bigint(20) | NO | 等待事件所属类型的 ID |
| WAIT_CALSS# | bigint(20) | NO | 等待事件所属类型的下标 |
| WAIT_CLASS | varchar(64) | NO | 等待事件所属类型的名称 |

37
docs/docs-cn/13.reference-guide/1.system-view/3.performance-view/47.v-session_event.md Normal file
View File

@ -0,0 +1,37 @@
v$session_event
====================================
功能
-----------
统计每一个 Session 发生的等待事件。
相关表/视图
---------------
gv$session_event
字段说明
-------------
| **字段名称** | **类型** | **是否可以为 NULL** | **描述** |
|-------------------|-------------|----------------|---------------------|
| SID | bigint(20) | NO | Session 的 ID |
| CON_ID | bigint(20) | NO | 租户的 ID |
| EVENT_ID | bigint(20) | NO | 等待事件的 ID |
| EVENT | varchar(64) | NO | 等待事件的描述 |
| WAIT_CLASS_ID | bigint(20) | NO | 等待事件所属类型的 ID |
| WAIT_CLASS# | bigint(20) | NO | 等待事件所属类型的下标 |
| WAIT_CLASS | varchar(64) | NO | 等待事件所属类型的名称 |
| TOTAL_WAITS | bigint(20) | NO | 等待事件的总等待次数 |
| TOTAL_TIMEOUTS | bigint(20) | NO | 等待事件的总等待超时次数 |
| TIME_WAITED | double | NO | 等待事件的总等待时间，单位 10ms |
| MAX_WAIT | double | NO | 等待事件的最长等待时间，单位 10ms |
| AVERAGE_WAIT | double | NO | 等待事件的平均等待时间，单位 10ms |
| TIME_WAITED_MICRO | bigint(20) | NO | 等待事件的总等待时间（微秒） |

Some files were not shown because too many files have changed in this diff Show More