Skip to content

Commit

Permalink
[Docs][Connector-V2][Feishu]Refactor connector-v2 docs using unified …
Browse files Browse the repository at this point in the history
…format Feishu (#5343)
  • Loading branch information
ruanwenjun committed Aug 21, 2023
1 parent 0cdd306 commit 794207c
Showing 1 changed file with 40 additions and 26 deletions.
66 changes: 40 additions & 26 deletions docs/en/connector-v2/sink/Feishu.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,55 @@

> Feishu sink connector
## Description

Used to launch Feishu web hooks using data.

> For example, if the data from upstream is [`age: 12, name: tyrantlucifer`], the body content is the following: `{"age": 12, "name": "tyrantlucifer"}`
## Support Those Engines

**Tips: Feishu sink only support `post json` webhook and the data from source will be treated as body content in web hook.**
> Spark<br/>
> Flink<br/>
> SeaTunnel Zeta<br/>
## Key features
## Key Features

- [ ] [exactly-once](../../concept/connector-v2-features.md)
- [ ] [cdc](../../concept/connector-v2-features.md)

## Options

| name | type | required | default value |
|----------------|--------|----------|---------------|
| url | String | Yes | - |
| headers | Map | No | - |
| common-options | | no | - |

### url [string]

Feishu webhook url

### headers [Map]

Http request headers
## Description

### common options
Used to launch Feishu web hooks using data.

Sink plugin common parameters, please refer to [Sink Common Options](common-options.md) for details
> For example, if the data from upstream is [`age: 12, name: tyrantlucifer`], the body content is the following: `{"age": 12, "name": "tyrantlucifer"}`
## Example
**Tips: Feishu sink only support `post json` webhook and the data from source will be treated as body content in web hook.**

simple:
## Data Type Mapping

| Seatunnel Data type | Feishu Data type |
|-----------------------------|------------------|
| ROW<br/>MAP | Json |
| NULL | null |
| BOOLEAN | boolean |
| TINYINT | byte |
| SMALLINT | short |
| INT | int |
| BIGINT | long |
| FLOAT | float |
| DOUBLE | double |
| DECIMAL | BigDecimal |
| BYTES | byte[] |
| STRING | String |
| TIME<br/>TIMESTAMP<br/>TIME | String |
| ARRAY | JsonArray |

## Sink Options

| Name | Type | Required | Default | Description |
|----------------|--------|----------|---------|-----------------------------------------------------------------------------------------------------|
| url | String | Yes | - | Feishu webhook url |
| headers | Map | No | - | Http request headers |
| common-options | | no | - | Sink plugin common parameters, please refer to [Sink Common Options](common-options.md) for details |

## Task Example

### Simple:

```hocon
Feishu {
Expand Down

0 comments on commit 794207c

Please sign in to comment.