@lancedb/lancedb 0.42.0-beta.0 → 0.42.0-beta.10
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/arrow.js +3 -1
- package/dist/blob.d.ts +1 -1
- package/dist/connection.d.ts +2 -2
- package/dist/index.d.ts +4 -3
- package/dist/indices.d.ts +4 -1
- package/dist/job.d.ts +53 -2
- package/dist/job.js +118 -3
- package/dist/native.d.ts +83 -17
- package/dist/native.js +52 -52
- package/dist/query.d.ts +25 -0
- package/dist/query.js +25 -0
- package/dist/table.d.ts +99 -16
- package/dist/table.js +18 -5
- package/package.json +9 -9
- package/pnpm-workspace.yaml +0 -7
package/dist/arrow.js
CHANGED
|
@@ -1070,7 +1070,9 @@ async function fromBufferToRecordBatch(data) {
|
|
|
1070
1070
|
* Create a buffer containing a single record batch
|
|
1071
1071
|
*/
|
|
1072
1072
|
async function fromRecordBatchToBuffer(batch) {
|
|
1073
|
-
|
|
1073
|
+
// Arrow writers require data types from their own library instance.
|
|
1074
|
+
const table = (0, sanitize_1.sanitizeTable)({ schema: batch.schema, batches: [batch] });
|
|
1075
|
+
const writer = new apache_arrow_1.RecordBatchFileWriter().writeAll(table);
|
|
1074
1076
|
return Buffer.from(await writer.toUint8Array());
|
|
1075
1077
|
}
|
|
1076
1078
|
/**
|
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
|
|
176
|
+
* read stops, including in-flight requests to a LanceDB Enterprise table.
|
|
177
177
|
*/
|
|
178
178
|
signal?: AbortSignal;
|
|
179
179
|
};
|
package/dist/connection.d.ts
CHANGED
|
@@ -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
|
|
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
|
|
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
|
@@ -7,16 +7,17 @@ export { MaterializedView, MaterializedViewDefinition, MaterializedViewSelect, }
|
|
|
7
7
|
export { ViewDescription } from "./view";
|
|
8
8
|
export { JsHeaderProvider as NativeJsHeaderProvider } from "./native.js";
|
|
9
9
|
export { instrumentLanceDbMetrics } from "./otel";
|
|
10
|
-
export { AddColumnsSql, ConnectionOptions, ConnectNamespaceOptions, IndexStatistics, IndexConfig, ClientConfig, TimeoutConfig, RetryConfig, TlsConfig, OptimizeStats, CompactionStats, RemovalStats, TableStatistics, FragmentStatistics, FragmentSummaryStats, Tags, TagContents, BranchContents, MergeResult, AddResult, AddColumnsResult, RefreshColumnResult, FunctionErrors, FunctionErrorsOptions, FunctionErrorRecord, FunctionErrorFragment, RefreshMaterializedViewResult, AlterColumnsResult, UpdateFieldMetadataResult, DeleteResult, DropColumnsResult, UpdateResult, SplitCalculatedOptions, SplitRandomOptions, SplitHashOptions, SplitSequentialOptions, ShuffleOptions, OAuthConfig as NativeOAuthConfig, } from "./native.js";
|
|
10
|
+
export { AddColumnsSql, ConnectionOptions, ConnectNamespaceOptions, IndexStatistics, IndexConfig, ClientConfig, TimeoutConfig, RetryConfig, TlsConfig, OptimizeStats, CompactionStats, RemovalStats, TableStatistics, FragmentStatistics, FragmentSummaryStats, Tags, TagContents, BranchContents, MergeResult, AddResult, AddColumnsResult, RefreshColumnOptions, RefreshColumnResult, FunctionErrors, FunctionErrorsOptions, FunctionErrorRecord, FunctionErrorFragment, RefreshMaterializedViewResult, AlterColumnsResult, UpdateFieldMetadataResult, DeleteResult, DropColumnsResult, UpdateResult, SplitCalculatedOptions, SplitRandomOptions, SplitHashOptions, SplitSequentialOptions, ShuffleOptions, OAuthConfig as NativeOAuthConfig, } from "./native.js";
|
|
11
11
|
export { makeArrowTable, makeJsonField, MakeArrowTableOptions, Data, VectorColumnOptions, } from "./arrow";
|
|
12
12
|
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
|
-
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";
|
|
20
|
+
export { Table, Branches, BranchColumnSummary, BranchColumnChange, BranchIndexSummary, BranchRowCountSummary, CherryPickError, BranchDiff, CherryPickPreview, CherryPickResult, AddDataOptions, UpdateOptions, OptimizeOptions, CompactionOptions, Version, WriteProgress, FtsToken, TokenizeTableOptions, RTEWriteSpec, RTEStats, TableShardStats, SsTableStats, MemtableStats, ColumnAlteration, FieldMetadataUpdate, } from "./table";
|
|
20
21
|
export { HeaderProvider, StaticHeaderProvider, OAuthHeaderProvider, TokenResponse, } from "./header";
|
|
21
22
|
export { ClientAuthMethod, OAuthConfig, OAuthFlowType, OAuthSession, SessionLogout, SessionStatus, TokenCacheOptions, } from "./oauth";
|
|
22
23
|
export { MergeInsertBuilder, WriteExecutionOptions } from "./merge";
|
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
|
-
*
|
|
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
|
-
/**
|
|
67
|
-
|
|
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
|
-
/**
|
|
84
|
-
|
|
85
|
-
|
|
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
|
-
/**
|
|
190
|
-
|
|
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
|
/**
|
|
@@ -453,8 +463,8 @@ export declare class Table {
|
|
|
453
463
|
vectorSearch(vector: Float32Array): VectorQuery
|
|
454
464
|
addColumns(transforms: Array<AddColumnsSql>): Promise<AddColumnsResult>
|
|
455
465
|
addComputedColumns(columns: Array<AddColumnsSql>): Promise<AddColumnsResult>
|
|
456
|
-
refreshColumn(column: string): Promise<RefreshColumnResult>
|
|
457
|
-
refreshColumnAsync(column: string): Promise<Job>
|
|
466
|
+
refreshColumn(column: string, options?: RefreshColumnOptions | undefined | null): Promise<RefreshColumnResult>
|
|
467
|
+
refreshColumnAsync(column: string, options?: RefreshColumnOptions | undefined | null): Promise<Job>
|
|
458
468
|
functionErrors(options?: FunctionErrorsOptions | undefined | null): Promise<FunctionErrors>
|
|
459
469
|
refreshMaterializedView(sourceVersion?: number | undefined | null, full?: boolean | undefined | null): Promise<RefreshMaterializedViewResult>
|
|
460
470
|
materializedViewDefinition(): Promise<string>
|
|
@@ -482,7 +492,7 @@ export declare class Table {
|
|
|
482
492
|
branches(): Promise<Branches>
|
|
483
493
|
/** The branch this handle is scoped to, or `null` for the main branch. */
|
|
484
494
|
currentBranch(): string | null
|
|
485
|
-
optimize(beforeTimestampMs?: number | undefined | null, deleteUnverified?: boolean | undefined | null): Promise<OptimizeStats>
|
|
495
|
+
optimize(beforeTimestampMs?: number | undefined | null, deleteUnverified?: boolean | undefined | null, compactionOptions?: CompactionOptions | undefined | null): Promise<OptimizeStats>
|
|
486
496
|
listIndices(): Promise<Array<IndexConfig>>
|
|
487
497
|
tokenize(query: string, column?: string | undefined | null, indexName?: string | undefined | null): Promise<Array<FtsToken>>
|
|
488
498
|
indexStats(indexName: string): Promise<IndexStatistics | null>
|
|
@@ -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
|
|
@@ -661,6 +672,14 @@ export interface ColumnOrdering {
|
|
|
661
672
|
columnName: string
|
|
662
673
|
}
|
|
663
674
|
|
|
675
|
+
/** Per-invocation file-compaction settings. All numbers must be safe integers. */
|
|
676
|
+
export interface CompactionOptions {
|
|
677
|
+
targetRowsPerFragment?: number
|
|
678
|
+
maxSourceRows?: number
|
|
679
|
+
ioBufferSize?: number
|
|
680
|
+
batchSize?: number
|
|
681
|
+
}
|
|
682
|
+
|
|
664
683
|
/** Statistics about a compaction operation. */
|
|
665
684
|
export interface CompactionStats {
|
|
666
685
|
/** The number of fragments removed */
|
|
@@ -866,6 +885,8 @@ export interface FunctionErrorRecord {
|
|
|
866
885
|
tableVersion: number
|
|
867
886
|
errorType: string
|
|
868
887
|
errorMessage: string
|
|
888
|
+
/** User-code traceback, possibly truncated by the server. */
|
|
889
|
+
traceback?: string
|
|
869
890
|
createdAtMillis: number
|
|
870
891
|
}
|
|
871
892
|
|
|
@@ -905,56 +926,56 @@ export interface IndexConfig {
|
|
|
905
926
|
/**
|
|
906
927
|
* The UUID of the first segment of the index.
|
|
907
928
|
*
|
|
908
|
-
* `undefined` in LanceDB
|
|
929
|
+
* `undefined` in LanceDB Enterprise, which does not yet surface this.
|
|
909
930
|
*/
|
|
910
931
|
indexUuid?: string
|
|
911
932
|
/**
|
|
912
933
|
* The protobuf type URL, a precise type identifier for the index.
|
|
913
934
|
*
|
|
914
|
-
* `undefined` in LanceDB
|
|
935
|
+
* `undefined` in LanceDB Enterprise.
|
|
915
936
|
*/
|
|
916
937
|
typeUrl?: string
|
|
917
938
|
/**
|
|
918
939
|
* When the index was created.
|
|
919
940
|
*
|
|
920
|
-
* `undefined` in LanceDB
|
|
941
|
+
* `undefined` in LanceDB Enterprise or indices created before timestamps were tracked.
|
|
921
942
|
*/
|
|
922
943
|
createdAt?: Date
|
|
923
944
|
/**
|
|
924
945
|
* The number of rows indexed, across all segments.
|
|
925
946
|
*
|
|
926
|
-
* May be `undefined` in LanceDB
|
|
947
|
+
* May be `undefined` in LanceDB Enterprise if the server does not report it.
|
|
927
948
|
*/
|
|
928
949
|
numIndexedRows?: number
|
|
929
950
|
/**
|
|
930
951
|
* The number of rows not yet covered by this index.
|
|
931
952
|
*
|
|
932
|
-
* May be `undefined` in LanceDB
|
|
953
|
+
* May be `undefined` in LanceDB Enterprise if the server does not report it.
|
|
933
954
|
*/
|
|
934
955
|
numUnindexedRows?: number
|
|
935
956
|
/**
|
|
936
957
|
* The total size in bytes of all index files across all segments.
|
|
937
958
|
*
|
|
938
|
-
* `undefined` in LanceDB
|
|
959
|
+
* `undefined` in LanceDB Enterprise or indices without size tracking.
|
|
939
960
|
*/
|
|
940
961
|
sizeBytes?: number
|
|
941
962
|
/**
|
|
942
963
|
* The number of segments that make up the index.
|
|
943
964
|
*
|
|
944
|
-
* `undefined` in LanceDB
|
|
965
|
+
* `undefined` in LanceDB Enterprise.
|
|
945
966
|
*/
|
|
946
967
|
numSegments?: number
|
|
947
968
|
/**
|
|
948
969
|
* The on-disk index format version.
|
|
949
970
|
*
|
|
950
|
-
* `undefined` in LanceDB
|
|
971
|
+
* `undefined` in LanceDB Enterprise.
|
|
951
972
|
*/
|
|
952
973
|
indexVersion?: number
|
|
953
974
|
/**
|
|
954
975
|
* Index-type-specific details parsed as a JavaScript object.
|
|
955
976
|
*
|
|
956
977
|
* Falls back to a raw string if JSON parsing fails. `undefined` in
|
|
957
|
-
* LanceDB
|
|
978
|
+
* LanceDB Enterprise or when details are unavailable.
|
|
958
979
|
*/
|
|
959
980
|
indexDetails?: any
|
|
960
981
|
}
|
|
@@ -980,6 +1001,8 @@ export interface IndexStatistics {
|
|
|
980
1001
|
export interface JobFailureInfo {
|
|
981
1002
|
phase?: string
|
|
982
1003
|
message?: string
|
|
1004
|
+
/** User-code traceback, possibly truncated by the server. */
|
|
1005
|
+
traceback?: string
|
|
983
1006
|
retryable?: boolean
|
|
984
1007
|
}
|
|
985
1008
|
|
|
@@ -997,6 +1020,10 @@ export interface JobInfo {
|
|
|
997
1020
|
state: string
|
|
998
1021
|
/** When the job was created, in milliseconds since the epoch. */
|
|
999
1022
|
createdAtMillis: number
|
|
1023
|
+
/** Structured lifecycle, queue, pause, and job-type-specific progress. */
|
|
1024
|
+
progress: Record<string, unknown>
|
|
1025
|
+
/** Whether an operator has parked this job. */
|
|
1026
|
+
paused: boolean
|
|
1000
1027
|
}
|
|
1001
1028
|
|
|
1002
1029
|
/** The catalog of described LanceDB metrics. Empty until the recorder is installed. */
|
|
@@ -1143,17 +1170,56 @@ export interface OptimizeStats {
|
|
|
1143
1170
|
/** Create a permutation builder for the given table */
|
|
1144
1171
|
export declare function permutationBuilder(table: Table): PermutationBuilder
|
|
1145
1172
|
|
|
1173
|
+
/**
|
|
1174
|
+
* Options for `Table.refreshColumn` and `Table.refreshColumnAsync`. Every
|
|
1175
|
+
* option is LanceDB Enterprise only; a LanceDB Embedded refresh ignores
|
|
1176
|
+
* `batchSize`, `gpuClass` and `gpuCount` and rejects the rest.
|
|
1177
|
+
*/
|
|
1178
|
+
export interface RefreshColumnOptions {
|
|
1179
|
+
/** Only refresh the rows matching this SQL filter. */
|
|
1180
|
+
where?: string
|
|
1181
|
+
/** Maximum rows per Function call; must be greater than zero. */
|
|
1182
|
+
batchSize?: number
|
|
1183
|
+
/** GPU class for Function workers. */
|
|
1184
|
+
gpuClass?: string
|
|
1185
|
+
/** Positive aggregate GPU budget for Function workers. */
|
|
1186
|
+
gpuCount?: number
|
|
1187
|
+
/**
|
|
1188
|
+
* `"fail"` (default) stops on a row error; `"skip"` writes null and
|
|
1189
|
+
* records the error, subject to the failure limits.
|
|
1190
|
+
*/
|
|
1191
|
+
errorPolicy?: string
|
|
1192
|
+
/**
|
|
1193
|
+
* Under a skip policy, fail the job once more than this share of rows
|
|
1194
|
+
* (0 to 1) has failed.
|
|
1195
|
+
*/
|
|
1196
|
+
maxFailedFraction?: number
|
|
1197
|
+
/**
|
|
1198
|
+
* Under a skip policy, fail the job once more than this many rows have
|
|
1199
|
+
* failed.
|
|
1200
|
+
*/
|
|
1201
|
+
maxFailedRows?: number
|
|
1202
|
+
/** Deadline for one Function call, in seconds. */
|
|
1203
|
+
rowTimeoutSeconds?: number
|
|
1204
|
+
/** Deadline for Function initialization, in seconds. */
|
|
1205
|
+
initTimeoutSeconds?: number
|
|
1206
|
+
/** Worker count for an expression column; Function columns reject it. */
|
|
1207
|
+
numWorkers?: number
|
|
1208
|
+
/** Cap on executor processes per Function worker. */
|
|
1209
|
+
maxExecutorProcessesPerWorker?: number
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1146
1212
|
export interface RefreshColumnResult {
|
|
1147
1213
|
rowsFilled: number
|
|
1148
1214
|
version: number
|
|
1149
1215
|
}
|
|
1150
1216
|
|
|
1151
1217
|
export interface RefreshMaterializedViewResult {
|
|
1152
|
-
/** How the view was brought up to date: "rebuild", or absent for LanceDB
|
|
1218
|
+
/** How the view was brought up to date: "rebuild", or absent for LanceDB Enterprise SQL refreshes. */
|
|
1153
1219
|
mode?: string
|
|
1154
|
-
/** Rows written by this refresh, or absent for LanceDB
|
|
1220
|
+
/** Rows written by this refresh, or absent for LanceDB Enterprise SQL refreshes. */
|
|
1155
1221
|
rowsWritten?: number
|
|
1156
|
-
/** Source version refreshed to, or absent for LanceDB
|
|
1222
|
+
/** Source version refreshed to, or absent for LanceDB Enterprise SQL refreshes. */
|
|
1157
1223
|
sourceVersion?: number
|
|
1158
1224
|
version: number
|
|
1159
1225
|
}
|
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.
|
|
80
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
79
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
99
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
98
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
124
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
123
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
143
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
142
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
163
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
162
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
182
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
181
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
205
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
204
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
223
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
222
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
242
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
241
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
266
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
265
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
285
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
284
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
310
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
309
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
329
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
328
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
350
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
349
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
369
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
368
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
390
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
389
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
409
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
408
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
430
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
429
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
449
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
448
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
470
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
469
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
489
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
488
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
509
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
508
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
528
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
527
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
552
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
551
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
571
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
570
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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.
|
|
590
|
-
throw new Error(`Native binding package version mismatch, expected 0.42.0-beta.
|
|
589
|
+
if (bindingPackageVersion !== '0.42.0-beta.10' && 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.10 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
|
@@ -32,6 +32,9 @@ export interface QueryExecutionOptions {
|
|
|
32
32
|
maxBatchLength?: number;
|
|
33
33
|
/**
|
|
34
34
|
* Timeout for query execution in milliseconds
|
|
35
|
+
*
|
|
36
|
+
* The timeout also covers reading the results, so consuming them slowly can
|
|
37
|
+
* exceed it.
|
|
35
38
|
*/
|
|
36
39
|
timeoutMs?: number;
|
|
37
40
|
/**
|
|
@@ -365,6 +368,11 @@ export declare class VectorQuery extends StandardQueryBase<NativeVectorQuery> {
|
|
|
365
368
|
/**
|
|
366
369
|
* Set the initial IVF search effort to a finite value in [0, 1].
|
|
367
370
|
*
|
|
371
|
+
* Efforts 0.1 and 0.25 target empirical mean partition-routing recall of
|
|
372
|
+
* 80% and 90% for L2, cosine and dot through k=100000. The probe budget
|
|
373
|
+
* adapts to the metric and k. Hamming and larger k remain uncalibrated;
|
|
374
|
+
* 100000 is not an API limit. Remote queries also require server support.
|
|
375
|
+
*
|
|
368
376
|
* The default, null, uses Auto (internally 0.5). Zero starts at the caller
|
|
369
377
|
* minimum; one searches all partitions within the caller maximum. Later
|
|
370
378
|
* probing may continue when too few candidates are found.
|
|
@@ -409,6 +417,23 @@ export declare class VectorQuery extends StandardQueryBase<NativeVectorQuery> {
|
|
|
409
417
|
* also increase the latency of your query. The default value is 1.5*limit.
|
|
410
418
|
*/
|
|
411
419
|
ef(ef: number): VectorQuery;
|
|
420
|
+
/**
|
|
421
|
+
* Set the speed / accuracy tradeoff to use for approximate search
|
|
422
|
+
*
|
|
423
|
+
* This currently affects RQ-quantized indexes, such as IVF_RQ, and
|
|
424
|
+
* prefiltered search on HNSW indexes, where "fast" enables the ACORN
|
|
425
|
+
* traversal. Other index types ignore this setting.
|
|
426
|
+
*
|
|
427
|
+
* "fast" favors lower latency and may reduce recall, "normal" (the default)
|
|
428
|
+
* uses the index's default balance, and "accurate" favors higher recall and
|
|
429
|
+
* may increase latency.
|
|
430
|
+
*
|
|
431
|
+
* @example
|
|
432
|
+
* ```ts
|
|
433
|
+
* table.vectorSearch([0.1, 0.2]).approxMode("fast").limit(10);
|
|
434
|
+
* ```
|
|
435
|
+
*/
|
|
436
|
+
approxMode(approxMode: "fast" | "normal" | "accurate"): VectorQuery;
|
|
412
437
|
/**
|
|
413
438
|
* Set the vector column to query
|
|
414
439
|
*
|
package/dist/query.js
CHANGED
|
@@ -599,6 +599,11 @@ class VectorQuery extends StandardQueryBase {
|
|
|
599
599
|
/**
|
|
600
600
|
* Set the initial IVF search effort to a finite value in [0, 1].
|
|
601
601
|
*
|
|
602
|
+
* Efforts 0.1 and 0.25 target empirical mean partition-routing recall of
|
|
603
|
+
* 80% and 90% for L2, cosine and dot through k=100000. The probe budget
|
|
604
|
+
* adapts to the metric and k. Hamming and larger k remain uncalibrated;
|
|
605
|
+
* 100000 is not an API limit. Remote queries also require server support.
|
|
606
|
+
*
|
|
602
607
|
* The default, null, uses Auto (internally 0.5). Zero starts at the caller
|
|
603
608
|
* minimum; one searches all partitions within the caller maximum. Later
|
|
604
609
|
* probing may continue when too few candidates are found.
|
|
@@ -666,6 +671,26 @@ class VectorQuery extends StandardQueryBase {
|
|
|
666
671
|
this.doVectorCall((inner) => inner.ef(ef));
|
|
667
672
|
return this;
|
|
668
673
|
}
|
|
674
|
+
/**
|
|
675
|
+
* Set the speed / accuracy tradeoff to use for approximate search
|
|
676
|
+
*
|
|
677
|
+
* This currently affects RQ-quantized indexes, such as IVF_RQ, and
|
|
678
|
+
* prefiltered search on HNSW indexes, where "fast" enables the ACORN
|
|
679
|
+
* traversal. Other index types ignore this setting.
|
|
680
|
+
*
|
|
681
|
+
* "fast" favors lower latency and may reduce recall, "normal" (the default)
|
|
682
|
+
* uses the index's default balance, and "accurate" favors higher recall and
|
|
683
|
+
* may increase latency.
|
|
684
|
+
*
|
|
685
|
+
* @example
|
|
686
|
+
* ```ts
|
|
687
|
+
* table.vectorSearch([0.1, 0.2]).approxMode("fast").limit(10);
|
|
688
|
+
* ```
|
|
689
|
+
*/
|
|
690
|
+
approxMode(approxMode) {
|
|
691
|
+
super.doCall((inner) => inner.approxMode(approxMode));
|
|
692
|
+
return this;
|
|
693
|
+
}
|
|
669
694
|
/**
|
|
670
695
|
* Set the vector column to query
|
|
671
696
|
*
|
package/dist/table.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import { BlobFile, BlobReadOptions } from "./blob";
|
|
|
3
3
|
import { IndexOptions } from "./indices";
|
|
4
4
|
import { Job } from "./job";
|
|
5
5
|
import { MergeInsertBuilder } from "./merge";
|
|
6
|
-
import { AddColumnsResult, AddColumnsSql, AddResult, AlterColumnsResult, BranchContents, DeleteResult, DropColumnsResult, FunctionErrors, FunctionErrorsOptions, IndexConfig, IndexStatistics, Branches as NativeBranches, OptimizeStats, RTEStats, RefreshColumnResult, RefreshMaterializedViewResult, TableStatistics, Tags, UpdateFieldMetadataResult, UpdateResult, Table as _NativeTable } from "./native";
|
|
6
|
+
import { AddColumnsResult, AddColumnsSql, AddResult, AlterColumnsResult, BranchContents, DeleteResult, DropColumnsResult, FunctionErrors, FunctionErrorsOptions, IndexConfig, IndexStatistics, Branches as NativeBranches, OptimizeStats, RTEStats, RefreshColumnOptions, RefreshColumnResult, RefreshMaterializedViewResult, TableStatistics, Tags, UpdateFieldMetadataResult, UpdateResult, Table as _NativeTable } from "./native";
|
|
7
7
|
import { AutoQuery, FullTextQuery, Query, TakeQuery, VectorQuery } from "./query";
|
|
8
8
|
import { IntoSql } from "./util";
|
|
9
9
|
export { IndexConfig } from "./native";
|
|
@@ -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
|
|
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.
|
|
@@ -89,7 +89,30 @@ export interface UpdateOptions {
|
|
|
89
89
|
*/
|
|
90
90
|
where: string;
|
|
91
91
|
}
|
|
92
|
+
/** Per-invocation compaction settings. Values must be safe integers. */
|
|
93
|
+
export interface CompactionOptions {
|
|
94
|
+
/** Positive target rows per output fragment; also affects candidate selection. */
|
|
95
|
+
targetRowsPerFragment?: number;
|
|
96
|
+
/** Positive live-source-row budget across whole tasks; an oversized first task can produce no work. */
|
|
97
|
+
maxSourceRows?: number;
|
|
98
|
+
/** Scanner I/O read-ahead budget in bytes; zero disables byte-based I/O backpressure. */
|
|
99
|
+
ioBufferSize?: number;
|
|
100
|
+
/** Positive scanner batch size in rows. */
|
|
101
|
+
batchSize?: number;
|
|
102
|
+
}
|
|
92
103
|
export interface OptimizeOptions {
|
|
104
|
+
/**
|
|
105
|
+
* Compaction settings for this invocation. Omitted remote values inherit table
|
|
106
|
+
* tuning, then deployment/built-in defaults.
|
|
107
|
+
* Remote tables require a server supporting these SQL options; settings do
|
|
108
|
+
* not change table policy. This is not a runtime or total-memory limit.
|
|
109
|
+
* @example
|
|
110
|
+
* await tbl.optimize({ compactionOptions: {
|
|
111
|
+
* targetRowsPerFragment: 1000, maxSourceRows: 5000,
|
|
112
|
+
* ioBufferSize: 64 * 1024 * 1024, batchSize: 128,
|
|
113
|
+
* } });
|
|
114
|
+
*/
|
|
115
|
+
compactionOptions?: CompactionOptions;
|
|
93
116
|
/**
|
|
94
117
|
* If set then all versions older than the given date
|
|
95
118
|
* be removed. The current version will never be removed.
|
|
@@ -281,6 +304,24 @@ export declare abstract class Table {
|
|
|
281
304
|
* We currently don't support custom named indexes.
|
|
282
305
|
* The index name will always be `${column}_idx`.
|
|
283
306
|
*
|
|
307
|
+
* On LanceDB Embedded tables the index is built before the returned promise
|
|
308
|
+
* resolves. On LanceDB Enterprise tables it resolves once the build is
|
|
309
|
+
* scheduled. Until the build finishes, a vector index may be missing from
|
|
310
|
+
* {@link Table.listIndices}, a scalar or FTS index may be listed with 0
|
|
311
|
+
* indexed rows, and queries won't use the index. To wait until the index is
|
|
312
|
+
* ready, set {@link IndexOptions.waitTimeoutSeconds}, call
|
|
313
|
+
* {@link Table.waitForIndex}, or use {@link Table.createIndexAsync} and wait
|
|
314
|
+
* on its job when the server returned a job ID.
|
|
315
|
+
*
|
|
316
|
+
* `waitTimeoutSeconds` waits for the submitted build when the server returns
|
|
317
|
+
* a job ID. On older servers that don't return one, it falls back to polling
|
|
318
|
+
* the index by name. {@link Table.waitForIndex} always waits by name. When
|
|
319
|
+
* replacing an existing index, those name-based waits may return before the
|
|
320
|
+
* new build finishes because the old index can still match.
|
|
321
|
+
* `createIndexAsync` can track a specific build only when the server returned
|
|
322
|
+
* a job ID; otherwise it returns an already-complete job and callers must
|
|
323
|
+
* use {@link Table.waitForIndex} for that build.
|
|
324
|
+
*
|
|
284
325
|
* @example
|
|
285
326
|
* // If the column has a vector (fixed size list) data type then
|
|
286
327
|
* // an IvfPq vector index will be created.
|
|
@@ -311,6 +352,11 @@ export declare abstract class Table {
|
|
|
311
352
|
*
|
|
312
353
|
* The job may already be complete when returned; callers must not assume
|
|
313
354
|
* the index exists until {@link Job.wait} resolves.
|
|
355
|
+
*
|
|
356
|
+
* In LanceDB Enterprise, the returned job tracks this submission only if the
|
|
357
|
+
* server returns a job ID. If it does not, the job is already complete and
|
|
358
|
+
* does not wait for the background build; use {@link Table.waitForIndex} and
|
|
359
|
+
* account for the replacement caveat described in {@link Table.createIndex}.
|
|
314
360
|
*/
|
|
315
361
|
abstract createIndexAsync(column: string, options?: Partial<IndexOptions>): Promise<Job>;
|
|
316
362
|
/**
|
|
@@ -349,7 +395,7 @@ export declare abstract class Table {
|
|
|
349
395
|
* Large columns (e.g. high-dimensional vectors or binary data) may not be
|
|
350
396
|
* practical to prewarm.
|
|
351
397
|
*
|
|
352
|
-
* This feature is currently only supported in LanceDB
|
|
398
|
+
* This feature is currently only supported in LanceDB Enterprise.
|
|
353
399
|
*/
|
|
354
400
|
abstract prewarmData(columns?: string[]): Promise<void>;
|
|
355
401
|
/**
|
|
@@ -484,7 +530,7 @@ export declare abstract class Table {
|
|
|
484
530
|
*
|
|
485
531
|
* LanceDB Embedded computed-column declaration and refresh require a source
|
|
486
532
|
* build with the `experimental-functions` Cargo feature. Published packages
|
|
487
|
-
* disable it; LanceDB
|
|
533
|
+
* disable it; LanceDB Enterprise operations remain available.
|
|
488
534
|
*
|
|
489
535
|
* The `{ computed }` form stores the expression rather than evaluating it
|
|
490
536
|
* now: the column is committed with no values, and rows get them from
|
|
@@ -496,7 +542,7 @@ export declare abstract class Table {
|
|
|
496
542
|
* declaration reads a column, that column cannot be renamed, retyped or
|
|
497
543
|
* dropped.
|
|
498
544
|
*
|
|
499
|
-
* In LanceDB
|
|
545
|
+
* In LanceDB Enterprise the expression is planned by the
|
|
500
546
|
* server, and the refresh runs as a server job -- see
|
|
501
547
|
* {@link Table#refreshColumnAsync}.
|
|
502
548
|
* @param {AddColumnsSql[] | Field | Field[] | Schema} newColumnTransforms Either:
|
|
@@ -523,40 +569,55 @@ export declare abstract class Table {
|
|
|
523
569
|
* Rows appended since the last refresh are filled by the next one, and
|
|
524
570
|
* rows whose inputs changed since they were computed are recomputed;
|
|
525
571
|
* everything else is left as it is. LanceDB Embedded only: in LanceDB
|
|
526
|
-
*
|
|
572
|
+
* Enterprise a refresh runs as a server job, through {@link Table#refreshColumnAsync}.
|
|
527
573
|
* @param {string} column The name of the computed column to fill.
|
|
574
|
+
* @param {RefreshColumnOptions} options Refresh options, all LanceDB
|
|
575
|
+
* Enterprise only; see {@link Table#refreshColumnAsync}.
|
|
528
576
|
* @returns {Promise<RefreshColumnResult>} A promise that resolves to the
|
|
529
577
|
* number of rows filled and the new version number of the table.
|
|
530
578
|
*/
|
|
531
|
-
abstract refreshColumn(column: string): Promise<RefreshColumnResult>;
|
|
579
|
+
abstract refreshColumn(column: string, options?: RefreshColumnOptions): Promise<RefreshColumnResult>;
|
|
532
580
|
/**
|
|
533
581
|
* Like {@link Table#refreshColumn}, but returns a handle to the refresh
|
|
534
582
|
* job instead of blocking until it completes.
|
|
535
583
|
* LanceDB Embedded refresh requires a source build with
|
|
536
|
-
* `experimental-functions`. LanceDB
|
|
584
|
+
* `experimental-functions`. LanceDB Enterprise jobs do not require this
|
|
537
585
|
* feature.
|
|
538
586
|
*
|
|
539
587
|
* The job may already be complete when returned; callers must not assume
|
|
540
588
|
* the column is filled until {@link Job.wait} resolves. Invalid input --
|
|
541
589
|
* an unknown column, or one that is not computed -- rejects here rather
|
|
542
590
|
* than failing the job. In LanceDB Embedded the job runs in-process; in
|
|
543
|
-
* LanceDB
|
|
591
|
+
* LanceDB Enterprise it is the server's backfill job.
|
|
544
592
|
* @param {string} column The name of the computed column to fill.
|
|
593
|
+
* @param {RefreshColumnOptions} options Refresh options, mirroring the SQL
|
|
594
|
+
* `REFRESH COLUMN ... WHERE ... WITH (...)` form: `where` narrows the rows,
|
|
595
|
+
* `errorPolicy`, `maxFailedFraction`, `maxFailedRows`, `rowTimeoutSeconds`
|
|
596
|
+
* and `initTimeoutSeconds` govern failing rows, and `batchSize`,
|
|
597
|
+
* `gpuClass`, `gpuCount`, `numWorkers` and `maxExecutorProcessesPerWorker`
|
|
598
|
+
* size the workers. All are LanceDB Enterprise only; a LanceDB Embedded
|
|
599
|
+
* refresh rejects every option other than `batchSize`, `gpuClass` and
|
|
600
|
+
* `gpuCount`.
|
|
545
601
|
* @example
|
|
546
602
|
* ```ts
|
|
547
|
-
* const job = await table.refreshColumnAsync("
|
|
603
|
+
* const job = await table.refreshColumnAsync("embedding", {
|
|
604
|
+
* where: "published_at > '2026-01-01'",
|
|
605
|
+
* errorPolicy: "skip",
|
|
606
|
+
* maxFailedFraction: 0.01,
|
|
607
|
+
* rowTimeoutSeconds: 30,
|
|
608
|
+
* });
|
|
548
609
|
* await job.wait();
|
|
549
610
|
* console.log(await job.status()); // "finished"
|
|
550
611
|
* ```
|
|
551
612
|
*/
|
|
552
|
-
abstract refreshColumnAsync(column: string): Promise<Job>;
|
|
613
|
+
abstract refreshColumnAsync(column: string, options?: RefreshColumnOptions): Promise<Job>;
|
|
553
614
|
/**
|
|
554
615
|
* The per-row errors Function refreshes recorded on this table.
|
|
555
616
|
*
|
|
556
617
|
* A refresh running under a skip policy records each row it skipped with
|
|
557
618
|
* the input that failed and the error. This lists those records, newest
|
|
558
619
|
* job first, plus a summary for any fragment whose per-row detail was
|
|
559
|
-
* capped. LanceDB
|
|
620
|
+
* capped. LanceDB Enterprise only; reading errors needs read
|
|
560
621
|
* access to the table, since a message carries the value that failed.
|
|
561
622
|
* @param {FunctionErrorsOptions} options Optional filters: `jobId`,
|
|
562
623
|
* `column`, and `limit` (server default 10000, cap 100000).
|
|
@@ -580,6 +641,9 @@ export declare abstract class Table {
|
|
|
580
641
|
abstract materializedViewDefinition(): Promise<string>;
|
|
581
642
|
/**
|
|
582
643
|
* Alter the name or nullability of columns.
|
|
644
|
+
*
|
|
645
|
+
* Local tables reject renaming source or vector columns referenced by
|
|
646
|
+
* `embedding_functions` schema metadata, preserving the embedding binding.
|
|
583
647
|
* @param {ColumnAlteration[]} columnAlterations One or more alterations to
|
|
584
648
|
* apply to columns.
|
|
585
649
|
* @returns {Promise<AlterColumnsResult>} A promise that resolves to an object
|
|
@@ -611,6 +675,9 @@ export declare abstract class Table {
|
|
|
611
675
|
* underlying storage. In order to remove the data, you must subsequently
|
|
612
676
|
* call ``compact_files`` to rewrite the data without the removed columns and
|
|
613
677
|
* then call ``cleanup_files`` to remove the old files.
|
|
678
|
+
*
|
|
679
|
+
* Local tables reject dropping source or vector columns referenced by
|
|
680
|
+
* `embedding_functions` schema metadata, preserving the embedding binding.
|
|
614
681
|
* @param {string[]} columnNames The names of the columns to drop. These can
|
|
615
682
|
* be nested column references (e.g. "a.b.c") or top-level column names
|
|
616
683
|
* (e.g. "a").
|
|
@@ -842,9 +909,25 @@ export declare abstract class Table {
|
|
|
842
909
|
* optimize should be run frequently. A good rule of thumb is to run optimize if
|
|
843
910
|
* you have added or modified 100,000 or more records or run more than 20 data
|
|
844
911
|
* modification operations.
|
|
912
|
+
*
|
|
913
|
+
* On a LanceDB Enterprise (remote) table, only compaction is currently
|
|
914
|
+
* supported. Pruning old versions and index optimization are silently
|
|
915
|
+
* skipped there instead of being attempted, so this call resolves
|
|
916
|
+
* successfully, with zeroed pruning statistics, once the compaction job
|
|
917
|
+
* has been submitted; it does not wait for that job to finish.
|
|
918
|
+
* `compactionOptions` can tune the four per-job settings documented in
|
|
919
|
+
* {@link CompactionOptions}. Older-server errors are propagated without
|
|
920
|
+
* retrying with the settings removed.
|
|
845
921
|
*/
|
|
846
922
|
abstract optimize(options?: Partial<OptimizeOptions>): Promise<OptimizeStats>;
|
|
847
|
-
/**
|
|
923
|
+
/**
|
|
924
|
+
* List all indices that have been created with {@link Table.createIndex}
|
|
925
|
+
*
|
|
926
|
+
* On LanceDB Enterprise tables, an index whose build hasn't finished may be
|
|
927
|
+
* missing (vector indices) or listed with 0 indexed rows (scalar and FTS
|
|
928
|
+
* indices), and `numUnindexedRows` may be undefined. Use
|
|
929
|
+
* {@link Table.waitForIndex} to wait until an index is ready.
|
|
930
|
+
*/
|
|
848
931
|
abstract listIndices(): Promise<IndexConfig[]>;
|
|
849
932
|
/**
|
|
850
933
|
* Tokenize a full-text search query using the tokenizer configured on an FTS index.
|
|
@@ -852,7 +935,7 @@ export declare abstract class Table {
|
|
|
852
935
|
* Specify exactly one of `column` or `indexName`.
|
|
853
936
|
*
|
|
854
937
|
* Model-backed tokenizers such as `jieba/*` and `lindera/*` are rebuilt in
|
|
855
|
-
* the client process from index metadata. In LanceDB
|
|
938
|
+
* the client process from index metadata. In LanceDB Enterprise, this means the
|
|
856
939
|
* same tokenizer model files must also exist locally (under
|
|
857
940
|
* `LANCE_LANGUAGE_MODEL_HOME`) and must match the files the server uses. A
|
|
858
941
|
* mismatch cannot be detected: the returned tokens may differ from what the
|
|
@@ -946,8 +1029,8 @@ export declare class LocalTable extends Table {
|
|
|
946
1029
|
addColumns(newColumnTransforms: AddColumnsSql[] | Field | Field[] | Schema | {
|
|
947
1030
|
computed: AddColumnsSql[];
|
|
948
1031
|
}): Promise<AddColumnsResult>;
|
|
949
|
-
refreshColumn(column: string): Promise<RefreshColumnResult>;
|
|
950
|
-
refreshColumnAsync(column: string): Promise<Job>;
|
|
1032
|
+
refreshColumn(column: string, options?: RefreshColumnOptions): Promise<RefreshColumnResult>;
|
|
1033
|
+
refreshColumnAsync(column: string, options?: RefreshColumnOptions): Promise<Job>;
|
|
951
1034
|
functionErrors(options?: FunctionErrorsOptions): Promise<FunctionErrors>;
|
|
952
1035
|
refreshMaterializedView(sourceVersion?: number, full?: boolean): Promise<RefreshMaterializedViewResult>;
|
|
953
1036
|
materializedViewDefinition(): Promise<string>;
|
package/dist/table.js
CHANGED
|
@@ -276,11 +276,11 @@ class LocalTable extends Table {
|
|
|
276
276
|
}
|
|
277
277
|
throw new Error("Invalid input type for addColumns");
|
|
278
278
|
}
|
|
279
|
-
async refreshColumn(column) {
|
|
280
|
-
return await this.inner.refreshColumn(column);
|
|
279
|
+
async refreshColumn(column, options) {
|
|
280
|
+
return await this.inner.refreshColumn(column, options);
|
|
281
281
|
}
|
|
282
|
-
async refreshColumnAsync(column) {
|
|
283
|
-
return new job_1.Job(await this.inner.refreshColumnAsync(column));
|
|
282
|
+
async refreshColumnAsync(column, options) {
|
|
283
|
+
return new job_1.Job(await this.inner.refreshColumnAsync(column, options));
|
|
284
284
|
}
|
|
285
285
|
async functionErrors(options) {
|
|
286
286
|
(0, materialized_view_1.validateNonNegativeInteger)(options?.limit, "limit");
|
|
@@ -385,7 +385,20 @@ class LocalTable extends Table {
|
|
|
385
385
|
return this.inner.currentBranch() ?? null;
|
|
386
386
|
}
|
|
387
387
|
async optimize(options) {
|
|
388
|
-
|
|
388
|
+
// JavaScript callers can supply extra keys that TypeScript would reject.
|
|
389
|
+
// Refuse them before the native binding can silently discard a work limit.
|
|
390
|
+
const supported = new Set([
|
|
391
|
+
"targetRowsPerFragment",
|
|
392
|
+
"maxSourceRows",
|
|
393
|
+
"ioBufferSize",
|
|
394
|
+
"batchSize",
|
|
395
|
+
]);
|
|
396
|
+
for (const key of Object.keys(options?.compactionOptions ?? {})) {
|
|
397
|
+
if (!supported.has(key)) {
|
|
398
|
+
throw new Error(`Unsupported compaction option: ${key}`);
|
|
399
|
+
}
|
|
400
|
+
}
|
|
401
|
+
return await this.inner.optimize(options?.cleanupOlderThan?.getTime(), options?.deleteUnverified, options?.compactionOptions);
|
|
389
402
|
}
|
|
390
403
|
async listIndices() {
|
|
391
404
|
return await this.inner.listIndices();
|
package/package.json
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"ann"
|
|
12
12
|
],
|
|
13
13
|
"private": false,
|
|
14
|
-
"version": "0.42.0-beta.
|
|
14
|
+
"version": "0.42.0-beta.10",
|
|
15
15
|
"main": "dist/index.js",
|
|
16
16
|
"exports": {
|
|
17
17
|
".": "./dist/index.js",
|
|
@@ -109,15 +109,15 @@
|
|
|
109
109
|
"reflect-metadata": "^0.2.2"
|
|
110
110
|
},
|
|
111
111
|
"optionalDependencies": {
|
|
112
|
-
"@huggingface/transformers": "3.
|
|
112
|
+
"@huggingface/transformers": "4.3.2",
|
|
113
113
|
"openai": "4.29.2",
|
|
114
|
-
"@lancedb/lancedb-darwin-arm64": "0.42.0-beta.
|
|
115
|
-
"@lancedb/lancedb-linux-x64-gnu": "0.42.0-beta.
|
|
116
|
-
"@lancedb/lancedb-linux-arm64-gnu": "0.42.0-beta.
|
|
117
|
-
"@lancedb/lancedb-linux-x64-musl": "0.42.0-beta.
|
|
118
|
-
"@lancedb/lancedb-linux-arm64-musl": "0.42.0-beta.
|
|
119
|
-
"@lancedb/lancedb-win32-x64-msvc": "0.42.0-beta.
|
|
120
|
-
"@lancedb/lancedb-win32-arm64-msvc": "0.42.0-beta.
|
|
114
|
+
"@lancedb/lancedb-darwin-arm64": "0.42.0-beta.10",
|
|
115
|
+
"@lancedb/lancedb-linux-x64-gnu": "0.42.0-beta.10",
|
|
116
|
+
"@lancedb/lancedb-linux-arm64-gnu": "0.42.0-beta.10",
|
|
117
|
+
"@lancedb/lancedb-linux-x64-musl": "0.42.0-beta.10",
|
|
118
|
+
"@lancedb/lancedb-linux-arm64-musl": "0.42.0-beta.10",
|
|
119
|
+
"@lancedb/lancedb-win32-x64-msvc": "0.42.0-beta.10",
|
|
120
|
+
"@lancedb/lancedb-win32-arm64-msvc": "0.42.0-beta.10"
|
|
121
121
|
},
|
|
122
122
|
"peerDependencies": {
|
|
123
123
|
"@types/node": ">=22",
|
package/pnpm-workspace.yaml
CHANGED
|
@@ -47,10 +47,3 @@ minimumReleaseAgeExclude:
|
|
|
47
47
|
- js-yaml@4.3.1
|
|
48
48
|
- tar@7.5.21
|
|
49
49
|
- '@opentelemetry/core@2.8.0'
|
|
50
|
-
|
|
51
|
-
# @huggingface/transformers pins sharp ^0.33.5 and no released version has moved
|
|
52
|
-
# past ^0.34.5, all of which inherit the libvips CVEs in GHSA-f88m-g3jw-g9cj.
|
|
53
|
-
# Force the patched line. sharp is only reached by transformers' image pipeline,
|
|
54
|
-
# which LanceDB's text embedding function never uses.
|
|
55
|
-
overrides:
|
|
56
|
-
sharp: ^0.35.4
|