Files
lancedb/docs/src/js/interfaces/TableStatistics.md
T
Yuval LifshitzandClaude Opus 5.0 069b2f7d31 feat: add delete rows to table stats (#3783)
add to table stats the number of rows that has
been marked for deletion, but not yet deleted.
note that when a table fragment is removed due to
deletion of all of its rows, these rows are not counted. since the main
use of this feature is to determine when table compaction is needed, the
fact that these rows are not reported should not impact that decision
(deleted table fragments don't need compaction).

Fixes: https://github.com/lancedb/lancedb/issues/3761

Co-authored-by: Claude Opus 5.0 <noreply@anthropic.com>
2026-10-07 08:38:31 -07:00

1.1 KiB

@lancedb/lancedb • Docs


@lancedb/lancedb / TableStatistics

Interface: TableStatistics

Properties

fragmentStats

fragmentStats: FragmentStatistics;

Statistics on table fragments


numDeletedRows?

optional numDeletedRows: number;

The number of rows marked as deleted across all fragments of the table

These rows are not included in numRows, but still occupy space on disk until the table is compacted, so a large value here indicates that the table should be optimized. Fragments in which every row was deleted are dropped outright, so their rows are not counted here.

Absent (undefined) when the backend does not report deletion counts.


numIndices

numIndices: number;

The number of indices in the table


numRows

numRows: number;

The number of rows in the table


totalBytes

totalBytes: number;

The total size, in bytes, of the table's data files, index files, and overlay files

Read from the manifest, so this excludes deletion files and manifests.