Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 38 additions & 6 deletions docs/content/stable/admin/yb-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -447,15 +447,16 @@ Triggers manual compaction on a table.
```sh
yb-admin \
--master_addresses <master-addresses> \
compact_table <db-type>.<namespace> <table> [<timeout-in-seconds>] [ADD_INDEXES]
compact_table <db-type>.<namespace> <table> [<timeout-in-seconds>] [ADD_INDEXES] [ADD_VECTOR_INDEXES]
```

* *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default is `localhost:7100`.
* *db-type*: The type of database. Valid values are `ysql` and `ycql`.
* *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**

Expand All @@ -474,13 +475,14 @@ Compacted [yugabyte.table_name] tables.
```sh
yb-admin \
--master_addresses <master-addresses> \
compact_table tableid.<table-id> [<timeout-in-seconds>] [ADD_INDEXES]
compact_table tableid.<table-id> [<timeout-in-seconds>] [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**

Expand All @@ -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 <master-addresses> \
compact_table_by_id <table-id> [<timeout-in-seconds>] [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.
Expand Down Expand Up @@ -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**

Expand All @@ -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**

Expand Down
40 changes: 27 additions & 13 deletions docs/content/stable/admin/yb-ts-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,25 @@ Compact the specified tablet on the tablet server.
**Syntax**

```sh
yb-ts-cli [ --server_address=<host>:<port> ] compact_tablet <tablet_id>
yb-ts-cli [ --server_address=<host>:<port> ] compact_tablet <tablet-id>
```

* *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=<host>:<port> ] compact_vector_index <tablet-id> [<vector-index-id1> <vector-index-id2> ...]
```

* *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

Expand Down Expand Up @@ -123,30 +137,30 @@ yb-ts-cli [ --server_address=<host>:<port> ] 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=<host>:<port> ] delete_tablet <tablet_id> "<reason-string>"
yb-ts-cli [ --server_address=<host>:<port> ] delete_tablet <tablet-id> "<reason-string>"
```

* *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=<host>:<port> ] dump_tablet <tablet_id>
yb-ts-cli [ --server_address=<host>:<port> ] dump_tablet <tablet-id>
```

* *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

Expand All @@ -167,11 +181,11 @@ Flush the specified tablet on the tablet server.
**Syntax**

```sh
yb-ts-cli [ --server_address=<host>:<port> ] flush_tablet <tablet_id>
yb-ts-cli [ --server_address=<host>:<port> ] flush_tablet <tablet-id>
```

* *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

Expand Down Expand Up @@ -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=<host>:<port> ] remote_bootstrap <source_host> <tablet_id>
yb-ts-cli [ --server_address=<host>:<port> ] remote_bootstrap <source-host> <tablet-id>
```

* *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.

Expand Down
8 changes: 4 additions & 4 deletions docs/content/v2.20/admin/yb-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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**

Expand Down Expand Up @@ -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**

Expand All @@ -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**

Expand Down
26 changes: 13 additions & 13 deletions docs/content/v2.20/admin/yb-ts-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ Compact the specified tablet on the tablet server.
**Syntax**

```sh
yb-ts-cli [ --server_address=<host>:<port> ] compact_tablet <tablet_id>
yb-ts-cli [ --server_address=<host>:<port> ] compact_tablet <tablet-id>
```

* *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

Expand Down Expand Up @@ -130,30 +130,30 @@ yb-ts-cli [ --server_address=<host>:<port> ] 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=<host>:<port> ] delete_tablet <tablet_id> "<reason-string>"
yb-ts-cli [ --server_address=<host>:<port> ] delete_tablet <tablet-id> "<reason-string>"
```

* *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=<host>:<port> ] dump_tablet <tablet_id>
yb-ts-cli [ --server_address=<host>:<port> ] dump_tablet <tablet-id>
```

* *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

Expand All @@ -174,11 +174,11 @@ Flush the specified tablet on the tablet server.
**Syntax**

```sh
yb-ts-cli [ --server_address=<host>:<port> ] flush_tablet <tablet_id>
yb-ts-cli [ --server_address=<host>:<port> ] flush_tablet <tablet-id>
```

* *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

Expand Down Expand Up @@ -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=<host>:<port> ] remote_bootstrap <source_host> <tablet_id>
yb-ts-cli [ --server_address=<host>:<port> ] remote_bootstrap <source-host> <tablet-id>
```

* *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.

Expand Down
8 changes: 4 additions & 4 deletions docs/content/v2024.1/admin/yb-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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**

Expand Down Expand Up @@ -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**

Expand All @@ -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**

Expand Down
Loading