diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/00-database/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/00-database/index.md index b51c15af34..c00c595a2c 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/00-database/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/00-database/index.md @@ -1,8 +1,27 @@ --- -title: 数据库 +title: 数据库（Database） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend 中与数据库相关的命令的参考信息。 +本页面全面介绍 Databend 中的数据库操作，按功能分类便于查阅。 - \ No newline at end of file +## 数据库创建与管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE DATABASE](ddl-create-database.md) | 创建新数据库 | +| [ALTER DATABASE](ddl-alter-database.md) | 修改数据库 | +| [DROP DATABASE](ddl-drop-database.md) | 删除数据库 | +| [USE DATABASE](ddl-use-database.md) | 设置当前工作数据库 | +| [UNDROP DATABASE](undrop-database.md) | 恢复已删除的数据库 | + +## 数据库信息 + +| 命令 | 描述 | +|---------|-------------| +| [SHOW DATABASES](show-databases.md) | 列出所有数据库 | +| [SHOW CREATE DATABASE](show-create-database.md) | 显示数据库的 CREATE DATABASE 语句 | +| [SHOW DROP DATABASES](show-drop-databases.md) | 列出可恢复的已删除数据库 | + +:::note +数据库操作是 Databend 中组织数据的基础，执行前请确保具备相应权限。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/01-table/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/01-table/index.md index 0f70a4a8fe..6aed3a0397 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/01-table/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/01-table/index.md @@ -1,71 +1,58 @@ --- -title: 表 +title: 表（Table） --- -本页汇集了关于表操作的重要见解，为您提供在 Databend 中处理表的复杂性的全面指南。它将基本的表相关命令串联在一起，以提供对表管理中关键考虑因素的统一理解。 - -## 表创建要点 - -在继续创建表之前，最好先熟悉以下主题。 - -### 1. 了解表类型 - -Databend 支持两种基于时间回溯支持的表类型： - -- **普通表（默认）**：这些表本身支持时间回溯，允许您跟踪和检索历史数据。此功能对于数据分析和审计很有价值。 - -- **临时表**：相比之下，临时表不支持时间回溯。它们专为不需要历史数据跟踪的场景而设计。要创建临时表，您必须在 [CREATE TABLE](10-ddl-create-table.md) 命令中显式指定关键字 TRANSIENT。有关更多信息，请参见 [CREATE TRANSIENT TABLE](10-ddl-create-table.md#create-transient-table)。 - -### 2. 选择表存储 - -Databend 默认将表数据存储在 [databend-query.toml](https://github.com/databendlabs/databend/blob/main/scripts/distribution/configs/databend-query.toml) 配置文件中配置的位置。此外，它还提供了将表数据存储在与默认设置不同的存储桶中的灵活性。有关更多信息，请参见 [CREATE TABLE ... EXTERNAL_LOCATION](10-ddl-create-table.md#create-table--external_location)。 - -### 3. 定义表结构 - -在表中定义列的主要方法是通过 [CREATE TABLE](10-ddl-create-table.md#create-table) 命令，您可以在其中逐个列出您的列。请注意，计算列在 Databend 中作为企业版功能受支持。有关更多信息，请参见 [计算列](10-ddl-create-table.md#computed-columns)。 - -Databend 还提供了通过复制列结构甚至来自现有表的数据来创建表的便捷方法： - -- [CREATE TABLE ... LIKE](10-ddl-create-table.md#create-table--like)：创建一个与现有表具有相同列定义的表。 -- [CREATE TABLE ... AS](10-ddl-create-table.md#create-table--as)：创建一个表并根据 SELECT 查询的结果插入数据。 -- [ATTACH TABLE](92-attach-table.md)：通过将表与现有表关联来创建表。 - -### 4. 为大表设置 Cluster Key - -[Cluster Key](../06-clusterkey/index.md) 旨在通过物理上组织邻近的数据来提高查询性能。Databend 建议配置 Cluster Key，特别是对于遇到查询性能缓慢的大型表。有关在表创建期间设置 Cluster Key 的语法，请参见 [SET CLUSTER KEY](../06-clusterkey/dml-set-cluster-key.md)。 - -## 常规表维护 - -创建表后，您将获得有效组织和管理数据的基础。有了这个结构，您可以无缝地执行各种命令来增强、修改或从表中提取信息。无论是调整列属性、微调配置还是查询数据，Databend 都提供了一套通用的工具来满足您不断变化的需求。 - -- [DESCRIBE TABLE](50-describe-table.md), [SHOW FIELDS](show-fields.md)：显示有关给定表中列的信息。 -- [SHOW FULL COLUMNS](show-full-columns.md)：检索有关给定表中列的全面详细信息。 -- [SHOW CREATE TABLE](show-create-table.md)：显示创建指定表的 CREATE TABLE 语句。 -- [SHOW DROP TABLES](show-drop-tables.md)：列出当前或指定数据库中已删除的表。 -- [SHOW TABLE STATUS](show-table-status.md)：显示数据库中表的状态。 -- [SHOW TABLES](show-tables.md)：列出当前或指定数据库中的表。 -- [ALTER TABLE COLUMN](90-alter-table-column.md)：通过更改表的列来修改表的结构。 -- [ALTER TABLE OPTION](90-alter-table-option.md)：修改表的 Fuse 引擎 [Options](../../../00-sql-reference/30-table-engines/00-fuse.md#options)。 -- [RENAME TABLE](30-ddl-rename-table.md)：更改表的名称。 - -## 表删除和恢复策略 - -Databend 提供了各种用于删除表或清理表数据的命令。下表比较了这些命令，这些命令最初可能看起来很复杂，概述了每个操作的任何相关恢复选项。 - -| 命令 | 企业版？ | 描述 | 恢复 | -| -------------------------------------------- | -------- | ------------------------------------------------------------ | ------------------------------------- | -| [TRUNCATE TABLE](40-ddl-truncate-table.md) | 否 | 从表中删除所有数据，同时保留表的架构。 | [FLASHBACK TABLE](70-flashback-table.md) | -| [DROP TABLE](20-ddl-drop-table.md) | 否 | 删除表。 | [UNDROP TABLE](21-ddl-undrop-table.md) | -| [VACUUM TABLE](91-vacuum-table.md) | 是 | 永久删除表的历史数据文件。 | 不适用。 | -| [VACUUM DROP TABLE](91-vacuum-drop-table.md) | 是 | 永久删除已删除表的数据文件。 | 不适用。 | - -## 高级表优化技术 - -Databend 中的表可能需要随着时间的推移进行优化，以确保高效的性能和存储利用率。在这种情况下，以下命令可以帮助您： +本页面提供 Databend 中表操作的全面概述，按功能分类便于查阅。 + +## 表创建 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE TABLE](10-ddl-create-table.md) | 创建具有指定列和选项的新表 | +| [CREATE TABLE ... LIKE](10-ddl-create-table.md#create-table--like) | 创建与现有表列定义相同的新表 | +| [CREATE TABLE ... AS](10-ddl-create-table.md#create-table--as) | 基于 SELECT 查询结果创建表并插入数据 | +| [CREATE TRANSIENT TABLE](10-ddl-create-transient-table.md) | 创建不支持时间回溯（Time Travel）的表 | +| [CREATE EXTERNAL TABLE](10-ddl-create-table-external-location.md) | 创建数据存储在指定外部位置的表 | +| [ATTACH TABLE](92-attach-table.md) | 通过关联现有表创建新表 | + +## 表修改 + +| 命令 | 描述 | +|---------|-------------| +| [ALTER TABLE COLUMN](90-alter-table-column.md) | 修改表的列结构 | +| [ALTER TABLE CONNECTION](91-alter-table-connection.md) | 更新外部表的连接设置 | +| [ALTER TABLE OPTION](90-alter-table-option.md) | 修改表的 Fuse 引擎选项 | +| [ALTER TABLE COMMENT](90-alter-table-comment.md) | 更新表的注释 | +| [RENAME TABLE](30-ddl-rename-table.md) | 更改表名称 | + +## 表信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESCRIBE TABLE](50-describe-table.md) / [SHOW FIELDS](show-fields.md) | 显示指定表的列信息 | +| [SHOW FULL COLUMNS](show-full-columns.md) | 获取指定表的列详细信息 | +| [SHOW CREATE TABLE](show-create-table.md) | 显示创建指定表的 CREATE TABLE 语句 | +| [SHOW TABLES](show-tables.md) | 列出当前或指定数据库中的表 | +| [SHOW TABLE STATUS](show-table-status.md) | 显示数据库中的表状态 | +| [SHOW DROP TABLES](show-drop-tables.md) | 列出当前或指定数据库中已删除的表 | + +## 表删除与恢复 + +| 命令 | 描述 | 恢复选项 | +|---------|-------------|----------------| +| [TRUNCATE TABLE](40-ddl-truncate-table.md) | 清空表数据但保留表结构 | [FLASHBACK TABLE](70-flashback-table.md) | +| [DROP TABLE](20-ddl-drop-table.md) | 删除表 | [UNDROP TABLE](21-ddl-undrop-table.md) | +| [VACUUM TABLE](91-vacuum-table.md) | 永久删除表的历史数据文件（企业版 (Enterprise Edition)） | 不可恢复 | +| [VACUUM DROP TABLE](91-vacuum-drop-table.md) | 永久删除已删除表的数据文件（企业版 (Enterprise Edition)） | 不可恢复 | + +## 表优化 + +| 命令 | 描述 | +|---------|-------------| +| [ANALYZE TABLE](80-analyze-table.md) | 计算表统计信息以提升查询性能 | +| [OPTIMIZE TABLE](60-optimize-table.md) | 压缩或清理历史数据以节省存储空间并提升查询性能 | +| [SET CLUSTER KEY](../06-clusterkey/dml-set-cluster-key.md) | 配置聚簇键以提升大表查询性能 | :::note -表优化是一项高级操作。Databend 建议在继续操作之前仔细阅读以下链接并了解优化过程，以避免潜在的数据丢失。 -::: - -- [ANALYZE TABLE](80-analyze-table.md)：计算表统计信息。 -- [OPTIMIZE TABLE](60-optimize-table.md)：涉及压缩或清除历史数据以节省存储空间并提高查询性能。 \ No newline at end of file +表优化属于高级操作，执行前请仔细阅读文档以避免数据丢失风险。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/02-user/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/02-user/index.md index 1f737c8798..d2f655e24a 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/02-user/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/02-user/index.md @@ -1,29 +1,37 @@ --- -title: User & Role +title: 用户与角色 --- -本页提供了 Databend 中与用户和角色相关命令的参考信息。 +本页面全面介绍了 Databend 中的用户与角色操作，按功能分类以便查阅。 -## 用户和角色管理: +## 用户管理 -- [CREATE USER](01-user-create-user.md) -- [DROP USER](02-user-drop-user.md) -- [CREATE ROLE](04-user-create-role.md) -- [SET ROLE](04-user-set-role.md) -- [DROP ROLE](05-user-drop-role.md) +| 命令 | 描述 | +|---------|-------------| +| [CREATE USER](01-user-create-user.md) | 创建新用户账户 | +| [ALTER USER](03-user-alter-user.md) | 修改现有用户账户 | +| [DROP USER](02-user-drop-user.md) | 删除用户账户 | +| [DESC USER](01-user-desc-user.md) | 显示用户详细信息 | +| [SHOW USERS](02-user-show-users.md) | 列出系统所有用户 | -## 权限管理: +## 角色管理 -- [GRANT](10-grant.md) -- [REVOKE](11-revoke.md) +| 命令 | 描述 | +|---------|-------------| +| [CREATE ROLE](04-user-create-role.md) | 创建新角色 | +| [DROP ROLE](05-user-drop-role.md) | 删除角色 | +| [SET ROLE](04-user-set-role.md) | 设置当前会话的活动角色 | +| [SET SECONDARY ROLES](04-user-set-2nd-roles.md) | 设置会话的次要角色 | +| [SHOW ROLES](04-user-show-roles.md) | 列出系统所有角色 | -## 信息检索: +## 权限管理 -- [DESC USER](01-user-desc-user.md) -- [SHOW USERS](02-user-show-users.md) -- [SHOW ROLES](04-user-show-roles.md) -- [SHOW GRANTS](22-show-grants.md) +| 命令 | 描述 | +|---------|-------------| +| [GRANT](10-grant.md) | 向用户或角色授予权限 | +| [REVOKE](11-revoke.md) | 撤销用户或角色的权限 | +| [SHOW GRANTS](22-show-grants.md) | 显示授予用户或角色的权限 | -## 用户修改: - -- [ALTER USER](03-user-alter-user.md) \ No newline at end of file +:::note +完善的用户与角色管理是数据库安全的核心。授予权限时请始终遵循最小权限原则。 +::: diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/03-stage/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/03-stage/index.md index 7246caf8d9..b5717ea875 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/03-stage/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/03-stage/index.md @@ -1,14 +1,37 @@ --- -title: Stage 命令 +title: 存储阶段（Stage） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend 中与 Stage 相关的命令的参考信息。 +本页面全面概述了 Databend 中的 Stage 操作，按功能分类以便参考。 - +## Stage 管理 -相关主题： +| 命令 | 描述 | +|---------|-------------| +| [CREATE STAGE](01-ddl-create-stage.md) | 创建用于存储文件的新 Stage | +| [DROP STAGE](02-ddl-drop-stage.md) | 删除 Stage | +| [PRESIGN](presign.md) | 为 Stage 访问生成预签名 URL | + +## Stage 操作 + +| 命令 | 描述 | +|---------|-------------| +| [LIST STAGE](04-ddl-list-stage.md) | 列出 Stage 中的文件 | +| [REMOVE STAGE](05-ddl-remove-stage.md) | 从 Stage 中删除文件 | + +## Stage 信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESC STAGE](03-ddl-desc-stage.md) | 显示 Stage 的详细信息 | +| [SHOW STAGES](06-ddl-show-stages.md) | 列出当前或指定数据库中的所有 Stage | + +## 相关主题 - [使用 Stage](/guides/load-data/stage/) -- [从 Stage 加载](/guides/load-data/load/stage) -- [查询和转换](/guides/load-data/transform/querying-stage) \ No newline at end of file +- [从 Stage 加载数据](/guides/load-data/load/stage) +- [查询和转换](/guides/load-data/transform/querying-stage) + +:::note +Databend 中的 Stage 用作临时存储位置，用于存放需加载到表或从表卸载的数据文件。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/04-sequence/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/04-sequence/index.md index ec99d4e7b8..645c3ea063 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/04-sequence/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/04-sequence/index.md @@ -1,8 +1,23 @@ --- -title: Sequence +title: 序列（Sequence） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供 Databend 中与 sequence 相关的命令的参考信息。 +本文全面介绍了 Databend 中的序列操作，按功能分类组织以便查阅。 - \ No newline at end of file +## 序列管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE SEQUENCE](create-sequence.md) | 创建新的序列生成器 | +| [DROP SEQUENCE](drop-sequence.md) | 删除序列生成器 | + +## 序列信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESC SEQUENCE](desc-sequence.md) | 显示序列的详细信息 | +| [SHOW SEQUENCES](show-sequences.md) | 列出当前或指定数据库中的所有序列 | + +:::note +Databend 中的序列用于按顺序生成唯一数值，通常应用于主键（Primary Key）或其他唯一标识符场景。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/04-stream/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/04-stream/index.md index e3cab25ec6..7740cf29bb 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/04-stream/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/04-stream/index.md @@ -1,8 +1,27 @@ --- -title: Stream +title: 流（Stream） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供 Databend 中与 stream 相关的命令的参考信息。有关 stream 的更多信息，请参见 [通过 Stream 跟踪和转换数据](/guides/load-data/continuous-data-pipelines/stream)。 +本页面提供 Databend 中流操作的全面概述，按功能组织以便于参考。 - \ No newline at end of file +## 流管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE STREAM](create-stream.md) | 创建新流以跟踪表中的变更 | +| [DROP STREAM](drop-stream.md) | 删除流 | + +## 流信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESC STREAM](desc-stream.md) | 显示流的详细信息 | +| [SHOW STREAMS](show-streams.md) | 列出当前或指定数据库中的所有流 | + +## 相关主题 + +- [通过流跟踪和转换数据](/guides/load-data/continuous-data-pipelines/stream) + +:::note +Databend 中的流用于跟踪和捕获表变更，实现持续数据管道和实时数据处理。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/04-task/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/04-task/index.md index d459e57092..80ede81196 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/04-task/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/04-task/index.md @@ -1,8 +1,24 @@ --- -title: Task +title: 任务（Task） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend Cloud 中与 task 相关的命令的参考信息。 +本页面提供了 Databend 中任务操作的全面概述，按功能组织以便于参考。 - \ No newline at end of file +## 任务管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE TASK](01-ddl-create_task.md) | 创建新的计划任务 | +| [ALTER TASK](02-ddl-alter-task.md) | 修改现有任务 | +| [DROP TASK](03-ddl-drop-task.md) | 删除任务 | +| [EXECUTE TASK](04-ddl-execute-task.md) | 手动执行任务 | + +## 任务信息 + +| 命令 | 描述 | +|---------|-------------| +| [TASK ERROR INTEGRATION PAYLOAD](10-task-error-integration-payload.md) | 显示任务错误通知的错误载荷格式 | + +:::note +Databend 中的任务允许您安排和自动化 SQL 命令在指定间隔执行。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/05-view/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/05-view/index.md index ff293a74c2..9f37cb714e 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/05-view/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/05-view/index.md @@ -1,8 +1,24 @@ --- -title: View +title: 视图（View） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend 中与视图相关的命令的参考信息。 +本页面全面概述了 Databend 中的视图操作，按功能分类以便查阅。 - \ No newline at end of file +## 视图管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE VIEW](ddl-create-view.md) | 基于查询创建新视图 | +| [ALTER VIEW](ddl-alter-view.md) | 修改现有视图 | +| [DROP VIEW](ddl-drop-view.md) | 删除视图 | + +## 视图信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESC VIEW](desc-view.md) | 显示视图的详细信息 | +| [SHOW VIEWS](show-views.md) | 列出当前或指定数据库中的所有视图 | + +:::note +Databend 中的视图是存储在数据库中的命名查询，可像表一样引用。它们能简化复杂查询并控制对底层数据的访问。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/06-clusterkey/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/06-clusterkey/index.md index 680bb352f9..b84afe36f9 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/06-clusterkey/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/06-clusterkey/index.md @@ -1,8 +1,22 @@ --- -title: 集群键 +title: 聚簇键（Cluster Key） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供 Databend 中与集群键相关的命令的参考信息。有关集群键的更多信息，请参见 [集群键](/guides/performance/cluster-key)。 +本页面全面介绍了 Databend 中聚簇键的操作功能，按功能分类便于查阅。 - \ No newline at end of file +## 集群键管理 + +| 命令 | 描述 | +|---------|-------------| +| [SET CLUSTER KEY](dml-set-cluster-key.md) | 为表创建或替换聚簇键 | +| [ALTER CLUSTER KEY](dml-alter-cluster-key.md) | 修改现有聚簇键 | +| [DROP CLUSTER KEY](dml-drop-cluster-key.md) | 从表中移除聚簇键 | +| [RECLUSTER TABLE](dml-recluster-table.md) | 基于聚簇键重新组织表数据 | + +## 相关主题 + +- [聚簇键](/guides/performance/cluster-key) + +:::note +Databend 中的聚簇键用于在物理层面组织表数据，通过将相关数据集中存储来提升查询性能。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/07-aggregating-index/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/07-aggregating-index/index.md index 1414087687..5978002b03 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/07-aggregating-index/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/07-aggregating-index/index.md @@ -1,11 +1,24 @@ --- -title: 聚合索引 +title: 聚合索引（Aggregating Index） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; import EEFeature from '@site/src/components/EEFeature'; -本页提供 Databend 中与聚合索引相关的命令的参考信息。有关聚合索引的更多信息，请参见 [聚合索引](/guides/performance/aggregating-index)。 +本页面全面概述了 Databend 中的聚合索引操作，按功能组织以便参考。 - \ No newline at end of file +## 聚合索引管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE AGGREGATING INDEX](create-aggregating-index.md) | 为表创建新的聚合索引 | +| [DROP AGGREGATING INDEX](drop-aggregating-index.md) | 删除聚合索引 | +| [REFRESH AGGREGATING INDEX](refresh-aggregating-index.md) | 使用最新数据更新聚合索引 | + +## 相关主题 + +- [聚合索引](/guides/performance/aggregating-index) + +:::note +Databend 中的聚合索引通过预计算和存储聚合结果，提高聚合查询的性能。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/07-inverted-index/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/07-inverted-index/index.md index c57a21292d..8ca673c1d4 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/07-inverted-index/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/07-inverted-index/index.md @@ -1,11 +1,24 @@ --- -title: 倒排索引 +title: 倒排索引（Inverted Index） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; import EEFeature from '@site/src/components/EEFeature'; -本页提供 Databend 中与倒排索引相关命令的参考信息。有关倒排索引的更多信息，请参见 [全文索引](/guides/performance/fulltext-index)。 +本页面按功能分类，全面介绍 Databend 中的倒排索引操作，便于快速查阅。 - \ No newline at end of file +## 倒排索引管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE INVERTED INDEX](create-inverted-index.md) | 创建全文搜索用的倒排索引 | +| [DROP INVERTED INDEX](drop-inverted-index.md) | 删除倒排索引 | +| [REFRESH INVERTED INDEX](refresh-inverted-index.md) | 使用最新数据更新倒排索引 | + +## 相关主题 + +- [全文索引](/guides/performance/fulltext-index) + +:::note +Databend 的倒排索引为文本数据实现高效全文搜索功能，支持在大型文本列中快速执行关键词检索。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/07-ngram-index/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/07-ngram-index/index.md index 42c21ab61f..323d6199e2 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/07-ngram-index/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/07-ngram-index/index.md @@ -1,11 +1,19 @@ --- -title: NGRAM INDEX +title: Ngram 索引 --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; import EEFeature from '@site/src/components/EEFeature'; -本页提供了 Databend 中 Ngram 索引相关命令的参考信息。 +本文全面介绍 Databend 中 Ngram 索引的功能操作，按模块分类便于查阅。 - \ No newline at end of file +## Ngram 索引管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE NGRAM INDEX](create-ngram-index.md) | 创建新的 Ngram 索引用于高效子字符串搜索 | +| [DROP NGRAM INDEX](drop-ngram-index.md) | 删除 Ngram 索引 | + +:::note +Databend 的 Ngram 索引支持在文本数据中高效执行子字符串及模式匹配搜索，可显著提升 LIKE 等操作的性能。 +::: diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/07-virtual-column/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/07-virtual-column/index.md index 43e708629d..341c9449a9 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/07-virtual-column/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/07-virtual-column/index.md @@ -1,11 +1,23 @@ --- -title: VIRTUAL COLUMN +title: 虚拟列（Virtual Column） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; import EEFeature from '@site/src/components/EEFeature'; -本页提供 Databend 中与虚拟列相关的命令的参考信息。有关虚拟列的更多信息，请参见 [Virtual Column](/guides/performance/virtual-column)。 +本页全面概述了 Databend 中的虚拟列操作，按功能组织以便参考。 - \ No newline at end of file +## 虚拟列管理 + +| 命令 | 描述 | +|---------|-------------| +| [REFRESH VIRTUAL COLUMN](refresh-virtual-column.md) | 使用最新数据更新虚拟列 | +| [SHOW VIRTUAL COLUMNS](show-virtual-columns.md) | 列出表中的所有虚拟列 | + +## 相关主题 + +- [虚拟列](/guides/performance/virtual-column) + +:::note +Databend 中的虚拟列是从表中其他列计算得出的派生列。它们不物理存储，而是在查询执行期间按需计算。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/10-udf/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/10-udf/index.md index 61b20a3f65..8533f11575 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/10-udf/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/10-udf/index.md @@ -1,8 +1,22 @@ --- -title: 用户自定义函数 +title: 用户定义函数（User-Defined Function） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend 中 UDF 相关命令的参考信息。有关 UDF 的更多信息，请参见 [用户自定义函数](/guides/query/udf)。 +本页面全面概述了 Databend 中的用户定义函数（UDF）操作，按功能组织以便参考。 - \ No newline at end of file +## UDF 管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE FUNCTION](ddl-create-function.md) | 创建新的用户定义函数 | +| [ALTER FUNCTION](ddl-alter-function.md) | 修改现有的用户定义函数 | +| [DROP FUNCTION](ddl-drop-function.md) | 删除用户定义函数 | +| [SHOW USER FUNCTIONS](ddl-show-user-functions.md) | 列出所有用户定义函数 | + +## 相关主题 + +- [用户定义函数（User-Defined Function）](/guides/query/udf) + +:::note +Databend 中的用户定义函数（UDF）允许您使用 JavaScript、Python 或其他支持的语言创建自定义函数，从而扩展内置功能。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/11-external-function/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/11-external-function/index.md index 89f4c1f57d..604e7d44ec 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/11-external-function/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/11-external-function/index.md @@ -1,8 +1,21 @@ --- -title: External Function +title: 外部函数（External Function） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend 中 external function 相关命令的参考信息。有关 external function 的更多信息，请参见 [External Function](/guides/query/external-function)。 +本文档全面介绍 Databend 中的外部函数操作，按功能分类组织以便查阅。 - \ No newline at end of file +## 外部函数管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE EXTERNAL FUNCTION](ddl-create-function.md) | 创建新的外部函数 | +| [ALTER EXTERNAL FUNCTION](ddl-alter-function.md) | 修改现有外部函数 | +| [DROP EXTERNAL FUNCTION](ddl-drop-function.md) | 删除外部函数 | + +## 相关主题 + +- [外部函数](/guides/query/external-function) + +:::note +Databend 的外部函数支持通过 HTTP/HTTPS 端点与外部服务集成，从而扩展系统功能并利用外部计算资源。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/12-mask-policy/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/12-mask-policy/index.md index 275afa18a5..6466bf9fab 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/12-mask-policy/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/12-mask-policy/index.md @@ -1,11 +1,24 @@ --- -title: MASKING POLICY +title: 掩码策略（Masking Policy） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; import EEFeature from '@site/src/components/EEFeature'; -本页提供了 Databend 中 masking policy 命令的参考信息。有关 masking policy 的更多信息，请参见 [Masking Policy](/guides/security/masking-policy)。 +本页面提供了 Databend 中掩码策略（Masking Policy）操作的全面概述，按功能组织以便于参考。 - \ No newline at end of file +## 掩码策略管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE MASKING POLICY](create-mask-policy.md) | 创建新的掩码策略用于数据混淆 | +| [DESCRIBE MASKING POLICY](desc-mask-policy.md) | 显示特定掩码策略的详细信息 | +| [DROP MASKING POLICY](drop-mask-policy.md) | 删除掩码策略 | + +## 相关主题 + +- [掩码策略](/guides/security/masking-policy) + +:::note +Databend 中的掩码策略允许您在用户没有适当权限查询时，动态转换或混淆敏感数据以保护数据。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/12-network-policy/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/12-network-policy/index.md index 94cd3c2c9a..8b0f6ab04e 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/12-network-policy/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/12-network-policy/index.md @@ -1,9 +1,28 @@ --- -title: NETWORK POLICY +title: 网络策略（Network Policy） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面全面概述了 Databend 中的网络策略操作，按功能分类以便参考。 -本页提供 Databend 中网络策略命令的参考信息。有关网络策略的更多信息，请参见 [网络策略](/guides/security/network-policy)。 +## 网络策略管理 - \ No newline at end of file +| 命令 | 描述 | +|---------|-------------| +| [CREATE NETWORK POLICY](ddl-create-policy.md) | 创建基于 IP 地址控制访问的新网络策略 | +| [ALTER NETWORK POLICY](ddl-alter-policy.md) | 修改现有网络策略 | +| [DROP NETWORK POLICY](ddl-drop-policy.md) | 删除网络策略 | + +## 网络策略信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESCRIBE NETWORK POLICY](ddl-desc-policy.md) | 显示指定网络策略的详细信息 | +| [SHOW NETWORK POLICIES](ddl-show-policy.md) | 列出所有网络策略 | + +## 相关主题 + +- [网络策略](/guides/security/network-policy) + +:::note +Databend 的网络策略允许通过指定允许或阻止的 IP 地址及范围来控制数据库访问。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/12-password-policy/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/12-password-policy/index.md index 2a49d18d14..94d3476916 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/12-password-policy/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/12-password-policy/index.md @@ -1,8 +1,28 @@ --- -title: PASSWORD POLICY +title: 密码策略（Password Policy） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供 Databend 中密码策略命令的参考信息。要更深入地了解密码策略的工作原理，请参阅 [密码策略](/guides/security/password-policy)。 +本页面全面介绍了 Databend 中的密码策略操作，按功能分类整理以便参考。 - \ No newline at end of file +## 密码策略管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE PASSWORD POLICY](create-password-policy.md) | 创建具有特定要求的新密码策略 | +| [ALTER PASSWORD POLICY](alter-password-policy.md) | 修改现有密码策略 | +| [DROP PASSWORD POLICY](drop-password-policy.md) | 删除密码策略 | + +## 密码策略信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESCRIBE PASSWORD POLICY](desc-password-policy.md) | 显示特定密码策略的详细信息 | +| [SHOW PASSWORD POLICIES](show-password-policies.md) | 列出所有密码策略 | + +## 相关主题 + +- [密码策略](/guides/security/password-policy) + +:::note +Databend 的密码策略允许您强制执行用户密码的安全要求，例如最小长度、复杂性和过期规则。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/13-connection/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/13-connection/index.md index 587da4199b..4be42692fc 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/13-connection/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/13-connection/index.md @@ -1,37 +1,43 @@ --- -title: Connection +title: 连接（Connection） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -### 什么是 Connection？ +## 什么是连接？ -Databend 中的 Connection 是指一种指定的配置，它封装了与外部存储服务交互所需的详细信息。它作为一个集中且可重用的参数集，例如访问凭据、端点 URL 和存储类型，从而方便 Databend 与各种存储服务的集成。 +Databend 中的连接指一种预定义配置，用于封装与外部存储服务交互所需的详细信息。它提供一组集中管理的可重用参数（如访问凭证、端点 URL 和存储类型），简化 Databend 与各类存储服务的集成流程。 -Connection 可用于创建外部 Stage、外部表和附加表，从而提供了一种简化的模块化方法来管理和访问存储在外部存储服务中并通过 Databend 访问的数据。有关示例，请参见 [使用示例](#usage-examples)。 +连接可用于创建外部阶段、外部表及附加表，通过模块化方式统一管理 Databend 对外部存储服务的数据访问操作。 -### 管理 Connection +## 连接管理 -要管理 Databend 中的 Connection，请使用以下命令： +| 命令 | 描述 | +|---------|-------------| +| [CREATE CONNECTION](create-connection.md) | 创建访问外部存储服务的新连接 | +| [DROP CONNECTION](drop-connection.md) | 删除现有连接 | - +## 连接信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESCRIBE CONNECTION](desc-connection.md) | 显示指定连接的详细信息 | +| [SHOW CONNECTIONS](show-connections.md) | 列出当前数据库所有连接 | ### 使用示例 -本节中的示例首先创建一个 Connection，其中包含连接到 Amazon S3 所需的凭据。 随后，它们利用此已建立的 Connection 来创建外部 Stage 并附加现有表。 +本节示例首先创建包含 Amazon S3 访问凭证的连接，随后使用该连接创建外部阶段并附加数据表。 -此语句启动与 Amazon S3 的 Connection，指定必要的 Connection 参数： +此语句创建名为 toronto 的 Amazon S3 连接，包含必要参数： ```sql CREATE CONNECTION toronto STORAGE_TYPE = 's3' SECRET_ACCESS_KEY = '' ACCESS_KEY_ID = ''; - ``` -#### 示例 1：使用 Connection 创建外部 Stage +#### 示例 1：通过连接创建外部阶段 -以下示例使用先前定义的名为“toronto”的 Connection 创建一个外部 Stage： +使用已定义的 toronto 连接创建外部阶段： ```sql CREATE STAGE my_s3_stage @@ -39,7 +45,7 @@ CREATE STAGE my_s3_stage CONNECTION = (CONNECTION_NAME = 'toronto'); --- 相当于以下不使用 Connection 的语句： +-- 等效于未使用连接的语句： CREATE STAGE my_s3_stage URL = 's3://databend-toronto' @@ -47,18 +53,16 @@ CREATE STAGE my_s3_stage SECRET_ACCESS_KEY = '' ACCESS_KEY_ID = '' ); - ``` -#### 示例 2：使用 Connection 附加表 +#### 示例 2：通过连接附加表 -[ATTACH TABLE](../01-table/92-attach-table.md) 页面提供了[示例](../01-table/92-attach-table.md#examples)，演示了如何将 Databend Cloud 中的新表与 Databend 中的现有表连接起来，其中数据存储在名为“databend-toronto”的 Amazon S3 bucket 中。 在每个示例中，可以使用先前定义的名为“toronto”的 Connection 来简化步骤 3： +[ATTACH TABLE](../01-table/92-attach-table.md) 页面的[示例](../01-table/92-attach-table.md#examples)演示了如何将 Databend Cloud 新表连接到 Databend 现有表（数据存储在 Amazon S3 存储桶 "databend-toronto" 中）。各示例的步骤 3 均可通过 toronto 连接简化： ```sql title='Databend Cloud:' ATTACH TABLE employees_backup 's3://databend-toronto/1/216/' CONNECTION = (CONNECTION_NAME = 'toronto'); - ``` ```sql title='Databend Cloud:' @@ -66,12 +70,11 @@ ATTACH TABLE population_readonly 's3://databend-toronto/1/556/' CONNECTION = (CONNECTION_NAME = 'toronto') READ_ONLY; - ``` -#### 示例 3：使用 Connection 创建外部表 +#### 示例 3：通过连接创建外部表 -此示例演示如何使用先前定义的名为“toronto”的 Connection 创建名为“BOOKS”的外部表： +使用 toronto 连接创建名为 BOOKS 的外部表： ```sql CREATE TABLE BOOKS ( @@ -81,5 +84,4 @@ CREATE TABLE BOOKS ( ) 's3://databend-toronto' CONNECTION = (CONNECTION_NAME = 'toronto'); - ``` \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/13-file-format/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/13-file-format/index.md index f9a1ef1f10..361260e389 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/13-file-format/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/13-file-format/index.md @@ -1,8 +1,22 @@ --- -title: 文件格式 +title: 文件格式（File Format） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供 Databend 中文件格式相关命令的参考信息。 +本页面提供了 Databend 中文件格式操作的全面概述，按功能组织以便参考。 - \ No newline at end of file +## 文件格式管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE FILE FORMAT](01-ddl-create-file-format.md) | 创建一个命名的文件格式对象，用于数据加载和卸载 | +| [DROP FILE FORMAT](02-ddl-drop-file-format.md) | 删除文件格式对象 | + +## 文件格式信息 + +| 命令 | 描述 | +|---------|-------------| +| [SHOW FILE FORMATS](03-ddl-show-file-formats.md) | 列出当前数据库中的所有文件格式 | + +:::note +Databend 中的文件格式定义了数据加载操作期间如何解析数据文件，以及数据卸载操作期间如何格式化数据文件。它们提供了一种可重用的方式来指定文件类型、字段分隔符、压缩和其他格式选项。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/14-transaction/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/14-transaction/index.md index e8f92b6846..b9424eac29 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/14-transaction/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/14-transaction/index.md @@ -1,8 +1,23 @@ --- -title: 事务 +title: 事务（Transaction） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend 中与事务相关的命令的参考信息。 +本文档全面介绍 Databend 中的事务操作，按功能分类以便查阅。 - \ No newline at end of file +## 事务控制 + +| 命令 | 描述 | +|---------|-------------| +| [BEGIN](begin.md) | 启动新事务 | +| [COMMIT](commit.md) | 提交当前事务并保存所有更改 | +| [ROLLBACK](rollback.md) | 回滚当前事务并撤销所有更改 | + +## 事务信息 + +| 命令 | 描述 | +|---------|-------------| +| [SHOW LOCKS](show-locks.md) | 显示系统中的活动锁信息 | + +:::note +Databend 通过将 SQL 操作分组为原子单元来确保数据一致性，这些操作要么全部成功执行，要么完全回退，从而保障数据库完整性。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/15-variable/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/15-variable/index.md index f601d48815..54f32812d5 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/15-variable/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/15-variable/index.md @@ -1,8 +1,22 @@ --- -title: 变量 +title: 变量（Variable） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供 Databend 中与变量相关的命令的参考信息。 +本文档全面介绍 Databend 中的变量操作，按功能分类以便查阅。 - \ No newline at end of file +## 变量管理 + +| 命令 | 描述 | +|---------|-------------| +| [SET](set-variable.md) | 创建或修改会话/用户变量 | +| [UNSET](unset-variable.md) | 删除用户定义变量 | + +## 变量信息 + +| 命令 | 描述 | +|---------|-------------| +| [SHOW VARIABLES](show-variables.md) | 显示系统及用户变量的当前值 | + +:::note +Databend 的变量支持在会话内或跨会话存储和重用值，使脚本更具动态性与可重用性。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/16-notification/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/16-notification/index.md index 9e12af7caf..30fc3ba69a 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/16-notification/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/16-notification/index.md @@ -1,8 +1,17 @@ --- -title: 通知 +title: 通知（Notification） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供 Databend Cloud 中与通知相关的命令的参考信息。 +本文全面概述了 Databend Cloud 中的通知操作，按功能分类组织以便查阅。 - \ No newline at end of file +## 通知管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE NOTIFICATION](01-ddl-create-notification.md) | 创建新通知集成用于事件告警 | +| [ALTER NOTIFICATION](02-ddl-alter-notification.md) | 修改现有通知集成 | +| [DROP NOTIFICATION](03-ddl-drop-notification.md) | 删除通知集成 | + +:::note +Databend Cloud 的通知功能支持配置电子邮件或 Slack 等外部服务集成，用于接收数据库事件及操作相关的告警。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/17-dictionary/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/17-dictionary/index.md index 48ae91d210..448caf22f9 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/17-dictionary/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/17-dictionary/index.md @@ -1,8 +1,23 @@ --- -title: 字典 +title: 字典（Dictionary） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供 Databend 中与字典相关的命令的参考信息。 +本页面提供了 Databend 中字典操作的全面概述，按功能组织以便于参考。 - \ No newline at end of file +## 字典管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE DICTIONARY](create-dictionary.md) | 创建新的字典以访问外部数据源 | +| [DROP DICTIONARY](drop-dictionary.md) | 删除字典 | + +## 字典信息 + +| 命令 | 描述 | +|---------|-------------| +| [SHOW DICTIONARIES](show-dictionaries.md) | 列出当前数据库中的所有字典 | +| [SHOW CREATE DICTIONARY](show-create-dictionary.md) | 显示现有字典的 CREATE 语句 | + +:::note +Databend 中的字典允许您直接实时查询外部数据源（如 MySQL、Redis）的数据，无需 ETL 过程。这有助于解决数据一致性问题，提高查询（Query）性能，并简化数据管理。您可以使用 `dict_get` 函数查询外部数据。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/18-procedure/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/18-procedure/index.md index d2db15c043..61f6d9335b 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/18-procedure/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/18-procedure/index.md @@ -1,8 +1,24 @@ --- -title: 存储过程 +title: 存储过程（Stored Procedure） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend 中存储过程相关命令的参考信息。 +本页面全面概述了 Databend 中存储过程（Stored Procedure）的操作，按功能分类组织，便于查阅。 - \ No newline at end of file +## 过程管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE PROCEDURE](create-procedure.md) | 创建新的存储过程 | +| [DROP PROCEDURE](drop-procedure.md) | 删除存储过程 | +| [CALL](call-procedure.md) | 执行存储过程 | + +## 过程信息 + +| 命令 | 描述 | +|---------|-------------| +| [DESCRIBE PROCEDURE](desc-procedure.md) | 显示特定存储过程的详细信息 | +| [SHOW PROCEDURES](show-procedures.md) | 列出当前数据库中的所有存储过程 | + +:::note +Databend 的存储过程允许将系列 SQL 语句封装为可重用单元，通过单条命令执行，从而提升代码组织性和可维护性。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md index 102937388e..7628cb54bb 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/19-warehouse/index.md @@ -1,8 +1,28 @@ --- -title: 计算集群 +title: 计算集群（Warehouse） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页提供了 Databend 中与计算集群相关的命令的参考信息。 +本页面全面概述了 Databend 中计算集群的操作，按功能分类，便于参考。 - \ No newline at end of file +## 计算集群管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE WAREHOUSE](create-warehouse.md) | 创建新的计算集群用于计算资源 | +| [ALTER WAREHOUSE](alter-warehouse.md) | 修改现有计算集群的配置 | +| [DROP WAREHOUSE](drop-warehouse.md) | 删除计算集群 | +| [RENAME WAREHOUSE](rename-warehouse.md) | 更改计算集群的名称 | +| [SUSPEND WAREHOUSE](suspend-warehouse.md) | 临时停止计算集群以节省资源 | +| [RESUME WAREHOUSE](resume-warehouse.md) | 重启已暂停的计算集群 | +| [USE WAREHOUSE](use-warehouse.md) | 为当前会话设置计算集群 | + +## 计算集群信息 + +| 命令 | 描述 | +|---------|-------------| +| [SHOW WAREHOUSES](show-warehouses.md) | 列出所有计算集群 | +| [SHOW ONLINE NODES](show-online-nodes.md) | 显示当前计算集群中的活跃计算节点 | + +:::note +Databend 中的计算集群代表执行查询（Query）的计算资源。它们可以根据工作负载需求进行扩容或缩容，并在不使用时暂停以优化成本。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/10-sql-commands/00-ddl/20-workload-group/index.md b/docs/cn/sql-reference/10-sql-commands/00-ddl/20-workload-group/index.md index 79fc86d1bd..51e5707273 100644 --- a/docs/cn/sql-reference/10-sql-commands/00-ddl/20-workload-group/index.md +++ b/docs/cn/sql-reference/10-sql-commands/00-ddl/20-workload-group/index.md @@ -1,8 +1,24 @@ --- -title: 工作负载组 +title: 工作负载组（Workload Group） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本页面提供了 Databend 中工作负载组相关命令的参考信息。 +本页面全面概述了 Databend 中工作负载组的操作指南，按功能分类以便查阅。 - \ No newline at end of file +## 工作负载组管理 + +| 命令 | 描述 | +|---------|-------------| +| [CREATE WORKLOAD GROUP](create-workload-group.md) | 创建用于资源管理的新工作负载组 | +| [ALTER WORKLOAD GROUP](alter-workload-group.md) | 修改现有工作负载组配置 | +| [DROP WORKLOAD GROUP](drop-workload-group.md) | 删除工作负载组 | +| [RENAME WORKLOAD GROUP](rename-workload-group.md) | 重命名工作负载组 | + +## 工作负载组信息 + +| 命令 | 描述 | +|---------|-------------| +| [SHOW WORKLOAD GROUPS](show-workload-groups.md) | 列出所有工作负载组及其配置 | + +:::note +Databend 中的工作负载组允许您管理和优先分配不同类型查询和用户的资源，有助于优化性能和资源利用率。 +::: \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/00-array-functions/index.md b/docs/cn/sql-reference/20-sql-functions/00-array-functions/index.md index e81815a0e1..4796cbb1d4 100644 --- a/docs/cn/sql-reference/20-sql-functions/00-array-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/00-array-functions/index.md @@ -1,9 +1,43 @@ --- -title: 数组函数 +title: 数组函数 (Array Functions) --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面全面概述了 Databend 中的数组函数，按功能分类以便参考。 -本节提供 Databend 中数组函数的参考信息。 +## 数组创建和操作 - +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [ARRAY_APPEND](array-append.md) | 在数组末尾添加元素 | `ARRAY_APPEND([1, 2], 3)` → `[1,2,3]` | +| [ARRAY_CONCAT](array-concat.md) | 连接两个数组 | `ARRAY_CONCAT([1, 2], [3, 4])` → `[1,2,3,4]` | +| [ARRAY_PREPEND](array-prepend.md) | 在数组开头添加元素 | `ARRAY_PREPEND(0, [1, 2])` → `[0,1,2]` | +| [ARRAY_DISTINCT](array-distinct.md) | 移除数组中的重复元素 | `ARRAY_DISTINCT([1, 1, 2, 2])` → `[1,2]` | +| [ARRAY_FLATTEN](array-flatten.md) | 将嵌套数组扁平化为单层数组 | `ARRAY_FLATTEN([[1, 2], [3, 4]])` → `[1,2,3,4]` | +| [ARRAY_REMOVE_FIRST](array-remove-first.md) | 移除数组的首个元素 | `ARRAY_REMOVE_FIRST([1, 2, 3])` → `[2,3]` | +| [ARRAY_REMOVE_LAST](array-remove-last.md) | 移除数组的末尾元素 | `ARRAY_REMOVE_LAST([1, 2, 3])` → `[1,2]` | +| [ARRAY_SORT](array-sort.md) | 对数组元素进行排序 | `ARRAY_SORT([3, 1, 2])` → `[1,2,3]` | +| [ARRAY_UNIQUE](array-unique.md) | 移除数组中的重复元素 | `ARRAY_UNIQUE([1, 1, 2, 2])` → `[1,2]` | +| [ARRAYS_ZIP](arrays-zip.md) | 将多个数组合并为元组数组 | `ARRAYS_ZIP([1, 2], ['a', 'b'])` → `[(1,'a'),(2,'b')]` | +| [RANGE](range.md) | 生成指定范围的整数数组 | `RANGE(1, 5)` → `[1,2,3,4]` | + +## 数组访问和信息 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [ARRAY_GET](array-get.md) / [GET](get.md) | 获取指定位置的元素 | `ARRAY_GET([1, 2, 3], 1)` → `2` | +| [ARRAY_LENGTH](array-length.md) / [ARRAY_SIZE](array-size.md) | 返回数组元素数量 | `ARRAY_LENGTH([1, 2, 3])` → `3` | +| [ARRAY_INDEXOF](array-indexof.md) | 返回元素首次出现的位置 | `ARRAY_INDEXOF([1, 2, 3], 2)` → `1` | +| [ARRAY_CONTAINS](array-contains.md) / [CONTAINS](contains.md) | 检查数组是否包含特定元素 | `CONTAINS([1, 2, 3], 2)` → `true` | +| [SLICE](slice.md) / [ARRAY_SLICE](array-slice.md) | 提取子数组 | `SLICE([1, 2, 3, 4], 1, 2)` → `[2,3]` | + +## 数组转换 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [ARRAY_TRANSFORM](array-transform.md) | 对每个元素应用 lambda 函数 | `ARRAY_TRANSFORM([1, 2, 3], x -> x * 2)` → `[2,4,6]` | +| [ARRAY_FILTER](array-filter.md) | 根据 lambda 条件过滤元素 | `ARRAY_FILTER([1, 2, 3], x -> x > 1)` → `[2,3]` | +| [ARRAY_REDUCE](array-reduce.md) | 使用 lambda 函数将数组归约为单个值 | `ARRAY_REDUCE([1, 2, 3], 0, (s, x) -> s + x)` → `6` | +| [ARRAY_APPLY](array-apply.md) | 对每个元素应用函数 | `ARRAY_APPLY([1, 2, 3], x -> x * x)` → `[1,4,9]` | +| [ARRAY_AGGREGATE](array-aggregate.md) | 对数组元素应用聚合函数 | `ARRAY_AGGREGATE([1, 2, 3], 'sum')` → `6` | +| [ARRAY_TO_STRING](array-to-string.md) | 用分隔符将数组转换为字符串 | `ARRAY_TO_STRING([1, 2, 3], ',')` → `'1,2,3'` | +| [UNNEST](unnest.md) | 将数组展开为行集合 | `SELECT UNNEST([1, 2, 3])` → `1`, `2`, `3` (作为行) | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/01-bitmap-functions/index.md b/docs/cn/sql-reference/20-sql-functions/01-bitmap-functions/index.md index 029163439e..ff1af0b536 100644 --- a/docs/cn/sql-reference/20-sql-functions/01-bitmap-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/01-bitmap-functions/index.md @@ -1,9 +1,47 @@ --- -title: Bitmap 函数 +title: 位图（Bitmap）函数 --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面全面介绍 Databend 中的位图函数，按功能分类以便查阅。 -本节提供 Databend 中位图函数的参考信息。 +## 位图操作 - \ No newline at end of file +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [BITMAP_AND](bitmap-and.md) | 对两个位图执行按位与 | `BITMAP_AND(BUILD_BITMAP([1,4,5]), BUILD_BITMAP([4,5]))` → `{4,5}` | +| [BITMAP_OR](bitmap-or.md) | 对两个位图执行按位或 | `BITMAP_OR(BUILD_BITMAP([1,2]), BUILD_BITMAP([2,3]))` → `{1,2,3}` | +| [BITMAP_XOR](bitmap-xor.md) | 对两个位图执行按位异或 | `BITMAP_XOR(BUILD_BITMAP([1,2,3]), BUILD_BITMAP([2,3,4]))` → `{1,4}` | +| [BITMAP_NOT](bitmap-not.md) | 对位图执行按位非 | `BITMAP_NOT(BUILD_BITMAP([1,2,3]), 5)` → `{0,4}` | +| [BITMAP_AND_NOT](bitmap-and-not.md) | 返回第一个位图存在但第二个位图不存在的元素 | `BITMAP_AND_NOT(BUILD_BITMAP([1,2,3]), BUILD_BITMAP([2,3]))` → `{1}` | +| [BITMAP_UNION](bitmap-union.md) | 合并多个位图 | `BITMAP_UNION([BUILD_BITMAP([1,2]), BUILD_BITMAP([2,3])])` → `{1,2,3}` | +| [BITMAP_INTERSECT](bitmap-intersect.md) | 返回多个位图的交集 | `BITMAP_INTERSECT([BUILD_BITMAP([1,2,3]), BUILD_BITMAP([2,3,4])])` → `{2,3}` | + +## 位图信息 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [BITMAP_COUNT](bitmap-count.md) | 返回位图元素数量 | `BITMAP_COUNT(BUILD_BITMAP([1,2,3]))` → `3` | +| [BITMAP_CONTAINS](bitmap-contains.md) | 检查位图是否包含特定元素 | `BITMAP_CONTAINS(BUILD_BITMAP([1,2,3]), 2)` → `true` | +| [BITMAP_HAS_ANY](bitmap-has-any.md) | 检查位图是否包含另一位图的任意元素 | `BITMAP_HAS_ANY(BUILD_BITMAP([1,2,3]), BUILD_BITMAP([3,4]))` → `true` | +| [BITMAP_HAS_ALL](bitmap-has-all.md) | 检查位图是否包含另一位图的所有元素 | `BITMAP_HAS_ALL(BUILD_BITMAP([1,2,3]), BUILD_BITMAP([2,3]))` → `true` | +| [BITMAP_MIN](bitmap-min.md) | 返回位图最小元素 | `BITMAP_MIN(BUILD_BITMAP([1,2,3]))` → `1` | +| [BITMAP_MAX](bitmap-max.md) | 返回位图最大元素 | `BITMAP_MAX(BUILD_BITMAP([1,2,3]))` → `3` | +| [BITMAP_CARDINALITY](bitmap-cardinality.md) | 返回位图元素数量 | `BITMAP_CARDINALITY(BUILD_BITMAP([1,2,3]))` → `3` | + +## 位图计数操作 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [BITMAP_AND_COUNT](bitmap-and-count.md) | 返回两个位图按位与的元素数量 | `BITMAP_AND_COUNT(BUILD_BITMAP([1,2,3]), BUILD_BITMAP([2,3,4]))` → `2` | +| [BITMAP_OR_COUNT](bitmap-or-count.md) | 返回两个位图按位或的元素数量 | `BITMAP_OR_COUNT(BUILD_BITMAP([1,2]), BUILD_BITMAP([2,3]))` → `3` | +| [BITMAP_XOR_COUNT](bitmap-xor-count.md) | 返回两个位图按位异或的元素数量 | `BITMAP_XOR_COUNT(BUILD_BITMAP([1,2,3]), BUILD_BITMAP([2,3,4]))` → `2` | +| [BITMAP_NOT_COUNT](bitmap-not-count.md) | 返回位图按位非的元素数量 | `BITMAP_NOT_COUNT(BUILD_BITMAP([1,2,3]), 5)` → `2` | +| [INTERSECT_COUNT](intersect-count.md) | 返回多个位图交集的元素数量 | `INTERSECT_COUNT([BUILD_BITMAP([1,2,3]), BUILD_BITMAP([2,3,4])])` → `2` | + +## 位图子集操作 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [SUB_BITMAP](sub-bitmap.md) | 提取位图子集 | `SUB_BITMAP(BUILD_BITMAP([1,2,3,4,5]), 1, 3)` → `{2,3,4}` | +| [BITMAP_SUBSET_IN_RANGE](bitmap-subset-in-range.md) | 返回指定范围内的位图子集 | `BITMAP_SUBSET_IN_RANGE(BUILD_BITMAP([1,2,3,4,5]), 2, 4)` → `{2,3}` | +| [BITMAP_SUBSET_LIMIT](bitmap-subset-limit.md) | 返回带数量限制的位图子集 | `BITMAP_SUBSET_LIMIT(BUILD_BITMAP([1,2,3,4,5]), 2, 2)` → `{3,4}` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/02-conversion-functions/cast.md b/docs/cn/sql-reference/20-sql-functions/02-conversion-functions/cast.md index 48f7f47d2b..fc843bccc5 100644 --- a/docs/cn/sql-reference/20-sql-functions/02-conversion-functions/cast.md +++ b/docs/cn/sql-reference/20-sql-functions/02-conversion-functions/cast.md @@ -1,8 +1,8 @@ --- -title: "CAST, ::" +title: "CAST::" --- -将一个值从一种数据类型转换为另一种数据类型。`::` 是 CAST 的别名。 +将值从一种数据类型转换为另一种数据类型。`::` 是 CAST 的别名。 另请参阅：[TRY_CAST](try-cast.md) @@ -26,7 +26,8 @@ SELECT CAST(1 AS VARCHAR), 1::VARCHAR; └───────────────────────────────┘ ``` -将字符串转换为 Variant 并将 Variant 转换为 `Map` +将字符串转换为 +变体类型（Variant），再将其转换为 `Map` ```sql select '{"k1":"v1","k2":"v2"}'::Variant a, a::Map(String, String) b, b::Variant = a; ┌──────────────────────┬──────────────────────┬────────────────┐ diff --git a/docs/cn/sql-reference/20-sql-functions/02-conversion-functions/index.md b/docs/cn/sql-reference/20-sql-functions/02-conversion-functions/index.md index 7ef5b6986d..37babd8d44 100644 --- a/docs/cn/sql-reference/20-sql-functions/02-conversion-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/02-conversion-functions/index.md @@ -1,18 +1,51 @@ --- -title: '转换函数' +title: '转换函数（Conversion Functions）' --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面全面概述了 Databend 中的转换函数（Conversion Functions），按功能组织以便参考。 -本节提供 Databend 中转换函数的参考信息。 +## 类型转换函数（Type Conversion Functions） - +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [CAST](cast.md) | 将值转换为指定的数据类型 | `CAST('123' AS INT)` → `123` | +| [TRY_CAST](try-cast.md) | 安全地将值转换为指定数据类型，失败时返回 NULL | `TRY_CAST('abc' AS INT)` → `NULL` | +| [TO_BOOLEAN](to-boolean.md) | 将值转换为 BOOLEAN 类型 | `TO_BOOLEAN('true')` → `true` | +| [TO_STRING](to-string.md) | 将值转换为 STRING 类型 | `TO_STRING(123)` → `'123'` | +| [TO_VARCHAR](to-varchar.md) | 将值转换为 VARCHAR 类型 | `TO_VARCHAR(123)` → `'123'` | +| [TO_TEXT](to-text.md) | 将值转换为 TEXT 类型 | `TO_TEXT(123)` → `'123'` | -在将一个值从一种类型转换为另一种类型时，请注意以下事项： +## 数值转换函数（Numeric Conversion Functions） -- 当从浮点数、十进制数或字符串转换为整数或带有小数部分的十进制数时，Databend 会将值四舍五入为最接近的整数。这是由设置 `numeric_cast_option`（默认为 'rounding'）控制的，该设置控制数值类型转换操作的行为。当 `numeric_cast_option` 被显式设置为 'truncating' 时，Databend 将截断小数部分，丢弃任何小数值。 +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [TO_INT8](to-int8.md) | 将值转换为 INT8 类型 | `TO_INT8('123')` → `123` | +| [TO_INT16](to-int16.md) | 将值转换为 INT16 类型 | `TO_INT16('123')` → `123` | +| [TO_INT32](to-int32.md) | 将值转换为 INT32 类型 | `TO_INT32('123')` → `123` | +| [TO_INT64](to-int64.md) | 将值转换为 INT64 类型 | `TO_INT64('123')` → `123` | +| [TO_UINT8](to-uint8.md) | 将值转换为 UINT8 类型 | `TO_UINT8('123')` → `123` | +| [TO_UINT16](to-uint16.md) | 将值转换为 UINT16 类型 | `TO_UINT16('123')` → `123` | +| [TO_UINT32](to-uint32.md) | 将值转换为 UINT32 类型 | `TO_UINT32('123')` → `123` | +| [TO_UINT64](to-uint64.md) | 将值转换为 UINT64 类型 | `TO_UINT64('123')` → `123` | +| [TO_FLOAT32](to-float32.md) | 将值转换为 FLOAT32 类型 | `TO_FLOAT32('123.45')` → `123.45` | +| [TO_FLOAT64](to-float64.md) | 将值转换为 FLOAT64 类型 | `TO_FLOAT64('123.45')` → `123.45` | - ```sql title='示例:' +## 二进制和专用转换函数（Binary and Specialized Conversion Functions） + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [TO_BINARY](to-binary.md) | 将值转换为 BINARY 类型 | `TO_BINARY('abc')` → `binary value` | +| [TRY_TO_BINARY](try-to-binary.md) | 安全地将值转换为 BINARY 类型，失败时返回 NULL | `TRY_TO_BINARY('abc')` → `binary value` | +| [TO_HEX](to-hex.md) | 将值转换为十六进制字符串 | `TO_HEX(255)` → `'FF'` | +| [TO_VARIANT](to-variant.md) | 将值转换为 VARIANT 类型 | `TO_VARIANT('{"a": 1}')` → `{"a": 1}` | +| [BUILD_BITMAP](build-bitmap.md) | 从整数数组构建位图 | `BUILD_BITMAP([1,2,3])` → `bitmap value` | +| [TO_BITMAP](to-bitmap.md) | 将值转换为 BITMAP 类型 | `TO_BITMAP([1,2,3])` → `bitmap value` | + +在将值从一种类型转换为另一种类型时，请注意以下事项： + +- 当从浮点数、十进制数或字符串转换为整数或带小数部分的十进制数时，Databend 会将值四舍五入到最接近的整数。该行为由 `numeric_cast_option` 设置控制（默认为 'rounding'），它决定了数值转换操作的方式。当 `numeric_cast_option` 设置为 'truncating' 时，Databend 会截断小数部分，丢弃任何小数值。 + + ```sql title='示例：' SELECT CAST('0.6' AS DECIMAL(10, 0)), CAST(0.6 AS DECIMAL(10, 0)), CAST(1.5 AS INT); ┌──────────────────────────────────────────────────────────────────────────────────┐ @@ -32,16 +65,16 @@ import IndexOverviewList from '@site/src/components/IndexOverviewList'; └──────────────────────────────────────────────────────────────────────────────────┘ ``` - 下表总结了数值类型转换操作，突出显示了不同源和目标数值数据类型之间的转换可能性。请注意，它指定了字符串到整数转换的要求，其中源字符串必须包含一个整数值。 + 下表总结了数值转换操作，突出显示了不同源数据类型和目标数值数据类型之间的转换可能性。请注意，字符串到整数转换要求源字符串必须包含整数值。 - | 源类型 | 目标类型 | + | 源类型 | 目标类型 | |----------------|-------------| - | 字符串 | 十进制 | - | 浮点数 | 十进制 | - | 十进制 | 十进制 | - | 浮点数 | 整数 | - | 十进制 | 整数 | - | 字符串（整数） | 整数 | + | String | Decimal | + | Float | Decimal | + | Decimal | Decimal | + | Float | Int | + | Decimal | Int | + | String (Int) | Int | -- Databend 还提供了多种函数，用于将表达式转换为不同的日期和时间格式。更多信息，请参见 [日期与时间函数](../05-datetime-functions/index.md)。 \ No newline at end of file +- Databend 还提供多种函数，用于将表达式转换为不同的日期和时间格式。更多信息，请参阅[日期时间函数（Date & Time Functions）](../05-datetime-functions/index.md)。 \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/03-conditional-functions/index.md b/docs/cn/sql-reference/20-sql-functions/03-conditional-functions/index.md index faefd01326..48f1fce3a6 100644 --- a/docs/cn/sql-reference/20-sql-functions/03-conditional-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/03-conditional-functions/index.md @@ -1,9 +1,40 @@ --- -title: '条件函数' +title: '条件函数（Conditional Functions）' --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面全面概述了 Databend 中的条件函数，按功能分类以便参考。 -本节提供 Databend 中条件函数的参考信息。 +## 基本条件函数 - \ No newline at end of file +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [IF](if.md) / [IFF](iff.md) | 根据条件返回值 | `IF(1 > 0, 'yes', 'no')` → `'yes'` | +| [CASE](case.md) | 评估条件并返回匹配结果 | `CASE WHEN 1 > 0 THEN 'yes' ELSE 'no' END` → `'yes'` | +| [DECODE](decode.md) | 比较表达式与搜索值并返回结果 | `DECODE(2, 1, 'one', 2, 'two', 'other')` → `'two'` | +| [COALESCE](coalesce.md) | 返回第一个非 NULL 表达式 | `COALESCE(NULL, 'hello', 'world')` → `'hello'` | +| [NULLIF](nullif.md) | 若两表达式相等则返回 NULL，否则返回第一个表达式 | `NULLIF(5, 5)` → `NULL` | +| [IFNULL](ifnull.md) | 若第一个表达式不为 NULL 则返回该值，否则返回第二个 | `IFNULL(NULL, 'default')` → `'default'` | +| [NVL](nvl.md) | 返回第一个非 NULL 表达式 | `NVL(NULL, 'default')` → `'default'` | +| [NVL2](nvl2.md) | 若 expr1 不为 NULL 则返回 expr2，否则返回 expr3 | `NVL2('value', 'not null', 'is null')` → `'not null'` | + +## 比较函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [GREATEST](greatest.md) | 从列表中返回最大值 | `GREATEST(1, 5, 3)` → `5` | +| [LEAST](least.md) | 从列表中返回最小值 | `LEAST(1, 5, 3)` → `1` | +| [GREATEST_IGNORE_NULLS](greatest-ignore-nulls.md) | 返回最大的非 NULL 值 | `GREATEST_IGNORE_NULLS(NULL, 5, 3)` → `5` | +| [LEAST_IGNORE_NULLS](least-ignore-nulls.md) | 返回最小的非 NULL 值 | `LEAST_IGNORE_NULLS(NULL, 5, 3)` → `3` | +| [BETWEEN](between.md) | 检查值是否在指定范围内 | `5 BETWEEN 1 AND 10` → `true` | +| [IN](in.md) | 检查值是否匹配列表中的任意值 | `5 IN (1, 5, 10)` → `true` | + +## NULL 和错误处理函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [IS_NULL](is-null.md) | 检查值是否为 NULL | `IS_NULL(NULL)` → `true` | +| [IS_NOT_NULL](is-not-null.md) | 检查值是否不为 NULL | `IS_NOT_NULL('value')` → `true` | +| [IS_DISTINCT_FROM](is-distinct-from.md) | 检查两值是否不同，将 NULL 视为相同值 | `NULL IS DISTINCT FROM 0` → `true` | +| [IS_ERROR](is-error.md) | 检查表达式计算是否导致错误 | `IS_ERROR(1/0)` → `true` | +| [IS_NOT_ERROR](is-not-error.md) | 检查表达式计算是否未导致错误 | `IS_NOT_ERROR(1/1)` → `true` | +| [ERROR_OR](error-or.md) | 若第一个表达式无错误则返回该值，否则返回第二个 | `ERROR_OR(1/0, 0)` → `0` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/04-numeric-functions/index.md b/docs/cn/sql-reference/20-sql-functions/04-numeric-functions/index.md index 72442e069a..6fa8b4461b 100644 --- a/docs/cn/sql-reference/20-sql-functions/04-numeric-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/04-numeric-functions/index.md @@ -1,9 +1,69 @@ --- -title: 数值函数 +title: 数值函数（Numeric Functions） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面提供了 Databend 中数值函数的全面概述，按功能分类，便于参考。 -本节提供 Databend 中数值函数的参考信息。 +## 基本算术函数（Basic Arithmetic Functions） - \ No newline at end of file +| 函数（Function） | 描述（Description） | 示例（Example） | +|----------|-------------|---------| +| [PLUS](plus.md) / [ADD](add.md) | 加法运算符 | `5 + 3` → `8` | +| [MINUS](minus.md) / [SUBTRACT](subtract.md) | 减法运算符 | `5 - 3` → `2` | +| [MULTIPLY](multiply.md) | 乘法运算符 | `5 * 3` → `15` | +| [DIV](div.md) | 除法运算符 | `10 / 2` → `5.0` | +| [DIV0](div0.md) | 除数为零时返回 0 而不报错 | `DIV0(10, 0)` → `0` | +| [DIVNULL](divnull.md) | 除数为零时返回 NULL 而不报错 | `DIVNULL(10, 0)` → `NULL` | +| [INTDIV](intdiv.md) | 整数除法 | `10 DIV 3` → `3` | +| [MOD](mod.md) / [MODULO](modulo.md) | 取模运算（余数） | `10 % 3` → `1` | +| [NEG](neg.md) / [NEGATE](negate.md) | 取负 | `-5` → `-5` | + +## 舍入和截断函数（Rounding and Truncation Functions） + +| 函数（Function） | 描述（Description） | 示例（Example） | +|----------|-------------|---------| +| [ROUND](round.md) | 将数字舍入到指定的小数位数 | `ROUND(123.456, 2)` → `123.46` | +| [FLOOR](floor.md) | 返回不大于参数的最大整数 | `FLOOR(123.456)` → `123` | +| [CEIL](ceil.md) / [CEILING](ceiling.md) | 返回不小于参数的最小整数 | `CEIL(123.456)` → `124` | +| [TRUNCATE](truncate.md) | 将数字截断到指定的小数位数 | `TRUNCATE(123.456, 1)` → `123.4` | + +## 指数和对数函数（Exponential and Logarithmic Functions） + +| 函数（Function） | 描述（Description） | 示例（Example） | +|----------|-------------|---------| +| [EXP](exp.md) | 返回 e 的 x 次幂 | `EXP(1)` → `2.718281828459045` | +| [POW](pow.md) / [POWER](power.md) | 返回 x 的 y 次幂 | `POW(2, 3)` → `8` | +| [SQRT](sqrt.md) | 返回 x 的平方根 | `SQRT(16)` → `4` | +| [CBRT](cbrt.md) | 返回 x 的立方根 | `CBRT(27)` → `3` | +| [LN](ln.md) | 返回 x 的自然对数 | `LN(2.718281828459045)` → `1` | +| [LOG10](log10.md) | 返回 x 的以 10 为底的对数 | `LOG10(100)` → `2` | +| [LOG2](log2.md) | 返回 x 的以 2 为底的对数 | `LOG2(8)` → `3` | +| [LOGX](logx.md) | 返回以 x 为底的 y 的对数 | `LOGX(2, 8)` → `3` | +| [LOGBX](logbx.md) | 返回以 b 为底的 x 的对数 | `LOGBX(8, 2)` → `3` | + +## 三角函数（Trigonometric Functions） + +| 函数（Function） | 描述（Description） | 示例（Example） | +|----------|-------------|---------| +| [SIN](sin.md) | 返回 x 的正弦值 | `SIN(0)` → `0` | +| [COS](cos.md) | 返回 x 的余弦值 | `COS(0)` → `1` | +| [TAN](tan.md) | 返回 x 的正切值 | `TAN(0)` → `0` | +| [COT](cot.md) | 返回 x 的余切值 | `COT(1)` → `0.6420926159343306` | +| [ASIN](asin.md) | 返回 x 的反正弦值 | `ASIN(1)` → `1.5707963267948966` | +| [ACOS](acos.md) | 返回 x 的反余弦值 | `ACOS(1)` → `0` | +| [ATAN](atan.md) | 返回 x 的反正切值 | `ATAN(1)` → `0.7853981633974483` | +| [ATAN2](atan2.md) | 返回 y/x 的反正切值 | `ATAN2(1, 1)` → `0.7853981633974483` | +| [DEGREES](degrees.md) | 将弧度转换为度数 | `DEGREES(PI())` → `180` | +| [RADIANS](radians.md) | 将度数转换为弧度 | `RADIANS(180)` → `3.141592653589793` | +| [PI](pi.md) | 返回 π 的值 | `PI()` → `3.141592653589793` | + +## 其他数值函数（Other Numeric Functions） + +| 函数（Function） | 描述（Description） | 示例（Example） | +|----------|-------------|---------| +| [ABS](abs.md) | 返回 x 的绝对值 | `ABS(-5)` → `5` | +| [SIGN](sign.md) | 返回 x 的符号 | `SIGN(-5)` → `-1` | +| [FACTORIAL](factorial.md) | 返回 x 的阶乘 | `FACTORIAL(5)` → `120` | +| [RAND](rand.md) | 返回 0 到 1 之间的随机数 | `RAND()` → `0.123...` (随机) | +| [RANDN](randn.md) | 返回标准正态分布的随机数 | `RANDN()` → `-0.123...` (随机) | +| [CRC32](crc32.md) | 返回字符串的 CRC32 校验和 | `CRC32('Databend')` → `3899655467` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/04-numeric-functions/multiply.md b/docs/cn/sql-reference/20-sql-functions/04-numeric-functions/multiply.md new file mode 100644 index 0000000000..77670b67c0 --- /dev/null +++ b/docs/cn/sql-reference/20-sql-functions/04-numeric-functions/multiply.md @@ -0,0 +1,70 @@ +--- +title: MULTIPLY +--- + +MULTIPLY 函数用于执行两个数字的乘法运算，等价于 `*` 运算符。 + +## 语法 + +```sql +MULTIPLY(x, y) +-- 或使用运算符语法 +x * y +``` + +## 参数 + +| 参数 | 描述 | +|------|--------------| +| x, y | 相乘的数值表达式 | + +## 返回类型 + +根据输入参数返回对应数据类型的数值结果。 + +## 示例 + +```sql +-- 函数语法 +SELECT MULTIPLY(5, 3); ++----------------+ +| MULTIPLY(5, 3) | ++----------------+ +| 15 | ++----------------+ + +-- 运算符语法 +SELECT 5 * 3; ++-------+ +| 5 * 3 | ++-------+ +| 15 | ++-------+ + +-- 小数运算 +SELECT MULTIPLY(2.5, 4); ++------------------+ +| MULTIPLY(2.5, 4) | ++------------------+ +| 10.0 | ++------------------+ + +-- 列引用 +SELECT number, MULTIPLY(number, 10) AS multiplied +FROM numbers(5); ++--------+------------+ +| number | multiplied | ++--------+------------+ +| 0 | 0 | +| 1 | 10 | +| 2 | 20 | +| 3 | 30 | +| 4 | 40 | ++--------+------------+ +``` + +## 另请参阅 + +- [PLUS](plus.md) / [ADD](add.md) +- [MINUS](minus.md) / [SUBTRACT](subtract.md) +- [DIV](div.md) \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/05-datetime-functions/index.md b/docs/cn/sql-reference/20-sql-functions/05-datetime-functions/index.md index cae662dd7c..2a89ebcd0a 100644 --- a/docs/cn/sql-reference/20-sql-functions/05-datetime-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/05-datetime-functions/index.md @@ -1,79 +1,85 @@ --- -title: 日期 & 时间函数 +title: 日期与时间函数（Date & Time Functions） --- -本节提供了 Databend 中与日期时间相关的函数的参考信息。 +本页面提供 Databend 中日期与时间函数的全面概览，按功能分类以便参考。 -## 转换函数 +## 当前日期与时间函数 -- [DATE](date.md) -- [TO_MONTH](to-month) -- [MONTH](month.md) -- [TO_DATE](to-date) -- [TO_DATETIME](to-datetime) -- [TODAY](today.md) -- [TO_DAY_OF_MONTH](to-day-of-month) -- [DAY](day.md) -- [TO_DAY_OF_WEEK](to-day-of-week) -- [TO_DAY_OF_YEAR](to-day-of-year) -- [TO_HOUR](to-hour) -- [TO_MINUTE](to-minute) -- [TO_MONDAY](to-monday) -- [TOMORROW](tomorrow.md) -- [TO_QUARTER](to-quarter) -- [QUARTER](quarter.md) -- [TO_SECOND](to-second) -- [TO_START_OF_DAY](to-start-of-day) -- [TO_START_OF_FIFTEEN_MINUTES](to-start-of-fifteen-minutes) -- [TO_START_OF_FIVE_MINUTES](to-start-of-five-minutes) -- [TO_START_OF_HOUR](to-start-of-hour) -- [TO_START_OF_ISO_YEAR](to-start-of-iso-year) -- [TO_START_OF_MINUTE](to-start-of-minute) -- [TO_START_OF_MONTH](to-start-of-month) -- [TO_START_OF_QUARTER](to-start-of-quarter) -- [TO_START_OF_SECOND](to-start-of-second) -- [TO_START_OF_TENMINUTES](to-start-of-ten-minutes) -- [TO_START_OF_WEEK](to-start-of-week) -- [TO_START_OF_YEAR](to-start-of-year) -- [TO_TIMESTAMP](to-timestamp) -- [TO_UNIX_TIMESTAMP](to-unix-timestamp) -- [TO_WEEK_OF_YEAR](to-week-of-year) -- [WEEK](week.md) -- [WEEKOFYEAR](weekofyear.md) -- [TO_YEAR](to-year) -- [YEAR](year.md) -- [TO_YYYYMM](to-yyyymm) -- [TO_YYYYMMDD](to-yyyymmdd) -- [TO_YYYYMMDDHH](to-yyyymmddhh) -- [TO_YYYYMMDDHHMMSS](to-yyyymmddhhmmss) -- [MILLENNIUM](millennium.md) -- [YEARWEEK](yearweek.md) +| 函数 | 描述 | 示例 | +|------|------|------| +| [NOW](now.md) | 返回当前日期和时间 | `NOW()` → `2024-06-04 17:42:31.123456` | +| [CURRENT_TIMESTAMP](current-timestamp.md) | 返回当前日期和时间 | `CURRENT_TIMESTAMP()` → `2024-06-04 17:42:31.123456` | +| [TODAY](today.md) | 返回当前日期 | `TODAY()` → `2024-06-04` | +| [TOMORROW](tomorrow.md) | 返回明日日期 | `TOMORROW()` → `2024-06-05` | +| [YESTERDAY](yesterday.md) | 返回昨日日期 | `YESTERDAY()` → `2024-06-03` | -## 日期算术函数 +## 日期与时间提取函数 -- [ADD INTERVAL](addinterval.md) -- [DATE_ADD](date-add) -- [DATE_SUB](date-sub) -- [DATE_DIFF](date-diff) -- [DATE_BETWEEN](date-between.md) -- [SUBTRACT INTERVAL](subtractinterval.md) -- [MONTHS_BETWEEN](months-between.md) -- [LAST_DAY](last-day.md) -- [NEXT_DAY](next-day.md) -- [PREVIOUS_DAY](previous-day.md) -- [TIMESTAMP_DIFF](timestamp-diff.md) +| 函数 | 描述 | 示例 | +|------|------|------| +| [YEAR](year.md) | 提取日期中的年份 | `YEAR('2024-06-04')` → `2024` | +| [MONTH](month.md) | 提取日期中的月份 | `MONTH('2024-06-04')` → `6` | +| [DAY](day.md) | 提取日期中的天数 | `DAY('2024-06-04')` → `4` | +| [QUARTER](quarter.md) | 提取日期中的季度 | `QUARTER('2024-06-04')` → `2` | +| [WEEK](week.md) / [WEEKOFYEAR](weekofyear.md) | 提取日期中的周数 | `WEEK('2024-06-04')` → `23` | +| [EXTRACT](extract.md) | 提取日期的指定部分 | `EXTRACT(MONTH FROM '2024-06-04')` → `6` | +| [DATE_PART](date-part.md) | 提取日期的指定部分 | `DATE_PART('month', '2024-06-04')` → `6` | +| [YEARWEEK](yearweek.md) | 返回年份和周数组合值 | `YEARWEEK('2024-06-04')` → `202423` | +| [MILLENNIUM](millennium.md) | 返回日期所属的千禧年 | `MILLENNIUM('2024-06-04')` → `3` | -## 日期信息函数 +## 日期与时间转换函数 -- [DATE_PART](date-part.md) -- [DATE_FORMAT](date-format) -- [DATE_TRUNC](date-trunc) -- [NOW](now.md) -- [CURRENT_TIMESTAMP](current-timestamp.md) +| 函数 | 描述 | 示例 | +|------|------|------| +| [DATE](date.md) | 转换值为 DATE 类型 | `DATE('2024-06-04')` → `2024-06-04` | +| [TO_DATE](to-date.md) | 转换字符串为 DATE 类型 | `TO_DATE('2024-06-04')` → `2024-06-04` | +| [TO_DATETIME](to-datetime.md) | 转换字符串为 DATETIME 类型 | `TO_DATETIME('2024-06-04 12:30:45')` → `2024-06-04 12:30:45` | +| [TO_TIMESTAMP](to-timestamp.md) | 转换字符串为 TIMESTAMP 类型 | `TO_TIMESTAMP('2024-06-04 12:30:45')` → `2024-06-04 12:30:45` | +| [TO_UNIX_TIMESTAMP](to-unix-timestamp.md) | 转换日期为 Unix 时间戳 | `TO_UNIX_TIMESTAMP('2024-06-04')` → `1717516800` | +| [TO_YYYYMM](to-yyyymm.md) | 格式化日期为 YYYYMM | `TO_YYYYMM('2024-06-04')` → `202406` | +| [TO_YYYYMMDD](to-yyyymmdd.md) | 格式化日期为 YYYYMMDD | `TO_YYYYMMDD('2024-06-04')` → `20240604` | +| [TO_YYYYMMDDHH](to-yyyymmddhh.md) | 格式化日期为 YYYYMMDDHH | `TO_YYYYMMDDHH('2024-06-04 12:30:45')` → `2024060412` | +| [TO_YYYYMMDDHHMMSS](to-yyyymmddhhmmss.md) | 格式化日期为 YYYYMMDDHHMMSS | `TO_YYYYMMDDHHMMSS('2024-06-04 12:30:45')` → `20240604123045` | +| [DATE_FORMAT](date-format.md) | 按格式字符串格式化日期 | `DATE_FORMAT('2024-06-04', '%Y-%m-%d')` → `'2024-06-04'` | -## 其他 +## 日期与时间算术函数 -- [EXTRACT](extract.md) -- [TIME_SLOT](time-slot) -- [TIMEZONE](timezone.md) -- [YESTERDAY](yesterday.md) \ No newline at end of file +| 函数 | 描述 | 示例 | +|------|------|------| +| [DATE_ADD](date-add.md) | 为日期添加时间间隔 | `DATE_ADD(DAY, 7, '2024-06-04')` → `2024-06-11` | +| [DATE_SUB](date-sub.md) | 从日期减去时间间隔 | `DATE_SUB(MONTH, 1, '2024-06-04')` → `2024-05-04` | +| [ADD INTERVAL](addinterval.md) | 为日期添加间隔 | `'2024-06-04' + INTERVAL 1 DAY` → `2024-06-05` | +| [SUBTRACT INTERVAL](subtractinterval.md) | 从日期减去间隔 | `'2024-06-04' - INTERVAL 1 MONTH` → `2024-05-04` | +| [DATE_DIFF](date-diff.md) | 计算两个日期的差值 | `DATE_DIFF(DAY, '2024-06-01', '2024-06-04')` → `3` | +| [TIMESTAMP_DIFF](timestamp-diff.md) | 计算两个时间戳的差值 | `TIMESTAMP_DIFF(HOUR, '2024-06-04 10:00:00', '2024-06-04 15:00:00')` → `5` | +| [MONTHS_BETWEEN](months-between.md) | 计算两个日期间的月份数 | `MONTHS_BETWEEN('2024-06-04', '2024-01-04')` → `5` | +| [DATE_BETWEEN](date-between.md) | 判断日期是否在指定范围内 | `DATE_BETWEEN('2024-06-04', '2024-06-01', '2024-06-10')` → `true` | + +## 日期与时间截断函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [DATE_TRUNC](date-trunc.md) | 按精度截断时间戳 | `DATE_TRUNC('month', '2024-06-04')` → `2024-06-01` | +| [TO_START_OF_DAY](to-start-of-day.md) | 返回某日的起始时刻 | `TO_START_OF_DAY('2024-06-04 12:30:45')` → `2024-06-04 00:00:00` | +| [TO_START_OF_HOUR](to-start-of-hour.md) | 返回某小时的起始时刻 | `TO_START_OF_HOUR('2024-06-04 12:30:45')` → `2024-06-04 12:00:00` | +| [TO_START_OF_MINUTE](to-start-of-minute.md) | 返回某分钟的起始时刻 | `TO_START_OF_MINUTE('2024-06-04 12:30:45')` → `2024-06-04 12:30:00` | +| [TO_START_OF_MONTH](to-start-of-month.md) | 返回某月的起始日期 | `TO_START_OF_MONTH('2024-06-04')` → `2024-06-01` | +| [TO_START_OF_QUARTER](to-start-of-quarter.md) | 返回某季度的起始日期 | `TO_START_OF_QUARTER('2024-06-04')` → `2024-04-01` | +| [TO_START_OF_YEAR](to-start-of-year.md) | 返回某年的起始日期 | `TO_START_OF_YEAR('2024-06-04')` → `2024-01-01` | +| [TO_START_OF_WEEK](to-start-of-week.md) | 返回某周的起始日期 | `TO_START_OF_WEEK('2024-06-04')` → `2024-06-03` | + +## 日期与时间导航函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [LAST_DAY](last-day.md) | 返回月份的最后一天 | `LAST_DAY('2024-06-04')` → `2024-06-30` | +| [NEXT_DAY](next-day.md) | 返回下个指定星期的日期 | `NEXT_DAY('2024-06-04', 'SUNDAY')` → `2024-06-09` | +| [PREVIOUS_DAY](previous-day.md) | 返回上个指定星期的日期 | `PREVIOUS_DAY('2024-06-04', 'MONDAY')` → `2024-06-03` | + +## 其他日期与时间函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [TIMEZONE](timezone.md) | 返回当前时区 | `TIMEZONE()` → `'UTC'` | +| [TIME_SLOT](time-slot.md) | 生成时间槽 | `TIME_SLOT('2024-06-04 12:30:45', 15, 'MINUTE')` → `2024-06-04 12:30:00` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/05-interval-functions/index.md b/docs/cn/sql-reference/20-sql-functions/05-interval-functions/index.md index 0e7a0fb9f0..147958de5d 100644 --- a/docs/cn/sql-reference/20-sql-functions/05-interval-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/05-interval-functions/index.md @@ -1,9 +1,40 @@ --- -title: 间隔函数 +title: 间隔函数（Interval Functions） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本节提供 Databend 中间隔函数（Interval Functions）的参考信息。这些函数允许您创建各种时间单位的间隔值，用于日期和时间计算。 -本节提供了 Databend 中间隔函数的参考信息。 +## 时间单位转换函数 - \ No newline at end of file +### 基于天的间隔 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [TO_DAYS](to-days) | 将数字转换为天数间隔 | `TO_DAYS(2)` → `2 days` | +| [TO_WEEKS](to-weeks) | 将数字转换为周数间隔 | `TO_WEEKS(3)` → `21 days` | +| [TO_MONTHS](to-months) | 将数字转换为月数间隔 | `TO_MONTHS(2)` → `2 months` | +| [TO_YEARS](to-years) | 将数字转换为年数间隔 | `TO_YEARS(1)` → `1 year` | + +### 基于小时的间隔 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [TO_HOURS](to-hours) | 将数字转换为小时间隔 | `TO_HOURS(5)` → `5:00:00` | +| [TO_MINUTES](to-minutes) | 将数字转换为分钟间隔 | `TO_MINUTES(90)` → `1:30:00` | +| [TO_SECONDS](to-seconds) | 将数字转换为秒数间隔 | `TO_SECONDS(3600)` → `1:00:00` | +| [EPOCH](epoch) | TO_SECONDS 的别名 | `EPOCH(60)` → `00:01:00` | + +### 更小的时间单位 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [TO_MILLISECONDS](to-milliseconds) | 将数字转换为毫秒间隔 | `TO_MILLISECONDS(2000)` → `00:00:02` | +| [TO_MICROSECONDS](to-microseconds) | 将数字转换为微秒间隔 | `TO_MICROSECONDS(2000000)` → `00:00:02` | + +### 更大的时间单位 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [TO_DECADES](to-decades) | 将数字转换为十年间隔 | `TO_DECADES(2)` → `20 years` | +| [TO_CENTRIES](to-centries) | 将数字转换为世纪间隔 | `TO_CENTRIES(1)` → `100 years` | +| [TO_MILLENNIA](to-millennia) | 将数字转换为千年间隔 | `TO_MILLENNIA(1)` → `1000 years` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/06-string-functions/index.md b/docs/cn/sql-reference/20-sql-functions/06-string-functions/index.md index d17892178d..e71b2a7103 100644 --- a/docs/cn/sql-reference/20-sql-functions/06-string-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/06-string-functions/index.md @@ -2,76 +2,103 @@ title: 字符串函数 --- -本节提供了 Databend 中与字符串相关的函数的参考信息。 - -## 字符串操作: -- [CONCAT](concat.md) -- [CONCAT_WS](concat-ws.md) -- [INSERT](insert.md) -- [LEFT](left.md) -- [LPAD](lpad.md) -- [REPEAT](repeat.md) -- [REPLACE](replace.md) -- [REVERSE](reverse.md) -- [RIGHT](right.md) -- [RPAD](rpad.md) -- [SPLIT](split.md) -- [SPLIT_PART](split-part.md) -- [SUBSTR](substr.md) -- [SUBSTRING](substring.md) -- [TRANSLATE](translate.md) -- [TRIM](trim.md) -- [TRIM_BOTH](trim-both.md) -- [TRIM_LEADING](trim-leading.md) -- [TRIM_TRAILING](trim-trailing.md) -- [LTRIM](ltrim.md) -- [RTRIM](rtrim.md) - -## 字符串信息: -- [ASCII](ascii.md) -- [BIT_LENGTH](bit-length.md) -- [CHAR_LENGTH](char-length.md) -- [CHARACTER_LENGTH](character-length) -- [INSTR](instr.md) -- [LENGTH](length.md) -- [LOCATE](locate.md) -- [OCTET_LENGTH](octet-length.md) -- [ORD](ord.md) -- [POSITION](position.md) -- [STRCMP](strcmp.md) -- [JARO_WINKLER](jaro-winkler.md) - -## 大小写转换: -- [LCASE](lcase.md) -- [LOWER](lower.md) -- [UCASE](ucase.md) -- [UPPER](upper.md) - -## 模式匹配: -- [LIKE](like.md) -- [NOT_LIKE](not-like.md) -- [NOT_REGEXP](not-regexp.md) -- [NOT_RLIKE](not-rlike.md) -- [REGEXP](regexp.md) -- [REGEXP_INSTR](regexp-instr.md) -- [REGEXP_LIKE](regexp-like.md) -- [REGEXP_REPLACE](regexp-replace.md) -- [REGEXP_SUBSTR](regexp-substr.md) -- [RLIKE](rlike.md) -- [GLOB](glob.md) - -## 编码和解码: -- [BIN](bin.md) -- [FROM_BASE64](from-base64.md) -- [HEX](hex.md) -- [OCT](oct.md) -- [TO_BASE64](to-base64.md) -- [UNHEX](unhex.md) - -## 其他: -- [CHAR](char.md) -- [MID](mid.md) -- [QUOTE](quote.md) -- [SOUNDEX](soundex.md) -- [SOUNDSLIKE](soundslike.md) -- [SPACE](space.md) \ No newline at end of file +本页面全面概述了 Databend 中的字符串函数，按功能分类以便参考。 + +## 字符串拼接与操作 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [CONCAT](concat.md) | 拼接字符串 | `CONCAT('data', 'bend')` → `'databend'` | +| [CONCAT_WS](concat-ws.md) | 使用分隔符拼接字符串 | `CONCAT_WS('-', 'data', 'bend')` → `'data-bend'` | +| [INSERT](insert.md) | 在指定位置插入字符串 | `INSERT('databend', 5, 0, 'cloud')` → `'databcloudbend'` | +| [REPLACE](replace.md) | 替换子串的所有匹配项 | `REPLACE('databend', 'bend', 'cloud')` → `'datacloud'` | +| [TRANSLATE](translate.md) | 替换指定字符 | `TRANSLATE('databend', 'abn', '123')` → `'d1t12e3d'` | + +## 字符串提取 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [LEFT](left.md) | 返回左侧指定长度的字符 | `LEFT('databend', 4)` → `'data'` | +| [RIGHT](right.md) | 返回右侧指定长度的字符 | `RIGHT('databend', 4)` → `'bend'` | +| [SUBSTR](substr.md) / [SUBSTRING](substring.md) | 提取子字符串 | `SUBSTR('databend', 5, 4)` → `'bend'` | +| [MID](mid.md) | 提取子字符串 (SUBSTRING 的别名) | `MID('databend', 5, 4)` → `'bend'` | +| [SPLIT](split.md) | 分割字符串为数组 | `SPLIT('data,bend', ',')` → `['data', 'bend']` | +| [SPLIT_PART](split-part.md) | 返回分割后的指定部分 | `SPLIT_PART('data,bend', ',', 2)` → `'bend'` | + +## 字符串填充与格式化 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [LPAD](lpad.md) | 左侧填充字符串至指定长度 | `LPAD('bend', 8, 'data')` → `'databend'` | +| [RPAD](rpad.md) | 右侧填充字符串至指定长度 | `RPAD('data', 8, 'bend')` → `'databend'` | +| [REPEAT](repeat.md) | 重复字符串 n 次 | `REPEAT('data', 2)` → `'datadata'` | +| [SPACE](space.md) | 生成指定长度的空格字符串 | `SPACE(4)` → `' '` | +| [REVERSE](reverse.md) | 反转字符串 | `REVERSE('databend')` → `'dnebtad'` | + +## 字符串修剪 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [TRIM](trim.md) | 移除开头和结尾的空格 | `TRIM(' databend ')` → `'databend'` | +| [TRIM_BOTH](trim-both.md) | 移除两端的指定字符 | `TRIM_BOTH('xxdatabendxx', 'x')` → `'databend'` | +| [TRIM_LEADING](trim-leading.md) | 移除开头的指定字符 | `TRIM_LEADING('xxdatabend', 'x')` → `'databend'` | +| [TRIM_TRAILING](trim-trailing.md) | 移除结尾的指定字符 | `TRIM_TRAILING('databendxx', 'x')` → `'databend'` | +| [LTRIM](ltrim.md) | 移除开头的空格 | `LTRIM(' databend')` → `'databend'` | +| [RTRIM](rtrim.md) | 移除结尾的空格 | `RTRIM('databend ')` → `'databend'` | + +## 字符串信息 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [LENGTH](length.md) | 返回字符串长度 (字符数) | `LENGTH('databend')` → `8` | +| [CHAR_LENGTH](char-length.md) / [CHARACTER_LENGTH](character-length.md) | 返回字符串长度 (字符数) | `CHAR_LENGTH('databend')` → `8` | +| [BIT_LENGTH](bit-length.md) | 返回字符串位长度 | `BIT_LENGTH('databend')` → `64` | +| [OCTET_LENGTH](octet-length.md) | 返回字符串字节长度 | `OCTET_LENGTH('databend')` → `8` | +| [INSTR](instr.md) | 返回子串首次出现的起始位置 | `INSTR('databend', 'bend')` → `5` | +| [LOCATE](locate.md) | 返回子串首次出现的起始位置 | `LOCATE('bend', 'databend')` → `5` | +| [POSITION](position.md) | 返回子串首次出现的起始位置 | `POSITION('bend' IN 'databend')` → `5` | +| [STRCMP](strcmp.md) | 比较两个字符串 | `STRCMP('databend', 'datacloud')` → `-1` | +| [JARO_WINKLER](jaro-winkler.md) | 计算字符串相似度 | `JARO_WINKLER('databend', 'databand')` → `0.9619047619047619` | + +## 大小写转换 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [LOWER](lower.md) / [LCASE](lcase.md) | 转换为小写 | `LOWER('DataBend')` → `'databend'` | +| [UPPER](upper.md) / [UCASE](ucase.md) | 转换为大写 | `UPPER('databend')` → `'DATABEND'` | + +## 模式匹配 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [LIKE](like.md) | 通配符模式匹配 | `'databend' LIKE 'data%'` → `true` | +| [NOT_LIKE](not-like.md) | LIKE 的否定操作 | `'databend' NOT LIKE 'cloud%'` → `true` | +| [REGEXP](regexp.md) / [RLIKE](rlike.md) | 正则表达式匹配 | `'databend' REGEXP '^data'` → `true` | +| [NOT_REGEXP](not-regexp.md) / [NOT_RLIKE](not-rlike.md) | 正则匹配的否定操作 | `'databend' NOT REGEXP '^cloud'` → `true` | +| [REGEXP_LIKE](regexp-like.md) | 返回正则匹配结果 (布尔值) | `REGEXP_LIKE('databend', '^data')` → `true` | +| [REGEXP_INSTR](regexp-instr.md) | 返回正则匹配的起始位置 | `REGEXP_INSTR('databend', 'bend')` → `5` | +| [REGEXP_SUBSTR](regexp-substr.md) | 返回正则匹配的子串 | `REGEXP_SUBSTR('databend', 'bend')` → `'bend'` | +| [REGEXP_REPLACE](regexp-replace.md) | 替换正则匹配的内容 | `REGEXP_REPLACE('databend', 'bend', 'cloud')` → `'datacloud'` | +| [GLOB](glob.md) | Unix 风格模式匹配 | `'databend' GLOB 'data*'` → `true` | + +## 编码与解码 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [ASCII](ascii.md) | 返回首个字符的 ASCII 值 | `ASCII('D')` → `68` | +| [ORD](ord.md) | 返回首个字符的 Unicode 码点 | `ORD('D')` → `68` | +| [CHAR](char.md) | 根据码点返回字符 | `CHAR(68,97,116,97)` → `'Data'` | +| [BIN](bin.md) | 返回数值的二进制表示 | `BIN(5)` → `'101'` | +| [OCT](oct.md) | 返回数值的八进制表示 | `OCT(8)` → `'10'` | +| [HEX](hex.md) | 返回字符串的十六进制表示 | `HEX('ABC')` → `'414243'` | +| [UNHEX](unhex.md) | 将十六进制字符串解码为二进制字符串 | `UNHEX('414243')` → `'ABC'` | +| [TO_BASE64](to-base64.md) | 编码为 Base64 格式 | `TO_BASE64('databend')` → `'ZGF0YWJlbmQ='` | +| [FROM_BASE64](from-base64.md) | 解码 Base64 字符串 | `FROM_BASE64('ZGF0YWJlbmQ=')` → `'databend'` | + +## 其他 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [QUOTE](quote.md) | SQL 转义字符串 | `QUOTE('databend')` → `'"databend"'` | +| [SOUNDEX](soundex.md) | 生成 Soundex 编码 | `SOUNDEX('databend')` → `'D315'` | +| [SOUNDSLIKE](soundslike.md) | 比较 Soundex 编码 | `SOUNDSLIKE('databend', 'databand')` → `true` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/07-aggregate-functions/index.md b/docs/cn/sql-reference/20-sql-functions/07-aggregate-functions/index.md index c4345415ad..7efc590a25 100644 --- a/docs/cn/sql-reference/20-sql-functions/07-aggregate-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/07-aggregate-functions/index.md @@ -1,9 +1,91 @@ --- -title: '聚合函数' +title: '聚合函数（Aggregate Functions）' --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面全面概述了 Databend 中的聚合函数，按功能分类以便参考。 -本节提供 Databend 中聚合函数的参考信息。 +## 基础聚合 - \ No newline at end of file +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [COUNT](aggregate-count.md) | 计算行数或非空值的数量 | `COUNT(*)` → `10` | +| [COUNT_DISTINCT](aggregate-count-distinct.md) | 计算不同值的数量 | `COUNT(DISTINCT city)` → `5` | +| [APPROX_COUNT_DISTINCT](aggregate-approx-count-distinct.md) | 近似计算不同值的数量 | `APPROX_COUNT_DISTINCT(user_id)` → `9955` | +| [SUM](aggregate-sum.md) | 计算值的总和 | `SUM(sales)` → `1250.75` | +| [AVG](aggregate-avg.md) | 计算值的平均值 | `AVG(temperature)` → `72.5` | +| [MIN](aggregate-min.md) | 返回最小值 | `MIN(price)` → `9.99` | +| [MAX](aggregate-max.md) | 返回最大值 | `MAX(price)` → `99.99` | +| [ANY](aggregate-any.md) | 返回组中的任意一个值 | `ANY(status)` → `'active'` | + +## 条件聚合 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [COUNT_IF](aggregate-count-if.md) | 计算满足条件的行数 | `COUNT_IF(price > 100)` → `5` | +| [SUM_IF](aggregate-sum-if.md) | 对满足条件的值求和 | `SUM_IF(amount, status = 'completed')` → `750.25` | +| [AVG_IF](aggregate-avg-if.md) | 对满足条件的值求平均值 | `AVG_IF(score, passed = true)` → `85.6` | +| [MIN_IF](aggregate-min-if.md) | 返回条件为真时的最小值 | `MIN_IF(temp, location = 'outside')` → `45.2` | +| [MAX_IF](aggregate-max-if.md) | 返回条件为真时的最大值 | `MAX_IF(speed, vehicle = 'car')` → `120.5` | + +## 统计函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [VAR_POP](aggregate-var-pop.md) / [VARIANCE_POP](aggregate-variance-pop.md) | 总体方差 | `VAR_POP(height)` → `10.25` | +| [VAR_SAMP](aggregate-var-samp.md) / [VARIANCE_SAMP](aggregate-variance-samp.md) | 样本方差 | `VAR_SAMP(height)` → `12.3` | +| [STDDEV_POP](aggregate-stddev-pop.md) | 总体标准差 | `STDDEV_POP(height)` → `3.2` | +| [STDDEV_SAMP](aggregate-stddev-samp.md) | 样本标准差 | `STDDEV_SAMP(height)` → `3.5` | +| [COVAR_POP](aggregate-covar-pop.md) | 总体协方差 | `COVAR_POP(x, y)` → `2.5` | +| [COVAR_SAMP](aggregate-covar-samp.md) | 样本协方差 | `COVAR_SAMP(x, y)` → `2.7` | +| [KURTOSIS](aggregate-kurtosis.md) | 测量分布的峰度 | `KURTOSIS(values)` → `2.1` | +| [SKEWNESS](aggregate-skewness.md) | 测量分布的偏度 | `SKEWNESS(values)` → `0.2` | + +## 百分位数和分布 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [MEDIAN](aggregate-median.md) | 计算中位数 | `MEDIAN(response_time)` → `125` | +| [MODE](aggregate-mode.md) | 返回最频繁的值 | `MODE(category)` → `'electronics'` | +| [QUANTILE_CONT](aggregate-quantile-cont.md) | 连续插值分位数 | `QUANTILE_CONT(0.95)(response_time)` → `350.5` | +| [QUANTILE_DISC](aggregate-quantile-disc.md) | 离散分位数 | `QUANTILE_DISC(0.5)(age)` → `35` | +| [QUANTILE_TDIGEST](aggregate-quantile-tdigest.md) | 使用 t-digest 的近似分位数 | `QUANTILE_TDIGEST(0.9)(values)` → `95.2` | +| [QUANTILE_TDIGEST_WEIGHTED](aggregate-quantile-tdigest-weighted.md) | 加权 t-digest 分位数 | `QUANTILE_TDIGEST_WEIGHTED(0.5)(values, weights)` → `50.5` | +| [MEDIAN_TDIGEST](aggregate-median-tdigest.md) | 使用 t-digest 的近似中位数 | `MEDIAN_TDIGEST(response_time)` → `124.5` | +| [HISTOGRAM](aggregate-histogram.md) | 创建直方图桶 | `HISTOGRAM(10)(values)` → `[{...}]` | + +## 数组和集合聚合 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [ARRAY_AGG](aggregate-array-agg.md) | 将值收集到数组中 | `ARRAY_AGG(product)` → `['A', 'B', 'C']` | +| [GROUP_ARRAY_MOVING_AVG](aggregate-group-array-moving-avg.md) | 数组上的移动平均 | `GROUP_ARRAY_MOVING_AVG(3)(values)` → `[null, null, 3.0, 6.0, 9.0]` | +| [GROUP_ARRAY_MOVING_SUM](aggregate-group-array-moving-sum.md) | 数组上的移动总和 | `GROUP_ARRAY_MOVING_SUM(2)(values)` → `[null, 3, 7, 11, 15]` | + +## 字符串聚合 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [GROUP_CONCAT](aggregate-group-concat.md) | 使用分隔符连接值 | `GROUP_CONCAT(city, ', ')` → `'New York, London, Tokyo'` | +| [STRING_AGG](aggregate-string-agg.md) | 使用分隔符连接字符串 | `STRING_AGG(tag, ',')` → `'red,green,blue'` | +| [LISTAGG](aggregate-listagg.md) | 使用分隔符连接值 | `LISTAGG(name, ', ')` → `'Alice, Bob, Charlie'` | + +## JSON 聚合 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [JSON_ARRAY_AGG](aggregate-json-array-agg.md) | 将值聚合为 JSON 数组 | `JSON_ARRAY_AGG(name)` → `'["Alice", "Bob", "Charlie"]'` | +| [JSON_OBJECT_AGG](aggregate-json-object-agg.md) | 从键值对创建 JSON 对象 | `JSON_OBJECT_AGG(name, score)` → `'{"Alice": 95, "Bob": 87}'` | + +## 参数选择 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [ARG_MAX](aggregate-arg-max.md) | 返回 expr2 最大时对应的 expr1 值 | `ARG_MAX(name, score)` → `'Alice'` | +| [ARG_MIN](aggregate-arg-min.md) | 返回 expr2 最小时对应的 expr1 值 | `ARG_MIN(name, score)` → `'Charlie'` | + +## 漏斗分析 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [RETENTION](aggregate-retention.md) | 计算留存率 | `RETENTION(action = 'signup', action = 'purchase')` → `[100, 40]` | +| [WINDOWFUNNEL](aggregate-windowfunnel.md) | 在时间窗口内搜索事件序列 | `WINDOWFUNNEL(1800)(timestamp, event='view', event='click', event='purchase')` → `2` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/08-window-functions/index.md b/docs/cn/sql-reference/20-sql-functions/08-window-functions/index.md index 0d33c235cd..8186138fa6 100644 --- a/docs/cn/sql-reference/20-sql-functions/08-window-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/08-window-functions/index.md @@ -1,205 +1,234 @@ -已理解您的要求，我将严格按照您提供的规则进行翻译。请提供需要翻译的Markdown或JSON内容，我会立即开始翻译工作。 - ---- -title: '窗口函数' ---- - -## 概述 - -窗口函数对一组相关的行（“窗口”）进行操作。 - -对于每个输入行，窗口函数返回一个输出行，该输出行取决于传递给函数的特定行以及窗口中其他行的值。 - -主要有两种类型的顺序敏感窗口函数： - -* `排名相关函数`：排名相关函数根据行的“排名”列出信息。例如，按每年利润降序排列商店，利润最高的商店将排名为1，利润第二高的商店将排名为2，依此类推。 - -* `窗口框架函数`：窗口框架函数允许您在窗口中的行子集上执行滚动操作，例如计算累计总和或移动平均值。 - -## 支持窗口的函数列表 - -下表列出了所有窗口函数。 - -| 函数名称 | 类别 | 窗口 | 窗口框架 | 备注 | -|-----------------------------------------------------------------------|--------------|--------|--------------|-------| -| [ARRAY_AGG](../07-aggregate-functions/aggregate-array-agg.md) | 通用 | ✔ | | | -| [AVG](../07-aggregate-functions/aggregate-avg.md) | 通用 | ✔ | ✔ | | -| [AVG_IF](../07-aggregate-functions/aggregate-avg-if.md) | 通用 | ✔ | ✔ | | -| [COUNT](../07-aggregate-functions/aggregate-count.md) | 通用 | ✔ | ✔ | | -| [COUNT_IF](../07-aggregate-functions/aggregate-count-if.md) | 通用 | ✔ | ✔ | | -| [COVAR_POP](../07-aggregate-functions/aggregate-covar-pop.md) | 通用 | ✔ | | | -| [COVAR_SAMP](../07-aggregate-functions/aggregate-covar-samp.md) | 通用 | ✔ | | | -| [MAX](../07-aggregate-functions/aggregate-max.md) | 通用 | ✔ | ✔ | | -| [MAX_IF](../07-aggregate-functions/aggregate-max-if.md) | 通用 | ✔ | ✔ | | -| [MIN](../07-aggregate-functions/aggregate-min.md) | 通用 | ✔ | ✔ | | -| [MIN_IF](../07-aggregate-functions/aggregate-min-if.md) | 通用 | ✔ | ✔ | | -| [STDDEV_POP](../07-aggregate-functions/aggregate-stddev-pop.md) | 通用 | ✔ | ✔ | | -| [STDDEV_SAMP](../07-aggregate-functions/aggregate-stddev-samp.md) | 通用 | ✔ | ✔ | | -| [MEDIAN](../07-aggregate-functions/aggregate-median.md) | 通用 | ✔ | ✔ | | -| [QUANTILE_CONT](../07-aggregate-functions/aggregate-quantile-cont.md) | 通用 | ✔ | ✔ | | -| [QUANTILE_DISC](../07-aggregate-functions/aggregate-quantile-disc.md) | 通用 | ✔ | ✔ | | -| [KURTOSIS](../07-aggregate-functions/aggregate-kurtosis.md) | 通用 | ✔ | ✔ | | -| [SKEWNESS](../07-aggregate-functions/aggregate-skewness.md) | 通用 | ✔ | ✔ | | -| [SUM](../07-aggregate-functions/aggregate-sum.md) | 通用 | ✔ | ✔ | | -| [SUM_IF](../07-aggregate-functions/aggregate-sum-if.md) | 通用 | ✔ | ✔ | | -| [CUME_DIST](cume-dist.md) | 排名相关 | ✔ | | | -| [PERCENT_RANK](percent_rank.md) | 排名相关 | ✔ | ✔ | | -| [DENSE_RANK](dense-rank.md) | 排名相关 | ✔ | ✔ | | -| [RANK](rank.md) | 排名相关 | ✔ | ✔ | | -| [ROW_NUMBER](row-number.md) | 排名相关 | ✔ | | | -| [NTILE](ntile.md) | 排名相关 | ✔ | | | -| [FIRST_VALUE](first-value.md) | 排名相关 | ✔ | ✔ | | -| [FIRST](first.md) | 排名相关 | ✔ | ✔ | | -| [LAST_VALUE](last-value.md) | 排名相关 | ✔ | ✔ | | -| [LAST](last.md) | 排名相关 | ✔ | ✔ | | -| [NTH_VALUE](nth-value.md) | 排名相关 | ✔ | ✔ | | -| [LEAD](lead.md) | 排名相关 | ✔ | | | -| [LAG](lag.md) | 排名相关 | ✔ | | | - -## 窗口语法 - -```sql - ( [ ] ) OVER ( { named window | inline window } ) - -named window ::= - { window_name | ( window_name ) } - -inline window ::= - [ PARTITION BY ] - [ ORDER BY ] - [ window frame ] -``` -`named window` 是在 `SELECT` 语句的 `WINDOW` 子句中定义的窗口，例如：`SELECT a, SUM(a) OVER w FROM t WINDOW w AS ( inline window )`。 - -`` 是（[聚合函数](../07-aggregate-functions/index.md)、排名函数、值函数）之一。 - -`OVER` 子句指定该函数用作窗口函数。 - -`PARTITION BY` 子句允许将行分组为子组，例如按城市、按年份等。`PARTITION BY` 子句是可选的。您可以在不将整个行组分解为子组的情况下进行分析。 - -`ORDER BY` 子句对窗口内的行进行排序。 - -`window frame` 子句指定窗口框架类型和窗口框架范围。`window frame` 子句是可选的。如果省略 `window frame` 子句，默认的窗口框架类型为 `RANGE`，默认的窗口框架范围为 `UNBOUNDED PRECEDING AND CURRENT ROW`。 - -## 窗口框架语法 - -`window frame` 可以是以下类型之一： - -```sql -cumulativeFrame ::= - { - { ROWS | RANGE } BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW - | { ROWS | RANGE } BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING - } -``` - -```sql -slidingFrame ::= - { - ROWS BETWEEN { PRECEDING | FOLLOWING } AND { PRECEDING | FOLLOWING } - | ROWS BETWEEN UNBOUNDED PRECEDING AND { PRECEDING | FOLLOWING } - | ROWS BETWEEN { PRECEDING | FOLLOWING } AND UNBOUNDED FOLLOWING - } -``` - -## 示例 - -**创建表** -```sql -CREATE TABLE employees ( - employee_id INT, - first_name VARCHAR, - last_name VARCHAR, - department VARCHAR, - salary INT -); -``` - -**插入数据** -```sql -INSERT INTO employees (employee_id, first_name, last_name, department, salary) VALUES - (1, 'John', 'Doe', 'IT', 75000), - (2, 'Jane', 'Smith', 'HR', 85000), - (3, 'Mike', 'Johnson', 'IT', 90000), - (4, 'Sara', 'Williams', 'Sales', 60000), - (5, 'Tom', 'Brown', 'HR', 82000), - (6, 'Ava', 'Davis', 'Sales', 62000), - (7, 'Olivia', 'Taylor', 'IT', 72000), - (8, 'Emily', 'Anderson', 'HR', 77000), - (9, 'Sophia', 'Lee', 'Sales', 58000), - (10, 'Ella', 'Thomas', 'IT', 67000); -``` - -**示例 1：按工资对员工进行排名** - -在此示例中，我们使用 RANK() 函数按工资降序对员工进行排名。工资最高的员工将获得排名1，工资最低的员工将获得最高的排名号。 -```sql -SELECT employee_id, first_name, last_name, department, salary, RANK() OVER (ORDER BY salary DESC) AS rank -FROM employees; -``` - -结果： - -| employee_id | first_name | last_name | department | salary | rank | -|-------------|------------|-----------|------------|--------|------| -| 3 | Mike | Johnson | IT | 90000 | 1 | -| 2 | Jane | Smith | HR | 85000 | 2 | -| 5 | Tom | Brown | HR | 82000 | 3 | -| 8 | Emily | Anderson | HR | 77000 | 4 | -| 1 | John | Doe | IT | 75000 | 5 | -| 7 | Olivia | Taylor | IT | 72000 | 6 | -| 10 | Ella | Thomas | IT | 67000 | 7 | -| 6 | Ava | Davis | Sales | 62000 | 8 | -| 4 | Sara | Williams | Sales | 60000 | 9 | -| 9 | Sophia | Lee | Sales | 58000 | 10 | - - - -**示例 2：计算每个部门的总工资** - -在此示例中，我们使用 SUM() 函数与 PARTITION BY 来计算每个部门的总工资。每行将显示部门及其总工资。 -```sql -SELECT department, SUM(salary) OVER (PARTITION BY department) AS total_salary -FROM employees; -``` - -结果： - -| department | total_salary | -|------------|--------------| -| HR | 244000 | -| HR | 244000 | -| HR | 244000 | -| IT | 304000 | -| IT | 304000 | -| IT | 304000 | -| IT | 304000 | -| Sales | 180000 | -| Sales | 180000 | -| Sales | 180000 | - - -**示例 3：计算每个部门的工资累计总和** - -在此示例中，我们使用 SUM() 函数与累积窗口框架来计算每个部门内的工资累计总和。累计总和基于按 employee_id 排序的员工的工资。 -```sql -SELECT employee_id, first_name, last_name, department, salary, - SUM(salary) OVER (PARTITION BY department ORDER BY employee_id - ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW) AS running_total -FROM employees; -``` - -结果： - -| employee_id | first_name | last_name | department | salary | running_total | -|-------------|------------|-----------|------------|--------|---------------| -| 2 | Jane | Smith | HR | 85000 | 85000 | -| 5 | Tom | Brown | HR | 82000 | 167000 | -| 8 | Emily | Anderson | HR | 77000 | 244000 | -| 1 | John | Doe | IT | 75000 | 75000 | -| 3 | Mike | Johnson | IT | 90000 | 165000 | -| 7 | Olivia | Taylor | IT | 72000 | 237000 | -| 10 | Ella | Thomas | IT | 67000 | 304000 | -| 4 | Sara | Williams | Sales | 60000 | 60000 | -| 6 | Ava | Davis | Sales | 62000 | 122000 | -| 9 | Sophia | Lee | Sales | 58000 | 180000 | \ No newline at end of file +--- +title: '窗口函数（Window Functions）' +--- + +## 概述 + +窗口函数对一组相关行（"窗口"）进行操作。对于每个输入行，窗口函数返回一个输出行，该输出行取决于传递给函数的特定行以及窗口中其他行的值。 + +有两种主要类型的顺序敏感窗口函数： + +* **排名相关函数**：基于行的"排名"列出信息。例如，按年利润降序排列商店，利润最高的商店将排名第1，利润第二高的商店将排名第2，依此类推。 + +* **窗口框架函数**：支持对窗口中行的子集执行滚动操作，例如计算运行总计或移动平均值。 + +## 窗口函数类别 + +Databend 支持两大类窗口函数： + +### 1. 专用窗口函数 + +这些函数专为窗口操作设计，提供排名、导航和值分析功能。 + +| 函数 | 描述 | 示例 | +|----------|-------------|---------| +| [RANK](rank.md) | 返回带间隙的排名 | `RANK() OVER (ORDER BY salary DESC)` → `1, 2, 2, 4, ...` | +| [DENSE_RANK](dense-rank.md) | 返回无间隙的排名 | `DENSE_RANK() OVER (ORDER BY salary DESC)` → `1, 2, 2, 3, ...` | +| [ROW_NUMBER](row-number.md) | 返回连续行号 | `ROW_NUMBER() OVER (ORDER BY hire_date)` → `1, 2, 3, 4, ...` | +| [CUME_DIST](cume-dist.md) | 返回累积分布 | `CUME_DIST() OVER (ORDER BY score)` → `0.2, 0.4, 0.8, 1.0, ...` | +| [PERCENT_RANK](percent_rank.md) | 返回相对排名 (0-1) | `PERCENT_RANK() OVER (ORDER BY score)` → `0.0, 0.25, 0.75, ...` | +| [NTILE](ntile.md) | 将行划分为 N 组 | `NTILE(4) OVER (ORDER BY score)` → `1, 1, 2, 2, 3, 3, 4, 4, ...` | +| [FIRST_VALUE](first-value.md) | 返回窗口中的第一个值 | `FIRST_VALUE(product) OVER (PARTITION BY category ORDER BY sales)` | +| [LAST_VALUE](last-value.md) | 返回窗口中的最后一个值 | `LAST_VALUE(product) OVER (PARTITION BY category ORDER BY sales)` | +| [NTH_VALUE](nth-value.md) | 返回窗口中的第 N 个值 | `NTH_VALUE(product, 2) OVER (PARTITION BY category ORDER BY sales)` | +| [LEAD](lead.md) | 访问后续行的值 | `LEAD(price, 1) OVER (ORDER BY date)` → 下一天的价格 | +| [LAG](lag.md) | 访问前一行的值 | `LAG(price, 1) OVER (ORDER BY date)` → 前一天的价格 | +| [FIRST](first.md) | 返回第一个值（别名） | `FIRST(product) OVER (PARTITION BY category ORDER BY sales)` | +| [LAST](last.md) | 返回最后一个值（别名） | `LAST(product) OVER (PARTITION BY category ORDER BY sales)` | + +### 2. 用作窗口函数的聚合函数 + +这些标准聚合函数可与 OVER 子句结合使用，执行窗口操作。 + +| 函数 | 描述 | 窗口框架支持 | 示例 | +|----------|-------------|---------------------|---------| +| [SUM](../07-aggregate-functions/aggregate-sum.md) | 计算窗口总和 | ✓ | `SUM(sales) OVER (PARTITION BY region ORDER BY date)` | +| [AVG](../07-aggregate-functions/aggregate-avg.md) | 计算窗口平均值 | ✓ | `AVG(score) OVER (ORDER BY id ROWS BETWEEN 2 PRECEDING AND CURRENT ROW)` | +| [COUNT](../07-aggregate-functions/aggregate-count.md) | 统计窗口行数 | ✓ | `COUNT(*) OVER (PARTITION BY department)` | +| [MIN](../07-aggregate-functions/aggregate-min.md) | 返回窗口最小值 | ✓ | `MIN(price) OVER (PARTITION BY category)` | +| [MAX](../07-aggregate-functions/aggregate-max.md) | 返回窗口最大值 | ✓ | `MAX(price) OVER (PARTITION BY category)` | +| [ARRAY_AGG](../07-aggregate-functions/aggregate-array-agg.md) | 将值收集到数组 | | `ARRAY_AGG(product) OVER (PARTITION BY category)` | +| [STDDEV_POP](../07-aggregate-functions/aggregate-stddev-pop.md) | 总体标准差 | ✓ | `STDDEV_POP(value) OVER (PARTITION BY group)` | +| [STDDEV_SAMP](../07-aggregate-functions/aggregate-stddev-samp.md) | 样本标准差 | ✓ | `STDDEV_SAMP(value) OVER (PARTITION BY group)` | +| [MEDIAN](../07-aggregate-functions/aggregate-median.md) | 中位数值 | ✓ | `MEDIAN(response_time) OVER (PARTITION BY server)` | + +**条件变体** + +| 函数 | 描述 | 窗口框架支持 | 示例 | +|----------|-------------|---------------------|---------| +| [COUNT_IF](../07-aggregate-functions/aggregate-count-if.md) | 条件计数 | ✓ | `COUNT_IF(status = 'complete') OVER (PARTITION BY dept)` | +| [SUM_IF](../07-aggregate-functions/aggregate-sum-if.md) | 条件求和 | ✓ | `SUM_IF(amount, status = 'paid') OVER (PARTITION BY customer)` | +| [AVG_IF](../07-aggregate-functions/aggregate-avg-if.md) | 条件平均值 | ✓ | `AVG_IF(score, passed = true) OVER (PARTITION BY class)` | +| [MIN_IF](../07-aggregate-functions/aggregate-min-if.md) | 条件最小值 | ✓ | `MIN_IF(temp, location = 'outside') OVER (PARTITION BY day)` | +| [MAX_IF](../07-aggregate-functions/aggregate-max-if.md) | 条件最大值 | ✓ | `MAX_IF(speed, vehicle = 'car') OVER (PARTITION BY test)` | + +## 窗口函数语法 + +```sql + ( [ ] ) OVER ( { named_window | inline_window } ) +``` + +其中： + +```sql +named_window ::= window_name + +inline_window ::= + [ PARTITION BY ] + [ ORDER BY ] + [ window_frame ] +``` + +### 关键组件 + +| 组件 | 描述 | 示例 | +|-----------|-------------|--------| +| `` | 应用的窗口函数 | `SUM()`, `RANK()` 等 | +| `OVER` | 指示窗口函数用法 | 所有窗口函数必需 | +| `PARTITION BY` | 将行分组为分区 | `PARTITION BY department` | +| `ORDER BY` | 分区内行排序 | `ORDER BY salary DESC` | +| `window_frame` | 定义计算行范围 | `ROWS BETWEEN 1 PRECEDING AND CURRENT ROW` | +| `named_window` | 引用 WINDOW 子句定义的窗口 | `SELECT sum(x) OVER w FROM t WINDOW w AS (PARTITION BY y)` | + +## 窗口框架语法 + +窗口框架定义每行函数计算包含的行范围，包含两种类型： + +### 1. 框架类型 + +| 框架类型 | 描述 | 示例 | +|------------|-------------|--------| +| `ROWS` | 基于物理行的框架 | `ROWS BETWEEN 3 PRECEDING AND CURRENT ROW` | +| `RANGE` | 基于逻辑值的框架 | `RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW` | + +### 2. 框架范围 + +| 框架范围模式 | 描述 | 示例 | +|----------------------|-------------|--------| +| **累积框架** | | | +| `BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW` | 起始行到当前行 | 运行总计 | +| `BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING` | 当前行到结束行 | 当前位置的运行总计 | +| **滑动框架** | | | +| `BETWEEN N PRECEDING AND CURRENT ROW` | 当前行前 N 行 + 当前行 | 3 天移动平均 | +| `BETWEEN CURRENT ROW AND N FOLLOWING` | 当前行 + 后续 N 行 | 前瞻性计算 | +| `BETWEEN N PRECEDING AND N FOLLOWING` | 前 N 行 + 当前行 + 后 N 行 | 居中移动平均 | +| `BETWEEN UNBOUNDED PRECEDING AND N FOLLOWING` | 起始行到当前后 N 行 | 扩展累积计算 | +| `BETWEEN N PRECEDING AND UNBOUNDED FOLLOWING` | 当前前 N 行到结束行 | 扩展向后计算 | + +## 窗口函数示例 + +以下示例使用员工数据集演示常见窗口函数用例。 + +### 示例数据设置 + +```sql +-- 创建员工表 +CREATE TABLE employees ( + employee_id INT, + first_name VARCHAR, + last_name VARCHAR, + department VARCHAR, + salary INT +); + +-- 插入示例数据 +INSERT INTO employees VALUES + (1, 'John', 'Doe', 'IT', 75000), + (2, 'Jane', 'Smith', 'HR', 85000), + (3, 'Mike', 'Johnson', 'IT', 90000), + (4, 'Sara', 'Williams', 'Sales', 60000), + (5, 'Tom', 'Brown', 'HR', 82000), + (6, 'Ava', 'Davis', 'Sales', 62000), + (7, 'Olivia', 'Taylor', 'IT', 72000), + (8, 'Emily', 'Anderson', 'HR', 77000), + (9, 'Sophia', 'Lee', 'Sales', 58000), + (10, 'Ella', 'Thomas', 'IT', 67000); +``` + +### 示例 1：排名函数 + +按薪资降序排列员工： + +```sql +SELECT + employee_id, + first_name, + last_name, + department, + salary, + RANK() OVER (ORDER BY salary DESC) AS rank, + DENSE_RANK() OVER (ORDER BY salary DESC) AS dense_rank, + ROW_NUMBER() OVER (ORDER BY salary DESC) AS row_num +FROM employees +ORDER BY salary DESC; +``` + +**结果：** + +| employee_id | first_name | last_name | department | salary | rank | dense_rank | row_num | +|-------------|------------|-----------|------------|--------|------|------------|--------| +| 3 | Mike | Johnson | IT | 90000 | 1 | 1 | 1 | +| 2 | Jane | Smith | HR | 85000 | 2 | 2 | 2 | +| 5 | Tom | Brown | HR | 82000 | 3 | 3 | 3 | +| 8 | Emily | Anderson | HR | 77000 | 4 | 4 | 4 | +| 1 | John | Doe | IT | 75000 | 5 | 5 | 5 | + +### 示例 2：分区 + +计算部门统计信息： + +```sql +SELECT DISTINCT + department, + COUNT(*) OVER (PARTITION BY department) AS employee_count, + SUM(salary) OVER (PARTITION BY department) AS total_salary, + AVG(salary) OVER (PARTITION BY department) AS avg_salary, + MIN(salary) OVER (PARTITION BY department) AS min_salary, + MAX(salary) OVER (PARTITION BY department) AS max_salary +FROM employees +ORDER BY department; +``` + +**结果：** + +| department | employee_count | total_salary | avg_salary | min_salary | max_salary | +|------------|----------------|-------------|------------|------------|------------| +| HR | 3 | 244000 | 81333.33 | 77000 | 85000 | +| IT | 4 | 304000 | 76000.00 | 67000 | 90000 | +| Sales | 3 | 180000 | 60000.00 | 58000 | 62000 | + +### 示例 3：运行总计与移动平均 + +计算部门内运行总计与移动平均： + +```sql +SELECT + employee_id, + first_name, + department, + salary, + -- 运行总计（累积求和） + SUM(salary) OVER ( + PARTITION BY department + ORDER BY employee_id + ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW + ) AS running_total, + -- 当前行与前一行移动平均 + AVG(salary) OVER ( + PARTITION BY department + ORDER BY employee_id + ROWS BETWEEN 1 PRECEDING AND CURRENT ROW + ) AS moving_avg +FROM employees +ORDER BY department, employee_id; +``` + +**结果：** + +| employee_id | first_name | department | salary | running_total | moving_avg | +|-------------|------------|------------|--------|---------------|------------| +| 2 | Jane | HR | 85000 | 85000 | 85000.00 | +| 5 | Tom | HR | 82000 | 167000 | 83500.00 | +| 8 | Emily | HR | 77000 | 244000 | 79500.00 | +| 1 | John | IT | 75000 | 75000 | 75000.00 | +| 3 | Mike | IT | 90000 | 165000 | 82500.00 | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/09-geo-functions/index.md b/docs/cn/sql-reference/20-sql-functions/09-geo-functions/index.md index 3d97b2d0ed..1e85ad41cd 100644 --- a/docs/cn/sql-reference/20-sql-functions/09-geo-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/09-geo-functions/index.md @@ -1,60 +1,80 @@ --- -title: 地理函数 +title: H3 函数 --- -本节提供 Databend 中地理函数的参考信息。 +本节提供 Databend 中 H3 函数的参考信息。H3 是一种地理空间索引系统，通过将地球划分为六边形单元，支持高效的空间分析与操作。 ## 坐标转换 -- [GEO_TO_H3](geo-to-h3.md) -- [GEOHASH_DECODE](geohash-decode.md) -- [GEOHASH_ENCODE](geohash-encode.md) -- [STRING_TO_H3](string-to-h3.md) -- [H3_TO_GEO](h3-to-geo.md) -- [H3_TO_STRING](h3-to-string.md) +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [GEO_TO_H3](geo-to-h3) | 将经纬度转换为 H3 索引 | `GEO_TO_H3(37.7950, 55.7129, 15)` → `644325524701193974` | +| [H3_TO_GEO](h3-to-geo) | 将 H3 索引转换为经纬度 | `H3_TO_GEO(644325524701193974)` → `[37.7950, 55.7129]` | +| [H3_TO_STRING](h3-to-string) | 将 H3 索引转换为字符串表示 | `H3_TO_STRING(644325524701193974)` → `'8f2830828052d25'` | +| [STRING_TO_H3](string-to-h3) | 将字符串表示转换为 H3 索引 | `STRING_TO_H3('8f2830828052d25')` → `644325524701193974` | +| [GEOHASH_ENCODE](geohash-encode) | 将经纬度编码为 geohash 字符串 | `GEOHASH_ENCODE(37.7950, 55.7129, 12)` → `'ucfv0nzpt3s7'` | +| [GEOHASH_DECODE](geohash-decode) | 将 geohash 字符串解码为经纬度 | `GEOHASH_DECODE('ucfv0nzpt3s7')` → `[37.7950, 55.7129]` | ## 六边形属性 -- [H3_CELL_AREA_M2](h3-cell-area-m2.md) -- [H3_CELL_AREA_RADS2](h3-cell-area-rads2.md) -- [H3_HEX_AREA_KM2](h3-hex-area-km2.md) -- [H3_HEX_AREA_M2](h3-hex-area-m2.md) -- [H3_GET_BASE_CELL](h3-get-base-cell.md) -- [H3_GET_FACES](h3-get-faces.md) -- [H3_GET_RESOLUTION](h3-get-resolution.md) -- [H3_TO_CENTER_CHILD](h3-to-center-child.md) -- [H3_TO_CHILDREN](h3-to-children.md) -- [H3_TO_GEO_BOUNDARY](h3-to-geo-boundary.md) -- [H3_TO_PARENT](h3-to-parent.md) -- [H3_NUM_HEXAGONS](h3-num-hexagons.md) +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [H3_GET_RESOLUTION](h3-get-resolution) | 返回 H3 索引的分辨率 | `H3_GET_RESOLUTION(644325524701193974)` → `15` | +| [H3_GET_BASE_CELL](h3-get-base-cell) | 返回 H3 索引的基础单元编号 | `H3_GET_BASE_CELL(644325524701193974)` → `14` | +| [H3_IS_VALID](h3-is-valid) | 检查 H3 索引是否有效 | `H3_IS_VALID(644325524701193974)` → `TRUE` | +| [H3_IS_PENTAGON](h3-is-pentagon) | 检查 H3 索引是否为五边形 | `H3_IS_PENTAGON(644325524701193974)` → `FALSE` | +| [H3_IS_RES_CLASS_III](h3-is-res-class-iii) | 检查 H3 索引是否属于 III 类分辨率 | `H3_IS_RES_CLASS_III(644325524701193974)` → `FALSE` | +| [H3_GET_FACES](h3-get-faces) | 返回 H3 单元相交的二十面体面 | `H3_GET_FACES(644325524701193974)` → `[7]` | +| [H3_TO_PARENT](h3-to-parent) | 返回指定分辨率下 H3 索引的父级索引 | `H3_TO_PARENT(644325524701193974, 10)` → `622236721289822207` | +| [H3_TO_CHILDREN](h3-to-children) | 返回指定分辨率下 H3 索引的子级索引 | `H3_TO_CHILDREN(622236721289822207, 11)` → `[...]` | +| [H3_TO_CENTER_CHILD](h3-to-center-child) | 返回指定分辨率下 H3 索引的中心子级索引 | `H3_TO_CENTER_CHILD(622236721289822207, 11)` → `625561602857582591` | + +## 面积与边界 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [H3_CELL_AREA_M2](h3-cell-area-m2) | 返回 H3 单元面积（平方米） | `H3_CELL_AREA_M2(644325524701193974)` → `0.8953` | +| [H3_CELL_AREA_RADS2](h3-cell-area-rads2) | 返回 H3 单元面积（平方弧度） | `H3_CELL_AREA_RADS2(644325524701193974)` → `2.2e-14` | +| [H3_HEX_AREA_KM2](h3-hex-area-km2) | 返回指定分辨率的六边形平均面积（平方公里） | `H3_HEX_AREA_KM2(10)` → `0.0152` | +| [H3_HEX_AREA_M2](h3-hex-area-m2) | 返回指定分辨率的六边形平均面积（平方米） | `H3_HEX_AREA_M2(10)` → `15200` | +| [H3_TO_GEO_BOUNDARY](h3-to-geo-boundary) | 返回 H3 单元的边界坐标数组 | `H3_TO_GEO_BOUNDARY(644325524701193974)` → `[[lon1,lat1], [lon2,lat2], ...]` | +| [H3_NUM_HEXAGONS](h3-num-hexagons) | 返回指定分辨率的六边形数量 | `H3_NUM_HEXAGONS(2)` → `5882` | ## 六边形关系 -- [H3_HEX_RING](h3-hex-ring.md) -- [H3_K_RING](h3-k-ring.md) -- [H3_INDEXES_ARE_NEIGHBORS](h3-indexes-are-neighbors.md) -- [H3_IS_PENTAGON](h3-is-pentagon.md) -- [H3_IS_RES_CLASS_III](h3-is-res-class-iii.md) -- [H3_IS_VALID](h3-is-valid.md) -- [H3_GET_DESTINATION_INDEX_FROM_UNIDIRECTIONAL_EDGE](h3-get-destination-index-from-unidirectional-edge.md) -- [H3_GET_INDEXES_FROM_UNIDIRECTIONAL_EDGE](h3-get-indexes-from-unidirectional-edge.md) -- [H3_GET_ORIGIN_INDEX_FROM_UNIDIRECTIONAL_EDGE](h3-get-origin-index-from-unidirectional-edge.md) -- [H3_GET_UNIDIRECTIONAL_EDGE_BOUNDARY](h3-get-unidirectional-edge-boundary.md) -- [H3_GET_UNIDIRECTIONAL_EDGE](h3-get-unidirectional-edge.md) -- [H3_GET_UNIDIRECTIONAL_EDGES_FROM_HEXAGON](h3-get-unidirectional-edges-from-hexagon.md) -- [H3_UNIDIRECTIONAL_EDGE_IS_VALID](h3-unidirectional-edge-is-valid.md) +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [H3_DISTANCE](h3-distance) | 返回两个 H3 索引的网格距离 | `H3_DISTANCE(599119489002373119, 599119491149856767)` → `1` | +| [H3_INDEXES_ARE_NEIGHBORS](h3-indexes-are-neighbors) | 检查两个 H3 索引是否相邻 | `H3_INDEXES_ARE_NEIGHBORS(599119489002373119, 599119491149856767)` → `TRUE` | +| [H3_K_RING](h3-k-ring) | 返回原点 k 阶邻域内的所有 H3 索引 | `H3_K_RING(599119489002373119, 1)` → `[599119489002373119, 599119491149856767, ...]` | +| [H3_HEX_RING](h3-hex-ring) | 返回距离原点精确 k 阶的所有 H3 索引 | `H3_HEX_RING(599119489002373119, 1)` → `[599119491149856767, ...]` | + +## 边函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [H3_GET_UNIDIRECTIONAL_EDGE](h3-get-unidirectional-edge) | 返回相邻 H3 索引间的单向边索引 | `H3_GET_UNIDIRECTIONAL_EDGE(from_h3, to_h3)` → `edge_index` | +| [H3_UNIDIRECTIONAL_EDGE_IS_VALID](h3-unidirectional-edge-is-valid) | 检查 H3 边索引是否有效 | `H3_UNIDIRECTIONAL_EDGE_IS_VALID(edge_index)` → `TRUE` | +| [H3_GET_ORIGIN_INDEX_FROM_UNIDIRECTIONAL_EDGE](h3-get-origin-index-from-unidirectional-edge) | 从边索引获取起点 H3 索引 | `H3_GET_ORIGIN_INDEX_FROM_UNIDIRECTIONAL_EDGE(edge_index)` → `from_h3` | +| [H3_GET_DESTINATION_INDEX_FROM_UNIDIRECTIONAL_EDGE](h3-get-destination-index-from-unidirectional-edge) | 从边索引获取终点 H3 索引 | `H3_GET_DESTINATION_INDEX_FROM_UNIDIRECTIONAL_EDGE(edge_index)` → `to_h3` | +| [H3_GET_INDEXES_FROM_UNIDIRECTIONAL_EDGE](h3-get-indexes-from-unidirectional-edge) | 从边索引获取起点与终点 H3 索引 | `H3_GET_INDEXES_FROM_UNIDIRECTIONAL_EDGE(edge_index)` → `[from_h3, to_h3]` | +| [H3_GET_UNIDIRECTIONAL_EDGES_FROM_HEXAGON](h3-get-unidirectional-edges-from-hexagon) | 返回 H3 索引发出的所有单向边 | `H3_GET_UNIDIRECTIONAL_EDGES_FROM_HEXAGON(h3_index)` → `[edge1, edge2, ...]` | +| [H3_GET_UNIDIRECTIONAL_EDGE_BOUNDARY](h3-get-unidirectional-edge-boundary) | 返回 H3 边的边界坐标 | `H3_GET_UNIDIRECTIONAL_EDGE_BOUNDARY(edge_index)` → `[[lon1,lat1], [lon2,lat2]]` | ## 测量 -- [H3_DISTANCE](h3-distance.md) -- [H3_EDGE_ANGLE](h3-edge-angle.md) -- [H3_EDGE_LENGTH_KM](h3-edge-length-km.md) -- [H3_EDGE_LENGTH_M](h3-edge-length-m.md) -- [H3_EXACT_EDGE_LENGTH_KM](h3-exact-edge-length-km.md) -- [H3_EXACT_EDGE_LENGTH_M](h3-exact-edge-length-m.md) -- [H3_EXACT_EDGE_LENGTH_RADS](h3-exact-edge-length-rads.md) +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [H3_EDGE_LENGTH_KM](h3-edge-length-km) | 返回指定分辨率的平均边长（千米） | `H3_EDGE_LENGTH_KM(10)` → `0.065` | +| [H3_EDGE_LENGTH_M](h3-edge-length-m) | 返回指定分辨率的平均边长（米） | `H3_EDGE_LENGTH_M(10)` → `65.91` | +| [H3_EXACT_EDGE_LENGTH_KM](h3-exact-edge-length-km) | 返回精确边长（千米） | `H3_EXACT_EDGE_LENGTH_KM(edge_index)` → `0.066` | +| [H3_EXACT_EDGE_LENGTH_M](h3-exact-edge-length-m) | 返回精确边长（米） | `H3_EXACT_EDGE_LENGTH_M(edge_index)` → `66.12` | +| [H3_EXACT_EDGE_LENGTH_RADS](h3-exact-edge-length-rads) | 返回精确边长（弧度） | `H3_EXACT_EDGE_LENGTH_RADS(edge_index)` → `0.00001` | +| [H3_EDGE_ANGLE](h3-edge-angle) | 返回两条边的夹角（弧度） | `H3_EDGE_ANGLE(edge1, edge2)` → `1.047` | ## 通用工具 -- [POINT_IN_POLYGON](point-in-polygon.md) -- [H3_LINE](h3-line.md) \ No newline at end of file +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [POINT_IN_POLYGON](point-in-polygon) | 检查点是否在多边形内 | `POINT_IN_POLYGON([lon, lat], [[p1_lon, p1_lat], [p2_lon, p2_lat], ...])` → `TRUE` | +| [H3_LINE](h3-line) | 返回两个 H3 索引间连线路径的索引 | `H3_LINE(from_h3, to_h3)` → `[from_h3, ..., to_h3]` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/09-geometry-functions/index.md b/docs/cn/sql-reference/20-sql-functions/09-geometry-functions/index.md index 52a07408eb..6b70221a5e 100644 --- a/docs/cn/sql-reference/20-sql-functions/09-geometry-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/09-geometry-functions/index.md @@ -1,8 +1,72 @@ --- -title: 几何函数 +title: 几何函数（Geometry Functions） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本节提供了 Databend 中几何函数的参考信息。 +本页面全面概述了 Databend 中的几何函数（Geometry Functions），按功能分类以便参考。 - \ No newline at end of file +## 几何创建函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [ST_MAKEGEOMPOINT](st-makegeompoint.md) / [ST_GEOM_POINT](st-geom-point.md) | 构造点几何体 | `ST_MAKEGEOMPOINT(-122.35, 37.55)` → `POINT(-122.35 37.55)` | +| [ST_MAKELINE](st-makeline.md) / [ST_MAKE_LINE](st-make-line.md) | 基于点创建线字符串 | `ST_MAKELINE(ST_MAKEGEOMPOINT(-122.35, 37.55), ST_MAKEGEOMPOINT(-122.40, 37.60))` → `LINESTRING(-122.35 37.55, -122.40 37.60)` | +| [ST_MAKEPOLYGON](st-makepolygon.md) | 基于线字符串创建多边形 | `ST_MAKEPOLYGON(ST_MAKELINE(...))` → `POLYGON(...)` | +| [ST_POLYGON](st-polygon.md) | 创建多边形 | `ST_POLYGON(...)` → `POLYGON(...)` | + +## 几何转换函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [ST_GEOMETRYFROMTEXT](st-geometryfromtext.md) / [ST_GEOMFROMTEXT](st-geomfromtext.md) | 将 WKT 转换为几何体 | `ST_GEOMETRYFROMTEXT('POINT(-122.35 37.55)')` → `POINT(-122.35 37.55)` | +| [ST_GEOMETRYFROMWKB](st-geometryfromwkb.md) / [ST_GEOMFROMWKB](st-geomfromwkb.md) | 将 WKB 转换为几何体 | `ST_GEOMETRYFROMWKB(...)` → `POINT(...)` | +| [ST_GEOMETRYFROMEWKT](st-geometryfromewkt.md) / [ST_GEOMFROMEWKT](st-geomfromewkt.md) | 将 EWKT 转换为几何体 | `ST_GEOMETRYFROMEWKT('SRID=4326;POINT(-122.35 37.55)')` → `POINT(-122.35 37.55)` | +| [ST_GEOMETRYFROMEWKB](st-geometryfromewkb.md) / [ST_GEOMFROMEWKB](st-geomfromewkb.md) | 将 EWKB 转换为几何体 | `ST_GEOMETRYFROMEWKB(...)` → `POINT(...)` | +| [ST_GEOMFROMGEOHASH](st-geomfromgeohash.md) | 将 GeoHash 转换为几何体 | `ST_GEOMFROMGEOHASH('9q8yyk8')` → `POLYGON(...)` | +| [ST_GEOMPOINTFROMGEOHASH](st-geompointfromgeohash.md) | 将 GeoHash 转换为点 | `ST_GEOMPOINTFROMGEOHASH('9q8yyk8')` → `POINT(...)` | +| [TO_GEOMETRY](to-geometry.md) | 将多种格式转换为几何体 | `TO_GEOMETRY('POINT(-122.35 37.55)')` → `POINT(-122.35 37.55)` | + +## 几何输出函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [ST_ASTEXT](st-astext.md) | 将几何体转换为 WKT | `ST_ASTEXT(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `'POINT(-122.35 37.55)'` | +| [ST_ASWKT](st-aswkt.md) | 将几何体转换为 WKT | `ST_ASWKT(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `'POINT(-122.35 37.55)'` | +| [ST_ASBINARY](st-asbinary.md) / [ST_ASWKB](st-aswkb.md) | 将几何体转换为 WKB | `ST_ASBINARY(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `WKB representation` | +| [ST_ASEWKT](st-asewkt.md) | 将几何体转换为 EWKT | `ST_ASEWKT(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `'SRID=4326;POINT(-122.35 37.55)'` | +| [ST_ASEWKB](st-asewkb.md) | 将几何体转换为 EWKB | `ST_ASEWKB(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `EWKB representation` | +| [ST_ASGEOJSON](st-asgeojson.md) | 将几何体转换为 GeoJSON | `ST_ASGEOJSON(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `'{"type":"Point","coordinates":[-122.35,37.55]}'` | +| [ST_GEOHASH](st-geohash.md) | 将几何体转换为 GeoHash | `ST_GEOHASH(ST_MAKEGEOMPOINT(-122.35, 37.55), 7)` → `'9q8yyk8'` | +| [TO_STRING](to-string.md) | 将几何体转换为字符串 | `TO_STRING(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `'POINT(-122.35 37.55)'` | + +## 几何属性 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [ST_DIMENSION](st-dimension.md) | 返回几何体的维度 | `ST_DIMENSION(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `0` | +| [ST_SRID](st-srid.md) | 返回几何体的 SRID | `ST_SRID(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `4326` | +| [ST_NPOINTS](st-npoints.md) / [ST_NUMPOINTS](st-numpoints.md) | 返回几何体中的点数 | `ST_NPOINTS(ST_MAKELINE(...))` → `2` | +| [ST_X](st-x.md) | 返回点的 X 坐标 | `ST_X(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `-122.35` | +| [ST_Y](st-y.md) | 返回点的 Y 坐标 | `ST_Y(ST_MAKEGEOMPOINT(-122.35, 37.55))` → `37.55` | +| [ST_XMIN](st-xmin.md) | 返回最小 X 坐标 | `ST_XMIN(ST_MAKELINE(...))` → `-122.40` | +| [ST_XMAX](st-xmax.md) | 返回最大 X 坐标 | `ST_XMAX(ST_MAKELINE(...))` → `-122.35` | +| [ST_YMIN](st-ymin.md) | 返回最小 Y 坐标 | `ST_YMIN(ST_MAKELINE(...))` → `37.55` | +| [ST_YMAX](st-ymax.md) | 返回最大 Y 坐标 | `ST_YMAX(ST_MAKELINE(...))` → `37.60` | +| [ST_LENGTH](st-length.md) | 返回线字符串的长度 | `ST_LENGTH(ST_MAKELINE(...))` → `5.57` | + +## 几何访问器 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [ST_POINTN](st-pointn.md) | 从线字符串返回指定点 | `ST_POINTN(ST_MAKELINE(...), 1)` → `POINT(-122.35 37.55)` | +| [ST_STARTPOINT](st-startpoint.md) | 返回线字符串的起点 | `ST_STARTPOINT(ST_MAKELINE(...))` → `POINT(-122.35 37.55)` | +| [ST_ENDPOINT](st-endpoint.md) | 返回线字符串的终点 | `ST_ENDPOINT(ST_MAKELINE(...))` → `POINT(-122.40 37.60)` | + +## 空间操作 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [ST_DISTANCE](st-distance.md) | 返回两个几何体间的距离 | `ST_DISTANCE(ST_MAKEGEOMPOINT(-122.35, 37.55), ST_MAKEGEOMPOINT(-122.40, 37.60))` → `5.57` | +| [HAVERSINE](haversine.md) | 返回两点间的大圆距离 | `HAVERSINE(37.55, -122.35, 37.60, -122.40)` → `6.12` | +| [ST_CONTAINS](st-contains.md) | 判断几何体是否包含另一几何体 | `ST_CONTAINS(ST_MAKEPOLYGON(...), ST_MAKEGEOMPOINT(...))` → `TRUE` | +| [ST_TRANSFORM](st-transform.md) | 将几何体从某 SRID 转换至另一 SRID | `ST_TRANSFORM(ST_MAKEGEOMPOINT(-122.35, 37.55), 3857)` → `POINT(-13618288.8 4552395.0)` | +| [ST_SETSRID](st-setsrid.md) | 设置几何体的 SRID | `ST_SETSRID(ST_MAKEGEOMPOINT(-122.35, 37.55), 3857)` → `POINT(-122.35 37.55)` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/10-map-functions/index.md b/docs/cn/sql-reference/20-sql-functions/10-map-functions/index.md index 931585405c..67a8b3b6b2 100644 --- a/docs/cn/sql-reference/20-sql-functions/10-map-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/10-map-functions/index.md @@ -1,9 +1,41 @@ --- -title: Map 函数 +title: 映射函数（Map Functions） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本节提供 Databend 中映射函数（Map Functions）的参考信息。映射函数允许您创建、操作映射数据结构（键值对），并从中提取信息。 -本节提供了 Databend 中 map 函数的参考信息。 +## 映射创建和组合 - \ No newline at end of file +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [MAP_CAT](map-cat) | 将多个映射合并为单个映射 | `MAP_CAT({'a':1}, {'b':2})` → `{'a':1,'b':2}` | + +## 映射访问和信息 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [MAP_KEYS](map-keys) | 返回映射中的所有键，以数组形式 | `MAP_KEYS({'a':1,'b':2})` → `['a','b']` | +| [MAP_VALUES](map-values) | 返回映射中的所有值，以数组形式 | `MAP_VALUES({'a':1,'b':2})` → `[1,2]` | +| [MAP_SIZE](map-size) | 返回映射中键值对的数量 | `MAP_SIZE({'a':1,'b':2,'c':3})` → `3` | +| [MAP_CONTAINS_KEY](map-contains-key) | 检查映射是否包含特定键 | `MAP_CONTAINS_KEY({'a':1,'b':2}, 'a')` → `TRUE` | + +## 映射修改 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [MAP_INSERT](map-insert) | 向映射中插入一个键值对 | `MAP_INSERT({'a':1,'b':2}, 'c', 3)` → `{'a':1,'b':2,'c':3}` | +| [MAP_DELETE](map-delete) | 从映射中删除一个键值对 | `MAP_DELETE({'a':1,'b':2,'c':3}, 'b')` → `{'a':1,'c':3}` | + +## 映射转换 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [MAP_TRANSFORM_KEYS](map-transform-keys) | 对映射中的每个键应用一个函数 | `MAP_TRANSFORM_KEYS({'a':1,'b':2}, x -> UPPER(x))` → `{'A':1,'B':2}` | +| [MAP_TRANSFORM_VALUES](map-transform-values) | 对映射中的每个值应用一个函数 | `MAP_TRANSFORM_VALUES({'a':1,'b':2}, x -> x * 10)` → `{'a':10,'b':20}` | + +## 映射过滤和选择 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [MAP_FILTER](map-filter) | 基于谓词过滤键值对 | `MAP_FILTER({'a':1,'b':2,'c':3}, (k,v) -> v > 1)` → `{'b':2,'c':3}` | +| [MAP_PICK](map-pick) | 创建一个仅包含指定键的新映射 | `MAP_PICK({'a':1,'b':2,'c':3}, ['a','c'])` → `{'a':1,'c':3}` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/10-search-functions/index.md b/docs/cn/sql-reference/20-sql-functions/10-search-functions/index.md index 5569a20cc9..be801b9cad 100644 --- a/docs/cn/sql-reference/20-sql-functions/10-search-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/10-search-functions/index.md @@ -1,12 +1,51 @@ --- -title: 全文搜索函数 +title: 全文搜索函数（Full-Text Search Functions） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本节提供 Databend 中全文搜索函数的参考信息。 +本节提供 Databend 中全文搜索函数的参考信息。这些函数可实现与专用搜索引擎类似的强大文本搜索能力。 :::info -Databend 的全文搜索函数灵感来源于 [Elasticsearch 全文搜索函数](https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-functions-search.html)。 +Databend 的全文搜索函数设计灵感源自 [Elasticsearch 全文搜索函数](https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-functions-search.html)。 ::: - \ No newline at end of file +## 搜索函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [MATCH](match) | 在选定列中搜索包含指定关键词的文档 | `MATCH('title, body', 'technology')` | +| [QUERY](query) | 使用高级语法搜索满足指定查询表达式的文档 | `QUERY('title:technology AND society')` | +| [SCORE](score) | 配合 MATCH 或 QUERY 使用时返回搜索结果的相关性评分 | `SELECT title, SCORE() FROM articles WHERE MATCH('title', 'technology')` | + +## 使用示例 + +### 基本文本搜索 + +```sql +-- 在 title 或 body 列中搜索包含 'technology' 的文档 +SELECT * FROM articles +WHERE MATCH('title, body', 'technology'); +``` + +### 高级查询表达式 + +```sql +-- 搜索 title 列包含 'technology' 且 body 列包含 'impact' 的文档 +SELECT * FROM articles +WHERE QUERY('title:technology AND body:impact'); +``` + +### 相关性评分 + +```sql +-- 执行带相关性评分的搜索，并按评分降序排序 +SELECT title, body, SCORE() +FROM articles +WHERE MATCH('title^2, body', 'technology') +ORDER BY SCORE() DESC; +``` + +使用这些函数前，需在目标列上创建倒排索引（Inverted Index）： + +```sql +CREATE INVERTED INDEX idx ON articles(title, body); +``` \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/10-semi-structured-functions/index.md b/docs/cn/sql-reference/20-sql-functions/10-semi-structured-functions/index.md index 693d7cd04b..b4747a0001 100644 --- a/docs/cn/sql-reference/20-sql-functions/10-semi-structured-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/10-semi-structured-functions/index.md @@ -1,79 +1,103 @@ --- -title: 半结构化函数 +title: 半结构化函数（Semi-Structured Functions） --- -本节提供了 Databend 中半结构化数据函数的参考信息。 - -## 基本操作 - -### 解析和验证 -- [PARSE_JSON](parse-json.md): 将 JSON 字符串解析为 variant 值 -- [CHECK_JSON](check-json.md): 验证字符串是否为有效的 JSON - -### 对象访问和提取 -- [GET](get.md): 通过键从 JSON 对象中获取值 -- [GET_PATH](get-path.md): 通过路径从 JSON 对象中获取值 -- [GET_IGNORE_CASE](get-ignore-case.md): 获取不区分大小写的键的值 -- [OBJECT_KEYS](object-keys.md): 返回 JSON 对象的键 -- [JSON_OBJECT_KEYS](json-object-keys.md): 将 JSON 对象的键作为数组返回 - -### 类型检查和转换 -- [JSON_TYPEOF](json-typeof.md): 返回 JSON 值的类型 -- [AS_TYPE](as-type.md): 将 JSON 值转换为指定的 SQL 类型 -- [JSON_TO_STRING](json-to-string.md): 将 JSON 值转换为字符串 -- [IS_OBJECT](is-object.md): 检查 JSON 值是否为对象 -- [IS_ARRAY](is-array.md): 检查 JSON 值是否为数组 -- [IS_STRING](is-string.md): 检查 JSON 值是否为字符串 -- [IS_INTEGER](is-integer.md): 检查 JSON 值是否为整数 -- [IS_FLOAT](is-float.md): 检查 JSON 值是否为浮点数 -- [IS_BOOLEAN](is-boolean.md): 检查 JSON 值是否为布尔值 -- [IS_NULL_VALUE](is-null-value.md): 检查 JSON 值是否为 null - -## 构建和修改 - -### JSON 对象操作 -- [JSON_OBJECT](json-object.md): 从键值对创建 JSON 对象 -- [JSON_OBJECT_INSERT](json-object-insert.md): 将值插入 JSON 对象 -- [JSON_OBJECT_DELETE](json-object-delete.md): 从 JSON 对象中删除键 -- [JSON_OBJECT_PICK](json-object-pick.md): 使用选定的键创建一个新对象 -- [JSON_STRIP_NULLS](json-strip-nulls.md): 从 JSON 对象中删除 null 值 -- [JSON_OBJECT_KEEP_NULL](json-object-keep-null.md): 创建一个保留 null 值的 JSON 对象 - -### JSON 数组操作 -- [JSON_ARRAY](json-array.md): 从输入值创建 JSON 数组 -- [JSON_ARRAY_INSERT](json-array-insert.md): 将值插入 JSON 数组 -- [JSON_ARRAY_DISTINCT](json-array-distinct.md): 返回具有不同元素的数组 -- [FLATTEN](flatten.md): 将嵌套数组展平为单个数组 - -## 高级查询和转换 - -### 路径查询 -- [JSON_PATH_EXISTS](json-path-exists.md): 检查 JSON 路径是否存在 -- [JSON_PATH_QUERY](json-path-query.md): 使用路径表达式查询 JSON 数据 -- [JSON_PATH_QUERY_FIRST](json-path-query-first.md): 从路径查询返回第一个匹配项 -- [JSON_PATH_QUERY_ARRAY](json-path-query-array.md): 将查询结果作为 JSON 数组返回 -- [JSON_EXTRACT_PATH_TEXT](json-extract-path-text.md): 从 JSON 路径提取文本 -- [JSON_PATH_MATCH](json-path-match.md): 将 JSON 数据与路径表达式进行匹配 -- [JQ](jq.md): 提供类似 jq 的 JSON 处理功能 - -### 数组转换 -- [JSON_ARRAY_MAP](json-array-map.md): 将函数映射到数组元素 -- [JSON_ARRAY_FILTER](json-array-filter.md): 使用条件过滤数组元素 -- [JSON_ARRAY_TRANSFORM](json-array-transform.md): 使用表达式转换数组元素 -- [JSON_ARRAY_APPLY](json-array-apply.md): 将函数应用于每个数组元素 -- [JSON_ARRAY_REDUCE](json-array-reduce.md): 将数组缩减为单个值 - -### 集合操作 -- [JSON_ARRAY_INTERSECTION](json-array-intersection.md): 返回数组之间的公共元素 -- [JSON_ARRAY_EXCEPT](json-array-except.md): 返回第一个数组中但不在第二个数组中的元素 -- [JSON_ARRAY_OVERLAP](json-array-overlap.md): 检查数组是否具有公共元素 - -### 对象转换 -- [JSON_MAP_FILTER](json-map-filter.md): 过滤 JSON 对象中的键值对 -- [JSON_MAP_TRANSFORM_KEYS](json-map-transform-keys.md): 转换 JSON 对象中的键 -- [JSON_MAP_TRANSFORM_VALUES](json-map-transform-values.md): 转换 JSON 对象中的值 - -### 扩展和格式化 -- [JSON_ARRAY_ELEMENTS](json-array-elements.md): 将 JSON 数组扩展为一组行 -- [JSON_EACH](json-each.md): 将最外层的 JSON 对象扩展为键值对 -- [JSON_PRETTY](json-pretty.md): 使用缩进格式化 JSON 以提高可读性 +本节提供 Databend 中半结构化数据函数的参考信息。这些函数可帮助您高效处理 JSON 及其他半结构化数据格式。 + +## 解析和验证 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [PARSE_JSON](parse-json) | 将 JSON 字符串解析为 Variant 类型值 | `PARSE_JSON('{"name":"Databend"}')` | +| [CHECK_JSON](check-json) | 验证字符串是否为有效 JSON | `CHECK_JSON('{"name":"Databend"}')` → `true` | + +## 对象访问和提取 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [GET](get) | 通过键名从 JSON 对象获取值 | `GET(parse_json('{"name":"Databend"}'), 'name')` → `'Databend'` | +| [GET_PATH](get-path) | 通过路径从 JSON 对象获取值 | `GET_PATH(parse_json('{"user":{"name":"Databend"}}'), 'user.name')` → `'Databend'` | +| [GET_IGNORE_CASE](get-ignore-case) | 通过不区分大小写的键名获取值 | `GET_IGNORE_CASE(parse_json('{"Name":"Databend"}'), 'name')` → `'Databend'` | +| [OBJECT_KEYS](object-keys) | 返回 JSON 对象的键名集合 | `OBJECT_KEYS(parse_json('{"a":1,"b":2}'))` → `['a', 'b']` | +| [JSON_OBJECT_KEYS](json-object-keys) | 以数组形式返回 JSON 对象的键名 | `JSON_OBJECT_KEYS(parse_json('{"a":1,"b":2}'))` → `['a', 'b']` | + +## 类型检查和转换 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [JSON_TYPEOF](json-typeof) | 返回 JSON 值的类型 | `JSON_TYPEOF(parse_json('123'))` → `'number'` | +| [AS_TYPE](as-type) | 将 JSON 值转换为指定 SQL 类型 | `AS_TYPE(parse_json('123'), 'INT')` → `123` | +| [JSON_TO_STRING](json-to-string) | 将 JSON 值转换为字符串 | `JSON_TO_STRING(parse_json('{"a":1}'))` → `'{"a":1}'` | +| [IS_OBJECT](is-object) | 检查 JSON 值是否为对象 | `IS_OBJECT(parse_json('{"a":1}'))` → `true` | +| [IS_ARRAY](is-array) | 检查 JSON 值是否为数组 | `IS_ARRAY(parse_json('[1,2,3]'))` → `true` | +| [IS_STRING](is-string) | 检查 JSON 值是否为字符串 | `IS_STRING(parse_json('"hello"'))` → `true` | +| [IS_INTEGER](is-integer) | 检查 JSON 值是否为整数 | `IS_INTEGER(parse_json('123'))` → `true` | +| [IS_FLOAT](is-float) | 检查 JSON 值是否为浮点数 | `IS_FLOAT(parse_json('123.45'))` → `true` | +| [IS_BOOLEAN](is-boolean) | 检查 JSON 值是否为布尔值 | `IS_BOOLEAN(parse_json('true'))` → `true` | +| [IS_NULL_VALUE](is-null-value) | 检查 JSON 值是否为 null | `IS_NULL_VALUE(parse_json('null'))` → `true` | + +## JSON 对象操作 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [JSON_OBJECT](json-object) | 根据键值对创建 JSON 对象 | `JSON_OBJECT('name', 'Databend', 'version', '1.0')` → `'{"name":"Databend","version":"1.0"}'` | +| [JSON_OBJECT_INSERT](json-object-insert) | 向 JSON 对象插入键值对 | `JSON_OBJECT_INSERT(parse_json('{"a":1}'), 'b', 2)` → `'{"a":1,"b":2}'` | +| [JSON_OBJECT_DELETE](json-object-delete) | 从 JSON 对象删除指定键 | `JSON_OBJECT_DELETE(parse_json('{"a":1,"b":2}'), 'b')` → `'{"a":1}'` | +| [JSON_OBJECT_PICK](json-object-pick) | 选取指定键创建新 JSON 对象 | `JSON_OBJECT_PICK(parse_json('{"a":1,"b":2,"c":3}'), 'a', 'c')` → `'{"a":1,"c":3}'` | +| [JSON_STRIP_NULLS](json-strip-nulls) | 移除 JSON 对象中的 null 值 | `JSON_STRIP_NULLS(parse_json('{"a":1,"b":null}'))` → `'{"a":1}'` | +| [JSON_OBJECT_KEEP_NULL](json-object-keep-null) | 创建保留 null 值的 JSON 对象 | `JSON_OBJECT_KEEP_NULL('a', 1, 'b', NULL)` → `'{"a":1,"b":null}'` | + +## JSON 数组操作 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [JSON_ARRAY](json-array) | 根据输入值创建 JSON 数组 | `JSON_ARRAY(1, 'text', true)` → `'[1,"text",true]'` | +| [JSON_ARRAY_INSERT](json-array-insert) | 向 JSON 数组指定位置插入值 | `JSON_ARRAY_INSERT(parse_json('[1,3]'), 1, 2)` → `'[1,2,3]'` | +| [JSON_ARRAY_DISTINCT](json-array-distinct) | 返回去重后的数组 | `JSON_ARRAY_DISTINCT(parse_json('[1,2,1,3,2]'))` → `'[1,2,3]'` | +| [FLATTEN](flatten) | 将嵌套数组展平为一维数组 | `FLATTEN(parse_json('[[1,2],[3,4]]'))` → `'[1,2,3,4]'` | + +## 路径查询 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [JSON_PATH_EXISTS](json-path-exists) | 检查 JSON 路径是否存在 | `JSON_PATH_EXISTS(parse_json('{"a":{"b":1}}'), '$.a.b')` → `true` | +| [JSON_PATH_QUERY](json-path-query) | 使用路径表达式查询 JSON 数据 | `JSON_PATH_QUERY(parse_json('{"a":[1,2,3]}'), '$.a[*]')` → `[1,2,3]` | +| [JSON_PATH_QUERY_FIRST](json-path-query-first) | 返回路径查询的首个匹配结果 | `JSON_PATH_QUERY_FIRST(parse_json('{"a":[1,2,3]}'), '$.a[*]')` → `1` | +| [JSON_PATH_QUERY_ARRAY](json-path-query-array) | 以 JSON 数组返回路径查询结果 | `JSON_PATH_QUERY_ARRAY(parse_json('{"a":[1,2,3]}'), '$.a[*]')` → `'[1,2,3]'` | +| [JSON_EXTRACT_PATH_TEXT](json-extract-path-text) | 提取 JSON 路径对应的文本值 | `JSON_EXTRACT_PATH_TEXT(parse_json('{"a":{"b":"text"}}'), 'a', 'b')` → `'text'` | +| [JSON_PATH_MATCH](json-path-match) | 检查 JSON 数据是否匹配路径表达式 | `JSON_PATH_MATCH(parse_json('{"a":1}'), '$.a == 1')` → `true` | +| [JQ](jq) | 提供类 jq 的 JSON 处理能力 | `JQ(parse_json('{"a":{"b":1}}'), '.a.b')` → `1` | + +## 数组转换 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [JSON_ARRAY_MAP](json-array-map) | 对数组元素执行映射操作 | `JSON_ARRAY_MAP(parse_json('[1,2,3]'), x -> x * 2)` → `'[2,4,6]'` | +| [JSON_ARRAY_FILTER](json-array-filter) | 按条件过滤数组元素 | `JSON_ARRAY_FILTER(parse_json('[1,2,3,4]'), x -> x > 2)` → `'[3,4]'` | +| [JSON_ARRAY_TRANSFORM](json-array-transform) | 使用表达式转换数组元素 | `JSON_ARRAY_TRANSFORM(parse_json('[{"a":1},{"a":2}]'), x -> x.a)` → `'[1,2]'` | +| [JSON_ARRAY_APPLY](json-array-apply) | 对数组元素应用函数 | `JSON_ARRAY_APPLY(parse_json('[1,2,3]'), x -> x * x)` → `'[1,4,9]'` | +| [JSON_ARRAY_REDUCE](json-array-reduce) | 将数组归约为单个值 | `JSON_ARRAY_REDUCE(parse_json('[1,2,3]'), 0, (acc, x) -> acc + x)` → `6` | + +## 集合操作 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [JSON_ARRAY_INTERSECTION](json-array-intersection) | 返回数组之间的交集元素 | `JSON_ARRAY_INTERSECTION(parse_json('[1,2,3]'), parse_json('[2,3,4]'))` → `'[2,3]'` | +| [JSON_ARRAY_EXCEPT](json-array-except) | 返回仅存在于第一个数组的元素 | `JSON_ARRAY_EXCEPT(parse_json('[1,2,3]'), parse_json('[2,3,4]'))` → `'[1]'` | +| [JSON_ARRAY_OVERLAP](json-array-overlap) | 检查数组是否存在交集元素 | `JSON_ARRAY_OVERLAP(parse_json('[1,2,3]'), parse_json('[3,4,5]'))` → `true` | + +## 对象转换 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [JSON_MAP_FILTER](json-map-filter) | 按条件过滤 JSON 对象的键值对 | `JSON_MAP_FILTER(parse_json('{"a":1,"b":2}'), (k,v) -> v > 1)` → `'{"b":2}'` | +| [JSON_MAP_TRANSFORM_KEYS](json-map-transform-keys) | 转换 JSON 对象的键名 | `JSON_MAP_TRANSFORM_KEYS(parse_json('{"a":1,"b":2}'), k -> UPPER(k))` → `'{"A":1,"B":2}'` | +| [JSON_MAP_TRANSFORM_VALUES](json-map-transform-values) | 转换 JSON 对象的值 | `JSON_MAP_TRANSFORM_VALUES(parse_json('{"a":1,"b":2}'), v -> v * 10)` → `'{"a":10,"b":20}'` | + +## 展开和格式化 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [JSON_ARRAY_ELEMENTS](json-array-elements) | 将 JSON 数组展开为多行记录 | `SELECT * FROM JSON_ARRAY_ELEMENTS(parse_json('[1,2,3]'))` → `3 行记录，值分别为 1, 2, 3` | +| [JSON_EACH](json-each) | 将 JSON 对象展开为键值对记录 | `SELECT * FROM JSON_EACH(parse_json('{"a":1,"b":2}'))` → `2 行键值对记录` | +| [JSON_PRETTY](json-pretty) | 格式化 JSON 输出（含缩进） | `JSON_PRETTY(parse_json('{"a":1,"b":2}'))` → `'{\n "a": 1,\n "b": 2\n}'` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/11-ai-functions/index.md b/docs/cn/sql-reference/20-sql-functions/11-ai-functions/index.md index 4b435c33a3..3cbe2cca85 100644 --- a/docs/cn/sql-reference/20-sql-functions/11-ai-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/11-ai-functions/index.md @@ -1,10 +1,18 @@ --- -title: 'AI 函数' +title: 'AI 函数（AI Functions）' description: '使用基于 SQL 的 AI 函数进行知识库搜索和文本补全' --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本节提供 Databend 内置 AI 函数的参考信息，这些函数通过 SQL 直接提供自然语言处理、向量嵌入和文本生成功能。 -本文档演示了如何利用 Databend 内置的 AI 函数来创建文档嵌入、搜索相似文档以及基于上下文生成文本补全。 +:::info +Databend 的 AI 函数利用 OpenAI 模型，同时也支持 Azure OpenAI 服务以提高数据隐私保护。这些函数需要在 Databend 中配置 OpenAI API 密钥，在 Databend Cloud 上默认可用。 +::: - \ No newline at end of file +## 可用的 AI 函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [AI_TO_SQL](./01-ai-to-sql.md) | 将自然语言指令转换为 SQL 查询（Query） | `SELECT * FROM ai_to_sql('Get all products with price less than 100')` | +| [AI_EMBEDDING_VECTOR](./02-ai-embedding-vector.md) | 为文本数据生成向量嵌入 | `SELECT ai_embedding_vector('How to use Databend')` | +| [AI_TEXT_COMPLETION](./03-ai-text-completion.md) | 基于给定提示（Prompt）生成文本补全 | `SELECT ai_text_completion('What is a data warehouse?')` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/11-vector-distance-functions/index.md b/docs/cn/sql-reference/20-sql-functions/11-vector-distance-functions/index.md index f23f593bfa..e15ba45e24 100644 --- a/docs/cn/sql-reference/20-sql-functions/11-vector-distance-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/11-vector-distance-functions/index.md @@ -1,14 +1,20 @@ --- -title: '向量距离函数' -description: 'Databend 中用于相似性度量的向量距离函数' +title: '向量距离函数 (Vector Distance Functions)' +description: 'Databend 中用于相似性测量的向量距离函数' --- -# 向量距离函数 +本节提供 Databend 中向量距离函数的参考信息。这些函数在机器学习应用、向量搜索和 AI 驱动分析中，对测量向量间的相似性至关重要。 -Databend 提供了用于测量向量之间距离或相似度的函数，这对于向量搜索和机器学习应用至关重要。 +## 可用的向量距离函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [COSINE_DISTANCE](./00-vector-cosine-distance.md) | 计算向量间的角度距离（范围：0-1） | `COSINE_DISTANCE([1,2,3], [4,5,6])` | +| [L2_DISTANCE](./01-vector-l2-distance.md) | 计算欧几里得（直线）距离 | `L2_DISTANCE([1,2,3], [4,5,6])` | ## 函数比较 -| 函数 | 描述 | 范围 | 最适合 | 使用场景 | + +| 函数 | 描述 | 范围 | 最佳用途 | 应用场景 | |----------|-------------|-------|----------|-----------| -| [L2_DISTANCE](01-vector-l2-distance.md) | 欧几里得（直线）距离 | [0, ∞) | 当大小很重要时 | • 图像相似性
• 地理数据
• 异常检测
• 基于特征的聚类 | -| [COSINE_DISTANCE](00-vector-cosine-distance.md) | 向量之间的角度距离 | [0, 1] | 当方向比大小更重要时 | • 文档相似性
• 语义搜索
• 推荐系统
• 文本分析 | \ No newline at end of file +| [L2_DISTANCE](./01-vector-l2-distance.md) | 欧几里得（直线）距离 | [0, ∞) | 当向量大小重要时 | • 图像相似性
• 地理数据
• 异常检测
• 基于特征的聚类 | +| [COSINE_DISTANCE](./00-vector-cosine-distance.md) | 向量间的角度距离 | [0, 1] | 当方向比大小更重要时 | • 文档相似性
• 语义搜索
• 推荐系统
• 文本分析 | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/12-hash-functions/index.md b/docs/cn/sql-reference/20-sql-functions/12-hash-functions/index.md index bca1557211..8878b32f17 100644 --- a/docs/cn/sql-reference/20-sql-functions/12-hash-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/12-hash-functions/index.md @@ -2,8 +2,57 @@ title: 哈希函数 --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面全面概述了 Databend 中的哈希函数，按功能分类编排以便查阅。 -本节提供 Databend 中哈希函数的参考信息。 +## 加密哈希函数 - \ No newline at end of file +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [MD5](md5.md) | 计算 MD5 128 位校验和 | `MD5('1234567890')` → `'e807f1fcf82d132f9bb018ca6738a19f'` | +| [SHA1](sha1.md) / [SHA](sha.md) | 计算 SHA-1 160 位校验和 | `SHA1('1234567890')` → `'01b307acba4f54f55aafc33bb06bbbf6ca803e9a'` | +| [SHA2](sha2.md) | 计算 SHA-2 系列哈希值（SHA-224、SHA-256、SHA-384、SHA-512） | `SHA2('1234567890', 256)` → `'c775e7b757ede630cd0aa1113bd102661ab38829ca52a6422ab782862f268646'` | +| [BLAKE3](blake3.md) | 计算 BLAKE3 哈希值 | `BLAKE3('1234567890')` → `'e2cf6ae2a7e65c7b9e089da1ad582100a0d732551a6a07abb07f7a4a119ecc51'` | + +## 非加密哈希函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [XXHASH32](xxhash32.md) | 计算 xxHash32 32 位哈希值 | `XXHASH32('1234567890')` → `3768853052` | +| [XXHASH64](xxhash64.md) | 计算 xxHash64 64 位哈希值 | `XXHASH64('1234567890')` → `12237639266330420150` | +| [SIPHASH64](siphash64.md) / [SIPHASH](siphash.md) | 计算 SipHash-2-4 64 位哈希值 | `SIPHASH64('1234567890')` → `2917646445633666330` | +| [CITY64WITHSEED](city64withseed.md) | 计算带种子的 CityHash64 哈希值 | `CITY64WITHSEED('1234567890', 42)` → `5210846883572933352` | + +## 使用示例 + +### 数据完整性验证 + +```sql +-- 计算文件内容的 MD5 哈希 +SELECT + filename, + MD5(file_content) AS content_hash +FROM files +ORDER BY filename; +``` + +### 数据匿名化 + +```sql +-- 存储或处理前哈希敏感数据 +SELECT + user_id, + SHA2(email, 256) AS hashed_email, + SHA2(phone_number, 256) AS hashed_phone +FROM users; +``` + +### 基于哈希的分区 + +```sql +-- 使用哈希函数实现数据分布 +SELECT + XXHASH64(customer_id) % 10 AS partition_id, + COUNT(*) AS records_count +FROM orders +GROUP BY partition_id; +``` \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/13-uuid-functions/index.md b/docs/cn/sql-reference/20-sql-functions/13-uuid-functions/index.md index 879ee55ced..714604ba47 100644 --- a/docs/cn/sql-reference/20-sql-functions/13-uuid-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/13-uuid-functions/index.md @@ -1,8 +1,51 @@ --- title: UUID 函数 --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本节提供 Databend 中与 UUID 相关的函数的参考信息。 +本页面提供 Databend 中 UUID 相关函数的参考信息。这些函数用于生成和处理通用唯一标识符（UUID）。 - \ No newline at end of file +## UUID 生成函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [GEN_RANDOM_UUID](gen-random-uuid.md) | 生成随机 UUID（v1.2.658 起使用版本 7，此前使用版本 4） | `GEN_RANDOM_UUID()` → `'01890a5d-ac96-7cc6-8128-01d71ab8b93e'` | +| [UUID](uuid.md) | GEN_RANDOM_UUID 的别名 | `UUID()` → `'01890a5d-ac96-7cc6-8128-01d71ab8b93e'` | + +## 使用示例 + +### 生成主键 + +```sql +-- 创建带 UUID 主键的表 +CREATE TABLE users ( + id UUID DEFAULT GEN_RANDOM_UUID(), + username VARCHAR, + email VARCHAR, + PRIMARY KEY(id) +); + +-- 插入数据时不指定 UUID +INSERT INTO users (username, email) +VALUES ('johndoe', 'john@example.com'); + +-- 查看自动生成的 UUID +SELECT * FROM users; +``` + +### 为分布式系统创建唯一标识符 + +```sql +-- 为分布式事件跟踪生成多个 UUID +SELECT + GEN_RANDOM_UUID() AS event_id, + 'user_login' AS event_type, + NOW() AS event_time +FROM numbers(5); +``` + +### UUID 版本信息 + +Databend 的 UUID 实现方案变更如下： + +- **v1.2.658 起**：使用 UUID 版本 7（含时间戳信息，支持时序排序） +- **v1.2.658 此前**：使用 UUID 版本 4（完全随机生成） \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/14-ip-address-functions/index.md b/docs/cn/sql-reference/20-sql-functions/14-ip-address-functions/index.md index 061311bf41..eac1d28261 100644 --- a/docs/cn/sql-reference/20-sql-functions/14-ip-address-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/14-ip-address-functions/index.md @@ -2,8 +2,20 @@ title: IP 地址函数 --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本页面提供 Databend 中 IP 地址相关函数的参考信息。这些函数用于在 IP 地址的字符串和数字表示形式之间进行转换。 -本节提供 Databend 中与 IP 地址相关函数的参考信息。 +## IP 地址转换函数 - \ No newline at end of file +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [INET_ATON](inet-aton.md) / [IPV4_STRING_TO_NUM](ipv4-string-to-num.md) | 将 IPv4 地址字符串转换为 32 位整数 | `INET_ATON('192.168.1.1')` → `3232235777` | +| [INET_NTOA](inet-ntoa.md) / [IPV4_NUM_TO_STRING](ipv4-num-to-string.md) | 将 32 位整数转换为 IPv4 地址字符串 | `INET_NTOA(3232235777)` → `'192.168.1.1'` | + +## 安全 IP 地址转换函数 + +这些函数通过返回 NULL 而非报错的方式安全处理无效输入。 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [TRY_INET_ATON](try-inet-aton.md) / [TRY_IPV4_STRING_TO_NUM](try-ipv4-string-to-num.md) | 安全地将 IPv4 地址字符串转换为 32 位整数 | `TRY_INET_ATON('invalid')` → `NULL` | +| [TRY_INET_NTOA](try-inet-ntoa.md) / [TRY_IPV4_NUM_TO_STRING](try-ipv4-num-to-string.md) | 安全地将 32 位整数转换为 IPv4 地址字符串 | `TRY_INET_NTOA(-1)` → `NULL` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/15-context-functions/index.md b/docs/cn/sql-reference/20-sql-functions/15-context-functions/index.md index 3550cf5230..77c1f434e6 100644 --- a/docs/cn/sql-reference/20-sql-functions/15-context-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/15-context-functions/index.md @@ -1,8 +1,26 @@ --- -title: 上下文函数 +title: Context Functions（上下文函数） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本节提供 Databend 中与上下文相关函数的参考信息。 +本页面提供 Databend 中上下文相关函数的参考信息。这些函数返回有关当前会话、数据库或系统上下文的信息。 - \ No newline at end of file +## Session Information Functions（会话信息函数） + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [CONNECTION_ID](connection-id.md) | 返回当前连接的连接 ID | `CONNECTION_ID()` → `42` | +| [CURRENT_USER](current-user.md) | 返回当前连接的用户名和主机 | `CURRENT_USER()` → `'root'@'%'` | +| [LAST_QUERY_ID](last-query-id.md) | 返回最后执行查询的查询 ID | `LAST_QUERY_ID()` → `'01890a5d-ac96-7cc6-8128-01d71ab8b93e'` | + +## Database Context Functions（数据库上下文函数） + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [CURRENT_CATALOG](current-catalog.md) | 返回当前目录的名称 | `CURRENT_CATALOG()` → `'default'` | +| [DATABASE](database.md) | 返回当前数据库的名称 | `DATABASE()` → `'default'` | + +## System Information Functions（系统信息函数） + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [VERSION](version.md) | 返回当前 Databend 版本 | `VERSION()` → `'DatabendQuery v1.2.252-nightly-193ed56304'` | diff --git a/docs/cn/sql-reference/20-sql-functions/16-system-functions/index.md b/docs/cn/sql-reference/20-sql-functions/16-system-functions/index.md index 51edb9bf5e..df596a19b8 100644 --- a/docs/cn/sql-reference/20-sql-functions/16-system-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/16-system-functions/index.md @@ -1,14 +1,29 @@ --- -title: 系统函数 +title: 系统函数 (System Functions) --- -本节提供 Databend 中与系统相关函数的参考信息。 +本页面提供 Databend 中系统相关函数的参考信息，这些函数可帮助分析和监控 Databend 部署的内部存储与性能情况。 -## 函数列表： -- [FUSE_ENCODING](fuse_encoding.md) -- [CLUSTERING_INFORMATION](clustering_information.md) -- [FUSE_COLUMN](fuse_column.md) -- [FUSE_BLOCK](fuse_block.md) -- [FUSE_SEGMENT](fuse_segment.md) -- [FUSE_STATISTIC](fuse_statistic.md) -- [FUSE_SNAPSHOT](fuse_snapshot.md) +## 表元数据函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [CLUSTERING_INFORMATION](clustering_information.md) | 返回表的聚类信息 | `CLUSTERING_INFORMATION('default', 'mytable')` | + +## 存储层函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [FUSE_SNAPSHOT](fuse_snapshot.md) | 返回表的快照信息 | `FUSE_SNAPSHOT('default', 'mytable')` | +| [FUSE_SEGMENT](fuse_segment.md) | 返回表的段信息 | `FUSE_SEGMENT('default', 'mytable')` | +| [FUSE_BLOCK](fuse_block.md) | 返回表的块信息 | `FUSE_BLOCK('default', 'mytable')` | +| [FUSE_COLUMN](fuse_column.md) | 返回表的列信息 | `FUSE_COLUMN('default', 'mytable')` | + +## 存储优化函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [FUSE_STATISTIC](fuse_statistic.md) | 返回表的统计信息 | `FUSE_STATISTIC('default', 'mytable')` | +| [FUSE_ENCODING](fuse_encoding.md) | 返回表的编码信息 | `FUSE_ENCODING('default', 'mytable')` | +| [FUSE_VIRTUAL_COLUMN](fuse_virtual_column.md) | 返回虚拟列信息 | `FUSE_VIRTUAL_COLUMN('default', 'mytable')` | +| [FUSE_TIME_TRAVEL_SIZE](fuse_time_travel_size.md) | 返回 Time Travel 存储信息 | `FUSE_TIME_TRAVEL_SIZE('default', 'mytable')` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/17-table-functions/index.md b/docs/cn/sql-reference/20-sql-functions/17-table-functions/index.md index e51aadd930..6759f27b22 100644 --- a/docs/cn/sql-reference/20-sql-functions/17-table-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/17-table-functions/index.md @@ -1,8 +1,38 @@ --- -title: 表函数 +title: 表函数 (Table Functions) --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本节提供了 Databend 中表函数的参考信息。 +本页面提供 Databend 中表函数的参考信息。表函数返回一组行（类似于表），可在查询的 `FROM` 子句中使用。 - \ No newline at end of file +## 数据探索函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [INFER_SCHEMA](./01-infer-schema.md) | 检测文件元数据模式并获取列定义 | `SELECT * FROM INFER_SCHEMA(LOCATION => '@mystage/data/')` | +| [INSPECT_PARQUET](./02-inspect-parquet.md) | 检查 Parquet 文件结构 | `SELECT * FROM INSPECT_PARQUET(LOCATION => '@mystage/data.parquet')` | +| [LIST_STAGE](./03-list-stage.md) | 列出 Stage 中的文件 | `SELECT * FROM LIST_STAGE(LOCATION => '@mystage/data/')` | +| [RESULT_SCAN](./result-scan.md) | 检索历史查询的结果集 | `SELECT * FROM RESULT_SCAN(LAST_QUERY_ID())` | + +## 数据生成函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [GENERATE_SERIES](./05-generate-series.md) | 生成数值序列 | `SELECT * FROM GENERATE_SERIES(1, 10, 2)` | + +## 系统管理函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [SHOW_GRANTS](./show-grants.md) | 显示已授予权限 | `SELECT * FROM SHOW_GRANTS()` | +| [SHOW_VARIABLES](./show-variables.md) | 显示系统变量 | `SELECT * FROM SHOW_VARIABLES()` | +| [STREAM_STATUS](./stream-status.md) | 显示流状态信息 | `SELECT * FROM STREAM_STATUS('mystream')` | +| [TASK_HISTORY](./task_histroy.md) | 显示任务执行历史 | `SELECT * FROM TASK_HISTORY('mytask')` | +| [FUSE_VACUUM_TEMPORARY_TABLE](./fuse-vacuum-temporary-table.md) | 清理临时表 | `SELECT * FROM FUSE_VACUUM_TEMPORARY_TABLE()` | +| [FUSE_AMEND](./fuse-amend.md) | 执行数据修正操作 | `SELECT * FROM FUSE_AMEND()` | + +## Iceberg 集成函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [ICEBERG_MANIFEST](iceberg-manifest) | 显示 Iceberg 表清单信息 | `SELECT * FROM ICEBERG_MANIFEST('mytable')` | +| [ICEBERG_SNAPSHOT](iceberg-snapshot) | 显示 Iceberg 表快照信息 | `SELECT * FROM ICEBERG_SNAPSHOT('mytable')` | diff --git a/docs/cn/sql-reference/20-sql-functions/18-sequence-functions/index.md b/docs/cn/sql-reference/20-sql-functions/18-sequence-functions/index.md index 3fb1d3af2a..6c045789bb 100644 --- a/docs/cn/sql-reference/20-sql-functions/18-sequence-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/18-sequence-functions/index.md @@ -1,8 +1,11 @@ --- -title: 序列函数 +title: 序列函数（Sequence Functions） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; -本节提供 Databend 中序列函数的参考信息。 +本节提供 Databend 中序列函数的参考信息。序列函数允许您使用序列对象（Sequence Objects），这些对象生成唯一的、自动递增的数值。 - \ No newline at end of file +## 可用的序列函数 + +| 函数 | 描述 | 示例 | +|------|------|------| +| [NEXTVAL](nextval) | 从序列中检索下一个值 | `NEXTVAL(my_sequence)` | diff --git a/docs/cn/sql-reference/20-sql-functions/19-dictionary-functions/index.md b/docs/cn/sql-reference/20-sql-functions/19-dictionary-functions/index.md index f2ca071b21..f44b8e39b8 100644 --- a/docs/cn/sql-reference/20-sql-functions/19-dictionary-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/19-dictionary-functions/index.md @@ -1,9 +1,18 @@ --- -title: Dictionary Functions +title: 字典函数（Dictionary Functions） --- -import IndexOverviewList from '@site/src/components/IndexOverviewList'; +本节提供 Databend 中字典函数（Dictionary Functions）的参考信息。字典函数允许您直接从 MySQL 和 Redis 等外部数据源实时查询数据，无需 ETL 过程。 -本节提供了有关 Databend 中字典函数的参考信息。 +## 字典函数的优势 - +- **实时数据访问**：直接查询外部数据源，无需数据同步 +- **数据一致性**：确保 Databend 与外部系统之间的数据一致性 +- **性能提升**：减少对频繁访问参考数据的查询延迟 +- **简化数据管理**：消除对复杂 ETL 管道的需求 + +## 可用的字典函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [DICT_GET](dict-get) | 使用键从字典中检索值 | `DICT_GET(my_dict, 'attribute', key_value)` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/19-test-functions/index.md b/docs/cn/sql-reference/20-sql-functions/19-test-functions/index.md new file mode 100644 index 0000000000..3ca45dc136 --- /dev/null +++ b/docs/cn/sql-reference/20-sql-functions/19-test-functions/index.md @@ -0,0 +1,11 @@ +--- +title: 测试函数（Test Functions） +--- + +本页面提供 Databend 中测试函数的参考信息。这些函数主要用于测试和调试目的。 + +## 可用的测试函数 + +| 函数 | 描述 | 示例 | +|----------|-------------|--------| +| [SLEEP](sleep) | 暂停执行指定秒数 | `SELECT SLEEP(2)` → `0` | \ No newline at end of file diff --git a/docs/cn/sql-reference/20-sql-functions/index.md b/docs/cn/sql-reference/20-sql-functions/index.md index cc6a6557e0..ea464e204e 100644 --- a/docs/cn/sql-reference/20-sql-functions/index.md +++ b/docs/cn/sql-reference/20-sql-functions/index.md @@ -2,51 +2,70 @@ title: SQL 函数参考 --- -这些主题提供了 Databend 中系统定义函数的参考信息。 +本页面提供了 Databend 中所有可用 SQL 函数的参考，按类别组织。 + +## 核心 SQL 函数 + +| 类别 | 描述 | +|----------|-------------| +| [数值函数（Numeric Functions）](./04-numeric-functions/index.md) | 数值数据处理和分析的数学运算 | +| [字符串函数（String Functions）](./06-string-functions/index.md) | 文本操作和模式匹配的数据处理 | +| [日期时间函数（Date & Time Functions）](./05-datetime-functions/index.md) | 时间数据分析的日期和时间操作 | +| [聚合函数（Aggregate Functions）](./07-aggregate-functions/index.md) | 对多行执行计算的函数 | +| [窗口函数（Window Functions）](./08-window-functions/index.md) | 对与当前行相关的行集进行操作的函数 | ## 数据类型函数 -- [Array Functions](./00-array-functions/index.md) - 处理和操作数组数据。 -- [Map Functions](./10-map-functions/index.md) - 处理和操作 Map 数据。 -- [String Functions](./06-string-functions/index.md) - 操作字符串并执行正则表达式操作。 -- [Numeric Functions](./04-numeric-functions/index.md) - 执行计算和数值运算。 -- [Date & Time Functions](./05-datetime-functions/index.md) - 操作和格式化日期和时间。 -- [Interval Functions](./05-interval-functions/index.md) - 处理时间间隔和持续时间。 -- [Semi-structured and Structured Data Functions](./10-semi-structured-functions/index.md) - 处理 JSON 和其他结构化数据格式。 +| 类别 | 描述 | +|----------|-------------| +| [转换函数（Conversion Functions）](./02-conversion-functions/index.md) | 不同数据类型间的类型转换和强制转换操作 | +| [数组函数（Array Functions）](./00-array-functions/index.md) | 创建和操作数组集合的函数 | +| [映射函数（Map Functions）](./10-map-functions/index.md) | 处理键值对集合的函数 | +| [半结构化函数（Semi-structured Functions）](./10-semi-structured-functions/index.md) | 处理 JSON 和其他半结构化数据的函数 | -## 分析函数 +## 逻辑和控制函数 -- [Aggregate Functions](./07-aggregate-functions/index.md) - 计算总和、平均值、计数等摘要。 -- [Window Functions](./08-window-functions/index.md) - 提供指定范围内行的聚合计算。 +| 类别 | 描述 | +|----------|-------------| +| [条件函数（Conditional Functions）](./03-conditional-functions/index.md) | 基于逻辑的数据转换和流程控制函数 | +| [间隔函数（Interval Functions）](./05-interval-functions/index.md) | 用于日期计算的时间间隔创建和操作 | -## AI 和 Vector 函数 +## 系统和元数据函数 -- [AI Functions](./11-ai-functions/index.md) - 利用 AI 和机器学习能力。 -- [Vector Distance Functions](./11-vector-distance-functions/index.md) - 计算向量之间的距离以进行相似性搜索。 +| 类别 | 描述 | +|----------|-------------| +| [表函数（Table Functions）](./17-table-functions/index.md) | 返回结果集作为表的函数 | +| [系统函数（System Functions）](./16-system-functions/index.md) | 访问系统信息和管理的函数 | +| [上下文函数（Context Functions）](./15-context-functions/index.md) | 访问会话和环境信息的函数 | -## 地理空间函数 +## 专业分析函数 -- [Geo Functions](./09-geo-functions/index.md) - 处理和操作地理空间数据。 -- [Geometry Functions](./09-geometry-functions/index.md) - 处理几何形状和计算。 +| 类别 | 描述 | +|----------|-------------| +| [地理函数（Geo Functions）](./09-geo-functions/index.md) | 地理坐标和 H3 地理空间操作 | +| [几何函数（Geometry Functions）](./09-geometry-functions/index.md) | 几何形状操作和空间计算 | +| [搜索函数（Search Functions）](./10-search-functions/index.md) | 全文搜索功能和文本相关性 | -## 数据处理函数 +## AI 和向量函数 -- [Conversion Functions](./02-conversion-functions/index.md) - 转换数据类型和强制转换值。 -- [Conditional Functions](./03-conditional-functions/index.md) - 实现条件逻辑和 case 语句。 -- [Bitmap Functions](./01-bitmap-functions/index.md) - 执行按位运算和操作。 -- [Full-Text Search Functions](./10-search-functions/index.md) - 利用倒排索引实现高效的数据检索。 +| 类别 | 描述 | +|----------|-------------| +| [AI 函数（AI Functions）](./11-ai-functions/index.md) | 自然语言处理和 AI 功能 | +| [向量距离函数（Vector Distance Functions）](./11-vector-distance-functions/index.md) | 向量相似性和距离计算 | -## 系统和实用函数 +## 数据完整性函数 -- [System Functions](./16-system-functions/index.md) - 访问系统级信息并执行控制操作。 -- [Table Functions](./17-table-functions/index.md) - 以表格格式返回结果。 -- [Context Functions](./15-context-functions/index.md) - 提供有关当前 SQL 执行上下文的信息。 -- [Hash Functions](./12-hash-functions/index.md) - 生成哈希值以用于数据安全和比较。 -- [UUID Functions](./13-uuid-functions/index.md) - 生成和操作 UUID。 -- [IP Address Functions](./14-ip-address-functions/index.md) - 操作和分析 IP 地址数据。 +| 类别 | 描述 | +|----------|-------------| +| [哈希函数（Hash Functions）](./12-hash-functions/index.md) | 数据哈希和指纹算法 | +| [UUID 函数（UUID Functions）](./13-uuid-functions/index.md) | 通用唯一标识符生成和处理 | +| [IP 地址函数（IP Address Functions）](./14-ip-address-functions/index.md) | IP 地址操作和转换 | +| [位图函数（Bitmap Functions）](./01-bitmap-functions/index.md) | 位级操作 | -## 其他专用函数 +## 实用函数 -- [Dictionary Functions](./19-dictionary-functions/index.md) - 处理字典数据结构。 -- [Sequence Functions](./18-sequence-functions/index.md) - 生成和操作序列。 -- [Other Miscellaneous Functions](./20-other-functions/index.md) - 各种其他函数的集合。 \ No newline at end of file +| 类别 | 描述 | +|----------|-------------| +| [序列函数（Sequence Functions）](./18-sequence-functions/index.md) | 序列生成和操作 | +| [字典函数（Dictionary Functions）](./19-dictionary-functions/index.md) | 外部数据源集成 | +| [测试函数（Test Functions）](./19-test-functions/index.md) | 用于测试和开发目的的函数 | \ No newline at end of file