Skip to content

Commit d60ae25

Browse files
sundy-lib41sh
andauthored
docs: add DESCRIBE NOTIFICATION INTEGRATION SQL reference (#3165)
* docs: add describe notification sql reference * update --------- Co-authored-by: baishen <baishen2009@gmail.com>
1 parent 69ee512 commit d60ae25

4 files changed

Lines changed: 70 additions & 2 deletions

File tree

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: DESCRIBE NOTIFICATION INTEGRATION
3+
sidebar_position: 4
4+
---
5+
6+
显示通知集成的属性信息。
7+
8+
:::note
9+
此命令需要启用 cloud control。
10+
:::
11+
12+
## 语法
13+
14+
```sql
15+
DESCRIBE NOTIFICATION INTEGRATION <name>
16+
```
17+
18+
`DESC NOTIFICATION INTEGRATION <name>` 也可以作为同义写法使用。
19+
20+
## 输出
21+
22+
结果会包含通知的创建时间、名称、标识、类型、启用状态、webhook 选项和备注信息。
23+
24+
## 示例
25+
26+
```sql
27+
DESCRIBE NOTIFICATION INTEGRATION SampleNotification;
28+
```

docs/cn/sql-reference/10-sql-commands/00-ddl/16-notification/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ title: 通知(Notification)
1212
| [ALTER NOTIFICATION](02-ddl-alter-notification.md) | 修改现有通知集成 |
1313
| [DROP NOTIFICATION](03-ddl-drop-notification.md) | 删除通知集成 |
1414

15+
## 通知信息
16+
17+
| 命令 | 描述 |
18+
|---------|-------------|
19+
| [DESCRIBE NOTIFICATION](04-desc-notification.md) | 显示通知集成的属性信息 |
20+
1521
:::note
1622
Databend Cloud 的通知功能支持配置电子邮件或 Slack 等外部服务集成,用于接收数据库事件及操作相关的告警。
17-
:::
23+
:::
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: DESCRIBE NOTIFICATION INTEGRATION
3+
sidebar_position: 4
4+
---
5+
6+
Shows the properties of a notification integration.
7+
8+
:::note
9+
This command requires cloud control to be enabled.
10+
:::
11+
12+
## Syntax
13+
14+
```sql
15+
DESCRIBE NOTIFICATION INTEGRATION <name>
16+
```
17+
18+
`DESC NOTIFICATION INTEGRATION <name>` is accepted as a synonym.
19+
20+
## Output
21+
22+
The result includes the notification's creation time, name, identifier, type, enabled state, webhook options, and comment.
23+
24+
## Example
25+
26+
```sql
27+
DESCRIBE NOTIFICATION INTEGRATION SampleNotification;
28+
```

docs/en/sql-reference/10-sql-commands/00-ddl/16-notification/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ This page provides a comprehensive overview of Notification operations in Databe
1212
| [ALTER NOTIFICATION](02-ddl-alter-notification.md) | Modifies an existing notification integration |
1313
| [DROP NOTIFICATION](03-ddl-drop-notification.md) | Removes a notification integration |
1414

15+
## Notification Information
16+
17+
| Command | Description |
18+
|---------|-------------|
19+
| [DESCRIBE NOTIFICATION](04-desc-notification.md) | Shows the properties of a notification integration |
20+
1521
:::note
1622
Notifications in Databend Cloud allow you to configure integrations with external services like email or Slack to receive alerts about database events and operations.
17-
:::
23+
:::

0 commit comments

Comments
 (0)