DuckDB-WASM
Preparing search index...
index
AsyncDuckDBBindings
Interface AsyncDuckDBBindings
An interface for the async DuckDB bindings
interface
AsyncDuckDBBindings
{
logger
:
Logger
;
cancelPendingQuery
(
conn
:
number
)
:
Promise
<
boolean
>
;
closePrepared
(
conn
:
number
,
statement
:
number
)
:
Promise
<
void
>
;
copyFileToBuffer
(
name
:
string
)
:
Promise
<
Uint8Array
>
;
copyFileToPath
(
name
:
string
,
out
:
string
)
:
Promise
<
void
>
;
createPrepared
(
conn
:
number
,
text
:
string
)
:
Promise
<
number
>
;
disconnect
(
conn
:
number
)
:
Promise
<
void
>
;
dropFile
(
name
:
string
)
:
Promise
<
null
>
;
dropFiles
(
names
?:
string
[]
)
:
Promise
<
null
>
;
fetchQueryResults
(
conn
:
number
)
:
Promise
<
Uint8Array
|
null
>
;
insertArrowFromIPCStream
(
conn
:
number
,
buffer
:
Uint8Array
,
options
?:
CSVInsertOptions
,
)
:
Promise
<
void
>
;
insertCSVFromPath
(
conn
:
number
,
path
:
string
,
options
:
CSVInsertOptions
,
)
:
Promise
<
void
>
;
insertJSONFromPath
(
conn
:
number
,
path
:
string
,
options
:
JSONInsertOptions
,
)
:
Promise
<
void
>
;
pollPendingQuery
(
conn
:
number
)
:
Promise
<
Uint8Array
|
null
>
;
registerFileBuffer
(
name
:
string
,
buffer
:
Uint8Array
)
:
Promise
<
void
>
;
registerFileHandle
<
HandleType
>
(
name
:
string
,
handle
:
HandleType
,
protocol
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
Promise
<
void
>
;
registerFileURL
(
name
:
string
,
url
:
string
,
proto
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
Promise
<
void
>
;
runPrepared
(
conn
:
number
,
statement
:
number
,
params
:
any
[]
,
)
:
Promise
<
Uint8Array
>
;
runQuery
(
conn
:
number
,
text
:
string
)
:
Promise
<
Uint8Array
>
;
sendPrepared
(
conn
:
number
,
statement
:
number
,
params
:
any
[]
,
)
:
Promise
<
Uint8Array
>
;
startPendingQuery
(
conn
:
number
,
text
:
string
,
allowStreamResult
:
boolean
,
)
:
Promise
<
Uint8Array
|
null
>
;
}
Implemented by
AsyncDuckDB
Index
Properties
logger
Methods
cancel
Pending
Query
close
Prepared
copy
File
To
Buffer
copy
File
To
Path
create
Prepared
disconnect
drop
File
drop
Files
fetch
Query
Results
insert
Arrow
From
IPC
Stream
insert
CSV
From
Path
insert
JSON
From
Path
poll
Pending
Query
register
File
Buffer
register
File
Handle
register
File
URL
run
Prepared
run
Query
send
Prepared
start
Pending
Query
Properties
logger
logger
:
Logger
Methods
cancel
Pending
Query
cancelPendingQuery
(
conn
:
number
)
:
Promise
<
boolean
>
Parameters
conn
:
number
Returns
Promise
<
boolean
>
close
Prepared
closePrepared
(
conn
:
number
,
statement
:
number
)
:
Promise
<
void
>
Parameters
conn
:
number
statement
:
number
Returns
Promise
<
void
>
copy
File
To
Buffer
copyFileToBuffer
(
name
:
string
)
:
Promise
<
Uint8Array
>
Parameters
name
:
string
Returns
Promise
<
Uint8Array
>
copy
File
To
Path
copyFileToPath
(
name
:
string
,
out
:
string
)
:
Promise
<
void
>
Parameters
name
:
string
out
:
string
Returns
Promise
<
void
>
create
Prepared
createPrepared
(
conn
:
number
,
text
:
string
)
:
Promise
<
number
>
Parameters
conn
:
number
text
:
string
Returns
Promise
<
number
>
disconnect
disconnect
(
conn
:
number
)
:
Promise
<
void
>
Parameters
conn
:
number
Returns
Promise
<
void
>
drop
File
dropFile
(
name
:
string
)
:
Promise
<
null
>
Parameters
name
:
string
Returns
Promise
<
null
>
drop
Files
dropFiles
(
names
?:
string
[]
)
:
Promise
<
null
>
Parameters
Optional
names
:
string
[]
Returns
Promise
<
null
>
fetch
Query
Results
fetchQueryResults
(
conn
:
number
)
:
Promise
<
Uint8Array
|
null
>
Parameters
conn
:
number
Returns
Promise
<
Uint8Array
|
null
>
insert
Arrow
From
IPC
Stream
insertArrowFromIPCStream
(
conn
:
number
,
buffer
:
Uint8Array
,
options
?:
CSVInsertOptions
,
)
:
Promise
<
void
>
Parameters
conn
:
number
buffer
:
Uint8Array
Optional
options
:
CSVInsertOptions
Returns
Promise
<
void
>
insert
CSV
From
Path
insertCSVFromPath
(
conn
:
number
,
path
:
string
,
options
:
CSVInsertOptions
,
)
:
Promise
<
void
>
Parameters
conn
:
number
path
:
string
options
:
CSVInsertOptions
Returns
Promise
<
void
>
insert
JSON
From
Path
insertJSONFromPath
(
conn
:
number
,
path
:
string
,
options
:
JSONInsertOptions
,
)
:
Promise
<
void
>
Parameters
conn
:
number
path
:
string
options
:
JSONInsertOptions
Returns
Promise
<
void
>
poll
Pending
Query
pollPendingQuery
(
conn
:
number
)
:
Promise
<
Uint8Array
|
null
>
Parameters
conn
:
number
Returns
Promise
<
Uint8Array
|
null
>
register
File
Buffer
registerFileBuffer
(
name
:
string
,
buffer
:
Uint8Array
)
:
Promise
<
void
>
Parameters
name
:
string
buffer
:
Uint8Array
Returns
Promise
<
void
>
register
File
Handle
registerFileHandle
<
HandleType
>
(
name
:
string
,
handle
:
HandleType
,
protocol
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
Promise
<
void
>
Type Parameters
HandleType
Parameters
name
:
string
handle
:
HandleType
protocol
:
DuckDBDataProtocol
directIO
:
boolean
Returns
Promise
<
void
>
register
File
URL
registerFileURL
(
name
:
string
,
url
:
string
,
proto
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
Promise
<
void
>
Parameters
name
:
string
url
:
string
proto
:
DuckDBDataProtocol
directIO
:
boolean
Returns
Promise
<
void
>
run
Prepared
runPrepared
(
conn
:
number
,
statement
:
number
,
params
:
any
[]
)
:
Promise
<
Uint8Array
>
Parameters
conn
:
number
statement
:
number
params
:
any
[]
Returns
Promise
<
Uint8Array
>
run
Query
runQuery
(
conn
:
number
,
text
:
string
)
:
Promise
<
Uint8Array
>
Parameters
conn
:
number
text
:
string
Returns
Promise
<
Uint8Array
>
send
Prepared
sendPrepared
(
conn
:
number
,
statement
:
number
,
params
:
any
[]
,
)
:
Promise
<
Uint8Array
>
Parameters
conn
:
number
statement
:
number
params
:
any
[]
Returns
Promise
<
Uint8Array
>
start
Pending
Query
startPendingQuery
(
conn
:
number
,
text
:
string
,
allowStreamResult
:
boolean
,
)
:
Promise
<
Uint8Array
|
null
>
Parameters
conn
:
number
text
:
string
allowStreamResult
:
boolean
Returns
Promise
<
Uint8Array
|
null
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
logger
Methods
cancel
Pending
Query
close
Prepared
copy
File
To
Buffer
copy
File
To
Path
create
Prepared
disconnect
drop
File
drop
Files
fetch
Query
Results
insert
Arrow
From
IPC
Stream
insert
CSV
From
Path
insert
JSON
From
Path
poll
Pending
Query
register
File
Buffer
register
File
Handle
register
File
URL
run
Prepared
run
Query
send
Prepared
start
Pending
Query
DuckDB-WASM
Loading...
An interface for the async DuckDB bindings