diff --git a/docs/content/stable/admin/yb-admin.md b/docs/content/stable/admin/yb-admin.md index 7a1fc545c98a..c05d04989439 100644 --- a/docs/content/stable/admin/yb-admin.md +++ b/docs/content/stable/admin/yb-admin.md @@ -447,7 +447,7 @@ Triggers manual compaction on a table. ```sh yb-admin \ --master_addresses \ - compact_table . [] [ADD_INDEXES] + compact_table .
[] [ADD_INDEXES] [ADD_VECTOR_INDEXES] ``` * *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`. @@ -455,7 +455,8 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to compact. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default is `20`. -* ADD_INDEXES: Whether to compact the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to compact the secondary indexes associated with the table. YCQL only. +* ADD_VECTOR_INDEXES: Indicates to compact the [vector indexes](../../additional-features/pg-extensions/extension-pgvector/#vector-indexing) (pgvector) associated with the table. **Example** @@ -474,13 +475,14 @@ Compacted [yugabyte.table_name] tables. ```sh yb-admin \ --master_addresses \ - compact_table tableid. [] [ADD_INDEXES] + compact_table tableid. [] [ADD_INDEXES] [ADD_VECTOR_INDEXES] ``` * *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`. * *table-id*: The unique UUID associated with the table. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default is `20`. -* ADD_INDEXES: Whether to compact the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to compact the secondary indexes associated with the table. YCQL only. +* ADD_VECTOR_INDEXES: Indicates to compact the [vector indexes](../../additional-features/pg-extensions/extension-pgvector/#vector-indexing) (pgvector) associated with the table. **Example** @@ -494,6 +496,36 @@ yb-admin \ Compacted [000033eb000030008000000000004002] tables. ``` +#### compact_table_by_id + +Triggers manual compaction on a table by table ID (without resolving namespace and table name). + +**Syntax** + +```sh +yb-admin \ + --master_addresses \ + compact_table_by_id [] [ADD_INDEXES] [ADD_VECTOR_INDEXES] +``` + +* *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`. +* *table-id*: The unique UUID associated with the table. +* *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default is `20`. +* ADD_INDEXES: Indicates to compact the secondary indexes associated with the table. YCQL only. +* ADD_VECTOR_INDEXES: Indicates to compact the [vector indexes](/stable/additional-features/pg-extensions/extension-pgvector/) (pgvector) associated with the table. + +**Example** + +```sh +./bin/yb-admin \ + --master_addresses $MASTER_RPC_ADDRS \ + compact_table_by_id 000033eb000030008000000000004002 ADD_VECTOR_INDEXES +``` + +```output +Compacted [000033eb000030008000000000004002] tables. +``` + #### compaction_status Show the status of full compaction on a table. @@ -690,7 +722,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to flush. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default is `20`. -* ADD_INDEXES: Whether to flush the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to flush the secondary indexes associated with the table. **Example** @@ -716,7 +748,7 @@ yb-admin \ * *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`. * *table-id*: The unique UUID associated with the table. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default is `20`. -* ADD_INDEXES: Whether to flush the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to flush the secondary indexes associated with the table. **Example** diff --git a/docs/content/stable/admin/yb-ts-cli.md b/docs/content/stable/admin/yb-ts-cli.md index 7f98ca805c97..c9273bb7cd3f 100644 --- a/docs/content/stable/admin/yb-ts-cli.md +++ b/docs/content/stable/admin/yb-ts-cli.md @@ -91,11 +91,25 @@ Compact the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] compact_tablet +yb-ts-cli [ --server_address=: ] compact_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to compact. + +### compact_vector_index + +Trigger compaction of [vector indexes](../../additional-features/pg-extensions/extension-pgvector/#vector-indexing) (pgvector) on a specific tablet. Use this for tablet-level vector index compaction when you need to compact only vector indexes on a given tablet (for example, after bulk loads or for maintenance). + +**Syntax** + +```sh +yb-ts-cli [ --server_address=: ] compact_vector_index [ ...] +``` + +* *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. +* *tablet-id*: The identifier of the tablet that contains the vector index(es). +* *vector-index-id1*, *vector-index-id2*, ...: Optional. Table IDs of specific vector indexes to compact. If omitted, all vector indexes on the tablet are compacted. ### count_intents @@ -123,30 +137,30 @@ yb-ts-cli [ --server_address=: ] current_hybrid_time ### delete_tablet -Deletes the tablet with the specified tablet ID (`tablet_id`) and reason. +Deletes the tablet with the specified tablet ID (`tablet-id`) and reason. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] delete_tablet "" +yb-ts-cli [ --server_address=: ] delete_tablet "" ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. * *reason-string*: Text string providing information on why the tablet was deleted. ### dump_tablet -Dump, or export, the specified tablet ID (`tablet_id`). +Dump, or export, the specified tablet ID (`tablet-id`). **Syntax** ```sh -yb-ts-cli [ --server_address=: ] dump_tablet +yb-ts-cli [ --server_address=: ] dump_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. ### flush_all_tablets @@ -167,11 +181,11 @@ Flush the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] flush_tablet +yb-ts-cli [ --server_address=: ] flush_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to flush. ### list_tablets @@ -204,12 +218,12 @@ Trigger a remote bootstrap of a tablet from another tablet server to the specifi **Syntax** ```sh -yb-ts-cli [ --server_address=: ] remote_bootstrap +yb-ts-cli [ --server_address=: ] remote_bootstrap ``` * *host*:*port*: The *host* and *port* of the tablet server running the remote bootstrap. Default is `localhost:9100`. -* *source_host*: The *host* or *host* and *port* of the tablet server to bootstrap from. -* *tablet_id*: The identifier of the tablet to trigger a remote bootstrap for. +* *source-host*: The *host* or *host* and *port* of the tablet server to bootstrap from. +* *tablet-id*: The identifier of the tablet to trigger a remote bootstrap for. See [Manual remote bootstrap of failed peer](/stable/troubleshoot/cluster/replace_failed_peers/) for example usage. diff --git a/docs/content/v2.20/admin/yb-admin.md b/docs/content/v2.20/admin/yb-admin.md index bba475dd123c..fd6e8cbcdcdf 100644 --- a/docs/content/v2.20/admin/yb-admin.md +++ b/docs/content/v2.20/admin/yb-admin.md @@ -453,7 +453,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to compact. * *timeout_in_seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default value is `20`. -* *ADD_INDEXES*: Whether to compact the secondary indexes associated with the table. Default is `false`. +* *ADD_INDEXES*: Indicates to compact the secondary indexes associated with the table. **Example** @@ -478,7 +478,7 @@ yb-admin \ * *master_addresses*: Comma-separated list of YB-Master hosts and ports. Default value is `localhost:7100`. * *table_id*: The unique UUID associated with the table. * *timeout_in_seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default value is `20`. -* *ADD_INDEXES*: Whether to compact the secondary indexes associated with the table. Default is `false`. +* *ADD_INDEXES*: Indicates to compact the secondary indexes associated with the table. **Example** @@ -688,7 +688,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to flush. * *timeout_in_seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default value is `20`. -* *ADD_INDEXES*: Whether to flush the secondary indexes associated with the table. Default is `false`. +* *ADD_INDEXES*: Indicates to flush the secondary indexes associated with the table. **Example** @@ -714,7 +714,7 @@ yb-admin \ * *master_addresses*: Comma-separated list of YB-Master hosts and ports. Default value is `localhost:7100`. * *table_id*: The unique UUID associated with the table. * *timeout_in_seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default value is `20`. -* *ADD_INDEXES*: Whether to flush the secondary indexes associated with the table. Default is `false`. +* *ADD_INDEXES*: Indicates to flush the secondary indexes associated with the table. **Example** diff --git a/docs/content/v2.20/admin/yb-ts-cli.md b/docs/content/v2.20/admin/yb-ts-cli.md index f0f17956ebf8..64f68939115b 100644 --- a/docs/content/v2.20/admin/yb-ts-cli.md +++ b/docs/content/v2.20/admin/yb-ts-cli.md @@ -98,11 +98,11 @@ Compact the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] compact_tablet +yb-ts-cli [ --server_address=: ] compact_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to compact. ##### count_intents @@ -130,30 +130,30 @@ yb-ts-cli [ --server_address=: ] current_hybrid_time ##### delete_tablet -Deletes the tablet with the specified tablet ID (`tablet_id`) and reason. +Deletes the tablet with the specified tablet ID (`tablet-id`) and reason. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] delete_tablet "" +yb-ts-cli [ --server_address=: ] delete_tablet "" ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. * *reason-string*: Text string providing useful information on why the tablet was deleted. ##### dump_tablet -Dump, or export, the specified tablet ID (`tablet_id`). +Dump, or export, the specified tablet ID (`tablet-id`). **Syntax** ```sh -yb-ts-cli [ --server_address=: ] dump_tablet +yb-ts-cli [ --server_address=: ] dump_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. ##### flush_all_tablets @@ -174,11 +174,11 @@ Flush the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] flush_tablet +yb-ts-cli [ --server_address=: ] flush_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to flush. ##### list_tablets @@ -211,12 +211,12 @@ Trigger a remote bootstrap of a tablet from another tablet server to the specifi **Syntax** ```sh -yb-ts-cli [ --server_address=: ] remote_bootstrap +yb-ts-cli [ --server_address=: ] remote_bootstrap ``` * *host*:*port*: The *host* and *port* of the tablet server running the remote bootstrap. Default is `localhost:9100`. -* *source_host*: The *host* or *host* and *port* of the tablet server to bootstrap from. -* *tablet_id*: The identifier of the tablet to trigger a remote bootstrap for. +* *source-host*: The *host* or *host* and *port* of the tablet server to bootstrap from. +* *tablet-id*: The identifier of the tablet to trigger a remote bootstrap for. See [Manual remote bootstrap of failed peer](/stable/troubleshoot/cluster/replace_failed_peers/) for example usage. diff --git a/docs/content/v2024.1/admin/yb-admin.md b/docs/content/v2024.1/admin/yb-admin.md index 31a51a494097..50a5a4eec70c 100644 --- a/docs/content/v2024.1/admin/yb-admin.md +++ b/docs/content/v2024.1/admin/yb-admin.md @@ -453,7 +453,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to compact. * *timeout_in_seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default value is `20`. -* *ADD_INDEXES*: Whether to compact the secondary indexes associated with the table. Default is `false`. +* *ADD_INDEXES*: Indicates to compact the secondary indexes associated with the table. **Example** @@ -478,7 +478,7 @@ yb-admin \ * *master_addresses*: Comma-separated list of YB-Master hosts and ports. Default value is `localhost:7100`. * *table_id*: The unique UUID associated with the table. * *timeout_in_seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default value is `20`. -* *ADD_INDEXES*: Whether to compact the secondary indexes associated with the table. Default is `false`. +* *ADD_INDEXES*: Indicates to compact the secondary indexes associated with the table. **Example** @@ -688,7 +688,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to flush. * *timeout_in_seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default value is `20`. -* *ADD_INDEXES*: Whether to flush the secondary indexes associated with the table. Default is `false`. +* *ADD_INDEXES*: Indicates to flush the secondary indexes associated with the table. **Example** @@ -714,7 +714,7 @@ yb-admin \ * *master_addresses*: Comma-separated list of YB-Master hosts and ports. Default value is `localhost:7100`. * *table_id*: The unique UUID associated with the table. * *timeout_in_seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default value is `20`. -* *ADD_INDEXES*: Whether to flush the secondary indexes associated with the table. Default is `false`. +* *ADD_INDEXES*: Indicates to flush the secondary indexes associated with the table. **Example** diff --git a/docs/content/v2024.1/admin/yb-ts-cli.md b/docs/content/v2024.1/admin/yb-ts-cli.md index 936d4082b825..897fc0df1bfe 100644 --- a/docs/content/v2024.1/admin/yb-ts-cli.md +++ b/docs/content/v2024.1/admin/yb-ts-cli.md @@ -110,11 +110,11 @@ Compact the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] compact_tablet +yb-ts-cli [ --server_address=: ] compact_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to compact. ##### count_intents @@ -142,30 +142,30 @@ yb-ts-cli [ --server_address=: ] current_hybrid_time ##### delete_tablet -Deletes the tablet with the specified tablet ID (`tablet_id`) and reason. +Deletes the tablet with the specified tablet ID (`tablet-id`) and reason. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] delete_tablet "" +yb-ts-cli [ --server_address=: ] delete_tablet "" ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. * *reason-string*: Text string providing information on why the tablet was deleted. ##### dump_tablet -Dump, or export, the specified tablet ID (`tablet_id`). +Dump, or export, the specified tablet ID (`tablet-id`). **Syntax** ```sh -yb-ts-cli [ --server_address=: ] dump_tablet +yb-ts-cli [ --server_address=: ] dump_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. ##### flush_all_tablets @@ -186,11 +186,11 @@ Flush the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] flush_tablet +yb-ts-cli [ --server_address=: ] flush_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to flush. ##### list_tablets @@ -223,12 +223,12 @@ Trigger a remote bootstrap of a tablet from another tablet server to the specifi **Syntax** ```sh -yb-ts-cli [ --server_address=: ] remote_bootstrap +yb-ts-cli [ --server_address=: ] remote_bootstrap ``` * *host*:*port*: The *host* and *port* of the tablet server running the remote bootstrap. Default is `localhost:9100`. -* *source_host*: The *host* or *host* and *port* of the tablet server to bootstrap from. -* *tablet_id*: The identifier of the tablet to trigger a remote bootstrap for. +* *source-host*: The *host* or *host* and *port* of the tablet server to bootstrap from. +* *tablet-id*: The identifier of the tablet to trigger a remote bootstrap for. See [Manual remote bootstrap of failed peer](/stable/troubleshoot/cluster/replace_failed_peers/) for example usage. diff --git a/docs/content/v2024.2/admin/yb-admin.md b/docs/content/v2024.2/admin/yb-admin.md index 99d709dc930a..45b77cf5ecd3 100644 --- a/docs/content/v2024.2/admin/yb-admin.md +++ b/docs/content/v2024.2/admin/yb-admin.md @@ -455,7 +455,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to compact. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default is `20`. -* ADD_INDEXES: Whether to compact the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to compact the secondary indexes associated with the table. **Example** @@ -480,7 +480,7 @@ yb-admin \ * *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`. * *table-id*: The unique UUID associated with the table. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default is `20`. -* ADD_INDEXES: Whether to compact the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to compact the secondary indexes associated with the table. **Example** @@ -690,7 +690,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to flush. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default is `20`. -* ADD_INDEXES: Whether to flush the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to flush the secondary indexes associated with the table. **Example** @@ -716,7 +716,7 @@ yb-admin \ * *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`. * *table-id*: The unique UUID associated with the table. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default is `20`. -* ADD_INDEXES: Whether to flush the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to flush the secondary indexes associated with the table. **Example** diff --git a/docs/content/v2024.2/admin/yb-ts-cli.md b/docs/content/v2024.2/admin/yb-ts-cli.md index 4ea06ef4d952..1399aebc610a 100644 --- a/docs/content/v2024.2/admin/yb-ts-cli.md +++ b/docs/content/v2024.2/admin/yb-ts-cli.md @@ -91,11 +91,11 @@ Compact the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] compact_tablet +yb-ts-cli [ --server_address=: ] compact_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to compact. ### count_intents @@ -123,30 +123,30 @@ yb-ts-cli [ --server_address=: ] current_hybrid_time ### delete_tablet -Deletes the tablet with the specified tablet ID (`tablet_id`) and reason. +Deletes the tablet with the specified tablet ID (`tablet-id`) and reason. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] delete_tablet "" +yb-ts-cli [ --server_address=: ] delete_tablet "" ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. * *reason-string*: Text string providing information on why the tablet was deleted. ### dump_tablet -Dump, or export, the specified tablet ID (`tablet_id`). +Dump, or export, the specified tablet ID (`tablet-id`). **Syntax** ```sh -yb-ts-cli [ --server_address=: ] dump_tablet +yb-ts-cli [ --server_address=: ] dump_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. ### flush_all_tablets @@ -167,11 +167,11 @@ Flush the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] flush_tablet +yb-ts-cli [ --server_address=: ] flush_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to flush. ### list_tablets @@ -204,12 +204,12 @@ Trigger a remote bootstrap of a tablet from another tablet server to the specifi **Syntax** ```sh -yb-ts-cli [ --server_address=: ] remote_bootstrap +yb-ts-cli [ --server_address=: ] remote_bootstrap ``` * *host*:*port*: The *host* and *port* of the tablet server running the remote bootstrap. Default is `localhost:9100`. -* *source_host*: The *host* or *host* and *port* of the tablet server to bootstrap from. -* *tablet_id*: The identifier of the tablet to trigger a remote bootstrap for. +* *source-host*: The *host* or *host* and *port* of the tablet server to bootstrap from. +* *tablet-id*: The identifier of the tablet to trigger a remote bootstrap for. See [Manual remote bootstrap of failed peer](/stable/troubleshoot/cluster/replace_failed_peers/) for example usage. diff --git a/docs/content/v2025.1/admin/yb-admin.md b/docs/content/v2025.1/admin/yb-admin.md index ed428d496bb6..6562b766ba4a 100644 --- a/docs/content/v2025.1/admin/yb-admin.md +++ b/docs/content/v2025.1/admin/yb-admin.md @@ -455,7 +455,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to compact. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default is `20`. -* ADD_INDEXES: Whether to compact the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to compact the secondary indexes associated with the table. **Example** @@ -480,7 +480,7 @@ yb-admin \ * *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`. * *table-id*: The unique UUID associated with the table. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for compaction to end. Default is `20`. -* ADD_INDEXES: Whether to compact the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to compact the secondary indexes associated with the table. **Example** @@ -690,7 +690,7 @@ yb-admin \ * *namespace*: The name of the database (for YSQL) or keyspace (for YCQL). * *table*: The name of the table to flush. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default is `20`. -* ADD_INDEXES: Whether to flush the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to flush the secondary indexes associated with the table. **Example** @@ -716,7 +716,7 @@ yb-admin \ * *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`. * *table-id*: The unique UUID associated with the table. * *timeout-in-seconds*: Specifies duration (in seconds) yb-admin waits for flushing to end. Default is `20`. -* ADD_INDEXES: Whether to flush the secondary indexes associated with the table. Default is `false`. +* ADD_INDEXES: Indicates to flush the secondary indexes associated with the table. **Example** diff --git a/docs/content/v2025.1/admin/yb-ts-cli.md b/docs/content/v2025.1/admin/yb-ts-cli.md index 57c9d1f256a5..73ca70a2bb69 100644 --- a/docs/content/v2025.1/admin/yb-ts-cli.md +++ b/docs/content/v2025.1/admin/yb-ts-cli.md @@ -91,11 +91,11 @@ Compact the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] compact_tablet +yb-ts-cli [ --server_address=: ] compact_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to compact. ### count_intents @@ -123,30 +123,30 @@ yb-ts-cli [ --server_address=: ] current_hybrid_time ### delete_tablet -Deletes the tablet with the specified tablet ID (`tablet_id`) and reason. +Deletes the tablet with the specified tablet ID (`tablet-id`) and reason. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] delete_tablet "" +yb-ts-cli [ --server_address=: ] delete_tablet "" ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. * *reason-string*: Text string providing information on why the tablet was deleted. ### dump_tablet -Dump, or export, the specified tablet ID (`tablet_id`). +Dump, or export, the specified tablet ID (`tablet-id`). **Syntax** ```sh -yb-ts-cli [ --server_address=: ] dump_tablet +yb-ts-cli [ --server_address=: ] dump_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier (ID) for the tablet. +* *tablet-id*: The identifier (ID) for the tablet. ### flush_all_tablets @@ -167,11 +167,11 @@ Flush the specified tablet on the tablet server. **Syntax** ```sh -yb-ts-cli [ --server_address=: ] flush_tablet +yb-ts-cli [ --server_address=: ] flush_tablet ``` * *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`. -* *tablet_id*: The identifier of the tablet to compact. +* *tablet-id*: The identifier of the tablet to flush. ### list_tablets @@ -204,12 +204,12 @@ Trigger a remote bootstrap of a tablet from another tablet server to the specifi **Syntax** ```sh -yb-ts-cli [ --server_address=: ] remote_bootstrap +yb-ts-cli [ --server_address=: ] remote_bootstrap ``` * *host*:*port*: The *host* and *port* of the tablet server running the remote bootstrap. Default is `localhost:9100`. -* *source_host*: The *host* or *host* and *port* of the tablet server to bootstrap from. -* *tablet_id*: The identifier of the tablet to trigger a remote bootstrap for. +* *source-host*: The *host* or *host* and *port* of the tablet server to bootstrap from. +* *tablet-id*: The identifier of the tablet to trigger a remote bootstrap for. See [Manual remote bootstrap of failed peer](/stable/troubleshoot/cluster/replace_failed_peers/) for example usage.