22-meta.md 17.4 KB
Newer Older
1
---
2 3
sidebar_label: Metadata
title: Information_Schema Database
4 5
---

6
TDengine includes a built-in database named `INFORMATION_SCHEMA` to provide access to database metadata, system information, and status information. This information includes database names, table names, and currently running SQL statements. All information related to TDengine maintenance is stored in this database. It contains several read-only tables. These tables are more accurately described as views, and they do not correspond to specific files. You can query these tables but cannot write data to them. The INFORMATION_SCHEMA database is intended to provide a unified method for SHOW commands to access data. However, using SELECT ... FROM INFORMATION_SCHEMA.tablename offers several advantages over SHOW commands:
7

8 9 10 11 12
1. You can use a USE statement to specify the INFORMATION_SCHEMA database as the current database.
2. You can use the familiar SELECT syntax to access information, provided that you know the table and column names.
3. You can filter and order the query results. More generally, you can use any SELECT syntax that TDengine supports to query the INFORMATION_SCHEMA database.
4. Future versions of TDengine can add new columns to INFORMATION_SCHEMA tables without affecting existing business systems.
5. It is easier for users coming from other database management systems. For example, Oracle users can query data dictionary tables.
13

14 15 16
:::info

- SHOW statements are still supported for the convenience of existing users.
17
- Some columns in the system table may be keywords, and you need to use the escape character '\`' when querying, for example, to query the VGROUPS in the database `test`:
18 19 20 21 22
```sql 
   select `vgroups` from ins_databases where name = 'test';
``` 

:::
23

24
This document introduces the tables of INFORMATION_SCHEMA and their structure.
25 26 27

## INS_DNODES

28
Provides information about dnodes. Similar to SHOW DNODES.
29

30
| #   |    **Column**    | **Data Type** | **Description**                  |
31
| --- | :------------: | ------------ | ------------------------- |
32 33 34 35 36 37 38
| 1   |     vnodes     | SMALLINT     | Current number of vnodes on the dnode |
| 2   |     vnodes     | SMALLINT     | Maximum number of vnodes on the dnode |
| 3   |     status     | BINARY(10)   | Current status                  |
| 4   |      note      | BINARY(256)  | Reason for going offline or other information            |
| 5   |       id       | SMALLINT     | Dnode ID                  |
| 6   |    endpoint    | BINARY(134)  | Dnode endpoint              |
| 7   |     create     | TIMESTAMP    | Creation time                  |
39 40 41

## INS_MNODES

42
Provides information about mnodes. Similar to SHOW MNODES.
43

44
| #   |    **Column**    | **Data Type** | **Description**                  |
45
| --- | :---------: | ------------ | ------------------ |
46 47 48 49 50
| 1   |       id       | SMALLINT     | Mnode ID                  |
| 2   |    endpoint    | BINARY(134)  | Mnode endpoint              |
| 3   |    role     | BINARY(10)   | Current role           |
| 4   |  role_time  | TIMESTAMP    | Time at which the current role was assumed |
| 5   | create_time | TIMESTAMP    | Creation time           |
51 52 53

## INS_MODULES

54
Provides information about modules. Similar to SHOW MODULES.
55

56
| #   |    **Column**    | **Data Type** | **Description**                  |
57
| --- | :------: | ------------ | ---------- |
58 59 60
| 1   |       id       | SMALLINT     | Module ID                  |
| 2   |    endpoint    | BINARY(134)  | Module endpoint              |
| 3   |  module  | BINARY(10)   | Module status   |
61 62 63

## INS_QNODES

64
Provides information about qnodes. Similar to SHOW QNODES.
65

66
| #   |    **Column**    | **Data Type** | **Description**                  |
67
| --- | :---------: | ------------ | ------------ |
68 69 70
| 1   |       id       | SMALLINT     | Qnode ID                  |
| 2   |    endpoint    | BINARY(134)  | Qnode endpoint              |
| 3   | create_time | TIMESTAMP    | Creation time           |
71 72 73

## INS_CLUSTER

74
Provides information about the cluster.
75

