Skip to content

[docs] Fix three configuration keys that do not match the code - #4917

Open
Jackeyzhe wants to merge 1 commit into
apache:mainfrom
Jackeyzhe:docs-fix-config-option-keys
Open

Jackeyzhe wants to merge 1 commit into
apache:mainfrom
Jackeyzhe:docs-fix-config-option-keys

Conversation

@Jackeyzhe

Copy link
Copy Markdown
Contributor

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 as table.auto-increment.cache-size. The description text is otherwise identical, and table-design/table-types/pk-table.md already refers to the option by its current name. Because the key starts with table., creating a table with the documented name is rejected by TableDescriptorValidation as 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.md use a hyphen where the code uses a dot:

  • kv.snapshot.lease-expiration-check-interval → kv.snapshot.lease.expiration-check-interval
  • kv.rocksdb.shared-rate-limiter-bytes-per-sec → kv.rocksdb.shared-rate-limiter.bytes-per-sec

Neither resolves to an option, so a value written to server.yaml under these names is ignored. For the rate limiter this is easy to miss, since the same entry is described as dynamically updatable and engine-flink/procedures.md spells the dotted name.

Brief change log

  • website/docs/engine-flink/options.md: rename table.auto-inc.batch-size to table.auto-increment.cache-size, and write the default as 100000 instead of 100000L, like the other Long rows 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_VALUE

API and Format

None.

Documentation

Corrects three configuration keys that do not resolve to any option in ConfigOptions.

@pbanakar pbanakar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing these stale configuration keys

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants