@lancedb/lancedb 0.15.1-beta.2 → 0.16.0

package/dist/table.d.ts

@@ -1,5 +1,4 @@
-import { Table as ArrowTable, Data, IntoVector, Schema, TableLike } from "./arrow";
-import { CreateTableOptions } from "./connection";
+import { Table as ArrowTable, Data, IntoVector, Schema } from "./arrow";
 import { IndexOptions } from "./indices";
 import { MergeInsertBuilder } from "./merge";
 import { AddColumnsSql, ColumnAlteration, IndexConfig, IndexStatistics, OptimizeStats, Table as _NativeTable } from "./native";
@@ -61,8 +60,14 @@ export interface Version {
  * can call the `close` method.  Once the Table is closed, it cannot be used for any
  * further operations.
  *
+ * Tables are created using the methods {@link Connection#createTable}
+ * and {@link Connection#createEmptyTable}. Existing tables are opened
+ * using {@link Connection#openTable}.
+ *
  * Closing a table is optional.  It not closed, it will be closed when it is garbage
  * collected.
+ *
+ * @hideconstructor
  */
 export declare abstract class Table {
     /** Returns the name of the table */
@@ -148,8 +153,9 @@ export declare abstract class Table {
      * Indices on scalar columns will speed up filtering (in both
      * vector and non-vector searches)
      *
-     * @note We currently don't support custom named indexes,
-     * The index name will always be `${column}_idx`
+     * We currently don't support custom named indexes.
+     * The index name will always be `${column}_idx`.
+     *
      * @example
      * // If the column has a vector (fixed size list) data type then
      * // an IvfPq vector index will be created.
@@ -175,7 +181,7 @@ export declare abstract class Table {
      *
      * @param name The name of the index.
      *
-     * @note This does not delete the index from disk, it just removes it from the table.
+     * This does not delete the index from disk, it just removes it from the table.
      * To delete the index, run {@link Table#optimize} after dropping the index.
      *
      * Use {@link Table.listIndices} to find the names of the indices.
@@ -374,10 +380,6 @@ export declare abstract class Table {
      * Use {@link Table.listIndices} to find the names of the indices.
      */
     abstract indexStats(name: string): Promise<IndexStatistics | undefined>;
-    static parseTableData(data: Record<string, unknown>[] | TableLike, options?: Partial<CreateTableOptions>, streaming?: boolean): Promise<{
-        buf: Buffer;
-        mode: string;
-    }>;
 }
 export declare class LocalTable extends Table {
     private readonly inner;

package/dist/table.js

@@ -7,7 +7,6 @@ const arrow_1 = require("./arrow");
 const registry_1 = require("./embedding/registry");
 const merge_1 = require("./merge");
 const query_1 = require("./query");
-const sanitize_1 = require("./sanitize");
 const util_1 = require("./util");
 /**
  * A Table is a collection of Records in a LanceDB Database.
@@ -18,35 +17,19 @@ const util_1 = require("./util");
  * can call the `close` method.  Once the Table is closed, it cannot be used for any
  * further operations.
  *
+ * Tables are created using the methods {@link Connection#createTable}
+ * and {@link Connection#createEmptyTable}. Existing tables are opened
+ * using {@link Connection#openTable}.
+ *
  * Closing a table is optional.  It not closed, it will be closed when it is garbage
  * collected.
+ *
+ * @hideconstructor
  */
 class Table {
     [Symbol.for("nodejs.util.inspect.custom")]() {
         return this.display();
     }
-    static async parseTableData(data, options, streaming = false) {
-        let mode = options?.mode ?? "create";
-        const existOk = options?.existOk ?? false;
-        if (mode === "create" && existOk) {
-            mode = "exist_ok";
-        }
-        let table;
-        if ((0, arrow_1.isArrowTable)(data)) {
-            table = (0, sanitize_1.sanitizeTable)(data);
-        }
-        else {
-            table = (0, arrow_1.makeArrowTable)(data, options);
-        }
-        if (streaming) {
-            const buf = await (0, arrow_1.fromTableToStreamBuffer)(table, options?.embeddingFunction, options?.schema);
-            return { buf, mode };
-        }
-        else {
-            const buf = await (0, arrow_1.fromTableToBuffer)(table, options?.embeddingFunction, options?.schema);
-            return { buf, mode };
-        }
-    }
 }
 exports.Table = Table;
 class LocalTable extends Table {

package/package.json

@@ -11,7 +11,7 @@
     "ann"
   ],
   "private": false,
-  "version": "0.15.1-beta.2",
+  "version": "0.16.0",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",
@@ -84,7 +84,7 @@
     "build": "npm run build:debug && tsc -b && shx cp lancedb/native.d.ts dist/native.d.ts && shx cp lancedb/*.node dist/",
     "build-release": "npm run build:release && tsc -b && shx cp lancedb/native.d.ts dist/native.d.ts",
     "lint-ci": "biome ci .",
-    "docs": "typedoc --plugin typedoc-plugin-markdown --out ../docs/src/js lancedb/index.ts",
+    "docs": "typedoc --plugin typedoc-plugin-markdown --treatWarningsAsErrors --out ../docs/src/js lancedb/index.ts",
     "postdocs": "node typedoc_post_process.js",
     "lint": "biome check . && biome format .",
     "lint-fix": "biome check --write . && biome format --write .",
@@ -98,14 +98,14 @@
     "reflect-metadata": "^0.2.2"
   },
   "optionalDependencies": {
-    "@lancedb/lancedb-darwin-x64": "0.15.1-beta.2",
-    "@lancedb/lancedb-darwin-arm64": "0.15.1-beta.2",
-    "@lancedb/lancedb-linux-x64-gnu": "0.15.1-beta.2",
-    "@lancedb/lancedb-linux-arm64-gnu": "0.15.1-beta.2",
-    "@lancedb/lancedb-linux-x64-musl": "0.15.1-beta.2",
-    "@lancedb/lancedb-linux-arm64-musl": "0.15.1-beta.2",
-    "@lancedb/lancedb-win32-x64-msvc": "0.15.1-beta.2",
-    "@lancedb/lancedb-win32-arm64-msvc": "0.15.1-beta.2"
+    "@lancedb/lancedb-darwin-x64": "0.16.0",
+    "@lancedb/lancedb-darwin-arm64": "0.16.0",
+    "@lancedb/lancedb-linux-x64-gnu": "0.16.0",
+    "@lancedb/lancedb-linux-arm64-gnu": "0.16.0",
+    "@lancedb/lancedb-linux-x64-musl": "0.16.0",
+    "@lancedb/lancedb-linux-arm64-musl": "0.16.0",
+    "@lancedb/lancedb-win32-x64-msvc": "0.16.0",
+    "@lancedb/lancedb-win32-arm64-msvc": "0.16.0"
   },
   "peerDependencies": {
     "apache-arrow": ">=15.0.0 <=18.1.0"

package/typedoc_post_process.js

@@ -40,23 +40,28 @@ function processDirectory(directoryPath) {
 function processContents(contents) {
   // This changes the parameters section to put the parameter description on
   // the same line as the bullet with the parameter name and type.
-  return contents.replace(/(## Parameters[\s\S]*?)(?=##|$)/g, (match) => {
-    let lines = match
-      .split("\n")
-      .map((line) => line.trim())
-
-      .filter((line) => line !== "")
-      .map((line) => {
-        if (line.startsWith("##")) {
-          return line;
-        } else if (line.startsWith("•")) {
-          return "\n*" + line.substring(1);
-        } else {
-          return "    " + line;
-        }
-      });
-    return lines.join("\n") + "\n\n";
-  });
+  return (
+    contents
+      .replace(/(## Parameters[\s\S]*?)(?=##|$)/g, (match) => {
+        let lines = match
+          .split("\n")
+          .map((line) => line.trim())
+
+          .filter((line) => line !== "")
+          .map((line) => {
+            if (line.startsWith("##")) {
+              return line;
+            } else if (line.startsWith("•")) {
+              return "\n*" + line.substring(1);
+            } else {
+              return "    " + line;
+            }
+          });
+        return lines.join("\n") + "\n\n";
+      })
+      // Also trim trailing whitespace
+      .replace(/([^ \t])[ \t]+\n/g, "$1\n")
+  );
 }
 
 // Start processing from the root directory