76
| #   |    **Column**    | **Data Type** | **Description**                  |
77
| --- | :---------: | ------------ | ---------- |
78 79 80
| 1   |     id      | BIGINT       | Cluster ID |
| 2   |    name     | BINARY(134)  | Cluster name   |
| 3   | create_time | TIMESTAMP    | Creation time           |
81 82 83

## INS_DATABASES

84
Provides information about user-created databases. Similar to SHOW DATABASES.
85

86
| #   |    **Column**    | **Data Type** | **Description**                  |
87
| --- | :------------------: | ---------------- | ------------------------------------------------ |
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
| 1| name| BINARY(32)| Database name |
| 2   | create_time | TIMESTAMP    | Creation time           |
| 3   |       ntables        | INT              | Number of standard tables and subtables (not including supertables) |
| 4   |       vgroups        | INT              | Number of vgroups                           |
| 6   |       replica        | INT              | Number of replicas                                           |
| 7   |        quorum        | BINARY(3)        | Strong consistency                                         |
| 8   |       duration       | INT              | Duration for storage of single files                         |
| 9   |         keep         | INT              | Data retention period                                     |
| 10  |        buffer        | INT              | Write cache size per vnode, in MB           |
| 11  |       pagesize       | INT              | Page size for vnode metadata storage engine, in KB   |
| 12  |        pages         | INT              | Number of pages per vnode metadata storage engine            |
| 13  |       minrows        | INT              | Maximum number of records per file block                           |
| 14  |       maxrows        | INT              | Minimum number of records per file block                           |
| 15  |         comp         | INT              | Compression method                                     |
| 16  |      precision       | BINARY(2)        | Time precision                                      |
| 17  |        status        | BINARY(10)       | Current database status                                       |
| 18  |      retention       | BINARY (60)      | Aggregation interval and retention period                         |
| 19  |    single_stable     | BOOL             | Whether the database can contain multiple supertables           |
| 20  |      cachemodel      | BINARY(60)       | Caching method for the newest data               |
| 21  |      cachesize       | INT              | Memory per vnode used for caching the newest data  |
| 22  |      wal_level       | INT              | WAL level                                     |
| 23  |   wal_fsync_period   | INT              | Interval at which WAL is written to disk  |
| 24  | wal_retention_period | INT              | WAL retention period                                   |
| 25  |  wal_retention_size  | INT              | Maximum WAL size                                   |
| 26  |   wal_roll_period    | INT              | WAL rotation period                                 |
113
| 27  |   wal_segment_size   | BIGINT | WAL file size |
114 115 116
| 28  |   stt_trigger   | SMALLINT | The threshold for number of files to trigger file merging |
| 29  |   table_prefix   | SMALLINT | The prefix length in the table name that is ignored when distributing table to vnode based on table name |
| 30  |   table_suffix   | SMALLINT | The suffix length in the table name that is ignored when distributing table to vnode based on table name |
117
| 31  |   tsdb_pagesize   | INT | The page size for internal storage engine, its unit is KB |
118 119 120

## INS_FUNCTIONS

121
Provides information about user-defined functions.
122

123
| #   |    **Column**    | **Data Type** | **Description**                  |
124
| --- | :---------: | ------------ | -------------- |
125 126 127 128 129 130 131
| 1   |    name     | BINARY(64)   | Function name         |
| 2   |   comment   | BINARY(255)  | Function description       |
| 3   |  aggregate  | INT          | Whether the UDF is an aggregate function |
| 4   | output_type | BINARY(31)   | Output data type       |
| 5   | create_time | TIMESTAMP    | Creation time       |
| 6   |  code_len   | INT          | Length of the source code       |
| 7   |   bufsize   | INT          | Buffer size    |
132 133 134

## INS_INDEXES

135
Provides information about user-created indices. Similar to SHOW INDEX.
136

137
| #   |    **Column**    | **Data Type** | **Description**                  |
138
| --- | :--------------: | ------------ | ---------------------------------------------------------------------------------- |
139 140 141 142 143 144
| 1   |     db_name      | BINARY(32)   | Database containing the table with the specified index                                                       |
| 2   |     table_name      | BINARY(192)   | Table containing the specified index                                                       |
| 3   |    index_name    | BINARY(192)  | Index name                                                                             |
| 4   |     db_name      | BINARY(64)   | Index column                                                       |
| 5   |    index_type    | BINARY(10)   | SMA or FULLTEXT index                                                             |
| 6   | index_extensions | BINARY(256)  | Other information For SMA indices, this shows a list of functions. For FULLTEXT indices, this is null. |
145 146 147

