mirror of
https://github.com/lancedb/lancedb.git
synced 2026-11-16 15:46:55 +00:00
feat: expose the remaining refresh options on the SDKs (#4890)
The server's backfill request takes a row filter, failure limits, per-call timeouts and worker sizing, and SQL exposes all of them through `REFRESH COLUMN ... WHERE ... WITH (...)`, but the typed SDKs could send only batch_size, GPU placement and the retry and error policies. Anyone needing a filtered refresh or a bounded skip policy had to drop to SQL. This adds `where`, `max_failed_fraction`, `max_failed_rows`, `row_timeout_seconds`, `init_timeout_seconds`, `num_workers` and `max_executor_processes_per_worker` to Python, Rust and Node, passed through unchanged. `RefreshColumnOptions` now serializes straight into the request body, so the three SDKs share one producer. Node gets a `RefreshColumnOptions` object, which also carries the options it lacked before. A LanceDB Embedded refresh rejects every option other than batch_size and GPU placement, naming the option.
This commit is contained in:
@@ -0,0 +1,124 @@
|
||||
[**@lancedb/lancedb**](../README.md) • **Docs**
|
||||
|
||||
***
|
||||
|
||||
[@lancedb/lancedb](../globals.md) / RefreshColumnOptions
|
||||
|
||||
# Interface: RefreshColumnOptions
|
||||
|
||||
Options for `Table.refreshColumn` and `Table.refreshColumnAsync`. Every
|
||||
option is LanceDB Enterprise only; a LanceDB Embedded refresh ignores
|
||||
`batchSize`, `gpuClass` and `gpuCount` and rejects the rest.
|
||||
|
||||
## Properties
|
||||
|
||||
### batchSize?
|
||||
|
||||
```ts
|
||||
optional batchSize: number;
|
||||
```
|
||||
|
||||
Maximum rows per Function call; must be greater than zero.
|
||||
|
||||
***
|
||||
|
||||
### errorPolicy?
|
||||
|
||||
```ts
|
||||
optional errorPolicy: string;
|
||||
```
|
||||
|
||||
`"fail"` (default) stops on a row error; `"skip"` writes null and
|
||||
records the error, subject to the failure limits.
|
||||
|
||||
***
|
||||
|
||||
### gpuClass?
|
||||
|
||||
```ts
|
||||
optional gpuClass: string;
|
||||
```
|
||||
|
||||
GPU class for Function workers.
|
||||
|
||||
***
|
||||
|
||||
### gpuCount?
|
||||
|
||||
```ts
|
||||
optional gpuCount: number;
|
||||
```
|
||||
|
||||
Positive aggregate GPU budget for Function workers.
|
||||
|
||||
***
|
||||
|
||||
### initTimeoutSeconds?
|
||||
|
||||
```ts
|
||||
optional initTimeoutSeconds: number;
|
||||
```
|
||||
|
||||
Deadline for Function initialization, in seconds.
|
||||
|
||||
***
|
||||
|
||||
### maxExecutorProcessesPerWorker?
|
||||
|
||||
```ts
|
||||
optional maxExecutorProcessesPerWorker: number;
|
||||
```
|
||||
|
||||
Cap on executor processes per Function worker.
|
||||
|
||||
***
|
||||
|
||||
### maxFailedFraction?
|
||||
|
||||
```ts
|
||||
optional maxFailedFraction: number;
|
||||
```
|
||||
|
||||
Under a skip policy, fail the job once more than this share of rows
|
||||
(0 to 1) has failed.
|
||||
|
||||
***
|
||||
|
||||
### maxFailedRows?
|
||||
|
||||
```ts
|
||||
optional maxFailedRows: number;
|
||||
```
|
||||
|
||||
Under a skip policy, fail the job once more than this many rows have
|
||||
failed.
|
||||
|
||||
***
|
||||
|
||||
### numWorkers?
|
||||
|
||||
```ts
|
||||
optional numWorkers: number;
|
||||
```
|
||||
|
||||
Worker count for an expression column; Function columns reject it.
|
||||
|
||||
***
|
||||
|
||||
### rowTimeoutSeconds?
|
||||
|
||||
```ts
|
||||
optional rowTimeoutSeconds: number;
|
||||
```
|
||||
|
||||
Deadline for one Function call, in seconds.
|
||||
|
||||
***
|
||||
|
||||
### where?
|
||||
|
||||
```ts
|
||||
optional where: string;
|
||||
```
|
||||
|
||||
Only refresh the rows matching this SQL filter.
|
||||
Reference in New Issue
Block a user