@lancedb/lancedb 0.41.0 → 0.42.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/table.d.ts CHANGED
@@ -68,8 +68,8 @@ export interface AddDataOptions {
68
68
  /**
69
69
  * Whether blob URIs outside registered external bases may be written.
70
70
  *
71
- * Defaults to `false`. This option is supported only for local/native
72
- * tables; remote tables return an error when it is enabled. An enabled write
71
+ * Defaults to `false`. This option is supported only in LanceDB Embedded;
72
+ * LanceDB Distributed returns an error when it is enabled. An enabled write
73
73
  * stores the absolute URI reference without registering a base or copying
74
74
  * the external object into the database. The object must remain accessible
75
75
  * when the blob is read later.
@@ -297,6 +297,11 @@ export declare abstract class Table {
297
297
  * }),
298
298
  * });
299
299
  * @example
300
+ * // Or size the partitions by row count instead of choosing how many.
301
+ * await table.createIndex("vector", {
302
+ * config: lancedb.Index.ivfPq({ targetPartitionSize: 4096 }),
303
+ * });
304
+ * @example
300
305
  * // Or create a Scalar index
301
306
  * await table.createIndex("my_float_col");
302
307
  */
@@ -344,7 +349,7 @@ export declare abstract class Table {
344
349
  * Large columns (e.g. high-dimensional vectors or binary data) may not be
345
350
  * practical to prewarm.
346
351
  *
347
- * This feature is currently only supported on remote tables.
352
+ * This feature is currently only supported in LanceDB Distributed.
348
353
  */
349
354
  abstract prewarmData(columns?: string[]): Promise<void>;
350
355
  /**
@@ -477,9 +482,9 @@ export declare abstract class Table {
477
482
  /**
478
483
  * Add new columns with defined values.
479
484
  *
480
- * Local computed-column declaration and refresh require a source build with
481
- * the `experimental-functions` Cargo feature. Published packages disable it;
482
- * remote Cloud/Enterprise operations remain available.
485
+ * LanceDB Embedded computed-column declaration and refresh require a source
486
+ * build with the `experimental-functions` Cargo feature. Published packages
487
+ * disable it; LanceDB Distributed operations remain available.
483
488
  *
484
489
  * The `{ computed }` form stores the expression rather than evaluating it
485
490
  * now: the column is committed with no values, and rows get them from
@@ -491,7 +496,7 @@ export declare abstract class Table {
491
496
  * declaration reads a column, that column cannot be renamed, retyped or
492
497
  * dropped.
493
498
  *
494
- * On LanceDB Cloud and Enterprise the expression is planned by the
499
+ * In LanceDB Distributed the expression is planned by the
495
500
  * server, and the refresh runs as a server job -- see
496
501
  * {@link Table#refreshColumnAsync}.
497
502
  * @param {AddColumnsSql[] | Field | Field[] | Schema} newColumnTransforms Either:
@@ -517,8 +522,8 @@ export declare abstract class Table {
517
522
  *
518
523
  * Rows appended since the last refresh are filled by the next one, and
519
524
  * rows whose inputs changed since they were computed are recomputed;
520
- * everything else is left as it is. Local tables only: a remote refresh
521
- * runs as a server job, through {@link Table#refreshColumnAsync}.
525
+ * everything else is left as it is. LanceDB Embedded only: in LanceDB
526
+ * Distributed a refresh runs as a server job, through {@link Table#refreshColumnAsync}.
522
527
  * @param {string} column The name of the computed column to fill.
523
528
  * @returns {Promise<RefreshColumnResult>} A promise that resolves to the
524
529
  * number of rows filled and the new version number of the table.
@@ -527,14 +532,15 @@ export declare abstract class Table {
527
532
  /**
528
533
  * Like {@link Table#refreshColumn}, but returns a handle to the refresh
529
534
  * job instead of blocking until it completes.
530
- * Local refresh requires a source build with `experimental-functions`.
531
- * Remote Cloud/Enterprise jobs do not require this feature.
535
+ * LanceDB Embedded refresh requires a source build with
536
+ * `experimental-functions`. LanceDB Distributed jobs do not require this
537
+ * feature.
532
538
  *
533
539
  * The job may already be complete when returned; callers must not assume
534
540
  * the column is filled until {@link Job.wait} resolves. Invalid input --
535
541
  * an unknown column, or one that is not computed -- rejects here rather
536
- * than failing the job. On local tables the job runs in-process; on
537
- * LanceDB Cloud and Enterprise it is the server's backfill job.
542
+ * than failing the job. In LanceDB Embedded the job runs in-process; in
543
+ * LanceDB Distributed it is the server's backfill job.
538
544
  * @param {string} column The name of the computed column to fill.
539
545
  * @example
540
546
  * ```ts
@@ -550,7 +556,7 @@ export declare abstract class Table {
550
556
  * A refresh running under a skip policy records each row it skipped with
551
557
  * the input that failed and the error. This lists those records, newest
552
558
  * job first, plus a summary for any fragment whose per-row detail was
553
- * capped. LanceDB Cloud and Enterprise only; reading errors needs read
559
+ * capped. LanceDB Distributed only; reading errors needs read
554
560
  * access to the table, since a message carries the value that failed.
555
561
  * @param {FunctionErrorsOptions} options Optional filters: `jobId`,
556
562
  * `column`, and `limit` (server default 10000, cap 100000).
@@ -846,7 +852,7 @@ export declare abstract class Table {
846
852
  * Specify exactly one of `column` or `indexName`.
847
853
  *
848
854
  * Model-backed tokenizers such as `jieba/*` and `lindera/*` are rebuilt in
849
- * the client process from index metadata. For remote tables, this means the
855
+ * the client process from index metadata. In LanceDB Distributed, this means the
850
856
  * same tokenizer model files must also exist locally (under
851
857
  * `LANCE_LANGUAGE_MODEL_HOME`) and must match the files the server uses. A
852
858
  * mismatch cannot be detected: the returned tokens may differ from what the
package/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "ann"
12
12
  ],
13
13
  "private": false,
14
- "version": "0.41.0",
14
+ "version": "0.42.0-beta.0",
15
15
  "main": "dist/index.js",
16
16
  "exports": {
17
17
  ".": "./dist/index.js",
@@ -111,13 +111,13 @@
111
111
  "optionalDependencies": {
112
112
  "@huggingface/transformers": "3.0.2",
113
113
  "openai": "4.29.2",
114
- "@lancedb/lancedb-darwin-arm64": "0.41.0",
115
- "@lancedb/lancedb-linux-x64-gnu": "0.41.0",
116
- "@lancedb/lancedb-linux-arm64-gnu": "0.41.0",
117
- "@lancedb/lancedb-linux-x64-musl": "0.41.0",
118
- "@lancedb/lancedb-linux-arm64-musl": "0.41.0",
119
- "@lancedb/lancedb-win32-x64-msvc": "0.41.0",
120
- "@lancedb/lancedb-win32-arm64-msvc": "0.41.0"
114
+ "@lancedb/lancedb-darwin-arm64": "0.42.0-beta.0",
115
+ "@lancedb/lancedb-linux-x64-gnu": "0.42.0-beta.0",
116
+ "@lancedb/lancedb-linux-arm64-gnu": "0.42.0-beta.0",
117
+ "@lancedb/lancedb-linux-x64-musl": "0.42.0-beta.0",
118
+ "@lancedb/lancedb-linux-arm64-musl": "0.42.0-beta.0",
119
+ "@lancedb/lancedb-win32-x64-msvc": "0.42.0-beta.0",
120
+ "@lancedb/lancedb-win32-arm64-msvc": "0.42.0-beta.0"
121
121
  },
122
122
  "peerDependencies": {
123
123
  "@types/node": ">=22",