## INS_STABLES

148
Provides information about supertables.
149

150
| #   |    **Column**    | **Data Type** | **Description**                  |
151
| --- | :-----------: | ------------ | ------------------------ |
152 153 154 155 156 157 158 159 160 161
| 1   |  stable_name  | BINARY(192)  | Supertable name               |
| 2   |    db_name    | BINARY(64)   | All databases in the supertable |
| 3   |  create_time  | TIMESTAMP    | Creation time                 |
| 4   |    columns    | INT          | Number of columns                   |
| 5   |     tags      | INT          | Number of tags                |
| 6   |  last_update  | TIMESTAMP    | Last updated time             |
| 7   | table_comment | BINARY(1024) | Table description                   |
| 8   |   watermark   | BINARY(64)   | Window closing time           |
| 9   |   max_delay   | BINARY(64)   | Maximum delay for pushing stream processing results  |
| 10  |    rollup     | BINARY(128)  | Rollup aggregate function          |
162 163 164

## INS_TABLES

165
Provides information about standard tables and subtables.
166

167
| #   |    **Column**    | **Data Type** | **Description**                  |
168
| --- | :-----------: | ------------ | ---------------- |
169 170 171 172 173 174 175 176 177 178
| 1   |  table_name   | BINARY(192)  | Table name             |
| 2   |    db_name    | BINARY(64)   | Database name         |
| 3   |  create_time  | TIMESTAMP    | Creation time         |
| 4   |    columns    | INT          | Number of columns           |
| 5   |  stable_name  | BINARY(192)  | Supertable name |
| 6   |      uid      | BIGINT       | Table ID            |
| 7   |   vgroup_id   | INT          | Vgroup ID        |
| 8   |      ttl      | INT          | Table time-to-live    |
| 9   | table_comment | BINARY(1024) | Table description           |
| 10  |     type      | BINARY(20)   | Table type           |
179 180 181

## INS_TAGS

182
| #   |    **Column**    | **Data Type** | **Description**                  |
183
| --- | :---------: | ------------- | ---------------------- |
184 185 186 187 188 189
| 1   | table_name  | BINARY(192)   | Table name                   |
| 2   |   db_name   | BINARY(64)    | Database name |
| 3   | stable_name | BINARY(192)   | Supertable name       |
| 4   |  tag_name   | BINARY(64)    | Tag name             |
| 5   |  tag_type   | BINARY(64)    | Tag type             |
| 6   |  tag_value  | BINARY(16384) | Tag value               |
190 191 192

## INS_USERS

193
Provides information about TDengine users.
194

195
| #   |    **Column**    | **Data Type** | **Description**                  |
196
| --- | :---------: | ------------ | -------- |
197 198 199
| 1   |  user_name  | BINARY(23)   | User name   |
| 2   |  privilege  | BINARY(256)  | User permissions     |
| 3   | create_time | TIMESTAMP    | Creation time |
200 201 202

## INS_GRANTS

203
Provides information about TDengine Enterprise Edition permissions.
204

205
| #   |    **Column**    | **Data Type** | **Description**                  |
206
| --- | :---------: | ------------ | -------------------------------------------------- |
207 208 209 210 211 212 213 214 215 216 217 218 219 220
| 1   |   version   | BINARY(9)    | Whether the deployment is a licensed or trial version |
| 2   |  cpu_cores  | BINARY(9)    | CPU cores included in license                           |
| 3   |   dnodes    | BINARY(10)   | Dnodes included in license                         |
| 4   |   streams   | BINARY(10)   | Streams included in license                                   |
| 5   |    users    | BINARY(10)   | Users included in license                                 |
| 6   |   streams   | BINARY(10)   | Accounts included in license                                   |
| 7   |   storage   | BINARY(21)   | Storage space included in license                             |
| 8   | connections | BINARY(21)   | Client connections included in license                           |
| 9   |  databases  | BINARY(11)   | Databases included in license                               |
| 10  |    speed    | BINARY(9)    | Write speed specified in license (data points per second)                       |
| 11  |  querytime  | BINARY(9)    | Total query time specified in license                               |
| 12  | timeseries  | BINARY(21)   | Number of metrics included in license                                 |
| 13  |   expired   | BINARY(5)    | Whether the license has expired                |
| 14  | expire_time | BINARY(19)   | When the trial period expires                                     |
221 222 223

