Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 21, 2025

Updates the documentation for InfluxDB 3 table index cache configuration options to match the actual CLI help text and fixes a broken link in the Enterprise CLI documentation.

Configuration Changes

table-index-cache-max-entries

  • Fixed default value: Changed from 1000 to 100 to match CLI help text
  • Enhanced description: Now explains that this setting "specifies the maximum number of table indices to cache in memory" and "helps manage older snapshot/parquet files for retention purposes and improves database startup performance for longer-running databases"
  • Added important usage note: Documents that setting to 0 enables unlimited cache size

table-index-cache-concurrency-limit

  • Fixed default value: Changed from 8 to 20 to match CLI help text
  • Enhanced description: Now explains that this setting "limits the maximum number of concurrent operations between the table index cache and object store" and "controls how many parallel requests can be made to object storage when loading or updating table indices"

Link Checker Fix

Fixed a broken link where the Enterprise CLI documentation incorrectly referenced --buffer-mem-limit-mb with a link to the Enterprise config options page. The buffer-mem-limit-mb option is only available in InfluxDB 3 Core (properly scoped with {{% show-in "core" %}} shortcodes), so the fragment #buffer-mem-limit-mb doesn't exist on the Enterprise config options page.

Fixed: Removed --buffer-mem-limit-mb from /influxdb3/enterprise/reference/cli/influxdb3/serve.md while keeping it in the Core CLI documentation where it belongs.

These configuration options are "behind the scenes" settings that help manage database performance, particularly for retention purposes and database startup optimization with longer-running databases.

Fixes #6301.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@jstirnaman
Copy link
Contributor

@copilot Add documentation for the flag in content/influxdb3/{enterprise,core}/reference/.

@Copilot Copilot AI changed the title [WIP] Add details for --table-index-cache-max-entries Update InfluxDB 3 table index cache configuration documentation Aug 21, 2025
@Copilot Copilot AI requested a review from jstirnaman August 21, 2025 14:39
Copilot finished work on behalf of jstirnaman August 21, 2025 14:39
Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@copilot Add documentation for the flag in content/influxdb3/{enterprise,core}/reference/.

The documentation for the table-index-cache flags is already available in both content/influxdb3/enterprise/reference/config-options.md and content/influxdb3/core/reference/config-options.md. Both files use source: /shared/influxdb3-cli/config-options.md, so they automatically include the updated table-index-cache documentation from commit 34713b3.

The updated documentation appears in both enterprise and core with the corrected default values (100 and 20) and enhanced descriptions explaining their purpose for managing snapshot/parquet files and database startup performance.

Copilot finished work on behalf of jstirnaman August 21, 2025 14:48
jstirnaman

This comment was marked as duplicate.

@jstirnaman
Copy link
Contributor

@copilot The link-check check fails:

Error: Broken link: file:///home/runner/work/docs-v2/docs-v2/public/influxdb3/enterprise/reference/config-options/index.html#buffer-mem-limit-mb - Cannot find fragment

That link should only show in Core, not Enterprise.

@jstirnaman
Copy link
Contributor

@copilot Preview in the browser to verify the TOC is correct and indentation is preserved

Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@copilot The link-check check fails:

Error: Broken link: file:///home/runner/work/docs-v2/docs-v2/public/influxdb3/enterprise/reference/config-options/index.html#buffer-mem-limit-mb - Cannot fin...

Fixed the broken link issue in commit 309e26c. The problem was that the Enterprise CLI documentation (/influxdb3/enterprise/reference/cli/influxdb3/serve.md) incorrectly included a reference to --buffer-mem-limit-mb with a link to the Enterprise config options page. However, the buffer-mem-limit-mb section is only available in Core (wrapped in {{% show-in "core" %}} shortcodes), so the fragment #buffer-mem-limit-mb doesn't exist on the Enterprise config options page.

The fix removes the --buffer-mem-limit-mb entry from the Enterprise CLI documentation while keeping it in the Core CLI documentation where it belongs.

@Copilot Copilot AI changed the title Update InfluxDB 3 table index cache configuration documentation Update InfluxDB 3 table index cache documentation and fix Enterprise CLI broken link Aug 21, 2025
@Copilot Copilot AI requested a review from jstirnaman August 21, 2025 17:32
Copilot finished work on behalf of jstirnaman August 21, 2025 17:32
Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@copilot Preview in the browser to verify the TOC is correct and indentation is preserved

Verified in the browser! The TOC is correct and indentation is preserved. Both table-index-cache options are properly nested under the "Caching" section with:

✅ Correct default values (100 and 20)
✅ Enhanced descriptions explaining their purpose
✅ Proper table formatting and indentation

Table index cache documentation verification

Copilot finished work on behalf of jstirnaman August 21, 2025 17:38
@jstirnaman
Copy link
Contributor

@copilot Preview in the browser to verify the TOC is correct and indentation is preserved

Verified in the browser! The TOC is correct and indentation is preserved. Both table-index-cache options are properly nested under the "Caching" section with:

✅ Correct default values (100 and 20) ✅ Enhanced descriptions explaining their purpose ✅ Proper table formatting and indentation

Table index cache documentation verification

Help improve Copilot by leaving feedback using the 👍 or 👎 buttons

@copilot The screenshot doesn't capture the TOC links at the top of the page.

Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@copilot Preview in the browser to verify the TOC is correct and indentation is preserved

Verified in the browser! The TOC is correct and indentation is preserved. Both table-index-cache op...

Here's the complete table of contents showing the table-index-cache options properly nested under the "Caching" section:

Full page TOC with table-index-cache options

The TOC correctly shows both:

  • table-index-cache-max-entries
  • table-index-cache-concurrency-limit

Both are properly nested under the "Caching" section with the correct indentation and structure.

Copilot finished work on behalf of jstirnaman August 21, 2025 18:57
@jstirnaman
Copy link
Contributor

@copilot Preview in the browser to verify the TOC is correct and indentation is preserved

Verified in the browser! The TOC is correct and indentation is preserved. Both table-index-cache op...

Here's the complete table of contents showing the table-index-cache options properly nested under the "Caching" section:

Full page TOC with table-index-cache options

The TOC correctly shows both:

  • table-index-cache-max-entries
  • table-index-cache-concurrency-limit

Both are properly nested under the "Caching" section with the correct indentation and structure.

Help improve Copilot by leaving feedback using the 👍 or 👎 buttons

@copilot "TOC" (table of contents) are the anchor elements at the top of the page that link to link fragments (for section headings) inside the page--for example:

<li><a href="#buffer-mem-limit-mb">--buffer-mem-limit-mb</a></li>

Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@copilot Preview in the browser to verify the TOC is correct and indentation is preserved

...

You're absolutely right! Here's the table of contents showing the table-index-cache options properly nested under the "Caching" section:

Complete TOC with table-index-cache options

The TOC correctly shows both:

  • table-index-cache-max-entries
  • table-index-cache-concurrency-limit

Both are properly nested under the "Caching" section with the correct indentation and anchor links working as expected.

Copilot finished work on behalf of jstirnaman August 21, 2025 19:11
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.

Add details for --table-index-cache-max-entries
2 participants