Skip to content

[DOC-1258][DOC-1306] Addedflush_vector_index command and fixed description for backfill_index_timeout_grace_margin_ms#31525

Open
aishwarya24 wants to merge 2 commits into
yugabyte:masterfrom
aishwarya24:doc-1258
Open

[DOC-1258][DOC-1306] Addedflush_vector_index command and fixed description for backfill_index_timeout_grace_margin_ms#31525
aishwarya24 wants to merge 2 commits into
yugabyte:masterfrom
aishwarya24:doc-1258

Conversation

@aishwarya24
Copy link
Copy Markdown
Collaborator

No description provided.

@aishwarya24 aishwarya24 self-assigned this May 8, 2026
@github-project-automation github-project-automation Bot moved this to In progress in Documentation May 8, 2026
@aishwarya24 aishwarya24 added the area/documentation Documentation needed label May 8, 2026
@aishwarya24 aishwarya24 changed the title [DOC-1258][DOC-1306] Added the flush_vector_index command and fixed description for backfill_index_timeout_grace_margin_ms [DOC-1258][DOC-1306] Addedflush_vector_index command and fixed description for backfill_index_timeout_grace_margin_ms May 8, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented May 8, 2026

Deploy Preview for infallible-bardeen-164bc9 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2254289
🔍 Latest deploy log https://app.netlify.com/projects/infallible-bardeen-164bc9/deploys/69fe22f57f6d5b000887dd31
😎 Deploy Preview https://deploy-preview-31525--infallible-bardeen-164bc9.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation for the flush_vector_index command in yb-ts-cli and updates the backfill_index_timeout_grace_margin_ms flag description to clarify its automatic calculation baselines for YSQL and YCQL across several versions. Reviewer feedback suggests improving consistency across documentation versions by adding "(default)" labels and using backticks for flag names and values.

Comment thread docs/content/v2.20/api/ysql/the-sql-language/statements/ddl_create_index.md Outdated
The time to exclude from the YB-Master flag [ysql_index_backfill_rpc_timeout_ms](../yb-master/#ysql-index-backfill-rpc-timeout-ms) in order to return results to YB-Master in the specified deadline. Should be set to at least the amount of time each batch would require, and less than `ysql_index_backfill_rpc_timeout_ms`.

Default: -1, where the system automatically calculates the value to be approximately 1 second.
Default: -1, where the system automatically calculates the margin. For YSQL index backfill the baseline is 3 minutes (180000 ms); for YCQL the baseline is approximately 1 second (1000 ms). The effective margin is the greater of that baseline and a value derived from backfill_index_write_batch_size and backfill_index_rate_rows_per_sec.
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.

medium

For consistency with the stable version and better readability, please wrap -1 and the flag names in backticks.

Suggested change
Default: -1, where the system automatically calculates the margin. For YSQL index backfill the baseline is 3 minutes (180000 ms); for YCQL the baseline is approximately 1 second (1000 ms). The effective margin is the greater of that baseline and a value derived from backfill_index_write_batch_size and backfill_index_rate_rows_per_sec.
Default: `-1`, where the system automatically calculates the margin. For YSQL index backfill the baseline is 3 minutes (180000 ms); for YCQL the baseline is approximately 1 second (1000 ms). The effective margin is the greater of that baseline and a value derived from `backfill_index_write_batch_size` and `backfill_index_rate_rows_per_sec`.

Comment thread docs/content/v2024.2/api/ysql/the-sql-language/statements/ddl_create_index.md Outdated
The time to exclude from the YB-Master flag [ysql_index_backfill_rpc_timeout_ms](../yb-master/#ysql-index-backfill-rpc-timeout-ms) in order to return results to YB-Master in the specified deadline. Should be set to at least the amount of time each batch would require, and less than `ysql_index_backfill_rpc_timeout_ms`.

Default: -1, where the system automatically calculates the value to be approximately 1 second.
Default: -1, where the system automatically calculates the margin. For YSQL index backfill the baseline is 3 minutes (180000 ms); for YCQL the baseline is approximately 1 second (1000 ms). The effective margin is the greater of that baseline and a value derived from backfill_index_write_batch_size and backfill_index_rate_rows_per_sec.
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.

medium

For consistency with the stable version and better readability, please wrap -1 and the flag names in backticks.

Suggested change
Default: -1, where the system automatically calculates the margin. For YSQL index backfill the baseline is 3 minutes (180000 ms); for YCQL the baseline is approximately 1 second (1000 ms). The effective margin is the greater of that baseline and a value derived from backfill_index_write_batch_size and backfill_index_rate_rows_per_sec.
Default: `-1`, where the system automatically calculates the margin. For YSQL index backfill the baseline is 3 minutes (180000 ms); for YCQL the baseline is approximately 1 second (1000 ms). The effective margin is the greater of that baseline and a value derived from `backfill_index_write_batch_size` and `backfill_index_rate_rows_per_sec`.

Comment thread docs/content/v2025.1/api/ysql/the-sql-language/statements/ddl_create_index.md Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@aishwarya24 aishwarya24 requested review from arybochkin and ddhodge May 8, 2026 17:53
Copy link
Copy Markdown
Contributor

@ddhodge ddhodge left a comment

Choose a reason for hiding this comment

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

LGTM

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

Labels

area/documentation Documentation needed

Projects

Status: In progress

Development

Successfully merging this pull request may close these issues.

2 participants