Skip to content

Commit

Permalink
zh keywords for reference and user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nicecui committed Dec 19, 2024
1 parent 30a2d30 commit bdd530f
Show file tree
Hide file tree
Showing 136 changed files with 144 additions and 0 deletions.
1 change: 1 addition & 0 deletions i18n/zh/docusaurus-plugin-content-docs/current/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [简介, 核心功能, 特点, 文档链接, 时序数据库, 实时数据洞察, GreptimeCloud]
description: 介绍了 GreptimeDB 的核心功能和特点,并提供了相关文档的链接,帮助用户快速上手和深入了解。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [版本号, 语义化版本控制, 主版本号, 次版本号, 修订号]
description: 介绍 GreptimeDB 版本号的语义化版本控制方案,包括主版本号、次版本号和修订号的定义和影响。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [命令行工具, 安装 Greptime, 启动服务, 配置示例, 升级版本]
description: 介绍 Greptime 命令行工具的安装、使用方法,包括全局选项、各子命令选项、配置示例、升级 GreptimeDB 版本等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [gtctl, 安装, Homebrew, 源代码构建, 自动补全, 快速入门, 部署, Kubernetes, 裸机模式]
description: 介绍 gtctl 工具的安装、使用方法,包括一键安装、通过 Homebrew 安装、从源代码构建、启用自动补全、快速入门、部署等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
keywords: [HTTP API, 管理 API, 健康检查, 状态, 指标, 配置, 仪表盘, 日志级别, 性能分析]
description: 介绍 GreptimeDB 中各种 HTTP 路径及其用法的完整列表。
---

# HTTP API 端点列表

