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

package/dist/arrow.js

@@ -542,8 +542,9 @@ class PathTree {
 function transposeData(data, field, path = []) {
     if (field.type instanceof apache_arrow_1.Struct) {
         const childFields = field.type.children;
+        const fullPath = [...path, field.name];
         const childVectors = childFields.map((child) => {
-            return transposeData(data, child, [...path, child.name]);
+            return transposeData(data, child, fullPath);
         });
         const structData = (0, apache_arrow_1.makeData)({
             type: field.type,
@@ -556,7 +557,11 @@ function transposeData(data, field, path = []) {
         const values = data.map((datum) => {
             let current = datum;
             for (const key of valuesPath) {
-                if (isObject(current) && Object.hasOwn(current, key)) {
+                if (current == null) {
+                    return null;
+                }
+                if (isObject(current) &&
+                    (Object.hasOwn(current, key) || key in current)) {
                     current = current[key];
                 }
                 else {

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, MergeResult, AddResult, AddColumnsResult, AlterColumnsResult, DeleteResult, DropColumnsResult, UpdateResult, } 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/merge.d.ts

@@ -1,5 +1,5 @@
 import { Data, Schema } from "./arrow";
-import { NativeMergeInsertBuilder } from "./native";
+import { MergeResult, NativeMergeInsertBuilder } from "./native";
 /** A builder used to create and run a merge insert operation */
 export declare class MergeInsertBuilder {
     #private;
@@ -48,7 +48,7 @@ export declare class MergeInsertBuilder {
     /**
      * Executes the merge insert operation
      *
-     * Nothing is returned but the `Table` is updated
+     * @returns {Promise<MergeResult>} the merge result
      */
-    execute(data: Data): Promise<void>;
+    execute(data: Data): Promise<MergeResult>;
 }

package/dist/merge.js

@@ -58,7 +58,7 @@ class MergeInsertBuilder {
     /**
      * Executes the merge insert operation
      *
-     * Nothing is returned but the `Table` is updated
+     * @returns {Promise<MergeResult>} the merge result
      */
     async execute(data) {
         let schema;
@@ -70,7 +70,7 @@ class MergeInsertBuilder {
             schema = this.#schema;
         }
         const buffer = await (0, arrow_1.fromDataToBuffer)(data, undefined, schema);
-        await this.#native.execute(buffer);
+        return await this.#native.execute(buffer);
     }
 }
 exports.MergeInsertBuilder = MergeInsertBuilder;

package/dist/native.d.ts

@@ -191,11 +191,70 @@ 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
   metadata: Record<string, string>
 }
+export interface UpdateResult {
+  rowsUpdated: number
+  version: number
+}
+export interface AddResult {
+  version: number
+}
+export interface DeleteResult {
+  version: number
+}
+export interface MergeResult {
+  version: number
+  numInsertedRows: number
+  numUpdatedRows: number
+  numDeletedRows: number
+}
+export interface AddColumnsResult {
+  version: number
+}
+export interface AlterColumnsResult {
+  version: number
+}
+export interface DropColumnsResult {
+  version: number
+}
 export interface ConnectionOptions {
   /**
    * (For LanceDB OSS only): The interval, in seconds, at which to check for
@@ -279,7 +338,7 @@ export class NativeMergeInsertBuilder {
   whenMatchedUpdateAll(condition?: string | undefined | null): NativeMergeInsertBuilder
   whenNotMatchedInsertAll(): NativeMergeInsertBuilder
   whenNotMatchedBySourceDelete(filter?: string | undefined | null): NativeMergeInsertBuilder
-  execute(buf: Buffer): Promise<void>
+  execute(buf: Buffer): Promise<MergeResult>
 }
 export class Query {
   onlyIf(predicate: string): void
@@ -346,19 +405,20 @@ export class Table {
   close(): void
   /** Return Schema as empty Arrow IPC file. */
   schema(): Promise<Buffer>
-  add(buf: Buffer, mode: string): Promise<void>
+  add(buf: Buffer, mode: string): Promise<AddResult>
   countRows(filter?: string | undefined | null): Promise<number>
-  delete(predicate: string): Promise<void>
+  delete(predicate: string): Promise<DeleteResult>
   createIndex(index: Index | undefined | null, column: string, replace?: boolean | undefined | null, waitTimeoutS?: number | undefined | null): Promise<void>
   dropIndex(indexName: string): Promise<void>
   prewarmIndex(indexName: string): Promise<void>
   waitForIndex(indexNames: Array<string>, timeoutS: number): Promise<void>
-  update(onlyIf: string | undefined | null, columns: Array<[string, string]>): Promise<bigint>
+  stats(): Promise<TableStatistics>
+  update(onlyIf: string | undefined | null, columns: Array<[string, string]>): Promise<UpdateResult>
   query(): Query
   vectorSearch(vector: Float32Array): VectorQuery
-  addColumns(transforms: Array<AddColumnsSql>): Promise<void>
-  alterColumns(alterations: Array<ColumnAlteration>): Promise<void>
-  dropColumns(columns: Array<string>): Promise<void>
+  addColumns(transforms: Array<AddColumnsSql>): Promise<AddColumnsResult>
+  alterColumns(alterations: Array<ColumnAlteration>): Promise<AlterColumnsResult>
+  dropColumns(columns: Array<string>): Promise<DropColumnsResult>
   version(): Promise<number>
   checkout(version: number): Promise<void>
   checkoutTag(tag: string): Promise<void>

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 { AddColumnsResult, AddColumnsSql, AddResult, AlterColumnsResult, DeleteResult, DropColumnsResult, IndexConfig, IndexStatistics, OptimizeStats, TableStatistics, Tags, UpdateResult, Table as _NativeTable } from "./native";
 import { FullTextQuery, Query, VectorQuery } from "./query";
 import { IntoSql } from "./util";
 export { IndexConfig } from "./native";
@@ -89,12 +89,16 @@ export declare abstract class Table {
     /**
      * Insert records into this Table.
      * @param {Data} data Records to be inserted into the Table
+     * @returns {Promise<AddResult>} A promise that resolves to an object
+     * containing the new version number of the table
      */
-    abstract add(data: Data, options?: Partial<AddDataOptions>): Promise<void>;
+    abstract add(data: Data, options?: Partial<AddDataOptions>): Promise<AddResult>;
     /**
      * Update existing records in the Table
      * @param opts.values The values to update. The keys are the column names and the values
      * are the values to set.
+     * @returns {Promise<UpdateResult>} A promise that resolves to an object containing
+     * the number of rows updated and the new version number
      * @example
      * ```ts
      * table.update({where:"x = 2", values:{"vector": [10, 10]}})
@@ -102,11 +106,13 @@ export declare abstract class Table {
      */
     abstract update(opts: {
         values: Map<string, IntoSql> | Record<string, IntoSql>;
-    } & Partial<UpdateOptions>): Promise<void>;
+    } & Partial<UpdateOptions>): Promise<UpdateResult>;
     /**
      * Update existing records in the Table
      * @param opts.valuesSql The values to update. The keys are the column names and the values
      * are the values to set. The values are SQL expressions.
+     * @returns {Promise<UpdateResult>} A promise that resolves to an object containing
+     * the number of rows updated and the new version number
      * @example
      * ```ts
      * table.update({where:"x = 2", valuesSql:{"x": "x + 1"}})
@@ -114,7 +120,7 @@ export declare abstract class Table {
      */
     abstract update(opts: {
         valuesSql: Map<string, string> | Record<string, string>;
-    } & Partial<UpdateOptions>): Promise<void>;
+    } & Partial<UpdateOptions>): Promise<UpdateResult>;
     /**
      * Update existing records in the Table
      *
@@ -132,6 +138,8 @@ export declare abstract class Table {
      * repeatedly calilng this method.
      * @param {Map<string, string> | Record<string, string>} updates - the
      * columns to update
+     * @returns {Promise<UpdateResult>} A promise that resolves to an object
+     * containing the number of rows updated and the new version number
      *
      * Keys in the map should specify the name of the column to update.
      * Values in the map provide the new value of the column.  These can
@@ -140,11 +148,15 @@ export declare abstract class Table {
      * @param {Partial<UpdateOptions>} options - additional options to control
      * the update behavior
      */
-    abstract update(updates: Map<string, string> | Record<string, string>, options?: Partial<UpdateOptions>): Promise<void>;
+    abstract update(updates: Map<string, string> | Record<string, string>, options?: Partial<UpdateOptions>): Promise<UpdateResult>;
     /** Count the total number of rows in the dataset. */
     abstract countRows(filter?: string): Promise<number>;
-    /** Delete the rows that satisfy the predicate. */
-    abstract delete(predicate: string): Promise<void>;
+    /**
+     * Delete the rows that satisfy the predicate.
+     * @returns {Promise<DeleteResult>} A promise that resolves to an object
+     * containing the new version number of the table
+     */
+    abstract delete(predicate: string): Promise<DeleteResult>;
     /**
      * Create an index to speed up queries.
      *
@@ -283,14 +295,18 @@ export declare abstract class Table {
      * the SQL expression to use to calculate the value of the new column. These
      * expressions will be evaluated for each row in the table, and can
      * reference existing columns in the table.
+     * @returns {Promise<AddColumnsResult>} A promise that resolves to an object
+     * containing the new version number of the table after adding the columns.
      */
-    abstract addColumns(newColumnTransforms: AddColumnsSql[]): Promise<void>;
+    abstract addColumns(newColumnTransforms: AddColumnsSql[]): Promise<AddColumnsResult>;
     /**
      * Alter the name or nullability of columns.
      * @param {ColumnAlteration[]} columnAlterations One or more alterations to
      * apply to columns.
+     * @returns {Promise<AlterColumnsResult>} A promise that resolves to an object
+     * containing the new version number of the table after altering the columns.
      */
-    abstract alterColumns(columnAlterations: ColumnAlteration[]): Promise<void>;
+    abstract alterColumns(columnAlterations: ColumnAlteration[]): Promise<AlterColumnsResult>;
     /**
      * Drop one or more columns from the dataset
      *
@@ -301,8 +317,10 @@ export declare abstract class Table {
      * @param {string[]} columnNames The names of the columns to drop. These can
      * be nested column references (e.g. "a.b.c") or top-level column names
      * (e.g. "a").
+     * @returns {Promise<DropColumnsResult>} A promise that resolves to an object
+     * containing the new version number of the table after dropping the columns.
      */
-    abstract dropColumns(columnNames: string[]): Promise<void>;
+    abstract dropColumns(columnNames: string[]): Promise<DropColumnsResult>;
     /** Retrieve the version of the table */
     abstract version(): Promise<number>;
     /**
@@ -415,6 +433,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;
@@ -426,14 +450,14 @@ export declare class LocalTable extends Table {
     private getEmbeddingFunctions;
     /** Get the schema of the table. */
     schema(): Promise<Schema>;
-    add(data: Data, options?: Partial<AddDataOptions>): Promise<void>;
+    add(data: Data, options?: Partial<AddDataOptions>): Promise<AddResult>;
     update(optsOrUpdates: (Map<string, string> | Record<string, string>) | ({
         values: Map<string, IntoSql> | Record<string, IntoSql>;
     } & Partial<UpdateOptions>) | ({
         valuesSql: Map<string, string> | Record<string, string>;
-    } & Partial<UpdateOptions>), options?: Partial<UpdateOptions>): Promise<void>;
+    } & Partial<UpdateOptions>), options?: Partial<UpdateOptions>): Promise<UpdateResult>;
     countRows(filter?: string): Promise<number>;
-    delete(predicate: string): Promise<void>;
+    delete(predicate: string): Promise<DeleteResult>;
     createIndex(column: string, options?: Partial<IndexOptions>): Promise<void>;
     dropIndex(name: string): Promise<void>;
     prewarmIndex(name: string): Promise<void>;
@@ -441,9 +465,9 @@ export declare class LocalTable extends Table {
     query(): Query;
     search(query: string | IntoVector | FullTextQuery, queryType?: string, ftsColumns?: string | string[]): VectorQuery | Query;
     vectorSearch(vector: IntoVector): VectorQuery;
-    addColumns(newColumnTransforms: AddColumnsSql[]): Promise<void>;
-    alterColumns(columnAlterations: ColumnAlteration[]): Promise<void>;
-    dropColumns(columnNames: string[]): Promise<void>;
+    addColumns(newColumnTransforms: AddColumnsSql[]): Promise<AddColumnsResult>;
+    alterColumns(columnAlterations: ColumnAlteration[]): Promise<AlterColumnsResult>;
+    dropColumns(columnNames: string[]): Promise<DropColumnsResult>;
     version(): Promise<number>;
     checkout(version: number | string): Promise<void>;
     checkoutLatest(): Promise<void>;
@@ -454,6 +478,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

@@ -66,7 +66,7 @@ class LocalTable extends Table {
         const mode = options?.mode ?? "append";
         const schema = await this.schema();
         const buffer = await (0, arrow_1.fromDataToBuffer)(data, undefined, schema);
-        await this.inner.add(buffer, mode);
+        return await this.inner.add(buffer, mode);
     }
     async update(optsOrUpdates, options) {
         const isValues = "values" in optsOrUpdates && typeof optsOrUpdates.values !== "string";
@@ -111,13 +111,13 @@ class LocalTable extends Table {
                 columns = Object.entries(optsOrUpdates);
                 predicate = options?.where;
         }
-        await this.inner.update(predicate, columns);
+        return await this.inner.update(predicate, columns);
     }
     async countRows(filter) {
         return await this.inner.countRows(filter);
     }
     async delete(predicate) {
-        await this.inner.delete(predicate);
+        return await this.inner.delete(predicate);
     }
     async createIndex(column, options) {
         // Bit of a hack to get around the fact that TS has no package-scope.
@@ -175,7 +175,7 @@ class LocalTable extends Table {
     }
     // TODO: Support BatchUDF
     async addColumns(newColumnTransforms) {
-        await this.inner.addColumns(newColumnTransforms);
+        return await this.inner.addColumns(newColumnTransforms);
     }
     async alterColumns(columnAlterations) {
         const processedAlterations = columnAlterations.map((alteration) => {
@@ -199,10 +199,10 @@ class LocalTable extends Table {
                 };
             }
         });
-        await this.inner.alterColumns(processedAlterations);
+        return await this.inner.alterColumns(processedAlterations);
     }
     async dropColumns(columnNames) {
-        await this.inner.dropColumns(columnNames);
+        return await this.inner.dropColumns(columnNames);
     }
     async version() {
         return await this.inner.version();
@@ -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.2",
   "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.2",
+    "@lancedb/lancedb-darwin-arm64": "0.19.1-beta.2",
+    "@lancedb/lancedb-linux-x64-gnu": "0.19.1-beta.2",
+    "@lancedb/lancedb-linux-arm64-gnu": "0.19.1-beta.2",
+    "@lancedb/lancedb-linux-x64-musl": "0.19.1-beta.2",
+    "@lancedb/lancedb-linux-arm64-musl": "0.19.1-beta.2",
+    "@lancedb/lancedb-win32-x64-msvc": "0.19.1-beta.2",
+    "@lancedb/lancedb-win32-arm64-msvc": "0.19.1-beta.2"
   },
   "peerDependencies": {
     "apache-arrow": ">=15.0.0 <=18.1.0"