diff --git a/docs/src/js/interfaces/IndexConfig.md b/docs/src/js/interfaces/IndexConfig.md index 6622c0189..c217e38e8 100644 --- a/docs/src/js/interfaces/IndexConfig.md +++ b/docs/src/js/interfaces/IndexConfig.md @@ -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. *** diff --git a/nodejs/src/table.rs b/nodejs/src/table.rs index a1410ad85..2f7d91a2a 100644 --- a/nodejs/src/table.rs +++ b/nodejs/src/table.rs @@ -879,11 +879,11 @@ pub struct IndexConfig { pub created_at: Option>, /// 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, /// 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, /// The total size in bytes of all index files across all segments. /// diff --git a/rust/lancedb/src/index.rs b/rust/lancedb/src/index.rs index 712a15fa0..5ce345e7e 100644 --- a/rust/lancedb/src/index.rs +++ b/rust/lancedb/src/index.rs @@ -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, /// 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, /// The total size in bytes of all index files across all segments. ///