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

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/blob.d.ts CHANGED
@@ -173,7 +173,7 @@ export declare class BlobFile {
173
173
  export type BlobReadOptions = {
174
174
  /**
175
175
  * Cancels the read. The call rejects with `signal.reason`, and the native
176
- * read stops, including in-flight requests to a LanceDB Distributed table.
176
+ * read stops, including in-flight requests to a LanceDB Enterprise table.
177
177
  */
178
178
  signal?: AbortSignal;
179
179
  };
@@ -215,7 +215,7 @@ export declare abstract class Connection {
215
215
  *
216
216
  * LanceDB Embedded creation and refresh require a source build with the
217
217
  * `experimental-functions` Cargo feature, disabled in published packages.
218
- * LanceDB Distributed operations do not require this feature.
218
+ * LanceDB Enterprise operations do not require this feature.
219
219
  *
220
220
  * The view is populated before creation returns. Set `withNoData` to create
221
221
  * only its definition and empty backing table. The view is a normal table:
@@ -420,7 +420,7 @@ export declare abstract class Connection {
420
420
  /**
421
421
  * Rename a table.
422
422
  *
423
- * Supported in LanceDB Distributed and by namespace backends that implement
423
+ * Supported in LanceDB Enterprise and by namespace backends that implement
424
424
  * renaming. Directory namespaces support renaming tables resolved through their
425
425
  * manifest, including tables within or across child namespaces. LanceDB Embedded
426
426
  * connections and directory-listing root tables reject with a "not supported" error.
package/dist/index.d.ts CHANGED
@@ -13,7 +13,8 @@ export { blob, isBlobField, BlobFile } from "./blob";
13
13
  export type { BlobData, BlobInput, BlobOptions, BlobRange, BlobReadOptions, BlobUri, } from "./blob";
14
14
  export { Connection, CreateTableOptions, TableNamesOptions, OpenTableOptions, CreateNamespaceOptions, DropNamespaceOptions, CreateNamespaceResponse, DropNamespaceResponse, DescribeNamespaceResponse, RenameTableOptions, } from "./connection";
15
15
  export { JobFailureInfo, JobInfo, Session } from "./native.js";
16
- export { Job, JobEventsOptions } from "./job";
16
+ export { Job, JobEventsOptions, } from "./job";
17
+ export type { JobProgress, JobProgressCallback } from "./job";
17
18
  export { AutoQuery, ExecutableQuery, Query, QueryBase, VectorQuery, TakeQuery, AnalyzePlanDistributedMetrics, BlobMode, QueryExecutionOptions, ColumnOrdering, FullTextSearchOptions, RecordBatchIterator, FullTextQuery, MatchQuery, PhraseQuery, BoostQuery, MultiMatchQuery, BooleanQuery, FullTextQueryType, Operator, Occur, } from "./query";
18
19
  export { Index, IndexOptions, IvfPqOptions, IvfRqOptions, IvfFlatOptions, HnswPqOptions, HnswSqOptions, FtsOptions, BaseTokenizer, } from "./indices";
19
20
  export { Table, Branches, BranchColumnSummary, BranchColumnChange, BranchIndexSummary, BranchRowCountSummary, CherryPickError, BranchDiff, CherryPickPreview, CherryPickResult, AddDataOptions, UpdateOptions, OptimizeOptions, Version, WriteProgress, FtsToken, TokenizeTableOptions, RTEWriteSpec, RTEStats, TableShardStats, SsTableStats, MemtableStats, ColumnAlteration, FieldMetadataUpdate, } from "./table";
package/dist/indices.d.ts CHANGED
@@ -780,7 +780,10 @@ export interface IndexOptions {
780
780
  /**
781
781
  * Timeout in seconds to wait for index creation to complete.
782
782
  *
783
- * If not specified, the method will return immediately after starting the index creation.
783
+ * Only applies to LanceDB Enterprise tables, which build the index in the
784
+ * background.
785
+ * If not specified, `createIndex` returns once the build is scheduled.
786
+ * LanceDB Embedded tables always build the index before `createIndex` returns.
784
787
  */
785
788
  waitTimeoutSeconds?: number;
786
789
  /**
package/dist/job.d.ts CHANGED
@@ -7,6 +7,38 @@ export interface JobEventsOptions {
7
7
  /** SQL-like filter over the event columns. */
8
8
  filter?: string;
9
9
  }
10
+ /**
11
+ * A forward-compatible structured progress snapshot for a server-side job.
12
+ *
13
+ * Fields are optional because older servers and different job types report
14
+ * different counters. A missing counter is unknown; it is not zero.
15
+ */
16
+ export interface JobProgress {
17
+ /** Lifecycle state, including states from newer servers. */
18
+ state?: string;
19
+ /** Coarse server-derived phase, including phases from newer servers. */
20
+ phase?: string | null;
21
+ /** Whether an operator has parked the job. */
22
+ paused?: boolean;
23
+ /**
24
+ * Planned, computed, skipped, remaining, and failed row counters, when the
25
+ * server reports them.
26
+ */
27
+ rows_planned?: number | null;
28
+ rows_computed?: number | null;
29
+ rows_skipped?: number | null;
30
+ rows_remaining?: number | null;
31
+ rows_failed?: number | null;
32
+ /** Execution identity and sample time used for client-side ETA derivation. */
33
+ execution_epoch?: number | null;
34
+ sample_at_millis?: number | null;
35
+ /** Best-effort remaining milliseconds, present only for a reliable sample. */
36
+ estimated_remaining_time_millis?: number;
37
+ /** Retain job-type-specific and newer-server fields without interpretation. */
38
+ [field: string]: unknown;
39
+ }
40
+ /** Callback for progress snapshots observed while waiting for a job. */
41
+ export type JobProgressCallback = (progress: JobProgress) => void;
10
42
  /**
11
43
  * A handle to an operation that may still be running.
12
44
  *
@@ -63,8 +95,25 @@ export declare class Job {
63
95
  * terminal failure state. Also refreshes the getters above.
64
96
  */
65
97
  status(): Promise<string>;
66
- /** Wait until the operation reaches a terminal state. */
67
- wait(): Promise<void>;
98
+ /**
99
+ * Fetch a structured progress snapshot.
100
+ *
101
+ * Registry jobs include lifecycle and queue metadata even when their job
102
+ * type does not report counters. The returned object is forward-compatible
103
+ * with newer servers and job types. In-process operations return null.
104
+ */
105
+ progress(): Promise<JobProgress | null>;
106
+ /**
107
+ * Wait until the operation reaches a terminal state.
108
+ *
109
+ * The optional callback observes the same snapshots fetched by the backend
110
+ * poller that drives completion; it does not start another poller. Without a
111
+ * callback, this preserves the original wait behavior. The callback is a
112
+ * synchronous observer: its return value is ignored and not awaited. If it
113
+ * throws, the error is logged with `console.warn` and waiting continues; a
114
+ * callback exception does not reject `wait`.
115
+ */
116
+ wait(progressCallback?: JobProgressCallback): Promise<void>;
68
117
  /** Request cancellation. Cancelling a finished operation is a no-op. */
69
118
  cancel(): Promise<void>;
70
119
  /**
@@ -87,6 +136,8 @@ export declare class Job {
87
136
  * `updated_by`, `emitted_from`, `emitted_by`, and `claim_entity` columns.
88
137
  */
89
138
  events(options?: JobEventsOptions): Promise<ArrowTable>;
139
+ private lastProgress;
140
+ private enrichProgress;
90
141
  /**
91
142
  * Every field the handle currently knows, one per line, with the JSON
92
143
  * payloads indented -- a refresh job's spec and result are the point of
package/dist/job.js CHANGED
@@ -80,9 +80,39 @@ class Job {
80
80
  async status() {
81
81
  return this.inner.status();
82
82
  }
83
- /** Wait until the operation reaches a terminal state. */
84
- async wait() {
85
- return this.inner.wait();
83
+ /**
84
+ * Fetch a structured progress snapshot.
85
+ *
86
+ * Registry jobs include lifecycle and queue metadata even when their job
87
+ * type does not report counters. The returned object is forward-compatible
88
+ * with newer servers and job types. In-process operations return null.
89
+ */
90
+ async progress() {
91
+ const progress = await this.inner.progress();
92
+ return progress === null ? null : this.enrichProgress(progress);
93
+ }
94
+ /**
95
+ * Wait until the operation reaches a terminal state.
96
+ *
97
+ * The optional callback observes the same snapshots fetched by the backend
98
+ * poller that drives completion; it does not start another poller. Without a
99
+ * callback, this preserves the original wait behavior. The callback is a
100
+ * synchronous observer: its return value is ignored and not awaited. If it
101
+ * throws, the error is logged with `console.warn` and waiting continues; a
102
+ * callback exception does not reject `wait`.
103
+ */
104
+ async wait(progressCallback) {
105
+ if (progressCallback === undefined) {
106
+ return this.inner.wait();
107
+ }
108
+ return this.inner.wait((progress) => {
109
+ try {
110
+ progressCallback(this.enrichProgress(progress));
111
+ }
112
+ catch (error) {
113
+ console.warn("Job progress callback threw:", error);
114
+ }
115
+ });
86
116
  }
87
117
  /** Request cancellation. Cancelling a finished operation is a no-op. */
88
118
  async cancel() {
@@ -116,6 +146,12 @@ class Job {
116
146
  }
117
147
  return (0, apache_arrow_1.tableFromIPC)(buf);
118
148
  }
149
+ lastProgress = null;
150
+ enrichProgress(progress) {
151
+ const enriched = withProgressEta(this.lastProgress, progress);
152
+ this.lastProgress = enriched;
153
+ return enriched;
154
+ }
119
155
  /**
120
156
  * Every field the handle currently knows, one per line, with the JSON
121
157
  * payloads indented -- a refresh job's spec and result are the point of
@@ -156,6 +192,85 @@ class Job {
156
192
  }
157
193
  exports.Job = Job;
158
194
  const REPR_INDENT = " ";
195
+ const ETA_MAX_SAMPLE_INTERVAL_MILLIS = 10 * 60 * 1_000;
196
+ function withProgressEta(previous, current) {
197
+ const snapshot = { ...current };
198
+ const estimate = progressEta(previous, current);
199
+ if (estimate !== null) {
200
+ snapshot.estimated_remaining_time_millis = estimate;
201
+ }
202
+ return snapshot;
203
+ }
204
+ function progressEta(previous, current) {
205
+ if (previous === null ||
206
+ (current.state !== "running" && current.state !== "finished")) {
207
+ return null;
208
+ }
209
+ const remaining = integerValue(current.rows_remaining);
210
+ if (current.state === "finished") {
211
+ return remaining === 0 ? 0 : null;
212
+ }
213
+ if (current.paused === true ||
214
+ previous.paused === true ||
215
+ isTransitionalPhase(current.phase) ||
216
+ isTransitionalPhase(previous.phase)) {
217
+ return null;
218
+ }
219
+ const epoch = integerValue(current.execution_epoch);
220
+ const previousEpoch = integerValue(previous.execution_epoch);
221
+ if (epoch === null || previousEpoch !== epoch) {
222
+ return null;
223
+ }
224
+ const sampleAt = integerValue(current.sample_at_millis);
225
+ const previousAt = integerValue(previous.sample_at_millis);
226
+ if (sampleAt === null || previousAt === null) {
227
+ return null;
228
+ }
229
+ const elapsed = sampleAt - previousAt;
230
+ if (elapsed <= 0 ||
231
+ elapsed > ETA_MAX_SAMPLE_INTERVAL_MILLIS ||
232
+ Date.now() - sampleAt > ETA_MAX_SAMPLE_INTERVAL_MILLIS) {
233
+ return null;
234
+ }
235
+ const planned = integerValue(current.rows_planned);
236
+ const currentRemaining = integerValue(current.rows_remaining);
237
+ const previousRemaining = integerValue(previous.rows_remaining);
238
+ if (planned === null ||
239
+ currentRemaining === null ||
240
+ previousRemaining === null) {
241
+ return null;
242
+ }
243
+ if (currentRemaining === 0) {
244
+ return 0;
245
+ }
246
+ if (planned !== previous.rows_planned) {
247
+ return null;
248
+ }
249
+ if (current.fragments_planned !== previous.fragments_planned) {
250
+ return null;
251
+ }
252
+ const currentComputed = integerValue(current.rows_computed);
253
+ const previousComputed = integerValue(previous.rows_computed);
254
+ if (currentComputed === null || previousComputed === null) {
255
+ return null;
256
+ }
257
+ const currentAccounted = currentComputed + (integerValue(current.rows_skipped) ?? 0);
258
+ const previousAccounted = previousComputed + (integerValue(previous.rows_skipped) ?? 0);
259
+ const advanced = currentAccounted - previousAccounted;
260
+ if (advanced <= 0 || currentRemaining > previousRemaining) {
261
+ return null;
262
+ }
263
+ return Math.floor((currentRemaining * elapsed) / advanced);
264
+ }
265
+ function integerValue(value) {
266
+ return typeof value === "number" && Number.isInteger(value) ? value : null;
267
+ }
268
+ function isTransitionalPhase(phase) {
269
+ return (phase === "queued" ||
270
+ phase === "starting" ||
271
+ phase === "initializing" ||
272
+ phase === "paused");
273
+ }
159
274
  // biome-ignore lint/suspicious/noExplicitAny: shape varies by job type
160
275
  function indentJson(value) {
161
276
  return JSON.stringify(value, null, 4).replace(/\n/g, `\n${REPR_INDENT}`);
package/dist/native.d.ts CHANGED
@@ -186,8 +186,18 @@ export declare class Job {
186
186
  * client version does not know pass through as-is.
187
187
  */
188
188
  status(): Promise<string>
189
- /** Wait until the operation reaches a terminal state. */
190
- wait(): Promise<void>
189
+ /**
190
+ * The current structured progress snapshot, or null for an in-process
191
+ * operation. Registry snapshots include lifecycle and queue metadata even
192
+ * when the job type or server does not report counters.
193
+ */
194
+ progress(): Promise<Record<string, unknown> | null>
195
+ /**
196
+ * Wait until the operation reaches a terminal state. When a callback is
197
+ * supplied, observe the same progress snapshots fetched by the existing
198
+ * backend poller without starting another polling loop.
199
+ */
200
+ wait(progressCallback?: (progress: Record<string, unknown>) => void): Promise<void>
191
201
  /** Request cancellation. Cancelling a finished operation is a no-op. */
192
202
  cancel(): Promise<void>
193
203
  /**
@@ -528,6 +538,7 @@ export declare class VectorQuery {
528
538
  maximumNprobes(maximumNprobes: number): void
529
539
  distanceRange(lowerBound?: number | undefined | null, upperBound?: number | undefined | null): void
530
540
  ef(ef: number): void
541
+ approxMode(approxMode: string): void
531
542
  bypassVectorIndex(): void
532
543
  onlyIf(predicate: string): void
533
544
  fullTextSearch(query: object): void
@@ -905,56 +916,56 @@ export interface IndexConfig {
905
916
  /**
906
917
  * The UUID of the first segment of the index.
907
918
  *
908
- * `undefined` in LanceDB Distributed, which does not yet surface this.
919
+ * `undefined` in LanceDB Enterprise, which does not yet surface this.
909
920
  */
910
921
  indexUuid?: string
911
922
  /**
912
923
  * The protobuf type URL, a precise type identifier for the index.
913
924
  *
914
- * `undefined` in LanceDB Distributed.
925
+ * `undefined` in LanceDB Enterprise.
915
926
  */
916
927
  typeUrl?: string
917
928
  /**
918
929
  * When the index was created.
919
930
  *
920
- * `undefined` in LanceDB Distributed or indices created before timestamps were tracked.
931
+ * `undefined` in LanceDB Enterprise or indices created before timestamps were tracked.
921
932
  */
922
933
  createdAt?: Date
923
934
  /**
924
935
  * The number of rows indexed, across all segments.
925
936
  *
926
- * May be `undefined` in LanceDB Distributed if the server does not report it.
937
+ * May be `undefined` in LanceDB Enterprise if the server does not report it.
927
938
  */
928
939
  numIndexedRows?: number
929
940
  /**
930
941
  * The number of rows not yet covered by this index.
931
942
  *
932
- * May be `undefined` in LanceDB Distributed if the server does not report it.
943
+ * May be `undefined` in LanceDB Enterprise if the server does not report it.
933
944
  */
934
945
  numUnindexedRows?: number
935
946
  /**
936
947
  * The total size in bytes of all index files across all segments.
937
948
  *
938
- * `undefined` in LanceDB Distributed or indices without size tracking.
949
+ * `undefined` in LanceDB Enterprise or indices without size tracking.
939
950
  */
940
951
  sizeBytes?: number
941
952
  /**
942
953
  * The number of segments that make up the index.
943
954
  *
944
- * `undefined` in LanceDB Distributed.
955
+ * `undefined` in LanceDB Enterprise.
945
956
  */
946
957
  numSegments?: number
947
958
  /**
948
959
  * The on-disk index format version.
949
960
  *
950
- * `undefined` in LanceDB Distributed.
961
+ * `undefined` in LanceDB Enterprise.
951
962
  */
952
963
  indexVersion?: number
953
964
  /**
954
965
  * Index-type-specific details parsed as a JavaScript object.
955
966
  *
956
967
  * Falls back to a raw string if JSON parsing fails. `undefined` in
957
- * LanceDB Distributed or when details are unavailable.
968
+ * LanceDB Enterprise or when details are unavailable.
958
969
  */
959
970
  indexDetails?: any
960
971
  }
@@ -997,6 +1008,10 @@ export interface JobInfo {
997
1008
  state: string
998
1009
  /** When the job was created, in milliseconds since the epoch. */
999
1010
  createdAtMillis: number
1011
+ /** Structured lifecycle, queue, pause, and job-type-specific progress. */
1012
+ progress: Record<string, unknown>
1013
+ /** Whether an operator has parked this job. */
1014
+ paused: boolean
1000
1015
  }
1001
1016
 
1002
1017
  /** The catalog of described LanceDB metrics. Empty until the recorder is installed. */
@@ -1149,11 +1164,11 @@ export interface RefreshColumnResult {
1149
1164
  }
1150
1165
 
1151
1166
  export interface RefreshMaterializedViewResult {
1152
- /** How the view was brought up to date: "rebuild", or absent for LanceDB Distributed SQL refreshes. */
1167
+ /** How the view was brought up to date: "rebuild", or absent for LanceDB Enterprise SQL refreshes. */
1153
1168
  mode?: string
1154
- /** Rows written by this refresh, or absent for LanceDB Distributed SQL refreshes. */
1169
+ /** Rows written by this refresh, or absent for LanceDB Enterprise SQL refreshes. */
1155
1170
  rowsWritten?: number
1156
- /** Source version refreshed to, or absent for LanceDB Distributed SQL refreshes. */
1171
+ /** Source version refreshed to, or absent for LanceDB Enterprise SQL refreshes. */
1157
1172
  sourceVersion?: number
1158
1173
  version: number
1159
1174
  }
package/dist/native.js CHANGED
@@ -76,8 +76,8 @@ function requireNative() {
76
76
  try {
77
77
  const binding = require('@lancedb/lancedb-android-arm64');
78
78
  const bindingPackageVersion = require('@lancedb/lancedb-android-arm64/package.json').version;
79
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
80
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
79
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
80
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
81
81
  }
82
82
  return binding;
83
83
  }
@@ -95,8 +95,8 @@ function requireNative() {
95
95
  try {
96
96
  const binding = require('@lancedb/lancedb-android-arm-eabi');
97
97
  const bindingPackageVersion = require('@lancedb/lancedb-android-arm-eabi/package.json').version;
98
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
99
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
98
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
99
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
100
100
  }
101
101
  return binding;
102
102
  }
@@ -120,8 +120,8 @@ function requireNative() {
120
120
  try {
121
121
  const binding = require('@lancedb/lancedb-win32-x64-gnu');
122
122
  const bindingPackageVersion = require('@lancedb/lancedb-win32-x64-gnu/package.json').version;
123
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
124
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
123
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
124
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
125
125
  }
126
126
  return binding;
127
127
  }
@@ -139,8 +139,8 @@ function requireNative() {
139
139
  try {
140
140
  const binding = require('@lancedb/lancedb-win32-x64-msvc');
141
141
  const bindingPackageVersion = require('@lancedb/lancedb-win32-x64-msvc/package.json').version;
142
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
143
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
142
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
143
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
144
144
  }
145
145
  return binding;
146
146
  }
@@ -159,8 +159,8 @@ function requireNative() {
159
159
  try {
160
160
  const binding = require('@lancedb/lancedb-win32-ia32-msvc');
161
161
  const bindingPackageVersion = require('@lancedb/lancedb-win32-ia32-msvc/package.json').version;
162
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
163
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
162
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
163
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
164
164
  }
165
165
  return binding;
166
166
  }
@@ -178,8 +178,8 @@ function requireNative() {
178
178
  try {
179
179
  const binding = require('@lancedb/lancedb-win32-arm64-msvc');
180
180
  const bindingPackageVersion = require('@lancedb/lancedb-win32-arm64-msvc/package.json').version;
181
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
182
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
181
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
182
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
183
183
  }
184
184
  return binding;
185
185
  }
@@ -201,8 +201,8 @@ function requireNative() {
201
201
  try {
202
202
  const binding = require('@lancedb/lancedb-darwin-universal');
203
203
  const bindingPackageVersion = require('@lancedb/lancedb-darwin-universal/package.json').version;
204
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
205
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
204
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
205
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
206
206
  }
207
207
  return binding;
208
208
  }
@@ -219,8 +219,8 @@ function requireNative() {
219
219
  try {
220
220
  const binding = require('@lancedb/lancedb-darwin-x64');
221
221
  const bindingPackageVersion = require('@lancedb/lancedb-darwin-x64/package.json').version;
222
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
223
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
222
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
223
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
224
224
  }
225
225
  return binding;
226
226
  }
@@ -238,8 +238,8 @@ function requireNative() {
238
238
  try {
239
239
  const binding = require('@lancedb/lancedb-darwin-arm64');
240
240
  const bindingPackageVersion = require('@lancedb/lancedb-darwin-arm64/package.json').version;
241
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
242
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
241
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
242
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
243
243
  }
244
244
  return binding;
245
245
  }
@@ -262,8 +262,8 @@ function requireNative() {
262
262
  try {
263
263
  const binding = require('@lancedb/lancedb-freebsd-x64');
264
264
  const bindingPackageVersion = require('@lancedb/lancedb-freebsd-x64/package.json').version;
265
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
266
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
265
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
266
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
267
267
  }
268
268
  return binding;
269
269
  }
@@ -281,8 +281,8 @@ function requireNative() {
281
281
  try {
282
282
  const binding = require('@lancedb/lancedb-freebsd-arm64');
283
283
  const bindingPackageVersion = require('@lancedb/lancedb-freebsd-arm64/package.json').version;
284
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
285
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
284
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
285
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
286
286
  }
287
287
  return binding;
288
288
  }
@@ -306,8 +306,8 @@ function requireNative() {
306
306
  try {
307
307
  const binding = require('@lancedb/lancedb-linux-x64-musl');
308
308
  const bindingPackageVersion = require('@lancedb/lancedb-linux-x64-musl/package.json').version;
309
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
310
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
309
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
310
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
311
311
  }
312
312
  return binding;
313
313
  }
@@ -325,8 +325,8 @@ function requireNative() {
325
325
  try {
326
326
  const binding = require('@lancedb/lancedb-linux-x64-gnu');
327
327
  const bindingPackageVersion = require('@lancedb/lancedb-linux-x64-gnu/package.json').version;
328
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
329
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
328
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
329
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
330
330
  }
331
331
  return binding;
332
332
  }
@@ -346,8 +346,8 @@ function requireNative() {
346
346
  try {
347
347
  const binding = require('@lancedb/lancedb-linux-arm64-musl');
348
348
  const bindingPackageVersion = require('@lancedb/lancedb-linux-arm64-musl/package.json').version;
349
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
350
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
349
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
350
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
351
351
  }
352
352
  return binding;
353
353
  }
@@ -365,8 +365,8 @@ function requireNative() {
365
365
  try {
366
366
  const binding = require('@lancedb/lancedb-linux-arm64-gnu');
367
367
  const bindingPackageVersion = require('@lancedb/lancedb-linux-arm64-gnu/package.json').version;
368
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
369
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
368
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
369
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
370
370
  }
371
371
  return binding;
372
372
  }
@@ -386,8 +386,8 @@ function requireNative() {
386
386
  try {
387
387
  const binding = require('@lancedb/lancedb-linux-arm-musleabihf');
388
388
  const bindingPackageVersion = require('@lancedb/lancedb-linux-arm-musleabihf/package.json').version;
389
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
390
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
389
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
390
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
391
391
  }
392
392
  return binding;
393
393
  }
@@ -405,8 +405,8 @@ function requireNative() {
405
405
  try {
406
406
  const binding = require('@lancedb/lancedb-linux-arm-gnueabihf');
407
407
  const bindingPackageVersion = require('@lancedb/lancedb-linux-arm-gnueabihf/package.json').version;
408
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
409
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
408
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
409
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
410
410
  }
411
411
  return binding;
412
412
  }
@@ -426,8 +426,8 @@ function requireNative() {
426
426
  try {
427
427
  const binding = require('@lancedb/lancedb-linux-loong64-musl');
428
428
  const bindingPackageVersion = require('@lancedb/lancedb-linux-loong64-musl/package.json').version;
429
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
430
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
429
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
430
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
431
431
  }
432
432
  return binding;
433
433
  }
@@ -445,8 +445,8 @@ function requireNative() {
445
445
  try {
446
446
  const binding = require('@lancedb/lancedb-linux-loong64-gnu');
447
447
  const bindingPackageVersion = require('@lancedb/lancedb-linux-loong64-gnu/package.json').version;
448
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
449
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
448
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
449
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
450
450
  }
451
451
  return binding;
452
452
  }
@@ -466,8 +466,8 @@ function requireNative() {
466
466
  try {
467
467
  const binding = require('@lancedb/lancedb-linux-riscv64-musl');
468
468
  const bindingPackageVersion = require('@lancedb/lancedb-linux-riscv64-musl/package.json').version;
469
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
470
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
469
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
470
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
471
471
  }
472
472
  return binding;
473
473
  }
@@ -485,8 +485,8 @@ function requireNative() {
485
485
  try {
486
486
  const binding = require('@lancedb/lancedb-linux-riscv64-gnu');
487
487
  const bindingPackageVersion = require('@lancedb/lancedb-linux-riscv64-gnu/package.json').version;
488
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
489
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
488
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
489
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
490
490
  }
491
491
  return binding;
492
492
  }
@@ -505,8 +505,8 @@ function requireNative() {
505
505
  try {
506
506
  const binding = require('@lancedb/lancedb-linux-ppc64-gnu');
507
507
  const bindingPackageVersion = require('@lancedb/lancedb-linux-ppc64-gnu/package.json').version;
508
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
509
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
508
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
509
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
510
510
  }
511
511
  return binding;
512
512
  }
@@ -524,8 +524,8 @@ function requireNative() {
524
524
  try {
525
525
  const binding = require('@lancedb/lancedb-linux-s390x-gnu');
526
526
  const bindingPackageVersion = require('@lancedb/lancedb-linux-s390x-gnu/package.json').version;
527
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
528
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
527
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
528
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
529
529
  }
530
530
  return binding;
531
531
  }
@@ -548,8 +548,8 @@ function requireNative() {
548
548
  try {
549
549
  const binding = require('@lancedb/lancedb-openharmony-arm64');
550
550
  const bindingPackageVersion = require('@lancedb/lancedb-openharmony-arm64/package.json').version;
551
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
552
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
551
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
552
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
553
553
  }
554
554
  return binding;
555
555
  }
@@ -567,8 +567,8 @@ function requireNative() {
567
567
  try {
568
568
  const binding = require('@lancedb/lancedb-openharmony-x64');
569
569
  const bindingPackageVersion = require('@lancedb/lancedb-openharmony-x64/package.json').version;
570
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
571
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
570
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
571
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
572
572
  }
573
573
  return binding;
574
574
  }
@@ -586,8 +586,8 @@ function requireNative() {
586
586
  try {
587
587
  const binding = require('@lancedb/lancedb-openharmony-arm');
588
588
  const bindingPackageVersion = require('@lancedb/lancedb-openharmony-arm/package.json').version;
589
- if (bindingPackageVersion !== '0.42.0-beta.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
590
- throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
589
+ if (bindingPackageVersion !== '0.42.0-beta.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
590
+ throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`);
591
591
  }
592
592
  return binding;
593
593
  }
package/dist/query.d.ts CHANGED
@@ -409,6 +409,23 @@ export declare class VectorQuery extends StandardQueryBase<NativeVectorQuery> {
409
409
  * also increase the latency of your query. The default value is 1.5*limit.
410
410
  */
411
411
  ef(ef: number): VectorQuery;
412
+ /**
413
+ * Set the speed / accuracy tradeoff to use for approximate search
414
+ *
415
+ * This currently affects RQ-quantized indexes, such as IVF_RQ, and
416
+ * prefiltered search on HNSW indexes, where "fast" enables the ACORN
417
+ * traversal. Other index types ignore this setting.
418
+ *
419
+ * "fast" favors lower latency and may reduce recall, "normal" (the default)
420
+ * uses the index's default balance, and "accurate" favors higher recall and
421
+ * may increase latency.
422
+ *
423
+ * @example
424
+ * ```ts
425
+ * table.vectorSearch([0.1, 0.2]).approxMode("fast").limit(10);
426
+ * ```
427
+ */
428
+ approxMode(approxMode: "fast" | "normal" | "accurate"): VectorQuery;
412
429
  /**
413
430
  * Set the vector column to query
414
431
  *
package/dist/query.js CHANGED
@@ -666,6 +666,26 @@ class VectorQuery extends StandardQueryBase {
666
666
  this.doVectorCall((inner) => inner.ef(ef));
667
667
  return this;
668
668
  }
669
+ /**
670
+ * Set the speed / accuracy tradeoff to use for approximate search
671
+ *
672
+ * This currently affects RQ-quantized indexes, such as IVF_RQ, and
673
+ * prefiltered search on HNSW indexes, where "fast" enables the ACORN
674
+ * traversal. Other index types ignore this setting.
675
+ *
676
+ * "fast" favors lower latency and may reduce recall, "normal" (the default)
677
+ * uses the index's default balance, and "accurate" favors higher recall and
678
+ * may increase latency.
679
+ *
680
+ * @example
681
+ * ```ts
682
+ * table.vectorSearch([0.1, 0.2]).approxMode("fast").limit(10);
683
+ * ```
684
+ */
685
+ approxMode(approxMode) {
686
+ super.doCall((inner) => inner.approxMode(approxMode));
687
+ return this;
688
+ }
669
689
  /**
670
690
  * Set the vector column to query
671
691
  *
package/dist/table.d.ts CHANGED
@@ -69,7 +69,7 @@ export interface AddDataOptions {
69
69
  * Whether blob URIs outside registered external bases may be written.
70
70
  *
71
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
72
+ * LanceDB Enterprise 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.
@@ -281,6 +281,24 @@ export declare abstract class Table {
281
281
  * We currently don't support custom named indexes.
282
282
  * The index name will always be `${column}_idx`.
283
283
  *
284
+ * On LanceDB Embedded tables the index is built before the returned promise
285
+ * resolves. On LanceDB Enterprise tables it resolves once the build is
286
+ * scheduled. Until the build finishes, a vector index may be missing from
287
+ * {@link Table.listIndices}, a scalar or FTS index may be listed with 0
288
+ * indexed rows, and queries won't use the index. To wait until the index is
289
+ * ready, set {@link IndexOptions.waitTimeoutSeconds}, call
290
+ * {@link Table.waitForIndex}, or use {@link Table.createIndexAsync} and wait
291
+ * on its job when the server returned a job ID.
292
+ *
293
+ * `waitTimeoutSeconds` waits for the submitted build when the server returns
294
+ * a job ID. On older servers that don't return one, it falls back to polling
295
+ * the index by name. {@link Table.waitForIndex} always waits by name. When
296
+ * replacing an existing index, those name-based waits may return before the
297
+ * new build finishes because the old index can still match.
298
+ * `createIndexAsync` can track a specific build only when the server returned
299
+ * a job ID; otherwise it returns an already-complete job and callers must
300
+ * use {@link Table.waitForIndex} for that build.
301
+ *
284
302
  * @example
285
303
  * // If the column has a vector (fixed size list) data type then
286
304
  * // an IvfPq vector index will be created.
@@ -311,6 +329,11 @@ export declare abstract class Table {
311
329
  *
312
330
  * The job may already be complete when returned; callers must not assume
313
331
  * the index exists until {@link Job.wait} resolves.
332
+ *
333
+ * In LanceDB Enterprise, the returned job tracks this submission only if the
334
+ * server returns a job ID. If it does not, the job is already complete and
335
+ * does not wait for the background build; use {@link Table.waitForIndex} and
336
+ * account for the replacement caveat described in {@link Table.createIndex}.
314
337
  */
315
338
  abstract createIndexAsync(column: string, options?: Partial<IndexOptions>): Promise<Job>;
316
339
  /**
@@ -349,7 +372,7 @@ export declare abstract class Table {
349
372
  * Large columns (e.g. high-dimensional vectors or binary data) may not be
350
373
  * practical to prewarm.
351
374
  *
352
- * This feature is currently only supported in LanceDB Distributed.
375
+ * This feature is currently only supported in LanceDB Enterprise.
353
376
  */
354
377
  abstract prewarmData(columns?: string[]): Promise<void>;
355
378
  /**
@@ -484,7 +507,7 @@ export declare abstract class Table {
484
507
  *
485
508
  * LanceDB Embedded computed-column declaration and refresh require a source
486
509
  * build with the `experimental-functions` Cargo feature. Published packages
487
- * disable it; LanceDB Distributed operations remain available.
510
+ * disable it; LanceDB Enterprise operations remain available.
488
511
  *
489
512
  * The `{ computed }` form stores the expression rather than evaluating it
490
513
  * now: the column is committed with no values, and rows get them from
@@ -496,7 +519,7 @@ export declare abstract class Table {
496
519
  * declaration reads a column, that column cannot be renamed, retyped or
497
520
  * dropped.
498
521
  *
499
- * In LanceDB Distributed the expression is planned by the
522
+ * In LanceDB Enterprise the expression is planned by the
500
523
  * server, and the refresh runs as a server job -- see
501
524
  * {@link Table#refreshColumnAsync}.
502
525
  * @param {AddColumnsSql[] | Field | Field[] | Schema} newColumnTransforms Either:
@@ -523,7 +546,7 @@ export declare abstract class Table {
523
546
  * Rows appended since the last refresh are filled by the next one, and
524
547
  * rows whose inputs changed since they were computed are recomputed;
525
548
  * 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}.
549
+ * Enterprise a refresh runs as a server job, through {@link Table#refreshColumnAsync}.
527
550
  * @param {string} column The name of the computed column to fill.
528
551
  * @returns {Promise<RefreshColumnResult>} A promise that resolves to the
529
552
  * number of rows filled and the new version number of the table.
@@ -533,14 +556,14 @@ export declare abstract class Table {
533
556
  * Like {@link Table#refreshColumn}, but returns a handle to the refresh
534
557
  * job instead of blocking until it completes.
535
558
  * LanceDB Embedded refresh requires a source build with
536
- * `experimental-functions`. LanceDB Distributed jobs do not require this
559
+ * `experimental-functions`. LanceDB Enterprise jobs do not require this
537
560
  * feature.
538
561
  *
539
562
  * The job may already be complete when returned; callers must not assume
540
563
  * the column is filled until {@link Job.wait} resolves. Invalid input --
541
564
  * an unknown column, or one that is not computed -- rejects here rather
542
565
  * than failing the job. In LanceDB Embedded the job runs in-process; in
543
- * LanceDB Distributed it is the server's backfill job.
566
+ * LanceDB Enterprise it is the server's backfill job.
544
567
  * @param {string} column The name of the computed column to fill.
545
568
  * @example
546
569
  * ```ts
@@ -556,7 +579,7 @@ export declare abstract class Table {
556
579
  * A refresh running under a skip policy records each row it skipped with
557
580
  * the input that failed and the error. This lists those records, newest
558
581
  * job first, plus a summary for any fragment whose per-row detail was
559
- * capped. LanceDB Distributed only; reading errors needs read
582
+ * capped. LanceDB Enterprise only; reading errors needs read
560
583
  * access to the table, since a message carries the value that failed.
561
584
  * @param {FunctionErrorsOptions} options Optional filters: `jobId`,
562
585
  * `column`, and `limit` (server default 10000, cap 100000).
@@ -580,6 +603,9 @@ export declare abstract class Table {
580
603
  abstract materializedViewDefinition(): Promise<string>;
581
604
  /**
582
605
  * Alter the name or nullability of columns.
606
+ *
607
+ * Local tables reject renaming source or vector columns referenced by
608
+ * `embedding_functions` schema metadata, preserving the embedding binding.
583
609
  * @param {ColumnAlteration[]} columnAlterations One or more alterations to
584
610
  * apply to columns.
585
611
  * @returns {Promise<AlterColumnsResult>} A promise that resolves to an object
@@ -611,6 +637,9 @@ export declare abstract class Table {
611
637
  * underlying storage. In order to remove the data, you must subsequently
612
638
  * call ``compact_files`` to rewrite the data without the removed columns and
613
639
  * then call ``cleanup_files`` to remove the old files.
640
+ *
641
+ * Local tables reject dropping source or vector columns referenced by
642
+ * `embedding_functions` schema metadata, preserving the embedding binding.
614
643
  * @param {string[]} columnNames The names of the columns to drop. These can
615
644
  * be nested column references (e.g. "a.b.c") or top-level column names
616
645
  * (e.g. "a").
@@ -844,7 +873,14 @@ export declare abstract class Table {
844
873
  * modification operations.
845
874
  */
846
875
  abstract optimize(options?: Partial<OptimizeOptions>): Promise<OptimizeStats>;
847
- /** List all indices that have been created with {@link Table.createIndex} */
876
+ /**
877
+ * List all indices that have been created with {@link Table.createIndex}
878
+ *
879
+ * On LanceDB Enterprise tables, an index whose build hasn't finished may be
880
+ * missing (vector indices) or listed with 0 indexed rows (scalar and FTS
881
+ * indices), and `numUnindexedRows` may be undefined. Use
882
+ * {@link Table.waitForIndex} to wait until an index is ready.
883
+ */
848
884
  abstract listIndices(): Promise<IndexConfig[]>;
849
885
  /**
850
886
  * Tokenize a full-text search query using the tokenizer configured on an FTS index.
@@ -852,7 +888,7 @@ export declare abstract class Table {
852
888
  * Specify exactly one of `column` or `indexName`.
853
889
  *
854
890
  * Model-backed tokenizers such as `jieba/*` and `lindera/*` are rebuilt in
855
- * the client process from index metadata. In LanceDB Distributed, this means the
891
+ * the client process from index metadata. In LanceDB Enterprise, this means the
856
892
  * same tokenizer model files must also exist locally (under
857
893
  * `LANCE_LANGUAGE_MODEL_HOME`) and must match the files the server uses. A
858
894
  * 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.42.0-beta.0",
14
+ "version": "0.42.0-beta.1",
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.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"
114
+ "@lancedb/lancedb-darwin-arm64": "0.42.0-beta.1",
115
+ "@lancedb/lancedb-linux-x64-gnu": "0.42.0-beta.1",
116
+ "@lancedb/lancedb-linux-arm64-gnu": "0.42.0-beta.1",
117
+ "@lancedb/lancedb-linux-x64-musl": "0.42.0-beta.1",
118
+ "@lancedb/lancedb-linux-arm64-musl": "0.42.0-beta.1",
119
+ "@lancedb/lancedb-win32-x64-msvc": "0.42.0-beta.1",
120
+ "@lancedb/lancedb-win32-arm64-msvc": "0.42.0-beta.1"
121
121
  },
122
122
  "peerDependencies": {
123
123
  "@types/node": ">=22",