fix

duckdb · Feb 20, 2025 · 57ef254 · 57ef254
1 parent 69f4375
commit 57ef254
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/packages/duckdb-wasm/src/bindings/config.ts b/packages/duckdb-wasm/src/bindings/config.ts
@@ -31,9 +31,11 @@ export interface DuckDBFilesystemConfig {
 
 export interface DuckDBOPFSConfig {
     /**
-     * Auto Opfs File Registration
+     * Defines how `opfs://` files are handled during SQL execution.
+     * - "auto": Automatically register `opfs://` files and drop them after execution.
+     * - "manual": Files must be manually registered and dropped.
      */
-    autoFileRegistration?: boolean;
+    fileHandling?: "auto" | "manual";
 }
 
 export enum DuckDBAccessMode {

diff --git a/packages/duckdb-wasm/src/parallel/async_bindings.ts b/packages/duckdb-wasm/src/parallel/async_bindings.ts
@@ -403,7 +403,7 @@ export class AsyncDuckDB implements AsyncDuckDBBindings {
 
     /** Run a query */
     public async runQuery(conn: ConnectionID, text: string): Promise<Uint8Array> {
-        if( this.isOpenedOPFSAutoFileRegistration() ){
+        if( this.shouldOPFSFileHandling() ){
             const files = await this.registerOPFSFileFromSQL(text);
             try {
                 return await this._runQueryAsync(conn, text);
@@ -431,7 +431,7 @@ export class AsyncDuckDB implements AsyncDuckDBBindings {
         text: string,
         allowStreamResult: boolean = false,
     ): Promise<Uint8Array | null> {
-        if( this.isOpenedOPFSAutoFileRegistration() ){
+        if( this.shouldOPFSFileHandling() ){
             const files = await this.registerOPFSFileFromSQL(text);
             try {
                 return await this._startPendingQueryAsync(conn, text, allowStreamResult);
@@ -692,9 +692,9 @@ export class AsyncDuckDB implements AsyncDuckDBBindings {
         await this.postTask(task);
     }
 
-    private isOpenedOPFSAutoFileRegistration():boolean {
+    private shouldOPFSFileHandling():boolean {
         if( isOPFSProtocol(this.config.path ?? "")){
-            return this.config.opfs?.autoFileRegistration ?? false;
+            return this.config.opfs?.fileHandling == "auto";
         }
         return false;
     }

diff --git a/packages/duckdb-wasm/test/opfs.test.ts b/packages/duckdb-wasm/test/opfs.test.ts
@@ -284,7 +284,7 @@ export function testOPFS(baseDir: string, bundle: () => duckdb.DuckDBBundle): vo
             await db.reset();
             await db.dropFile('test.parquet');
             db.config.opfs = {
-                autoFileRegistration: true
+                fileHandling: "auto"
             };
             conn = await db.connect();
             //2. send query
@@ -307,7 +307,7 @@ export function testOPFS(baseDir: string, bundle: () => duckdb.DuckDBBundle): vo
             await db.reset();
             await db.dropFile('test.parquet');
             db.config.opfs = {
-                autoFileRegistration: true
+                fileHandling: "auto"
             };
             conn = await db.connect();
             //2. send query
@@ -332,7 +332,7 @@ export function testOPFS(baseDir: string, bundle: () => duckdb.DuckDBBundle): vo
             await db.reset();
             await db.dropFile('datadir/test.parquet');
             db.config.opfs = {
-                autoFileRegistration: true
+                fileHandling: "auto"
             };
             conn = await db.connect();
             //2. send query
@@ -365,7 +365,7 @@ export function testOPFS(baseDir: string, bundle: () => duckdb.DuckDBBundle): vo
         it('Copy CSV to OPFS + Load CSV', async () => {
             //1. data preparation
             db.config.opfs = {
-                autoFileRegistration: true
+                fileHandling: "auto"
             };
             await conn.query(`COPY ( SELECT 32 AS value ) TO 'opfs://file.csv'`);
             await conn.query(`COPY ( SELECT 42 AS value ) TO 'opfs://file.csv'`);