feat(nodejs): expose Function refresh publication intervals (#4957)

Expose `publicationIntervalRows` on TypeScript refresh options and
forward it as `publication_interval_rows`. Accept positive safe integers
and preserve whole-fragment publication when omitted.

```typescript
const job = await table.refreshColumnAsync("embedding", {
  publicationIntervalRows: 10000,
});
await job.wait();
```

Document the threshold semantics and add coverage for serialization,
omission, invalid values, safe-integer boundaries, and Embedded
rejection.

Closes ENT-3755.
This commit is contained in:
Jack Ye
2026-11-11 07:34:54 -08:00
committed by GitHub
parent c1fee36045
commit e9774ed168
7 changed files with 103 additions and 6 deletions
+46
View File
@@ -776,6 +776,7 @@ describe("remote connection", () => {
const job = await table.refreshColumnAsync("embedding", {
where: "id % 2 = 0",
batchSize: 16,
publicationIntervalRows: 60,
maxConcurrency: 3,
gpuClass: "a10g",
gpuCount: 2,
@@ -788,6 +789,18 @@ describe("remote connection", () => {
});
expect(job.id).toBe("j-9");
await table.refreshColumnAsync("embedding");
await table.refreshColumnAsync("embedding", {
publicationIntervalRows: undefined,
});
for (const publicationIntervalRows of [
1,
2 ** 32 + 1,
Number.MAX_SAFE_INTEGER,
]) {
await table.refreshColumnAsync("embedding", {
publicationIntervalRows,
});
}
await table.refreshColumnAsync("embedding", {
resourceBudget: {
cpuMillis: 8_000,
@@ -799,6 +812,14 @@ describe("remote connection", () => {
maxConcurrency: true as unknown as number,
}),
).rejects.toThrow();
for (const publicationIntervalRows of [true, "60", 60n]) {
await expect(
table.refreshColumnAsync("embedding", {
publicationIntervalRows:
publicationIntervalRows as unknown as number,
}),
).rejects.toThrow();
}
// Invalid options reject before any request is sent.
for (const [options, message] of [
[{ maxFailedRows: -1 }, "maxFailedRows"],
@@ -806,6 +827,22 @@ describe("remote connection", () => {
[{ where: " " }, "where"],
[{ maxFailedFraction: 2 }, "max_failed_fraction"],
[{ rowTimeoutSeconds: 0 }, "row_timeout_seconds"],
[{ publicationIntervalRows: 0 }, "publicationIntervalRows"],
[{ publicationIntervalRows: -1 }, "publicationIntervalRows"],
[{ publicationIntervalRows: 1.5 }, "publicationIntervalRows"],
[{ publicationIntervalRows: Number.NaN }, "publicationIntervalRows"],
[
{ publicationIntervalRows: Number.POSITIVE_INFINITY },
"publicationIntervalRows",
],
[
{ publicationIntervalRows: Number.NEGATIVE_INFINITY },
"publicationIntervalRows",
],
[
{ publicationIntervalRows: Number.MAX_SAFE_INTEGER + 1 },
"publicationIntervalRows",
],
[{ maxConcurrency: 1.5 }, "maxConcurrency"],
[{ maxConcurrency: 0 }, "maxConcurrency"],
[{ maxConcurrency: -1 }, "maxConcurrency"],
@@ -893,6 +930,7 @@ describe("remote connection", () => {
expect(bodies).toEqual([
JSON.parse(
`{"column": "embedding", "where": "id % 2 = 0", "batch_size": 16,
"publication_interval_rows": 60,
"max_concurrency": 3, "gpu_class": "a10g", "gpu_count": 2,
"error_policy": "skip",
"max_failed_fraction": 0.01, "max_failed_rows": 50,
@@ -900,6 +938,14 @@ describe("remote connection", () => {
"max_executor_processes_per_worker": 2}`,
),
{ column: "embedding" },
{ column: "embedding" },
JSON.parse('{"column": "embedding", "publication_interval_rows": 1}'),
JSON.parse(
'{"column": "embedding", "publication_interval_rows": 4294967297}',
),
JSON.parse(
'{"column": "embedding", "publication_interval_rows": 9007199254740991}',
),
JSON.parse(
`{"column": "embedding",
"resource_budget": {
+8
View File
@@ -5686,6 +5686,14 @@ describe("computed columns", () => {
await expect(
table.refreshColumnAsync("x", { errorPolicy: "skip" }),
).rejects.toThrow("error_policy requires a LanceDB Enterprise refresh");
for (const refresh of [
() => table.refreshColumn("x", { publicationIntervalRows: 60 }),
() => table.refreshColumnAsync("x", { publicationIntervalRows: 60 }),
]) {
await expect(refresh()).rejects.toThrow(
"publication_interval_rows requires a LanceDB Enterprise refresh",
);
}
await expect(
table.refreshColumnAsync("x", { maxConcurrency: 4 }),
).rejects.toThrow("max_concurrency requires a LanceDB Enterprise refresh");