Skip to content

[hotfix] Fix incorrect description about bucket key in doc #746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
polyzos merged 3 commits into from
Apr 15, 2025
Merged

[hotfix] Fix incorrect description about bucket key in doc #746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5767c92
[hotfix] Fix incorrent
luoyuxia Apr 3, 2025
27d2309
[hotfix] Fix incorrect description about bucket key
luoyuxia Apr 15, 2025
f9a7c73
add some minor improvements
polyzos Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions ...flink/fluss-flink-common/src/main/java/com/alibaba/fluss/flink/FlinkConnectorOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,10 @@ public class FlinkConnectorOptions {
.noDefaultValue()
.withDescription(
"Specific the distribution policy of the Fluss table. "
+ "Data will be distributed to each bucket according to the hash value of bucket-key. "
+ "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 is with primary key, you can't specific bucket key currently. "
+ "The bucket keys will always be the primary key. "
+ "If the table is not with primary key, you can specific bucket key, and when the bucket key is not specified, "
+ "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.");

public static final ConfigOption<String> BOOTSTRAP_SERVERS =
Expand Down
2 changes: 1 addition & 1 deletion website/docs/engine-flink/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ ALTER TABLE log_table SET ('table.log.ttl' = '7d');
| Option | Type | Default | Description |
|-----------------------------------------|----------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| bucket.num | int | The bucket number of Fluss cluster. | The number of buckets of a Fluss table. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
Expand Down
4 changes: 2 additions & 2 deletions website/docs/table-design/table-types/pk-table/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ partition key.

## Bucket Assigning

For primary key tables, Fluss always determines which bucket the data belongs to based on the hash value of the primary
key for each record.
For primary key tables, Fluss always determines which bucket the data belongs to based on the hash value of the bucket
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).
Data with the same hash value will be distributed to the same bucket.

## Partial Update
Expand Down