Node.js API

Search Shortcut cmd + k | ctrl + k

Documentation / Client APIs / Node.js

Node.js API

模块

duckdb

Typedefs

ColumnInfo : object
TypeInfo : object
DuckDbError : object
HTTPError : object

duckdb

概述: DuckDB 是一个可嵌入的 SQL OLAP 数据库管理系统

duckdb
- ~Connection
  - .run(sql, …params, callback) ⇒ void
  - .all(sql, …params, callback) ⇒ void
  - .arrowIPCAll(sql, …params, callback) ⇒ void
  - .arrowIPCStream(sql, …params, callback) ⇒
  - .each(sql, …params, callback) ⇒ void
  - .stream(sql, …params)
  - .register_udf(name, return_type, fun) ⇒ void
  - .prepare(sql, …params, callback) ⇒ Statement
  - .exec(sql, …params, callback) ⇒ void
  - .register_udf_bulk(name, return_type, callback) ⇒ void
  - .unregister_udf(name, return_type, callback) ⇒ void
  - .register_buffer(name, array, force, callback) ⇒ void
  - .unregister_buffer(name, callback) ⇒ void
  - .close(callback) ⇒ void
- ~Statement
  - .sql ⇒
  - .get()
  - .run(sql, …params, callback) ⇒ void
  - .all(sql, …params, callback) ⇒ void
  - .arrowIPCAll(sql, …params, callback) ⇒ void
  - .each(sql, …params, callback) ⇒ void
  - .finalize(sql, …params, callback) ⇒ void
  - .stream(sql, …params)
  - .columns() ⇒ Array.
- ~QueryResult
  - .nextChunk() ⇒
  - .nextIpcBuffer() ⇒
  - .asyncIterator()
- ~Database
  - .close(callback) ⇒ void
  - .close_internal(callback) ⇒ void
  - .wait(callback) ⇒ void
  - .serialize(callback) ⇒ void
  - .parallelize(callback) ⇒ void
  - .connect(path) ⇒ Connection
  - .interrupt(callback) ⇒ void
  - .prepare(sql) ⇒ Statement
  - .run(sql, …params, callback) ⇒ void
  - .scanArrowIpc(sql, …params, callback) ⇒ void
  - .each(sql, …params, callback) ⇒ void
  - .stream(sql, …params)
  - .all(sql, …params, callback) ⇒ void
  - .arrowIPCAll(sql, …params, callback) ⇒ void
  - .arrowIPCStream(sql, …params, callback) ⇒ void
  - .exec(sql, …params, callback) ⇒ void
  - .register_udf(name, return_type, fun) ⇒ this
  - .register_buffer(name) ⇒ this
  - .unregister_buffer(name) ⇒ this
  - .unregister_udf(name) ⇒ this
  - .registerReplacementScan(fun) ⇒ this
  - .tokenize(text) ⇒ ScriptTokens
  - .get()
- ~TokenType
- ~ERROR : number
- ~OPEN_READONLY : number
- ~OPEN_READWRITE : number
- ~OPEN_CREATE : number
- ~OPEN_FULLMUTEX : number
- ~OPEN_SHAREDCACHE : number
- ~OPEN_PRIVATECACHE : number

duckdb~Connection

类型: duckdb 的内部类

~Connection
- .run(sql, …params, callback) ⇒ void
- .all(sql, …params, callback) ⇒ void
- .arrowIPCAll(sql, …params, callback) ⇒ void
- .arrowIPCStream(sql, …params, callback) ⇒
- .each(sql, …params, callback) ⇒ void
- .stream(sql, …params)
- .register_udf(name, return_type, fun) ⇒ void
- .prepare(sql, …params, callback) ⇒ Statement
- .exec(sql, …params, callback) ⇒ void
- .register_udf_bulk(name, return_type, callback) ⇒ void
- .unregister_udf(name, return_type, callback) ⇒ void
- .register_buffer(name, array, force, callback) ⇒ void
- .unregister_buffer(name, callback) ⇒ void
- .close(callback) ⇒ void

connection.run(sql, …params, callback) ⇒ `void`

运行一个SQL语句并在完成后触发回调

类型: Connection 的实例方法

参数	类型
sql
…params	`\*`
callback

connection.all(sql, …params, callback) ⇒ `void`

运行SQL查询并为所有结果行触发回调

类型: Connection 的实例方法

参数	类型
sql
…params	`\*`
callback

connection.arrowIPCAll(sql, …params, callback) ⇒ `void`

运行SQL查询并将结果序列化为Apache Arrow IPC格式（需要加载arrow扩展）

类型: Connection 的实例方法

参数	类型
sql
…params	`\*`
callback

connection.arrowIPCStream(sql, …params, callback) ⇒

运行一个SQL查询，返回一个IpcResultStreamIterator，允许将结果流式传输到Apache Arrow IPC格式（需要加载arrow扩展）

类型: Connection 的实例方法
返回: Promise

Param	Type
sql
…params	`\*`
callback

connection.each(sql, …params, callback) ⇒ `void`

运行SQL查询并为每个结果行触发回调

Kind: instance method of Connection

Param	Type
sql
…params	`\*`
callback

connection.stream(sql, …params)

Kind: instance method of Connection

Param	Type
sql
…params	`\*`

