Skip to content

Commit e214c31

Browse files
luoyuxiapolyzos
luoyuxia
and
polyzos
authored
[hotfix] Fix incorrect description about bucket key in doc (#746)
* [hotfix] Fix incorrent * [hotfix] Fix incorrect description about bucket key * add some minor improvements --------- Co-authored-by: ipolyzos <[email protected]>
1 parent 77d07b1 commit e214c31

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,10 @@ public class FlinkConnectorOptions {
4444
.noDefaultValue()
4545
.withDescription(
4646
"Specific the distribution policy of the Fluss table. "
47-
+ "Data will be distributed to each bucket according to the hash value of bucket-key. "
47+
+ "Data will be distributed to each bucket according to the hash value of bucket-key (It must be a subset of the primary keys excluding partition keys of the primary key table). "
4848
+ "If you specify multiple fields, delimiter is ','. "
49-
+ "If the table is with primary key, you can't specific bucket key currently. "
50-
+ "The bucket keys will always be the primary key. "
51-
+ "If the table is not with primary key, you can specific bucket key, and when the bucket key is not specified, "
49+
+ "If the table has a primary key and a bucket key is not specified, the bucket key will be used as primary key(excluding the partition key). "
50+
+ "If the table has no primary key and the bucket key is not specified, "
5251
+ "the data will be distributed to each bucket randomly.");
5352

5453
public static final ConfigOption<String> BOOTSTRAP_SERVERS =

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ ALTER TABLE log_table SET ('table.log.ttl' = '7d');
7979
| Option | Type | Default | Description |
8080
|-----------------------------------------|----------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
8181
| bucket.num | int | The bucket number of Fluss cluster. | The number of buckets of a Fluss table. |
82-
| bucket.key | String | (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. |
82+
| bucket.key | String | (none) | Specific the distribution policy of the Fluss table. Data will be distributed to each bucket according to the hash value of bucket-key (It must be a subset of the primary keys excluding partition keys of the primary key table). If you specify multiple fields, delimiter is ','. If the table has a primary key and a bucket key is not specified, the bucket key will be used as primary key(excluding the partition key). If the table has no primary key and the bucket key is not specified, the data will be distributed to each bucket randomly. |
8383
| table.log.ttl | Duration | 7 days | The time to live for log segments. The configuration controls the maximum time we will retain a log before we will delete old segments to free up space. If set to -1, the log will not be deleted. |
8484
| table.auto-partition.enabled | Boolean | false | Whether enable auto partition for the table. Disable by default. When auto partition is enabled, the partitions of the table will be created automatically. |
8585
| table.auto-partition.time-unit | ENUM | DAY | The time granularity for auto created partitions. The default value is 'DAY'. Valid values are 'HOUR', 'DAY', 'MONTH', 'QUARTER', 'YEAR'. If the value is 'HOUR', the partition format for auto created is yyyyMMddHH. If the value is 'DAY', the partition format for auto created is yyyyMMdd. If the value is 'MONTH', the partition format for auto created is yyyyMM. If the value is 'QUARTER', the partition format for auto created is yyyyQ. If the value is 'YEAR', the partition format for auto created is yyyy. |

‎website/docs/table-design/table-types/pk-table/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ partition key.
5151

5252
## Bucket Assigning
5353

54-
For primary key tables, Fluss always determines which bucket the data belongs to based on the hash value of the primary
55-
key for each record.
54+
For primary key tables, Fluss always determines which bucket the data belongs to based on the hash value of the bucket
55+
key (It must be a subset of the primary keys excluding partition keys of the primary key table) for each record. If the bucket key is not specified, the bucket key will used as the primary key (excluding the partition key).
5656
Data with the same hash value will be distributed to the same bucket.
5757

5858
## Partial Update

0 commit comments

Comments
 (0)