Skip to content

@sqlrooms/duckdb-node / createNodeDuckDbConnector

Function: createNodeDuckDbConnector()

createNodeDuckDbConnector(options): NodeDuckDbConnector

Creates a DuckDB connector for Node.js environments using @duckdb/node-api.

Parameters

ParameterTypeDescription
optionsNodeDuckDbConnectorOptionsConfiguration options for the connector

Returns

NodeDuckDbConnector

A NodeDuckDbConnector instance

Example

typescript
const connector = createNodeDuckDbConnector({
  dbPath: ':memory:',
  initializationQuery: 'INSTALL json; LOAD json;'
});

await connector.initialize();
const result = await connector.query('SELECT 1 as value');
console.log(result.numRows); // 1