@lancedb/lancedb 0.19.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, } 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/index.js

@@ -2,10 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: Copyright The LanceDB Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.packBits = exports.rerankers = exports.embedding = exports.MergeInsertBuilder = exports.Table = exports.Index = exports.FullTextQueryType = exports.MultiMatchQuery = exports.BoostQuery = exports.PhraseQuery = exports.MatchQuery = exports.RecordBatchIterator = exports.VectorQuery = exports.QueryBase = exports.Query = exports.Connection = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeArrowTable = void 0;
+exports.packBits = exports.rerankers = exports.embedding = exports.MergeInsertBuilder = exports.Table = exports.Index = exports.FullTextQueryType = exports.MultiMatchQuery = exports.BoostQuery = exports.PhraseQuery = exports.MatchQuery = exports.RecordBatchIterator = exports.VectorQuery = exports.QueryBase = exports.Query = exports.Connection = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeArrowTable = exports.TagContents = exports.Tags = void 0;
 exports.connect = connect;
 const connection_1 = require("./connection");
 const native_js_1 = require("./native.js");
+var native_js_2 = require("./native.js");
+Object.defineProperty(exports, "Tags", { enumerable: true, get: function () { return native_js_2.Tags; } });
+Object.defineProperty(exports, "TagContents", { enumerable: true, get: function () { return native_js_2.TagContents; } });
 var arrow_1 = require("./arrow");
 Object.defineProperty(exports, "makeArrowTable", { enumerable: true, get: function () { return arrow_1.makeArrowTable; } });
 Object.defineProperty(exports, "MakeArrowTableOptions", { enumerable: true, get: function () { return arrow_1.MakeArrowTableOptions; } });

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
@@ -361,9 +396,11 @@ export class Table {
   dropColumns(columns: Array<string>): Promise<void>
   version(): Promise<number>
   checkout(version: number): Promise<void>
+  checkoutTag(tag: string): Promise<void>
   checkoutLatest(): Promise<void>
   listVersions(): Promise<Array<Version>>
   restore(): Promise<void>
+  tags(): Promise<Tags>
   optimize(olderThanMs?: number | undefined | null, deleteUnverified?: boolean | undefined | null): Promise<OptimizeStats>
   listIndices(): Promise<Array<IndexConfig>>
   indexStats(indexName: string): Promise<IndexStatistics | null>
@@ -371,3 +408,14 @@ export class Table {
   usesV2ManifestPaths(): Promise<boolean>
   migrateManifestPathsV2(): Promise<void>
 }
+export class TagContents {
+  version: number
+  manifestSize: number
+}
+export class Tags {
+  list(): Promise<Record<string, TagContents>>
+  getVersion(tag: string): Promise<number>
+  create(tag: string, version: number): Promise<void>
+  delete(tag: string): Promise<void>
+  update(tag: string, version: number): Promise<void>
+}

package/dist/native.js

@@ -319,7 +319,7 @@ if (!nativeBinding) {
     }
     throw new Error(`Failed to load native binding`);
 }
-const { Connection, Index, RecordBatchIterator, NativeMergeInsertBuilder, Query, VectorQuery, JsFullTextQuery, Reranker, RrfReranker, Table } = nativeBinding;
+const { Connection, Index, RecordBatchIterator, NativeMergeInsertBuilder, Query, VectorQuery, JsFullTextQuery, Reranker, RrfReranker, Table, TagContents, Tags } = nativeBinding;
 module.exports.Connection = Connection;
 module.exports.Index = Index;
 module.exports.RecordBatchIterator = RecordBatchIterator;
@@ -330,3 +330,5 @@ module.exports.JsFullTextQuery = JsFullTextQuery;
 module.exports.Reranker = Reranker;
 module.exports.RrfReranker = RrfReranker;
 module.exports.Table = Table;
+module.exports.TagContents = TagContents;
+module.exports.Tags = Tags;

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, 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";
@@ -314,7 +314,7 @@ export declare abstract class Table {
      *
      * Calling this method will set the table into time-travel mode. If you
      * wish to return to standard mode, call `checkoutLatest`.
-     * @param {number} version The version to checkout
+     * @param {number | string} version The version to checkout, could be version number or tag
      * @example
      * ```typescript
      * import * as lancedb from "@lancedb/lancedb"
@@ -330,7 +330,7 @@ export declare abstract class Table {
      * console.log(await table.version()); // 2
      * ```
      */
-    abstract checkout(version: number): Promise<void>;
+    abstract checkout(version: number | string): Promise<void>;
     /**
      * Checkout the latest version of the table. _This is an in-place operation._
      *
@@ -342,6 +342,22 @@ export declare abstract class Table {
      * List all the versions of the table
      */
     abstract listVersions(): Promise<Version[]>;
+    /**
+     * Get a tags manager for this table.
+     *
+     * Tags allow you to label specific versions of a table with a human-readable name.
+     * The returned tags manager can be used to list, create, update, or delete tags.
+     *
+     * @returns {Tags} A tags manager for this table
+     * @example
+     * ```typescript
+     * const tagsManager = await table.tags();
+     * await tagsManager.create("v1", 1);
+     * const tags = await tagsManager.list();
+     * console.log(tags); // { "v1": { version: 1, manifestSize: ... } }
+     * ```
+     */
+    abstract tags(): Promise<Tags>;
     /**
      * Restore the table to the currently checked out version
      *
@@ -399,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;
@@ -429,14 +451,16 @@ export declare class LocalTable extends Table {
     alterColumns(columnAlterations: ColumnAlteration[]): Promise<void>;
     dropColumns(columnNames: string[]): Promise<void>;
     version(): Promise<number>;
-    checkout(version: number): Promise<void>;
+    checkout(version: number | string): Promise<void>;
     checkoutLatest(): Promise<void>;
     listVersions(): Promise<Version[]>;
     restore(): Promise<void>;
+    tags(): Promise<Tags>;
     optimize(options?: Partial<OptimizeOptions>): Promise<OptimizeStats>;
     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

@@ -208,7 +208,10 @@ class LocalTable extends Table {
         return await this.inner.version();
     }
     async checkout(version) {
-        await this.inner.checkout(version);
+        if (typeof version === "string") {
+            return this.inner.checkoutTag(version);
+        }
+        return this.inner.checkout(version);
     }
     async checkoutLatest() {
         await this.inner.checkoutLatest();
@@ -223,6 +226,9 @@ class LocalTable extends Table {
     async restore() {
         await this.inner.restore();
     }
+    async tags() {
+        return await this.inner.tags();
+    }
     async optimize(options) {
         let cleanupOlderThanMs;
         if (options?.cleanupOlderThan !== undefined &&
@@ -245,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.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.0",
-    "@lancedb/lancedb-darwin-arm64": "0.19.0",
-    "@lancedb/lancedb-linux-x64-gnu": "0.19.0",
-    "@lancedb/lancedb-linux-arm64-gnu": "0.19.0",
-    "@lancedb/lancedb-linux-x64-musl": "0.19.0",
-    "@lancedb/lancedb-linux-arm64-musl": "0.19.0",
-    "@lancedb/lancedb-win32-x64-msvc": "0.19.0",
-    "@lancedb/lancedb-win32-arm64-msvc": "0.19.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"