AsyncDuckDB | DuckDB-WASM
index AsyncDuckDB Class AsyncDuckDB An interface for the async DuckDB bindings Implements AsyncDuckDBBindings Index Constructors constructor Accessors config logger Methods cancel Pending Query close Prepared collect File Statistics connect connect Internal copy File To Buffer copy File To Path create Prepared detach disconnect drop File drop Files export File Statistics fetch Query Results flush Files get Feature Flags get Table Names get Version glob Files insert Arrow From IPC Stream insert CSV From Path insert JSON From Path instantiate is Detached open ping poll Pending Query register Empty File Buffer register File Buffer register File Handle register File Text register File URL register OPFS File Name reset run Prepared run Query send Prepared start Pending Query terminate tokenize Constructors constructor new AsyncDuckDB ( logger : Logger , worker ?: Worker | null ) : AsyncDuckDB Parameters logger : Logger worker : Worker | null = null Returns AsyncDuckDB Accessors config get config () : DuckDBConfig Get the logger Returns DuckDBConfig logger get logger () : Logger Get the logger Returns Logger Methods cancel Pending Query cancelPendingQuery ( conn : number ) : Promise < boolean > Cancel a pending query Parameters conn : number Returns Promise < boolean > close Prepared closePrepared ( conn : number , statement : number ) : Promise < void > Close a prepared statement Parameters conn : number statement : number Returns Promise < void > collect File Statistics collectFileStatistics ( name : string , enable : boolean ) : Promise < void > Enable file statistics Parameters name : string enable : boolean Returns Promise < void > connect connect () : Promise < AsyncDuckDBConnection > Connect to the database Returns Promise < AsyncDuckDBConnection > connect Internal connectInternal () : Promise < number > Connect to the database Returns Promise < number > copy File To Buffer copyFileToBuffer ( name : string ) : Promise < Uint8Array > Copy a file to a buffer.
Parameters name : string Returns Promise < Uint8Array > copy File To Path copyFileToPath ( name : string , path : string ) : Promise < void > Copy a file to a path. Parameters name : string path : string Returns Promise < void > create Prepared createPrepared ( conn : number , text : string ) : Promise < number > Prepare a statement and return its identifier Parameters conn : number text : string Returns Promise < number > detach detach () : void Detach from worker Returns void disconnect disconnect ( conn : number ) : Promise < void > Disconnect from the database Parameters conn : number Returns Promise < void > drop File dropFile ( name : string ) : Promise < null > Try to drop a file Parameters name : string Returns Promise < null > drop Files dropFiles ( names ?: string [] ) : Promise < null > Try to drop files Parameters Optional names : string [] Returns Promise < null > export File Statistics exportFileStatistics ( name : string ) : Promise < FileStatistics > Export file statistics Parameters name : string Returns Promise < FileStatistics > fetch Query Results fetchQueryResults ( conn : number ) : Promise < Uint8Array | null > Fetch query results Parameters conn : number Returns Promise < Uint8Array | null > flush Files flushFiles () : Promise < null > Flush all files Returns Promise < null > get Feature Flags getFeatureFlags () : Promise < number > Get the feature flags Returns Promise < number > get Table Names getTableNames ( conn : number , text : string ) : Promise < string [] > Get table names Parameters conn : number text : string Returns Promise < string [] > get Version getVersion () : Promise < string > Get the version Returns Promise < string > glob Files globFiles ( path : string ) : Promise < WebFile [] > Glob file infos Parameters path : string Returns Promise < WebFile [] > insert Arrow From IPC Stream insertArrowFromIPCStream ( conn : number , buffer : Uint8Array , options ?: ArrowInsertOptions , ) : Promise < void > Insert arrow from an ipc stream Parameters conn : number buffer : Uint8Array Optional options : ArrowInsertOptions Returns Promise < void > insert CSV From Path insertCSVFromPath ( conn : number , path : string , options : CSVInsertOptions , ) : Promise < void > Insert a csv file Parameters conn : number path : string options : CSVInsertOptions Returns Promise < void > insert JSON From Path insertJSONFromPath ( conn : number , path : string , options : JSONInsertOptions , ) : Promise < void > Insert a json file Parameters conn : number path : string options : JSONInsertOptions Returns Promise < void > instantiate instantiate ( mainModuleURL : string , pthreadWorkerURL ?: string | null , progress ?: ( progress : InstantiationProgress ) => void , ) : Promise < null > Open the database Parameters mainModuleURL : string pthreadWorkerURL : string | null = null progress : ( progress : InstantiationProgress ) => void = ...
Returns Promise < null > is Detached isDetached () : boolean Is in detached state, no worker defined Returns boolean open open ( config : DuckDBConfig ) : Promise < void > Open a new database Parameters config : DuckDBConfig Returns Promise < void > ping ping () : Promise < any > Ping the worker thread Returns Promise < any > poll Pending Query pollPendingQuery ( conn : number ) : Promise < Uint8Array | null > Poll a pending query Parameters conn : number Returns Promise < Uint8Array | null > register Empty File Buffer registerEmptyFileBuffer ( name : string ) : Promise < void > Register an empty file buffer.
Parameters name : string Returns Promise < void > register File Buffer registerFileBuffer ( name : string , buffer : Uint8Array ) : Promise < void > Register a file buffer. Parameters name : string buffer : Uint8Array Returns Promise < void > register File Handle registerFileHandle < HandleType > ( name : string , handle : HandleType , protocol : DuckDBDataProtocol , directIO : boolean , ) : Promise < void > Register a file handle.
Type Parameters HandleType Parameters name : string handle : HandleType protocol : DuckDBDataProtocol directIO : boolean Returns Promise < void > register File Text registerFileText ( name : string , text : string ) : Promise < void > Register file text Parameters name : string text : string Returns Promise < void > register File URL registerFileURL ( name : string , url : string , proto : DuckDBDataProtocol , directIO : boolean , ) : Promise < void > Register a file path.
Parameters name : string url : string proto : DuckDBDataProtocol directIO : boolean Returns Promise < void > register OPFS File Name registerOPFSFileName ( name : string ) : Promise < void > Enable file statistics Parameters name : string Returns Promise < void > reset reset () : Promise < null > Reset the duckdb Returns Promise < null > run Prepared runPrepared ( conn : number , statement : number , params : any [] ) : Promise < Uint8Array > Execute a prepared statement and return the full result Parameters conn : number statement : number params : any [] Returns Promise < Uint8Array > run Query runQuery ( conn : number , text : string ) : Promise < Uint8Array > Run a query Parameters conn : number text : string Returns Promise < Uint8Array > send Prepared sendPrepared ( conn : number , statement : number , params : any [] , ) : Promise < Uint8Array > Execute a prepared statement and stream the result Parameters conn : number statement : number params : any [] Returns Promise < Uint8Array > start Pending Query startPendingQuery ( conn : number , text : string , allowStreamResult ?: boolean , ) : Promise < Uint8Array | null > Start a pending query Parameters conn : number text : string allowStreamResult : boolean = false Returns Promise < Uint8Array | null > terminate terminate () : Promise < void > Kill the worker Returns Promise < void > tokenize tokenize ( text : string ) : Promise < ScriptTokens > Tokenize a script text Parameters text : string Returns Promise < ScriptTokens > Settings Member Visibility Inherited External Theme On This Page C
The rest of this page is on the live site.