node-duckdb.duckdb._constructor_.md

Node-DuckDB API > DuckDB > (constructor)

DuckDB.(constructor)

Represents a native instance of DuckDB.

Signature:

constructor(config?: IDuckDBConfig);

Parameters

Parameter	Type	Description
config	IDuckDBConfig	optional configuration object of type IDuckDBConfig.

Example 1

Initializing a duckdb database in memory:

import { DuckDB } from "node-duckdb";
const db = new DuckDB();

Example 2

Initializing a duckdb database from file:

import { DuckDB } from "node-duckdb";
const db = new DuckDB({ path: join(__dirname, "./mydb") });

Example 3

Initializing a duckdb database from file and setting some additional options:

import { DuckDB, OrderType } from "node-duckdb";
const db = new DuckDB({
  path: join(__dirname, "./mydb"),
  options: { defaultOrderType: OrderType.Descending, temporaryDirectory: false },
});