connection.register_udf(name, return_type, fun) ⇒ `void`

注册一个用户自定义函数

类型: Connection 的实例方法
注意: 这在一定程度上遵循了 wasm udfs，但更简单，因为我们可以更清晰地传递数据

参数
name
return_type
fun

connection.prepare(sql, …params, callback) ⇒ `Statement`

准备一个SQL查询以供执行

Kind: instance method of Connection

Param	Type
sql
…params	`\*`
callback

connection.exec(sql, …params, callback) ⇒ `void`

执行一个SQL查询

Kind: instance method of Connection

Param	Type
sql
…params	`\*`
callback

connection.register_udf_bulk(name, return_type, callback) ⇒ `void`

注册一个用户自定义函数

Kind: instance method of Connection

参数
name
return_type
callback

connection.unregister_udf(name, return_type, callback) ⇒ `void`

注销用户定义的函数

Kind: instance method of Connection

Param
name
return_type
callback

connection.register_buffer(name, array, force, callback) ⇒ `void`

注册一个缓冲区以使用Apache Arrow IPC扫描器进行扫描（需要加载arrow扩展）

Kind: instance method of Connection

Param
name
数组
force
callback

connection.unregister_buffer(name, callback) ⇒ `void`

注销缓冲区

Kind: instance method of Connection

Param
name
callback

connection.close(callback) ⇒ `void`

关闭连接

Kind: instance method of Connection

Param
callback

duckdb~Statement

Kind: inner class of duckdb

~Statement
- .sql ⇒
- .get()
- .run(sql, …params, callback) ⇒ void
- .all(sql, …params, callback) ⇒ void
- .arrowIPCAll(sql, …params, callback) ⇒ void
- .each(sql, …params, callback) ⇒ void
- .finalize(sql, …params, callback) ⇒ void
- .stream(sql, …params)
- .columns() ⇒ Array.<ColumnInfo>

statement.sql ⇒

类型: Statement 的实例属性
返回: 包含在语句中的 SQL
字段:

statement.get()

未实现

类型: Statement 的实例方法

statement.run(sql, …params, callback) ⇒ `void`

类型: Statement 的实例方法

Param	Type
sql
…params	`\*`
callback

statement.all(sql, …params, callback) ⇒ `void`

类型: Statement 的实例方法

Param	Type
sql
…params	`\*`
callback

statement.arrowIPCAll(sql, …params, callback) ⇒ `void`

类型: Statement 的实例方法

Param	Type
sql
…params	`\*`
callback

statement.each(sql, …params, callback) ⇒ `void`

类型: Statement 的实例方法

Param	Type
sql
…params	`\*`
callback

statement.finalize(sql, …params, callback) ⇒ `void`

类型: Statement 的实例方法

Param	Type
sql
…params	`\*`
callback

statement.stream(sql, …params)

Kind: instance method of Statement

Param	Type
sql
…params	`\*`

statement.columns() ⇒ `Array.`

类型: Statement 的实例方法
返回: Array. - - 列名和类型的数组

duckdb~QueryResult

Kind: inner class of duckdb

~QueryResult
- .nextChunk() ⇒
- .nextIpcBuffer() ⇒
- .asyncIterator()

queryResult.nextChunk() ⇒

类型: QueryResult 的实例方法
返回: 数据块

queryResult.nextIpcBuffer() ⇒

以零拷贝方式获取Arrow IPC流的下一个结果blob的函数。（需要加载arrow扩展）

类型: QueryResult 的实例方法
返回: 数据块

queryResult.asyncIterator()

类型: QueryResult 的实例方法

duckdb~数据库

主数据库接口

类型: duckdb 的内部属性

参数	描述
path	数据库文件的路径或 :memory: 用于内存数据库
access_mode	访问模式
config	配置对象
callback	回调函数

~Database
- .close(callback) ⇒ void
- .close_internal(callback) ⇒ void
- .wait(callback) ⇒ void
- .serialize(callback) ⇒ void
- .parallelize(callback) ⇒ void
- .connect(path) ⇒ Connection
- .interrupt(callback) ⇒ void
- .prepare(sql) ⇒ Statement
- .run(sql, …params, callback) ⇒ void
- .scanArrowIpc(sql, …params, callback) ⇒ void
- .each(sql, …params, callback) ⇒ void
- .stream(sql, …params)
- .all(sql, …params, callback) ⇒ void
- .arrowIPCAll(sql, …params, callback) ⇒ void
- .arrowIPCStream(sql, …params, callback) ⇒ void
- .exec(sql, …params, callback) ⇒ void
- .register_udf(name, return_type, fun) ⇒ this
- .register_buffer(name) ⇒ this
- .unregister_buffer(name) ⇒ this
- .unregister_udf(name) ⇒ this
- .registerReplacementScan(fun) ⇒ this
- .tokenize(text) ⇒ ScriptTokens
- .get()

database.close(callback) ⇒ `void`

关闭数据库实例

类型: Database 的实例方法

Param
callback

database.close_internal(callback) ⇒ `void`

内部方法。请勿使用，请改为调用 Connection#close

类型: Database 的实例方法

Param
callback

database.wait(callback) ⇒ `void`

当所有计划的数据库任务完成时触发回调。

类型: Database 的实例方法

Param
callback