DuckDB-WASM
Preparing search index...
index
DuckDBBindings
Interface DuckDBBindings
interface
DuckDBBindings
{
cancelPendingQuery
(
conn
:
number
)
:
boolean
;
closePrepared
(
conn
:
number
,
statement
:
number
)
:
void
;
collectFileStatistics
(
file
:
string
,
enable
:
boolean
)
:
void
;
connect
()
:
DuckDBConnection
;
copyFileToBuffer
(
name
:
string
)
:
Uint8Array
;
copyFileToPath
(
name
:
string
,
path
:
string
)
:
void
;
createPrepared
(
conn
:
number
,
text
:
string
)
:
number
;
createScalarFunction
(
conn
:
number
,
name
:
string
,
returns
:
DataType
,
func
:
(
...
args
:
any
[]
)
=>
void
,
)
:
void
;
disconnect
(
conn
:
number
)
:
void
;
dropFile
(
name
:
string
)
:
void
;
dropFiles
(
names
?:
string
[]
)
:
void
;
exportFileStatistics
(
file
:
string
)
:
FileStatistics
;
fetchQueryResults
(
conn
:
number
)
:
Uint8Array
|
null
;
flushFiles
()
:
void
;
getFeatureFlags
()
:
number
;
getTableNames
(
conn
:
number
,
text
:
string
)
:
string
[]
;
getVersion
()
:
string
;
globFiles
(
path
:
string
)
:
WebFile
[]
;
insertArrowFromIPCStream
(
conn
:
number
,
buffer
:
Uint8Array
,
options
?:
ArrowInsertOptions
,
)
:
void
;
insertCSVFromPath
(
conn
:
number
,
path
:
string
,
options
:
CSVInsertOptions
,
)
:
void
;
insertJSONFromPath
(
conn
:
number
,
path
:
string
,
options
:
JSONInsertOptions
,
)
:
void
;
instantiate
(
onProgress
:
(
p
:
InstantiationProgress
)
=>
void
,
)
:
Promise
<
DuckDBBindings
>
;
open
(
config
:
DuckDBConfig
)
:
void
;
pollPendingQuery
(
conn
:
number
)
:
Uint8Array
|
null
;
prepareDBFileHandle
(
path
:
string
,
protocol
:
DuckDBDataProtocol
,
)
:
Promise
<
void
>
;
prepareFileHandle
(
path
:
string
,
protocol
:
DuckDBDataProtocol
,
)
:
Promise
<
void
>
;
prepareFileHandleAsync
<
HandleType
>
(
name
:
string
,
handle
:
HandleType
,
protocol
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
Promise
<
HandleType
>
;
registerFileBuffer
(
name
:
string
,
buffer
:
Uint8Array
)
:
void
;
registerFileHandle
<
HandleType
>
(
name
:
string
,
handle
:
HandleType
,
protocol
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
void
;
registerFileHandleAsync
<
HandleType
>
(
name
:
string
,
handle
:
HandleType
,
protocol
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
Promise
<
void
>
;
registerFileText
(
name
:
string
,
text
:
string
)
:
void
;
registerFileURL
(
name
:
string
,
url
:
string
,
proto
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
void
;
registerOPFSFileName
(
file
:
string
)
:
Promise
<
void
>
;
reset
()
:
void
;
runPrepared
(
conn
:
number
,
statement
:
number
,
params
:
any
[]
)
:
Uint8Array
;
runQuery
(
conn
:
number
,
text
:
string
)
:
Uint8Array
;
sendPrepared
(
conn
:
number
,
statement
:
number
,
params
:
any
[]
)
:
Uint8Array
;
startPendingQuery
(
conn
:
number
,
text
:
string
,
allowStreamResult
:
boolean
,
)
:
Uint8Array
|
null
;
tokenize
(
text
:
string
)
:
ScriptTokens
;
}
Implemented by
DuckDBBindingsBase
Index
Methods
cancel
Pending
Query
close
Prepared
collect
File
Statistics
connect
copy
File
To
Buffer
copy
File
To
Path
create
Prepared
create
Scalar
Function
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
open
poll
Pending
Query
prepare
DB
File
Handle
prepare
File
Handle
prepare
File
Handle
Async
register
File
Buffer
register
File
Handle
register
File
Handle
Async
register
File
Text
register
File
URL
register
OPFS
File
Name
reset
run
Prepared
run
Query
send
Prepared
start
Pending
Query
tokenize
Methods
cancel
Pending
Query
cancelPendingQuery
(
conn
:
number
)
:
boolean
Parameters
conn
:
number
Returns
boolean
close
Prepared
closePrepared
(
conn
:
number
,
statement
:
number
)
:
void
Parameters
conn
:
number
statement
:
number
Returns
void
collect
File
Statistics
collectFileStatistics
(
file
:
string
,
enable
:
boolean
)
:
void
Parameters
file
:
string
enable
:
boolean
Returns
void
connect
connect
()
:
DuckDBConnection
Returns
DuckDBConnection
copy
File
To
Buffer
copyFileToBuffer
(
name
:
string
)
:
Uint8Array
Parameters
name
:
string
Returns
Uint8Array
copy
File
To
Path
copyFileToPath
(
name
:
string
,
path
:
string
)
:
void
Parameters
name
:
string
path
:
string
Returns
void
create
Prepared
createPrepared
(
conn
:
number
,
text
:
string
)
:
number
Parameters
conn
:
number
text
:
string
Returns
number
create
Scalar
Function
createScalarFunction
(
conn
:
number
,
name
:
string
,
returns
:
DataType
,
func
:
(
...
args
:
any
[]
)
=>
void
,
)
:
void
Parameters
conn
:
number
name
:
string
returns
:
DataType
func
:
(
...
args
:
any
[]
)
=>
void
Returns
void
disconnect
disconnect
(
conn
:
number
)
:
void
Parameters
conn
:
number
Returns
void
drop
File
dropFile
(
name
:
string
)
:
void
Parameters
name
:
string
Returns
void
drop
Files
dropFiles
(
names
?:
string
[]
)
:
void
Parameters
Optional
names
:
string
[]
Returns
void
export
File
Statistics
exportFileStatistics
(
file
:
string
)
:
FileStatistics
Parameters
file
:
string
Returns
FileStatistics
fetch
Query
Results
fetchQueryResults
(
conn
:
number
)
:
Uint8Array
|
null
Parameters
conn
:
number
Returns
Uint8Array
|
null
flush
Files
flushFiles
()
:
void
Returns
void
get
Feature
Flags
getFeatureFlags
()
:
number
Returns
number
get
Table
Names
getTableNames
(
conn
:
number
,
text
:
string
)
:
string
[]
Parameters
conn
:
number
text
:
string
Returns
string
[]
get
Version
getVersion
()
:
string
Returns
string
glob
Files
globFiles
(
path
:
string
)
:
WebFile
[]
Parameters
path
:
string
Returns
WebFile
[]
insert
Arrow
From
IPC
Stream
insertArrowFromIPCStream
(
conn
:
number
,
buffer
:
Uint8Array
,
options
?:
ArrowInsertOptions
,
)
:
void
Parameters
conn
:
number
buffer
:
Uint8Array
Optional
options
:
ArrowInsertOptions
Returns
void
insert
CSV
From
Path
insertCSVFromPath
(
conn
:
number
,
path
:
string
,
options
:
CSVInsertOptions
)
:
void
Parameters
conn
:
number
path
:
string
options
:
CSVInsertOptions
Returns
void
insert
JSON
From
Path
insertJSONFromPath
(
conn
:
number
,
path
:
string
,
options
:
JSONInsertOptions
)
:
void
Parameters
conn
:
number
path
:
string
options
:
JSONInsertOptions
Returns
void
instantiate
instantiate
(
onProgress
:
(
p
:
InstantiationProgress
)
=>
void
,
)
:
Promise
<
DuckDBBindings
>
Parameters
onProgress
:
(
p
:
InstantiationProgress
)
=>
void
Returns
Promise
<
DuckDBBindings
>
open
open
(
config
:
DuckDBConfig
)
:
void
Parameters
config
:
DuckDBConfig
Returns
void
poll
Pending
Query
pollPendingQuery
(
conn
:
number
)
:
Uint8Array
|
null
Parameters
conn
:
number
Returns
Uint8Array
|
null
prepare
DB
File
Handle
prepareDBFileHandle
(
path
:
string
,
protocol
:
DuckDBDataProtocol
)
:
Promise
<
void
>
Parameters
path
:
string
protocol
:
DuckDBDataProtocol
Returns
Promise
<
void
>
prepare
File
Handle
prepareFileHandle
(
path
:
string
,
protocol
:
DuckDBDataProtocol
)
:
Promise
<
void
>
Parameters
path
:
string
protocol
:
DuckDBDataProtocol
Returns
Promise
<
void
>
prepare
File
Handle
Async
prepareFileHandleAsync
<
HandleType
>
(
name
:
string
,
handle
:
HandleType
,
protocol
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
Promise
<
HandleType
>
Type Parameters
HandleType
Parameters
name
:
string
handle
:
HandleType
protocol
:
DuckDBDataProtocol
directIO
:
boolean
Returns
Promise
<
HandleType
>
register
File
Buffer
registerFileBuffer
(
name
:
string
,
buffer
:
Uint8Array
)
:
void
Parameters
name
:
string
buffer
:
Uint8Array
Returns
void
register
File
Handle
registerFileHandle
<
HandleType
>
(
name
:
string
,
handle
:
HandleType
,
protocol
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
void
Type Parameters
HandleType
Parameters
name
:
string
handle
:
HandleType
protocol
:
DuckDBDataProtocol
directIO
:
boolean
Returns
void
register
File
Handle
Async
registerFileHandleAsync
<
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
Text
registerFileText
(
name
:
string
,
text
:
string
)
:
void
Parameters
name
:
string
text
:
string
Returns
void
register
File
URL
registerFileURL
(
name
:
string
,
url
:
string
,
proto
:
DuckDBDataProtocol
,
directIO
:
boolean
,
)
:
void
Parameters
name
:
string
url
:
string
proto
:
DuckDBDataProtocol
directIO
:
boolean
Returns
void
register
OPFS
File
Name
registerOPFSFileName
(
file
:
string
)
:
Promise
<
void
>
Parameters
file
:
string
Returns
Promise
<
void
>
reset
reset
()
:
void
Returns
void
run
Prepared
runPrepared
(
conn
:
number
,
statement
:
number
,
params
:
any
[]
)
:
Uint8Array
Parameters
conn
:
number
statement
:
number
params
:
any
[]
Returns
Uint8Array
run
Query
runQuery
(
conn
:
number
,
text
:
string
)
:
Uint8Array
Parameters
conn
:
number
text
:
string
Returns
Uint8Array
send
Prepared
sendPrepared
(
conn
:
number
,
statement
:
number
,
params
:
any
[]
)
:
Uint8Array
Parameters
conn
:
number
statement
:
number
params
:
any
[]
Returns
Uint8Array
start
Pending
Query
startPendingQuery
(
conn
:
number
,
text
:
string
,
allowStreamResult
:
boolean
,
)
:
Uint8Array
|
null
Parameters
conn
:
number
text
:
string
allowStreamResult
:
boolean
Returns
Uint8Array
|
null
tokenize
tokenize
(
text
:
string
)
:
ScriptTokens
Parameters
text
:
string
Returns
ScriptTokens
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
cancel
Pending
Query
close
Prepared
collect
File
Statistics
connect
copy
File
To
Buffer
copy
File
To
Path
create
Prepared
create
Scalar
Function
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
open
poll
Pending
Query
prepare
DB
File
Handle
prepare
File
Handle
prepare
File
Handle
Async
register
File
Buffer
register
File
Handle
register
File
Handle
Async
register
File
Text
register
File
URL
register
OPFS
File
Name
reset
run
Prepared
run
Query
send
Prepared
start
Pending
Query
tokenize
DuckDB-WASM
Loading...