## INS_VGROUPS

224
Provides information about vgroups.
225

226
| #   |    **Column**    | **Data Type** | **Description**                  |
227
| --- | :-------: | ------------ | ------------------------------------------------------ |
228 229 230 231 232 233 234 235 236 237 238 239 240
| 1   | vgroup_id | INT          | Vgroup ID                                              |
| 2   |  db_name  | BINARY(32)   | Database name                                               |
| 3   |  tables   | INT          | Tables in vgroup                                  |
| 4   |  status   | BINARY(10)   | Vgroup status                                       |
| 5   | v1_dnode  | INT          | Dnode ID of first vgroup member                           |
| 6   | v1_status | BINARY(10)   | Status of first vgroup member                                       |
| 7   | v2_dnode  | INT          | Dnode ID of second vgroup member                           |
| 8   | v2_status | BINARY(10)   | Status of second vgroup member                                       |
| 9   | v3_dnode  | INT          | Dnode ID of third vgroup member                          |
| 10  | v3_status | BINARY(10)   | Status of third vgroup member                                       |
| 11  |  nfiles   | INT          | Number of data and metadata files in the vgroup                      |
| 12  | file_size | INT          | Size of the data and metadata files in the vgroup                      |
| 13  |   tsma    | TINYINT      | Whether time-range-wise SMA is enabled. 1 means enabled; 0 means disabled. |
241 242 243

## INS_CONFIGS

244
Provides system configuration information.
245

246
| #   |    **Column**    | **Data Type** | **Description**                  |
247
| --- | :------: | ------------ | ------------ |
248 249
| 1   |    name     | BINARY(32)  | Parameter   |
| 2   |  value   | BINARY(64)   | Value |
250 251 252

## INS_DNODE_VARIABLES

253
Provides dnode configuration information.
254

255
| #   |    **Column**    | **Data Type** | **Description**                  |
256
| --- | :------: | ------------ | ------------ |
257 258 259
| 1   | dnode_id | INT          | Dnode ID |
| 2   |   name   | BINARY(32)   | Parameter   |
| 3   |  value   | BINARY(64)   | Value |
D
dapan1121 已提交
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291

## INS_TOPICS

| #   |    **Column**    | **Data Type** | **Description**                  |
| --- | :---------: | ------------ | ------------------------------ |
| 1   | topic_name  | BINARY(192)  | Topic name                     |
| 2   |   db_name   | BINARY(64)   | Database for the topic                |
| 3   | create_time | TIMESTAMP    | Creation time              |
| 4   |     sql     | BINARY(1024) | SQL statement used to create the topic |

## INS_SUBSCRIPTIONS

| #   |    **Column**    | **Data Type** | **Description**                  |
| --- | :------------: | ------------ | ------------------------ |
| 1   |   topic_name   | BINARY(204)  | Subscribed topic           |
| 2   | consumer_group | BINARY(193)  | Subscribed consumer group         |
| 3   |   vgroup_id    | INT          | Vgroup ID for the consumer |
| 4   |  consumer_id   | BIGINT       | Consumer ID          |

## INS_STREAMS

| #   |    **Column**    | **Data Type** | **Description**                  |
| --- | :----------: | ------------ | --------------------------------------- |
| 1   | stream_name  | BINARY(64)   | Stream name                              |
| 2   | create_time  | TIMESTAMP    | Creation time                                |
| 3   |     sql      | BINARY(1024) | SQL statement used to create the stream             |
| 4   |    status    | BIANRY(20)   | Current status                              |
| 5   |  source_db   | BINARY(64)   | Source database                                |
| 6   |  target_db   | BIANRY(64)   | Target database                              |
| 7   | target_table | BINARY(192)  | Target table                      |
| 8   |  watermark   | BIGINT       | Watermark (see stream processing documentation)        |
| 9   |   trigger    | INT          | Method of triggering the result push (see stream processing documentation) |