Skip to content

Commit 2c8b6ad

Browse files
wuchongwuchong
authored
[docs] Add "Connector Options" page in "Engine Flink" (#520)
1 parent 737c2c6 commit 2c8b6ad

File tree

6 files changed

+168
-143
lines changed

6 files changed

+168
-143
lines changed

‎fluss-connectors/fluss-connector-flink/src/main/java/com/alibaba/fluss/connector/flink/FlinkConnectorOptions.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public class FlinkConnectorOptions {
9696
.durationType()
9797
.defaultValue(Duration.ofSeconds(10))
9898
.withDescription(
99-
"The interval in milliseconds for the Fluss source to discover "
99+
"The time interval for the Fluss source to discover "
100100
+ "the new partitions for partitioned table while scanning."
101101
+ " A non-positive value disables the partition discovery.");
102102

‎website/docs/engine-flink/ddl.md‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -161,14 +161,7 @@ For more details about Auto Partitioned (PrimaryKey/Log) Table, refer to [Auto P
161161

162162
### Options
163163

164-
The supported option in "with" parameters when creating a table are as follows:
165-
166-
| Option | Type | Required | Default | Description |
167-
|------------------------------------|----------|----------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
168-
| bucket.num | int | optional | The bucket number of Fluss cluster. | The number of buckets of a Fluss table. |
169-
| bucket.key | String | optional | (none) | Specific the distribution policy of the Fluss table. Data will be distributed to each bucket according to the hash value of bucket-key. If you specify multiple fields, delimiter is ','. If the table is with primary key, you can't specific bucket key currently. The bucket keys will always be the primary key(excluding partition key). If the table is not with primary key, you can specific bucket key, and when the bucket key is not specified, the data will be distributed to each bucket randomly. |
170-
| table.* | | | | All the [`table.` prefix configuration](maintenance/configuration.md) are supported to be defined in "with" options. |
171-
| client.* | | | | All the [`client.` prefix configuration](maintenance/configuration.md) are supported to be defined in "with" options. |
164+
The supported option in `WITH` parameters when creating a table are listed in [Connector Options](engine-flink/options.md) page.
172165

173166
## Create Table Like
174167

‎website/docs/engine-flink/lookups.md‎

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -124,19 +124,6 @@ ON `o`.`o_custkey` = `c`.`c_custkey` AND `o`.`o_dt` = `c`.`dt`;
124124

125125
For more details about Fluss partitioned table, see [Partitioned Tables](table-design/data-distribution/partitioning.md).
126126

127-
### Lookup Options
128-
129-
130-
| Option | Type | Required | Default | Description |
131-
|-------------------------------------------------|----------|----------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
132-
| lookup.cache | Enum | optional | NONE | The caching strategy for this lookup table, including NONE, PARTIAL. |
133-
| lookup.max-retries | Integer | optional | 3 | The maximum allowed retries if a lookup operation fails. |
134-
| lookup.partial-cache.expire-after-access | Duration | optional | (none) | Duration to expire an entry in the cache after accessing. |
135-
| lookup.partial-cache.expire-after-write | Duration | optional | (none) | Duration to expire an entry in the cache after writing. |
136-
| lookup.partial-cache.cache-missing-key | Boolean | optional | true | Whether to store an empty value into the cache if the lookup key doesn't match any rows in the table. |
137-
| lookup.partial-cache.max-rows | Long | optional | true | The maximum number of rows to store in the cache. |
138-
139-
140127
## Prefix Lookup
141128

142129
### Instructions
@@ -266,4 +253,8 @@ ON `o`.`o_custkey` = `c`.`c_custkey` AND `o`.`o_dt` = `c`.`dt`;
266253
-- join key is a prefix set of dimension table primary keys (excluding partition key) + partition key.
267254
```
268255

269-
For more details about Fluss partitioned table, see [Partitioned Tables](table-design/data-distribution/partitioning.md).
256+
For more details about Fluss partitioned table, see [Partitioned Tables](table-design/data-distribution/partitioning.md).
257+
258+
## Lookup Options
259+
260+
Fluss lookup join supports various configuration options. For more details, please refer to the [Connector Options](engine-flink/options.md#lookup-options) page.

0 commit comments

Comments
 (0)