Repository navigation
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Linked issue: Not required; this is a documentation correctness fix.
The configuration reference documents three keys that do not exist in
ConfigOptions, so following the docs does not configure what the description says.table.auto-inc.batch-size(engine-flink/options.md) is the previous name of the option now declared astable.auto-increment.cache-size. The description text is otherwise identical, andtable-design/table-types/pk-table.mdalready refers to the option by its current name. Because the key starts withtable., creating a table with the documented name is rejected byTableDescriptorValidationas an unrecognized table property, with a message that points at the cluster version rather than at the key.The two server keys in
maintenance/configuration.mduse a hyphen where the code uses a dot:kv.snapshot.lease-expiration-check-interval→kv.snapshot.lease.expiration-check-intervalkv.rocksdb.shared-rate-limiter-bytes-per-sec→kv.rocksdb.shared-rate-limiter.bytes-per-secNeither resolves to an option, so a value written to
server.yamlunder these names is ignored. For the rate limiter this is easy to miss, since the same entry is described as dynamically updatable andengine-flink/procedures.mdspells the dotted name.Brief change log
website/docs/engine-flink/options.md: renametable.auto-inc.batch-sizetotable.auto-increment.cache-size, and write the default as100000instead of100000L, like the otherLongrows in the same table.website/docs/maintenance/configuration.md: use the dotted key names for the snapshot lease check interval and the shared rate limiter.Tests
Documentation only. Each new key was checked against its declaration:
table.auto-increment.cache-size—ConfigOptions.java:2292,defaultValue(100000L)kv.snapshot.lease.expiration-check-interval—ConfigOptions.java:2458,durationType(),Duration.ofMinutes(10)kv.rocksdb.shared-rate-limiter.bytes-per-sec—ConfigOptions.java:2556,memoryType(),Long.MAX_VALUEAPI and Format
None.
Documentation
Corrects three configuration keys that do not resolve to any option in
ConfigOptions.