duckdb.mdx

title	DuckDB
sidebar_position	1

Sequelize for DuckDB

To use Sequelize with DuckDB, you need to install the @sequelize/duckdb dialect package:

npm i @sequelize/duckdb

Then use the DuckDbDialect class as the dialect option in the Sequelize constructor:

import { Sequelize } from '@sequelize/core';
import { DuckDbDialect } from '@sequelize/duckdb';

const sequelize = new Sequelize({
  dialect: DuckDbDialect,
  database: '/path/to/local/file',
});

To connect to MotherDuck, provide your database path in the database field:

import { Sequelize } from '@sequelize/core';
import { DuckDbDialect } from '@sequelize/duckdb';

const sequelize = new Sequelize({
  dialect: DuckDbDialect,
  database: 'md:my_db',
});