docs: row counts in list_indices can be set for remote tables

Remote list_indices fills num_indexed_rows / num_unindexed_rows from the
server's enriched response and only leaves them unset for servers that
do not report them. The Node and Rust documentation previously implied
those fields were always unavailable for remote tables.

Synchronize the generated TypeScript API reference with the Node source
comments.

Closes #4301

Co-authored-by: desty <lee.ji.myung@gmail.com>
This commit is contained in:
JiMyung Lee
2026-10-29 04:03:30 +08:00
committed by GitHub
parent edb79d38e3
commit 057a39a1c7
3 changed files with 7 additions and 6 deletions
+2 -2
View File
@@ -100,7 +100,7 @@ optional numIndexedRows: number;
The number of rows indexed, across all segments.
`undefined` for remote tables.
May be `undefined` for remote tables if the server does not report it.
***
@@ -124,7 +124,7 @@ optional numUnindexedRows: number;
The number of rows not yet covered by this index.
`undefined` for remote tables.
May be `undefined` for remote tables if the server does not report it.
***
+2 -2
View File
@@ -879,11 +879,11 @@ pub struct IndexConfig {
pub created_at: Option<DateTime<Utc>>,
/// The number of rows indexed, across all segments.
///
/// `undefined` for remote tables.
/// May be `undefined` for remote tables if the server does not report it.
pub num_indexed_rows: Option<i64>,
/// The number of rows not yet covered by this index.
///
/// `undefined` for remote tables.
/// May be `undefined` for remote tables if the server does not report it.
pub num_unindexed_rows: Option<i64>,
/// The total size in bytes of all index files across all segments.
///
+3 -2
View File
@@ -497,13 +497,14 @@ pub struct IndexConfig {
/// The number of rows indexed, across all segments.
///
/// This is approximate and may include rows that have since been deleted.
/// `None` if unavailable (e.g. for remote tables).
/// `None` if unavailable (e.g. for remote tables whose server does not
/// report it).
pub num_indexed_rows: Option<u64>,
/// The number of rows in the table that are not yet covered by this index.
///
/// Computed as the table's total row count minus [`Self::num_indexed_rows`].
/// Optimizing the index will fold these rows into it. `None` if unavailable
/// (e.g. for remote tables).
/// (e.g. for remote tables whose server does not report it).
pub num_unindexed_rows: Option<u64>,
/// The total size in bytes of all index files across all segments.
///