node-duckdb.duckdb.md

Node-DuckDB API > DuckDB

DuckDB class

The DuckDB class represents a DuckDB database instance.

Signature:

export declare class DuckDB

Constructors

Constructor	Modifiers	Description
(constructor)(config)		Represents a native instance of DuckDB.

Properties

Property	Modifiers	Type	Description
accessMode		AccessMode	Returns the access mode used by the database.
checkPointWALSize		number	Returns the checkpoint write ahead log size used by the database.
collation		string	Returns the collation used by the database.
defaultNullOrder		OrderByNullType	Returns the default sort order for null values.
defaultOrderType		OrderType	Returns the default sort order.
isClosed		boolean	Returns true if the underlying database has been closed, false otherwise.
maximumMemory		number	Returns the maximum memory limit for the database.
temporaryDirectory		string	Returns the temporary directory location for the database.
useTemporaryDirectory		boolean	Returns true if the database uses a temporary directory for storing data that does not fit into memory, false otherwise.

Methods

Method	Modifiers	Description
close()		Closes the underlying duckdb database, frees associated memory and renders it unusuable.
getBindingsVersion()	static	Returns the current version of the node-duckdb package (from package.json)