以下是 GreptimeDB 中各种 HTTP 路径及其用法的完整列表:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL 工具, 查询库, 编程语言 Driver, 数据库连接, Raw SQL, 命令行工具, GUI 工具, HTTP API]
description: 介绍如何使用 SQL 工具与 GreptimeDB 交互,包括推荐的查询库、安装方法、连接数据库、使用 Raw SQL 查询数据等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [管理函数, ADMIN 语句, SQL ADMIN, 数据库管理, 表管理, 数据管理]
description: ADMIN 语句用于运行管理函数来管理数据库和数据。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [修改数据库, 修改表, ALTER 语句, SQL ALTER, 数据库设置, 表设置]
description: ALTER 用于修改数据库的设置、表的设置或表的元数据。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [条件逻辑, CASE 语句, SQL CASE, 条件查询, 数据检索, SQL 语法]
description: CASE 语句允许在查询中执行条件逻辑,根据条件返回特定值。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [数据类型转换, CAST 语句, SQL CAST, 类型转换, 数据类型, SQL 语法]
description: CAST 用于将一个数据类型的表达式转换为另一个数据类型。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [ANSI SQL, SQL 兼容性, SQL 扩展, SQL 语法, 数据库兼容性, SQL 特性]
description: GreptimeDB 支持的 SQL 是 ANSI SQL 的子集,并且拥有一些特有的扩展。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [数据导入, 数据导出, COPY 语句, SQL COPY, 数据库复制, 表复制]
description: COPY 语句用于导入和导出表或数据库的数据。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [创建数据库, 创建表, CREATE 语句, SQL 创建, 数据库选项, 表选项]
description: CREATE 用于创建新的数据库或表,支持指定列、主键、时间索引、存储引擎和其他选项。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL 数据类型, 字符串类型, 数值类型, 日期和时间类型, 布尔类型, JSON 类型]
description: SQL 数据类型定义了列可以存储的数据类型,包括字符串、二进制、数值、日期和时间、布尔和 JSON 类型。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL DELETE 语句, 删除行数据, 数据删除, SQL 示例, 数据库操作]
description: DELETE 用于从表中删除行数据,满足条件的行会立刻被标记,后续查询无法获取这些行数据。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL DESCRIBE TABLE 语句, 表结构描述, 列信息, 数据库表, SQL 示例]
description: DESCRIBE TABLE 用于描述数据库中表的结构,包括列名、类型、主键、是否为空、默认值和语义类型。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL DISTINCT 语句, 唯一值选择, 数据去重, SQL 示例, 数据分析]
description: SELECT DISTINCT 用于从一组数据中选择唯一值,可以与过滤条件结合使用。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL DROP 语句, 删除数据库, 删除表, 删除视图, 删除流, SQL 示例]
description: DROP 用于删除数据库、表、流或视图,操作不可撤销,需谨慎使用。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL EXPLAIN 语句, 执行计划, 查询优化, ANALYZE 子句, SQL 示例]
description: EXPLAIN 用于提供语句的执行计划,ANALYZE 子句将执行语句并测量每个计划节点的时间和输出行数。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [DataFusion functions, scalar functions, window functions, array functions]
description: 介绍了 Apache DataFusion 项目中的函数,包括标量函数和窗口函数的定义、使用方法和相关的 SQL 查询示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [地理函数, 空间关系, SQL 查询, 数据库地理, 地理空间]
description: 列出了 GreptimeDB 中的所有地理空间相关函数,包括函数的定义、使用方法和相关的 SQL 查询示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [JSON函数, 数据转换, SQL 查询, 数据库 JSON, JSON 操作]
description: 列出了 GreptimeDB 中的所有 JSON 函数,包括函数的定义、使用方法和相关的 SQL 查询示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [函数概述, Datafusion 函数, GreptimeDB 函数, SQL 查询, 数据库函数]
description: 提供了 GreptimeDB 中函数的概述,包括函数的分类、定义和使用方法。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [向量函数, 距离计算, 向量运算, SQL 查询, 数据库向量]
description: 列出了 GreptimeDB 中的所有向量函数,包括函数的定义、使用方法和相关的 SQL 查询示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL GROUP BY 子句, 数据分组, 聚合函数, 数据汇总, SQL 示例]
description: GROUP BY 语句用于对具有相同值的行进行分组,通常与聚合函数一起使用。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [BUILD_INFO 表, 构建信息, 版本信息, SQL查询, 数据库构建]
description: 提供了 GreptimeDB 构建信息的相关内容,包括版本信息、构建时间和相关的 SQL 查询示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [CHARACTER_SETS 表, 字符集, SQL 查询, 数据库字符集, 字符集信息]
description: 介绍了 GreptimeDB 中的字符集,包括字符集的定义、使用方法和相关的 SQL 查询示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [CLUSTER_INFO 表, 集群信息, 节点信息, SQL查询, 数据库集群]
description: 提供了 GreptimeDB 集群信息的相关内容,包括集群状态、节点信息和相关的 SQL 查询示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [COLLATION_CHARACTER_SET_APPLICABILITY 表, 排序规则, 字符集, SQL 查询, 数据库适用性]
description: 介绍了 GreptimeDB 中排序规则与字符集的适用性,包括如何在 SQL 查询中使用这些规则和字符集。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [COLLATIONS 表, 排序规则, 字符集, SQL 查询, 数据库排序]
description: 介绍了 GreptimeDB 中字符集的排序规则,包括排序规则的定义、使用方法和相关的 SQL 查询示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [COLUMNS 表, 列信息, SQL查询, 数据库列, 表结构]
description: COLUMNS 表提供关于表中每列的详细信息。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [存储引擎信息, ENGINES 表, 支持级别, 默认存储引擎, 事务支持]
description: ENGINES 表提供关于存储引擎的信息,检查 GreptimeDB 是否支持某个存储引擎或查看默认的存储引擎。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [Flow 任务信息, FLOWS 表, 任务定义, 过期时间, 源表 id]
description: FLOWS 表提供 Flow 任务的相关信息。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [键约束, KEY_COLUMN_USAGE 表, 时间索引键, 外键约束, 列位置]
description: KEY_COLUMN_USAGE 表描述列的键约束,例如时间索引键的约束。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [系统元数据, INFORMATION_SCHEMA, MySQL 兼容性, 自定义表, 集群信息]
description: INFORMATION_SCHEMA 提供对系统元数据的访问,例如数据库或表的名称、列的数据类型等。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [分区表信息, PARTITIONS 表, 分区方法, 分区表达式, Region Id]
description: PARTITIONS 表提供关于分区表的信息。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [Procedure 信息, PROCEDURE_INFO表, Procedure 类型, 时间戳, 锁定键]
description: PROCEDURE_INFO 表提供各种 Procedure 的详细信息。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [Region 节点信息, REGION_PEERS 表, 节点状态, leader, learner]
description: REGION_PEERS 表显示 GreptimeDB 中单个 Region 节点的详细信息,例如它是 learner 还是 leader。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [Region 统计信息, REGION_STATISTICS 表, 总行数, 磁盘大小, 近似值]
description: REGION_STATISTICS 表提供关于某个 Region 统计信息的详细数据,包括总行数、磁盘大小等。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [运行时指标, RUNTIME_METRICS 表, 系统指标, 集群指标, HTTP 端点]
description: RUNTIME_METRICS 表提供系统运行时指标,包括集群中 `/metrics` HTTP 端点输出的所有指标。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [数据库信息, SCHEMATA 表, SHOW DATABASES, 字段描述, 数据库目录]
description: SCHEMATA 表提供数据库的相关信息及其字段描述。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [表约束, TABLE_CONSTRAINTS 表, SQL 约束, 数据库约束, 约束类型, 约束描述]
description: TABLE_CONSTRAINTS 表描述了哪些表具有约束及相关信息。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [表信息, TABLES 表, SQL 表, 数据库表, 表字段, 表描述]
description: TABLES 表提供数据库中表的信息及其字段描述。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [视图, VIEWS 表, SQL 视图, 数据库视图, 视图定义, 视图字段]
description: VIEWS 表提供当前用户可见的视图列表及其字段描述。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL INSERT 语句, 插入数据, 多条记录插入, 默认值插入, 二进制数据插入, 特殊数值插入]
description: INSERT 用于将一条或多条记录插入到 GreptimeDB 中的表中,支持指定列名和使用默认值。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL JOIN 子句, 表连接, INNER JOIN, LEFT JOIN, RIGHT JOIN, FULL OUTER JOIN, SQL 示例]
description: JOIN 用于组合两个或多个表中基于相关列的行,支持 INNER JOIN、LEFT JOIN、RIGHT JOIN 和 FULL OUTER JOIN。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SQL LIMIT 子句, 查询行数限制, SQL 性能优化, 数据库查询优化, SQL 示例]
description: 介绍了 `LIMIT` 子句的用法,通过示例展示了如何限制查询返回的行数。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [ORDER BY 语法, 数据排序, 升序排序, 降序排序, SQL 示例]
description: 介绍了 `ORDER BY` 语法的基本用法,通过示例展示了如何对数据进行升序或降序排序。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [Range 查询, 时间范围查询, 聚合查询, SQL 示例, FILL 选项]
description: 介绍了 Range 查询的语法和用法,包括 `FILL`、`TO` 和 `BY` 选项的详细说明和示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SELECT 语句, SQL 查询, WHERE 子句, LIMIT 子句, JOIN 子句, GROUP BY 子句]
description: 介绍了 `SELECT` 语句的基本语法和用法,包括 `WHERE`、`LIMIT`、`JOIN` 和 `GROUP BY` 子句的示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [SHOW 关键字, 数据库信息, 表信息, SQL 示例, SHOW DATABASES]
description: 介绍了 `SHOW` 关键字的各种用法,包括展示数据库、表、视图和索引等信息的语法和示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [TQL 关键字, EVAL, EXPLAIN, ANALYZE, 时间序列查询]
description: 介绍了 `TQL` 关键字及其在 GreptimeDB 中的用法,包括 `EVAL`、`EXPLAIN` 和 `ANALYZE` 的语法和示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [TRUNCATE TABLE, SQL 删除, 高效删除, 数据库操作, SQL 示例]
description: 介绍了 `TRUNCATE TABLE` 语句的用法,用于高效地删除表中的所有数据。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [WHERE 子句, SQL 过滤, 逻辑运算符, 数字比较, 列表查找]
description: 介绍了 `WHERE` 子句的用法,包括逻辑运算符、数字比较和列表查找的示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [公共表表达式, CTE, SQL 查询, WITH 关键字, SQL 示例]
description: 介绍了如何使用 `WITH` 关键字定义公共表表达式(CTE),包括基本语法和示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [指标收集, 数据收集, 隐私保护, 配置管理, 禁用指标, 操作系统, 机器架构, 集群信息]
description: 介绍 GreptimeDB 的指标收集功能,包括收集的数据类型、如何禁用指标收集等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [容量规划, CPU 需求, 内存需求, 存储需求, 数据保留策略, 硬件成本, 资源分配, 性能优化]
description: 提供 GreptimeDB 的 CPU、内存和存储需求的一般建议,帮助用户根据工作负载进行容量规划。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [备份, 恢复, 导出工具, 导入工具, 数据库备份, 数据恢复, 命令行工具, 使用场景, 最佳实践]
description: 介绍 GreptimeDB 的导出和导入工具,用于数据库备份和恢复,包括命令语法、选项、常见使用场景、最佳实践和故障排除等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [跨区域部署, 单集群, 灾难恢复, DR 解决方案, 数据中心, 高可用性, 网络延迟, 元数据, 数据分区]
description: 介绍 GreptimeDB 基于单集群跨区域部署的灾难恢复(DR)解决方案,包括不同区域和数据中心的部署架构及其比较。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [灾难恢复, DR 解决方案, 备份与恢复, RTO, RPO, 组件架构, 双活互备, 跨区域部署, 数据恢复]
description: 介绍 GreptimeDB 的灾难恢复(DR)解决方案,包括基本概念、组件架构、不同的 DR 解决方案及其比较。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [表操作, 创建表, 修改表, 删除表, 描述表]
description: 介绍 GreptimeDB 中表的基本操作,包括创建数据库和表、描述表、显示表定义和索引、列出现有表、修改表和删除表等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [压缩策略, 时间窗口压缩, 严格窗口压缩, SST 文件, 手动压缩]
description: 介绍 GreptimeDB 中的压缩策略,包括时间窗口压缩策略(TWCS)和严格窗口压缩策略(SWCS),以及它们的概念、参数和使用示例。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [数据管理, 存储位置, 表操作, 数据更新, TTL 策略]
description: 提供 GreptimeDB 数据管理的概述,包括存储位置说明、表的基本操作、更新或删除数据、TTL 策略、表分片、Region 迁移、Region Failover 和 Compaction 等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [Region Failover, 故障恢复, 恢复时间, 共享存储, Kafka WAL]
description: 介绍 Region Failover 功能及其在 GreptimeDB 中的应用,包括开启 Region Failover、恢复时间和改进恢复时间的建议等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [Region 迁移, 数据迁移, 负载均衡, 迁移请求, 迁移状态]
description: 介绍 Region 迁移功能及其在 GreptimeDB 中的应用,包括查询 Region 分布、选择迁移目标节点、发起迁移请求和查询迁移状态等内容。
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
keywords: [表分片, 分区规则, 分布式表, 插入数据, 分布式查询]
description: 介绍表分片技术及其在 GreptimeDB 中的应用,包括分片时机、分区规则、创建分布式表、插入数据和分布式查询等内容。
---

Expand Down
Loading

0 comments on commit bdd530f

Please sign in to comment.