@lancedb/lancedb 0.19.1-beta.0 → 0.19.1-beta.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Connection } from "./connection";
 import { ConnectionOptions } from "./native.js";
-export { AddColumnsSql, ConnectionOptions, IndexStatistics, IndexConfig, ClientConfig, TimeoutConfig, RetryConfig, OptimizeStats, CompactionStats, RemovalStats, Tags, TagContents, } from "./native.js";
+export { AddColumnsSql, ConnectionOptions, IndexStatistics, IndexConfig, ClientConfig, TimeoutConfig, RetryConfig, OptimizeStats, CompactionStats, RemovalStats, TableStatistics, FragmentStatistics, FragmentSummaryStats, Tags, TagContents, } from "./native.js";
 export { makeArrowTable, MakeArrowTableOptions, Data, VectorColumnOptions, } from "./arrow";
 export { Connection, CreateTableOptions, TableNamesOptions, OpenTableOptions, } from "./connection";
 export { ExecutableQuery, Query, QueryBase, VectorQuery, QueryExecutionOptions, FullTextSearchOptions, RecordBatchIterator, FullTextQuery, MatchQuery, PhraseQuery, BoostQuery, MultiMatchQuery, FullTextQueryType, } from "./query";

package/dist/native.d.ts

@@ -191,6 +191,40 @@ export interface IndexStatistics {
    */
   loss?: number
 }
+export interface TableStatistics {
+  /** The total number of bytes in the table */
+  totalBytes: number
+  /** The number of rows in the table */
+  numRows: number
+  /** The number of indices in the table */
+  numIndices: number
+  /** Statistics on table fragments */
+  fragmentStats: FragmentStatistics
+}
+export interface FragmentStatistics {
+  /** The number of fragments in the table */
+  numFragments: number
+  /** The number of uncompacted fragments in the table */
+  numSmallFragments: number
+  /** Statistics on the number of rows in the table fragments */
+  lengths: FragmentSummaryStats
+}
+export interface FragmentSummaryStats {
+  /** The number of rows in the fragment with the fewest rows */
+  min: number
+  /** The number of rows in the fragment with the most rows */
+  max: number
+  /** The mean number of rows in the fragments */
+  mean: number
+  /** The 25th percentile of number of rows in the fragments */
+  p25: number
+  /** The 50th percentile of number of rows in the fragments */
+  p50: number
+  /** The 75th percentile of number of rows in the fragments */
+  p75: number
+  /** The 99th percentile of number of rows in the fragments */
+  p99: number
+}
 export interface Version {
   version: number
   timestamp: number
@@ -353,6 +387,7 @@ export class Table {
   dropIndex(indexName: string): Promise<void>
   prewarmIndex(indexName: string): Promise<void>
   waitForIndex(indexNames: Array<string>, timeoutS: number): Promise<void>
+  stats(): Promise<TableStatistics>
   update(onlyIf: string | undefined | null, columns: Array<[string, string]>): Promise<bigint>
   query(): Query
   vectorSearch(vector: Float32Array): VectorQuery

package/dist/table.d.ts

@@ -1,7 +1,7 @@
 import { Table as ArrowTable, Data, DataType, IntoVector, Schema } from "./arrow";
 import { IndexOptions } from "./indices";
 import { MergeInsertBuilder } from "./merge";
-import { AddColumnsSql, IndexConfig, IndexStatistics, OptimizeStats, Tags, Table as _NativeTable } from "./native";
+import { AddColumnsSql, IndexConfig, IndexStatistics, OptimizeStats, TableStatistics, Tags, Table as _NativeTable } from "./native";
 import { FullTextQuery, Query, VectorQuery } from "./query";
 import { IntoSql } from "./util";
 export { IndexConfig } from "./native";
@@ -415,6 +415,12 @@ export declare abstract class Table {
      * Use {@link Table.listIndices} to find the names of the indices.
      */
     abstract indexStats(name: string): Promise<IndexStatistics | undefined>;
+    /** Returns table and fragment statistics
+     *
+     * @returns {TableStatistics} The table and fragment statistics
+     *
+     */
+    abstract stats(): Promise<TableStatistics>;
 }
 export declare class LocalTable extends Table {
     private readonly inner;
@@ -454,6 +460,7 @@ export declare class LocalTable extends Table {
     listIndices(): Promise<IndexConfig[]>;
     toArrow(): Promise<ArrowTable>;
     indexStats(name: string): Promise<IndexStatistics | undefined>;
+    stats(): Promise<TableStatistics>;
     mergeInsert(on: string | string[]): MergeInsertBuilder;
     /**
      * Check if the table uses the new manifest path scheme.

package/dist/table.js

@@ -251,6 +251,9 @@ class LocalTable extends Table {
         }
         return stats;
     }
+    async stats() {
+        return await this.inner.stats();
+    }
     mergeInsert(on) {
         on = Array.isArray(on) ? on : [on];
         return new merge_1.MergeInsertBuilder(this.inner.mergeInsert(on), this.schema());

package/package.json

@@ -11,7 +11,7 @@
     "ann"
   ],
   "private": false,
-  "version": "0.19.1-beta.0",
+  "version": "0.19.1-beta.1",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",
@@ -100,14 +100,14 @@
     "reflect-metadata": "^0.2.2"
   },
   "optionalDependencies": {
-    "@lancedb/lancedb-darwin-x64": "0.19.1-beta.0",
-    "@lancedb/lancedb-darwin-arm64": "0.19.1-beta.0",
-    "@lancedb/lancedb-linux-x64-gnu": "0.19.1-beta.0",
-    "@lancedb/lancedb-linux-arm64-gnu": "0.19.1-beta.0",
-    "@lancedb/lancedb-linux-x64-musl": "0.19.1-beta.0",
-    "@lancedb/lancedb-linux-arm64-musl": "0.19.1-beta.0",
-    "@lancedb/lancedb-win32-x64-msvc": "0.19.1-beta.0",
-    "@lancedb/lancedb-win32-arm64-msvc": "0.19.1-beta.0"
+    "@lancedb/lancedb-darwin-x64": "0.19.1-beta.1",
+    "@lancedb/lancedb-darwin-arm64": "0.19.1-beta.1",
+    "@lancedb/lancedb-linux-x64-gnu": "0.19.1-beta.1",
+    "@lancedb/lancedb-linux-arm64-gnu": "0.19.1-beta.1",
+    "@lancedb/lancedb-linux-x64-musl": "0.19.1-beta.1",
+    "@lancedb/lancedb-linux-arm64-musl": "0.19.1-beta.1",
+    "@lancedb/lancedb-win32-x64-msvc": "0.19.1-beta.1",
+    "@lancedb/lancedb-win32-arm64-msvc": "0.19.1-beta.1"
   },
   "peerDependencies": {
     "apache-arrow": ">=15.0.0 <=18.1.0"