duckdb

Summary: these jsdoc annotations are still a work in progress - feedback and suggestions are welcome!

• duckdb
  • ~Connection
    • .run(sql, …params, callback) ⇒ void
    • .all(sql, …params, callback) ⇒ void
    • .each(sql, …params, callback) ⇒ void
    • .stream(sql, …params)
    • .register(name, return_type, fun) ⇒ void
    • .prepare(sql, …params, callback) ⇒ Statement
    • .exec(sql, …params, callback) ⇒ void
    • .register_bulk(name, return_type, callback) ⇒ void
    • .unregister(name, return_type, callback) ⇒ void
  • ~Statement
    • .get()
    • .run(sql, …params, callback) ⇒ void
    • .all(sql, …params, callback) ⇒ void
    • .each(sql, …params, callback) ⇒ void
    • .finalize(sql, …params, callback) ⇒ void
    • .stream(sql, …params)
  • ~QueryResult
    • .nextChunk() ⇒
    • .asyncIterator()
  • ~Database
    • .close(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
    • .each(sql, …params, callback) ⇒ void
    • .all(sql, …params, callback) ⇒ void
    • .exec(sql, …params, callback) ⇒ void
    • .register(name, return_type, fun) ⇒ this
    • .unregister(name) ⇒ this
    • .get()
  • ~ERROR : number
  • ~OPEN_READONLY : number
  • ~OPEN_READWRITE : number
  • ~OPEN_CREATE : number
  • ~OPEN_FULLMUTEX : number
  • ~OPEN_SHAREDCACHE : number
  • ~OPEN_PRIVATECACHE : number

duckdb~Connection

Kind: inner class of duckdb

• ~Connection
  • .run(sql, …params, callback) ⇒ void
  • .all(sql, …params, callback) ⇒ void
  • .each(sql, …params, callback) ⇒ void
  • .stream(sql, …params)
  • .register(name, return_type, fun) ⇒ void
  • .prepare(sql, …params, callback) ⇒ Statement
  • .exec(sql, …params, callback) ⇒ void
  • .register_bulk(name, return_type, callback) ⇒ void
  • .unregister(name, return_type, callback) ⇒ void

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

Kind: instance method of Connection

Param	Type
sql
…params	\*
callback

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

Kind: instance method of Connection

Param	Type
sql
…params	\*
callback

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

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(name, return_type, fun) ⇒ void

Register a User Defined Function

Kind: instance method of Connection
Note: this follows the wasm udfs somewhat but is simpler because we can pass data much more cleanly

Param
name
return_type
fun

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

Kind: instance method of Connection

Param	Type
sql
…params	\*
callback

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

Kind: instance method of Connection

Param	Type
sql
…params	\*
callback

connection.register_bulk(name, return_type, callback) ⇒ void

Register a User Defined Function

Kind: instance method of Connection

Param
name
return_type
callback

connection.unregister(name, return_type, callback) ⇒ void

Unregister a User Defined Function

Kind: instance method of Connection

Param
name
return_type
callback

duckdb~Statement

Kind: inner class of duckdb

• ~Statement
  • .get()
  • .run(sql, …params, callback) ⇒ void
  • .all(sql, …params, callback) ⇒ void
  • .each(sql, …params, callback) ⇒ void
  • .finalize(sql, …params, callback) ⇒ void
  • .stream(sql, …params)

statement.get()

Not implemented

Kind: instance method of Statement

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

Kind: instance method of Statement

Param	Type
sql
…params	\*
callback

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

Kind: instance method of Statement

Param	Type
sql
…params	\*
callback

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

Kind: instance method of Statement

Param	Type
sql
…params	\*
callback

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

Kind: instance method of Statement

Param	Type
sql
…params	\*
callback

statement.stream(sql, …params)

Kind: instance method of Statement

Param	Type
sql
…params	\*

duckdb~QueryResult

Kind: inner class of duckdb

• ~QueryResult
  • .nextChunk() ⇒
  • .asyncIterator()

queryResult.nextChunk() ⇒

Kind: instance method of QueryResult
Returns: data chunk

queryResult.asyncIterator()

Kind: instance method of QueryResult

duckdb~Database

Main database interface

Kind: inner property of duckdb

• ~Database
  • .close(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
  • .each(sql, …params, callback) ⇒ void
  • .all(sql, …params, callback) ⇒ void
  • .exec(sql, …params, callback) ⇒ void
  • .register(name, return_type, fun) ⇒ this
  • .unregister(name) ⇒ this
  • .get()

database.close(callback) ⇒ void

Kind: instance method of Database

Param
callback

database.wait(callback) ⇒ void

Kind: instance method of Database

Param	Description
callback	TODO: what does this do?

database.serialize(callback) ⇒ void

TODO: what does this do?

Kind: instance method of Database

Param
callback

database.parallelize(callback) ⇒ void

TODO: what does this do?

Kind: instance method of Database

Param
callback

database.connect(path) ⇒ Connection

Kind: instance method of Database

Param	Description
path	the database to connect to, either a file path, or :memory:

database.interrupt(callback) ⇒ void

TODO: what does this do?

Kind: instance method of Database

Param
callback

database.prepare(sql) ⇒ Statement

Kind: instance method of Database

Param
sql

database.run(sql, …params, callback) ⇒ void

Kind: instance method of Database

Param	Type
sql
…params	\*
callback

database.each(sql, …params, callback) ⇒ void

Kind: instance method of Database

Param	Type
sql
…params	\*
callback

database.all(sql, …params, callback) ⇒ void

Kind: instance method of Database

Param	Type
sql
…params	\*
callback

database.exec(sql, …params, callback) ⇒ void

Kind: instance method of Database

Param	Type
sql
…params	\*
callback

database.register(name, return_type, fun) ⇒ this

Register a User Defined Function

Convenience method for Connection#register

Kind: instance method of Database

Param
name
return_type
fun

database.unregister(name) ⇒ this

Unregister a User Defined Function

Convenience method for Connection#unregister

Kind: instance method of Database

Param
name

database.get()

Not implemented

Kind: instance method of Database

duckdb~ERROR : number

Check that errno attribute equals this to check for a duckdb error

Kind: inner constant of duckdb

duckdb~OPEN_READONLY : number

Open database in readonly mode

Kind: inner constant of duckdb

duckdb~OPEN_READWRITE : number

Currently ignored

Kind: inner constant of duckdb

duckdb~OPEN_CREATE : number

Currently ignored

Kind: inner constant of duckdb

duckdb~OPEN_FULLMUTEX : number

Currently ignored

Kind: inner constant of duckdb

duckdb~OPEN_SHAREDCACHE : number

Currently ignored

Kind: inner constant of duckdb

duckdb~OPEN_PRIVATECACHE : number

Currently ignored

Kind: inner constant of duckdb