@lancedb/lancedb 0.40.0-beta.11 → 0.40.0-beta.13

package/dist/blob.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BlobFile = void 0;
 exports.blob = blob;
 exports.isBlobField = isBlobField;
+exports.runWithSignal = runWithSignal;
+exports.normalizeBlobInput = normalizeBlobInput;
+exports.blobToRead = blobToRead;
+exports.withBlobBytes = withBlobBytes;
 exports.coerceBlobValue = coerceBlobValue;
 const apache_arrow_1 = require("apache-arrow");
 const native_1 = require("./native");
@@ -87,25 +91,143 @@ class BlobFile {
         return this.inner.size();
     }
     /**
-     * Reads from the cursor to the end and advances the cursor.
+     * Reads from the cursor and advances the cursor.
      *
-     * A second call returns an empty buffer. {@link BlobFile.readRange} does
-     * not move the cursor.
+     * Reads to the end when `maxBytes` is omitted, or at most `maxBytes` bytes
+     * otherwise. Returns an empty buffer at the end of the blob.
+     * {@link BlobFile.readRange} does not move the cursor.
      */
-    read() {
-        return this.inner.read();
+    read(maxBytes, options) {
+        return runWithSignal(options?.signal, (signal) => this.inner.read(maxBytes, signal));
     }
     /**
      * Reads the half-open byte range `[start, end)`.
      *
      * Fails when `end` is past the blob size. Does not move the cursor.
      */
-    readRange(start, end) {
-        return this.inner.readRange(start, end);
+    readRange(start, end, options) {
+        return runWithSignal(options?.signal, (signal) => this.inner.readRange(start, end, signal));
+    }
+    /**
+     * Reads several half-open byte ranges. Returns one buffer per range, in
+     * the order given.
+     *
+     * Fails when any `end` is past the blob size. Does not move the cursor.
+     */
+    readRanges(ranges, options) {
+        return runWithSignal(options?.signal, (signal) => this.inner.readRanges(ranges, signal));
+    }
+    /** Moves the cursor to `position`, in bytes from the start of the blob. */
+    seek(position) {
+        return this.inner.seek(position);
+    }
+    /** Returns the cursor position in bytes. */
+    tell() {
+        return this.inner.tell();
+    }
+    /**
+     * Releases the handle. Reads after `close()` fail. Calling it again does
+     * nothing.
+     */
+    close() {
+        return this.inner.close();
+    }
+    /** Returns true after {@link BlobFile.close}. */
+    isClosed() {
+        return this.inner.isClosed();
     }
 }
 exports.BlobFile = BlobFile;
-function coerceBlobValue(value) {
+/** @ignore */
+async function runWithSignal(signal, run) {
+    if (signal === undefined) {
+        return run(undefined);
+    }
+    signal.throwIfAborted();
+    // napi-rs replaces `onabort` on the signal it receives, so pass a private
+    // signal and forward the caller's abort to it.
+    const controller = new AbortController();
+    const onAbort = () => controller.abort();
+    signal.addEventListener("abort", onAbort, { once: true });
+    try {
+        return await run(controller.signal);
+    }
+    catch (err) {
+        if (signal.aborted) {
+            throw signal.reason;
+        }
+        throw err;
+    }
+    finally {
+        signal.removeEventListener("abort", onAbort);
+    }
+}
+/**
+ * Rewrites the synchronous-only widenings of {@link BlobInput} (`ArrayBuffer`,
+ * `URL`) into `Uint8Array` and URI strings, keeping the value's shape. Other
+ * values are returned unchanged and validated later by {@link coerceBlobValue}.
+ *
+ * Throws on `Blob` / `File`, which must be read into bytes first.
+ */
+function normalizeBlobInput(value) {
+    if (blobToRead(value) !== undefined) {
+        throw new Error("Blob and File values must be read asynchronously. Pass them to " +
+            "createTable, add, or mergeInsert, or convert them with " +
+            "`new Uint8Array(await value.arrayBuffer())`");
+    }
+    if (value instanceof ArrayBuffer) {
+        return new Uint8Array(value);
+    }
+    if (value instanceof URL) {
+        return value.href;
+    }
+    if (isBlobStruct(value)) {
+        // Read `data` and `uri` explicitly: spreading a class instance would drop
+        // fields defined as getters on its prototype.
+        const out = {
+            ...value,
+            data: value.data,
+            uri: value.uri,
+        };
+        let changed = false;
+        if (value.data instanceof ArrayBuffer) {
+            out.data = new Uint8Array(value.data);
+            changed = true;
+        }
+        if (value.uri instanceof URL) {
+            out.uri = value.uri.href;
+            changed = true;
+        }
+        return changed ? out : value;
+    }
+    return value;
+}
+/**
+ * Returns the `Blob` / `File` a blob value needs read, either the value itself
+ * or its `data` field, or `undefined` when there is nothing to read.
+ */
+function blobToRead(value) {
+    if (isBlobLike(value)) {
+        return value;
+    }
+    if (isBlobStruct(value) && isBlobLike(value.data)) {
+        return value.data;
+    }
+    return undefined;
+}
+/**
+ * Replaces the `Blob` that {@link blobToRead} found in `value` with `bytes`,
+ * keeping the value's shape.
+ */
+function withBlobBytes(value, bytes) {
+    if (isBlobLike(value)) {
+        return bytes;
+    }
+    const record = value;
+    return { ...record, uri: record.uri, data: bytes };
+}
+function coerceBlobValue(input) {
+    const value = normalizeBlobInput(input);
     if (value == null) {
         return null;
     }
@@ -113,7 +235,7 @@ function coerceBlobValue(value) {
         return { data: value, uri: null };
     }
     if (ArrayBuffer.isView(value)) {
-        throw new Error("Blob data must be Buffer or Uint8Array");
+        throw new Error("Blob data must be Buffer, Uint8Array, ArrayBuffer, or Blob");
     }
     if (typeof value === "string") {
         if (value === "") {
@@ -121,21 +243,27 @@ function coerceBlobValue(value) {
         }
         return { data: null, uri: value };
     }
-    if (typeof value === "object") {
+    if (isBlobStruct(value)) {
         const record = value;
         if (!("data" in record) && !("uri" in record)) {
             throw new Error("Blob struct values must include a 'data' or 'uri' field");
         }
+        const unknownKeys = Object.keys(record).filter((key) => key !== "data" && key !== "uri");
+        if (unknownKeys.length > 0) {
+            throw new Error(`Blob struct values only support 'data' and 'uri', got ${unknownKeys
+                .map((key) => `'${key}'`)
+                .join(", ")}`);
+        }
         const uri = record.uri;
         if (uri === "") {
             throw new Error("Blob uri cannot be empty");
         }
         if (uri != null && typeof uri !== "string") {
-            throw new Error(`Blob uri must be a string or null, got ${typeof uri}`);
+            throw new Error(`Blob uri must be a string, URL, or null, got ${typeof uri}`);
         }
         const data = record.data;
         if (data != null && !isBlobBytes(data)) {
-            throw new Error("Blob data must be Buffer, Uint8Array, or null");
+            throw new Error("Blob data must be Buffer, Uint8Array, ArrayBuffer, Blob, or null");
         }
         const bytes = data ?? null;
         const uriValue = uri ?? null;
@@ -144,7 +272,33 @@ function coerceBlobValue(value) {
         }
         return { data: bytes, uri: uriValue };
     }
-    throw new Error("Blob column values must be Buffer, Uint8Array, a URI string, null, or { data?, uri? }");
+    throw new Error("Blob column values must be Buffer, Uint8Array, ArrayBuffer, Blob, a URI string or URL, null, or { data?, uri? }");
+}
+function isBlobLike(value) {
+    return typeof Blob !== "undefined" && value instanceof Blob;
+}
+/**
+ * Whether `value` is a `{ data?, uri? }` struct: any plain object, or any
+ * other object with a `data` or `uri` field (such as a class instance), apart
+ * from the binary, `Blob`, and `URL` values that are blob inputs themselves.
+ */
+function isBlobStruct(value) {
+    if (typeof value !== "object" ||
+        value === null ||
+        Array.isArray(value) ||
+        ArrayBuffer.isView(value) ||
+        value instanceof ArrayBuffer ||
+        (typeof SharedArrayBuffer !== "undefined" &&
+            value instanceof SharedArrayBuffer) ||
+        isBlobLike(value) ||
+        value instanceof URL) {
+        return false;
+    }
+    const prototype = Object.getPrototypeOf(value);
+    return (prototype === Object.prototype ||
+        prototype === null ||
+        "data" in value ||
+        "uri" in value);
 }
 function isBlobBytes(value) {
     return Buffer.isBuffer(value) || value instanceof Uint8Array;

package/dist/catalog.d.ts

@@ -1,6 +1,6 @@
 import { Connection } from "./connection";
 import { HeaderProvider } from "./header";
-import { ListDatabasesResponse, Catalog as NativeCatalog, CatalogOptions as NativeCatalogOptions } from "./native.js";
+import { Catalog as NativeCatalog, CatalogOptions as NativeCatalogOptions, DatabaseNames as NativeDatabaseNames } from "./native.js";
 import { OAuthConfig } from "./oauth";
 /** Options shared by a catalog and the database connections it returns. */
 export interface CatalogOptions extends Omit<NativeCatalogOptions, "oauthConfig"> {
@@ -8,7 +8,27 @@ export interface CatalogOptions extends Omit<NativeCatalogOptions, "oauthConfig"
     /** Called for each request to supply authentication headers. */
     headerProvider?: HeaderProvider | (() => Record<string, string> | Promise<Record<string, string>>);
 }
-export type { ListDatabasesResponse } from "./native.js";
+/**
+ * A lazy async iterator of database names with pagination state.
+ * Returned by {@link Catalog.listDatabases}.
+ */
+export declare class DatabaseNames implements AsyncIterableIterator<string> {
+    private readonly inner;
+    /** @hidden */
+    constructor(inner: NativeDatabaseNames);
+    [Symbol.asyncIterator](): AsyncIterableIterator<string>;
+    /** Fetch the next name, requesting another page only when needed. */
+    next(): Promise<IteratorResult<string>>;
+    /** Number of names available without another REST request. */
+    numPageResults(): number;
+    /**
+     * Token for the next REST request. Initially this is the supplied starting token.
+     * Returns undefined after the final page is fetched, even if names remain cached.
+     * Drain the cache before saving a token to avoid skipping names when resuming.
+     * A failed request terminates iteration and retains its token for a new iterator.
+     */
+    pageToken(): string | undefined;
+}
 /** A remote catalog manages databases through the server's root namespace. */
 export declare class Catalog {
     private readonly inner;
@@ -26,11 +46,23 @@ export declare class Catalog {
     dropDatabase(name: string, options?: {
         ignoreMissing?: boolean;
     }): Promise<void>;
-    /** List one page of databases; pass pageToken from a response for the next page. */
+    /**
+     * Iterate lazily over all database names using `for await...of`.
+     * pageToken resumes from a saved token; omitted starts at the beginning.
+     * pageLimit limits each REST response, not the total; omitted uses the server default.
+     * Request errors are raised during iteration and terminate the iterator.
+     *
+     * @example
+     * ```ts
+     * for await (const name of catalog.listDatabases({ pageLimit: 20 })) {
+     *   console.log(name);
+     * }
+     * ```
+     */
     listDatabases(options?: {
-        limit?: number;
+        pageLimit?: number;
         pageToken?: string;
-    }): Promise<ListDatabasesResponse>;
+    }): DatabaseNames;
 }
 /**
  * Connect to an HTTP(S) catalog endpoint. Catalog requests omit database-selection
@@ -40,7 +72,9 @@ export declare class Catalog {
  * ```ts
  * const catalog = await connectCatalog("https://my-server.example", { apiKey: "secret" });
  * const db = await catalog.createDatabase("analytics", { existOk: true });
- * const page = await catalog.listDatabases({ limit: 20 });
+ * for await (const name of catalog.listDatabases({ pageLimit: 20 })) {
+ *   console.log(name);
+ * }
  * ```
  */
 export declare function connectCatalog(endpoint: string, options?: CatalogOptions): Promise<Catalog>;

package/dist/catalog.js

@@ -2,10 +2,45 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: Copyright The LanceDB Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Catalog = void 0;
+exports.Catalog = exports.DatabaseNames = void 0;
 exports.connectCatalog = connectCatalog;
 const connection_1 = require("./connection");
 const native_js_1 = require("./native.js");
+/**
+ * A lazy async iterator of database names with pagination state.
+ * Returned by {@link Catalog.listDatabases}.
+ */
+class DatabaseNames {
+    inner;
+    /** @hidden */
+    constructor(inner) {
+        this.inner = inner;
+    }
+    [Symbol.asyncIterator]() {
+        return this;
+    }
+    /** Fetch the next name, requesting another page only when needed. */
+    async next() {
+        const value = await this.inner.next();
+        return value == null
+            ? { done: true, value: undefined }
+            : { done: false, value };
+    }
+    /** Number of names available without another REST request. */
+    numPageResults() {
+        return this.inner.numPageResults();
+    }
+    /**
+     * Token for the next REST request. Initially this is the supplied starting token.
+     * Returns undefined after the final page is fetched, even if names remain cached.
+     * Drain the cache before saving a token to avoid skipping names when resuming.
+     * A failed request terminates iteration and retains its token for a new iterator.
+     */
+    pageToken() {
+        return this.inner.pageToken() ?? undefined;
+    }
+}
+exports.DatabaseNames = DatabaseNames;
 /** A remote catalog manages databases through the server's root namespace. */
 class Catalog {
     inner;
@@ -29,15 +64,27 @@ class Catalog {
     async dropDatabase(name, options = {}) {
         await this.inner.dropDatabase(name, options.ignoreMissing);
     }
-    /** List one page of databases; pass pageToken from a response for the next page. */
-    async listDatabases(options = {}) {
-        if (options.limit !== undefined &&
-            (!Number.isInteger(options.limit) ||
-                options.limit <= 0 ||
-                options.limit > 2147483647)) {
+    /**
+     * Iterate lazily over all database names using `for await...of`.
+     * pageToken resumes from a saved token; omitted starts at the beginning.
+     * pageLimit limits each REST response, not the total; omitted uses the server default.
+     * Request errors are raised during iteration and terminate the iterator.
+     *
+     * @example
+     * ```ts
+     * for await (const name of catalog.listDatabases({ pageLimit: 20 })) {
+     *   console.log(name);
+     * }
+     * ```
+     */
+    listDatabases(options = {}) {
+        if (options.pageLimit !== undefined &&
+            (!Number.isInteger(options.pageLimit) ||
+                options.pageLimit <= 0 ||
+                options.pageLimit > 2147483647)) {
             throw new Error("Database list limit must be an integer between 1 and 2147483647");
         }
-        return this.inner.listDatabases(options.limit, options.pageToken);
+        return new DatabaseNames(this.inner.listDatabases(options.pageToken, options.pageLimit));
     }
 }
 exports.Catalog = Catalog;
@@ -49,7 +96,9 @@ exports.Catalog = Catalog;
  * ```ts
  * const catalog = await connectCatalog("https://my-server.example", { apiKey: "secret" });
  * const db = await catalog.createDatabase("analytics", { existOk: true });
- * const page = await catalog.listDatabases({ limit: 20 });
+ * for await (const name of catalog.listDatabases({ pageLimit: 20 })) {
+ *   console.log(name);
+ * }
  * ```
  */
 async function connectCatalog(endpoint, options = {}) {

package/dist/connection.d.ts

@@ -260,10 +260,6 @@ export declare abstract class Connection {
      * The view is populated before creation returns. Set `withNoData` to create
      * only its definition and empty backing table. The view is a normal table:
      * it can be queried, indexed and searched, and it appears in `tableNames`.
-     * The source table must have stable row ids (create it with
-     * the `newTableEnableStableRowIds` storage option); they keep the view's
-     * provenance valid across source compactions and cannot be enabled after
-     * a table exists.
      */
     abstract createMaterializedView(name: string, source: string, options?: {
         select?: MaterializedViewSelect;
@@ -501,6 +497,22 @@ export declare abstract class Connection {
      * such job exists. Cancelling an already-terminal job is a no-op success.
      */
     abstract cancelJob(jobId: string): Promise<boolean>;
+    /**
+     * Pause a server-side job by id.
+     *
+     * The job's workers drain and it stays parked until resumed. Resolves to
+     * "pausing", "already_paused", or "committing" -- a job finalizing its
+     * results cannot be parked; retry shortly.
+     */
+    abstract pauseJob(jobId: string): Promise<string>;
+    /**
+     * Resume a paused server-side job by id.
+     *
+     * Its workers pick their work back up from checkpoints. Resolves to
+     * "resumed", "still_pausing" -- the pause's worker drain is not confirmed
+     * yet; retry shortly -- or "not_paused".
+     */
+    abstract resumeJob(jobId: string): Promise<string>;
 }
 /** @hideconstructor */
 export declare class LocalConnection extends Connection {
@@ -552,6 +564,8 @@ export declare class LocalConnection extends Connection {
     openJob(jobId: string): Promise<Job>;
     listJobs(): Promise<JobInfo[]>;
     cancelJob(jobId: string): Promise<boolean>;
+    pauseJob(jobId: string): Promise<string>;
+    resumeJob(jobId: string): Promise<string>;
 }
 /**
  * Takes storage options and makes all the keys snake case.

package/dist/connection.js

@@ -249,6 +249,12 @@ class LocalConnection extends Connection {
     async cancelJob(jobId) {
         return this.inner.cancelJob(jobId);
     }
+    async pauseJob(jobId) {
+        return this.inner.pauseJob(jobId);
+    }
+    async resumeJob(jobId) {
+        return this.inner.resumeJob(jobId);
+    }
 }
 exports.LocalConnection = LocalConnection;
 /**
@@ -297,7 +303,8 @@ async function parseTableData(data, options, streaming = false) {
         table = (0, sanitize_1.sanitizeTable)(data);
     }
     else {
-        table = (0, arrow_1.makeArrowTable)(data, options);
+        const records = await (0, arrow_1.resolveBlobInputs)(data, options?.schema);
+        table = (0, arrow_1.makeArrowTable)(records, options);
     }
     if (streaming) {
         const buf = await (0, arrow_1.fromTableToStreamBuffer)(table, options?.embeddingFunction, options?.schema);

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export { instrumentLanceDbMetrics } from "./otel";
 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";
 export { makeArrowTable, makeJsonField, MakeArrowTableOptions, Data, VectorColumnOptions, } from "./arrow";
 export { blob, isBlobField, BlobFile } from "./blob";
-export type { BlobOptions } from "./blob";
+export type { BlobData, BlobInput, BlobOptions, BlobRange, BlobReadOptions, BlobUri, } from "./blob";
 export { Connection, CreateTableOptions, TableNamesOptions, ListTablesOptions, OpenTableOptions, ListNamespacesOptions, CreateNamespaceOptions, DropNamespaceOptions, ListNamespacesResponse, ListTablesResponse, CreateNamespaceResponse, DropNamespaceResponse, DescribeNamespaceResponse, RenameTableOptions, } from "./connection";
 export { JobFailureInfo, JobInfo, Session } from "./native.js";
 export { Job, JobEventsOptions } from "./job";
@@ -24,7 +24,7 @@ export * as embedding from "./embedding";
 export { permutationBuilder, PermutationBuilder } from "./permutation";
 export { Scannable, ScannableOptions } from "./scannable";
 export * as rerankers from "./rerankers";
-export { SchemaLike, TableLike, FieldLike, RecordBatchLike, DataLike, IntoVector, MultiVector, } from "./arrow";
+export { SchemaLike, TableLike, DataTypeLike, FieldLike, RecordBatchLike, DataLike, IntoVector, MultiVector, } from "./arrow";
 export { IntoSql, packBits } from "./util";
 /**
  * Options for tokenizing a full-text search query without a table index.
@@ -248,4 +248,4 @@ export declare function connectNamespace(implName: "rest", config: RestNamespace
  * ```
  */
 export declare function connectNamespace(implName: string, properties: Record<string, string>, options?: Partial<ConnectNamespaceOptions>): Promise<Connection>;
-export { Catalog, CatalogOptions, ListDatabasesResponse, connectCatalog, } from "./catalog";
+export { Catalog, CatalogOptions, DatabaseNames, connectCatalog, } from "./catalog";

package/dist/index.js

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: Copyright The LanceDB Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.connectCatalog = exports.Catalog = exports.packBits = exports.rerankers = exports.Scannable = exports.PermutationBuilder = exports.permutationBuilder = exports.embedding = exports.MergeInsertBuilder = exports.OAuthSession = exports.OAuthFlowType = exports.ClientAuthMethod = exports.OAuthHeaderProvider = exports.StaticHeaderProvider = exports.HeaderProvider = exports.Branches = exports.Table = exports.Index = exports.Occur = exports.Operator = exports.FullTextQueryType = exports.BooleanQuery = exports.MultiMatchQuery = exports.BoostQuery = exports.PhraseQuery = exports.MatchQuery = exports.RecordBatchIterator = exports.TakeQuery = exports.VectorQuery = exports.QueryBase = exports.Query = exports.AutoQuery = exports.Job = exports.Session = exports.Connection = exports.BlobFile = exports.isBlobField = exports.blob = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeJsonField = exports.makeArrowTable = exports.BranchContents = exports.TagContents = exports.Tags = exports.instrumentLanceDbMetrics = exports.NativeJsHeaderProvider = exports.MaterializedView = void 0;
+exports.connectCatalog = exports.DatabaseNames = exports.Catalog = exports.packBits = exports.rerankers = exports.Scannable = exports.PermutationBuilder = exports.permutationBuilder = exports.embedding = exports.MergeInsertBuilder = exports.OAuthSession = exports.OAuthFlowType = exports.ClientAuthMethod = exports.OAuthHeaderProvider = exports.StaticHeaderProvider = exports.HeaderProvider = exports.Branches = exports.Table = exports.Index = exports.Occur = exports.Operator = exports.FullTextQueryType = exports.BooleanQuery = exports.MultiMatchQuery = exports.BoostQuery = exports.PhraseQuery = exports.MatchQuery = exports.RecordBatchIterator = exports.TakeQuery = exports.VectorQuery = exports.QueryBase = exports.Query = exports.AutoQuery = exports.Job = exports.Session = exports.Connection = exports.BlobFile = exports.isBlobField = exports.blob = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeJsonField = exports.makeArrowTable = exports.BranchContents = exports.TagContents = exports.Tags = exports.instrumentLanceDbMetrics = exports.NativeJsHeaderProvider = exports.MaterializedView = void 0;
 exports.tokenize = tokenize;
 exports.connect = connect;
 exports.connectNamespace = connectNamespace;
@@ -184,4 +184,5 @@ async function connectNamespace(implName, configOrProperties, options) {
 }
 var catalog_1 = require("./catalog");
 Object.defineProperty(exports, "Catalog", { enumerable: true, get: function () { return catalog_1.Catalog; } });
+Object.defineProperty(exports, "DatabaseNames", { enumerable: true, get: function () { return catalog_1.DatabaseNames; } });
 Object.defineProperty(exports, "connectCatalog", { enumerable: true, get: function () { return catalog_1.connectCatalog; } });

package/dist/materialized_view.d.ts

@@ -57,17 +57,11 @@ export declare class MaterializedView {
     /**
      * Recompute the view from its source.
      *
-     * The refresh is incremental when the source's changes can be reconciled
-     * into the view -- rows added, changed or removed since the last one --
-     * and otherwise rebuilds. `full` forces a rebuild; `sourceVersion`
-     * refreshes to that source version instead of the latest.
-     *
-     * Concurrent refreshes of one view do not duplicate its rows. Two that
-     * plan the same source rows conflict on commit, and the loser throws
-     * rather than writing them a second time.
+     * Every refresh rebuilds the complete view. For local views,
+     * `sourceVersion` refreshes to that source version instead of the latest;
+     * remote SQL refreshes do not support source-version pinning.
      */
     refresh(options?: {
-        full?: boolean;
         sourceVersion?: number;
     }): Promise<RefreshMaterializedViewResult>;
 }

package/dist/materialized_view.js

@@ -132,18 +132,13 @@ class MaterializedView {
     /**
      * Recompute the view from its source.
      *
-     * The refresh is incremental when the source's changes can be reconciled
-     * into the view -- rows added, changed or removed since the last one --
-     * and otherwise rebuilds. `full` forces a rebuild; `sourceVersion`
-     * refreshes to that source version instead of the latest.
-     *
-     * Concurrent refreshes of one view do not duplicate its rows. Two that
-     * plan the same source rows conflict on commit, and the loser throws
-     * rather than writing them a second time.
+     * Every refresh rebuilds the complete view. For local views,
+     * `sourceVersion` refreshes to that source version instead of the latest;
+     * remote SQL refreshes do not support source-version pinning.
      */
     async refresh(options) {
         validateNonNegativeInteger(options?.sourceVersion, "sourceVersion");
-        return await this.inner.refreshMaterializedView(options?.full, options?.sourceVersion);
+        return await this.inner.refreshMaterializedView(options?.sourceVersion);
     }
 }
 exports.MaterializedView = MaterializedView;