Search Shortcut cmd + k | ctrl + k

- Installation
- Documentation

- Getting Started
- Connect

- Overview
- Concurrency

- Data Import

- Overview
- Data Sources
- CSV Files

- Overview
- Auto Detection
- Reading Faulty CSV Files
- Tips

- JSON Files

- Overview
- Creating JSON
- Loading JSON
- Writing JSON
- JSON Type
- JSON Functions
- Format Settings
- Installing and Loading
- SQL to / from JSON
- Caveats

- Multiple Files

- Overview
- Combining Schemas

- Parquet Files

- Overview
- Metadata
- Encryption
- Tips

- Partitioning

- Hive Partitioning
- Partitioned Writes

- Appender
- INSERT Statements

- Client APIs

- Overview
- C

- Overview
- Startup
- Configuration
- Query
- Data Chunks
- Vectors
- Values
- Types
- Prepared Statements
- Appender
- Table Functions
- Replacement Scans
- API Reference

- C++
- CLI

- Overview
- Arguments
- Dot Commands
- Output Formats
- Editing
- Autocomplete
- Syntax Highlighting

- Dart
- Go
- Java
- Julia
- Node.js (Neo)

- Overview

- Node.js

- Overview
- API Reference

- Python

- Overview
- Data Ingestion
- Conversion between DuckDB and Python
- DB API
- Relational API
- Function API
- Types API
- Expression API
- Spark API
- API Reference
- Known Python Issues

- R
- Rust
- Swift
- Wasm

- Overview
- Instantiation
- Data Ingestion
- Query
- Extensions

- ADBC
- ODBC

- Overview
- Linux Setup
- Windows Setup
- macOS Setup
- Configuration

- SQL

- Introduction
- Statements

- Overview
- ANALYZE
- ALTER TABLE
- ALTER VIEW
- ATTACH and DETACH
- CALL
- CHECKPOINT
- COMMENT ON
- COPY
- CREATE INDEX
- CREATE MACRO
- CREATE SCHEMA
- CREATE SECRET
- CREATE SEQUENCE
- CREATE TABLE
- CREATE VIEW
- CREATE TYPE
- DELETE
- DESCRIBE
- DROP
- EXPORT and IMPORT DATABASE
- INSERT
- LOAD / INSTALL
- PIVOT
- Profiling
- SELECT
- SET / RESET
- SET VARIABLE
- SUMMARIZE
- Transaction Management
- UNPIVOT
- UPDATE
- USE
- VACUUM

- Query Syntax

- SELECT
- FROM and JOIN
- WHERE
- GROUP BY
- GROUPING SETS
- HAVING
- ORDER BY
- LIMIT and OFFSET
- SAMPLE
- Unnesting
- WITH
- WINDOW
- QUALIFY
- VALUES
- FILTER
- Set Operations
- Prepared Statements

- Data Types

- Overview
- Array
- Bitstring
- Blob
- Boolean
- Date
- Enum
- Interval
- List
- Literal Types
- Map
- NULL Values
- Numeric
- Struct
- Text
- Time
- Timestamp
- Time Zones
- Union
- Typecasting

- Expressions

- Overview
- CASE Statement
- Casting
- Collations
- Comparisons
- IN Operator
- Logical Operators
- Star Expression
- Subqueries

- Functions

- Overview
- Aggregate Functions
- Array Functions
- Bitstring Functions
- Blob Functions
- Date Format Functions
- Date Functions
- Date Part Functions
- Enum Functions
- Interval Functions
- Lambda Functions
- List Functions
- Map Functions
- Nested Functions
- Numeric Functions
- Pattern Matching
- Regular Expressions
- Struct Functions
- Text Functions
- Time Functions
- Timestamp Functions
- Timestamp with Time Zone Functions
- Union Functions
- Utility Functions
- Window Functions

- Constraints
- Indexes
- Meta Queries

- Information Schema
- Metadata Functions

- DuckDB's SQL Dialect

- Overview
- Indexing
- Friendly SQL
- Keywords and Identifiers
- Order Preservation
- PostgreSQL Compatibility

- Samples

- Configuration

- Overview
- Pragmas
- Secrets Manager

- Extensions

- Overview
- Core Extensions
- Community Extensions
- Working with Extensions
- Versioning of Extensions
- Arrow
- AutoComplete
- AWS
- Azure
- Delta
- Excel
- Full Text Search
- httpfs (HTTP and S3)

- Overview
- HTTP(S) Support
- Hugging Face
- S3 API Support
- Legacy Authentication Scheme for S3 API

- Iceberg
- ICU
- inet
- jemalloc
- MySQL
- PostgreSQL
- Spatial

- Overview
- Function Reference
- R-Tree Indexes
- GDAL Integration

- SQLite
- Substrait
- TPC-DS
- TPC-H
- VSS

- Guides

- Overview
- Data Viewers

- Tableau
- CLI Charting with YouPlot

- Database Integration

- Overview
- MySQL Import
- PostgreSQL Import
- SQLite Import

- File Formats

- Overview
- CSV Import
- CSV Export
- Directly Reading Files
- Excel Import
- Excel Export
- JSON Import
- JSON Export
- Parquet Import
- Parquet Export
- Querying Parquet Files

- Network and Cloud Storage

- Overview
- HTTP Parquet Import
- S3 Parquet Import
- S3 Parquet Export
- S3 Iceberg Import
- S3 Express One
- GCS Import
- Cloudflare R2 Import
- DuckDB over HTTPS / S3

- Meta Queries

- Describe Table
- EXPLAIN: Inspect Query Plans
- EXPLAIN ANALYZE: Profile Queries
- List Tables
- Summarize
- DuckDB Environment

- ODBC

- ODBC Guide

- Performance

- Overview
- Environment
- Import
- Schema
- Indexing
- Join Operations
- File Formats
- How to Tune Workloads
- My Workload Is Slow
- Benchmarks

- Python

- Installation
- Executing SQL
- Jupyter Notebooks
- SQL on Pandas
- Import from Pandas
- Export to Pandas
- Import from Numpy
- Export to Numpy
- SQL on Arrow
- Import from Arrow
- Export to Arrow
- Relational API on Pandas
- Multiple Python Threads
- Integration with Ibis
- Integration with Polars
- Using fsspec Filesystems

- SQL Editors

- DBeaver SQL IDE

- SQL Features

- AsOf Join
- Full-Text Search
- query and query_table Functions

- Snippets

- Create Synthetic Data
- Sharing Macros

- Glossary of Terms
- Browse Offline

- Operations Manual

- Overview
- Limits
- Non-Deterministic Behavior
- Embedding DuckDB
- DuckDB's Footprint

- Files Created by DuckDB
- Gitignore for DuckDB
- Reclaiming Space

- Securing DuckDB

- Overview
- Securing Extensions

- Development

- DuckDB Repositories
- Testing

- Overview
- sqllogictest Introduction
- Writing Tests
- Debugging
- Result Verification
- Persistent Testing
- Loops
- Multiple Connections
- Catch

- Profiling
- Release Calendar
- Building

- Overview
- Build Instructions
- Build Configuration
- Building Extensions
- Platforms
- Troubleshooting

- Benchmark Suite

- Internals

- Overview
- Storage Versions and Format
- Execution Format
- Pivot

- Sitemap
- Why DuckDB
- Media
- FAQ
- Code of Conduct
- Live Demo

Node.js API

## Modules

duckdb

## Typedefs

ColumnInfo : `object`
TypeInfo : `object`
DuckDbError : `object`
HTTPError : `object`

## duckdb

Summary: DuckDB is an embeddable SQL OLAP Database Management System

- duckdb
  - ~Connection
    - .run(sql, …params, callback) ⇒ `void`
    - .all(sql, …params, callback) ⇒ `void`
    - .arrowIPCAll(sql, …params, callback) ⇒ `void`
    - .arrowIPCStream(sql, …params, callback) ⇒
    - .each(sql, …params, callback) ⇒ `void`
    - .stream(sql, …params)
    - .register_udf(name, return_type, fun) ⇒ `void`
    - .prepare(sql, …params, callback) ⇒ `Statement`
    - .exec(sql, …params, callback) ⇒ `void`
    - .register_udf_bulk(name, return_type, callback) ⇒ `void`
    - .unregister_udf(name, return_type, callback) ⇒ `void`
    - .register_buffer(name, array, force, callback) ⇒ `void`
    - .unregister_buffer(name, callback) ⇒ `void`
    - .close(callback) ⇒ `void`
  - ~Statement
    - .sql ⇒
    - .get()
    - .run(sql, …params, callback) ⇒ `void`
    - .all(sql, …params, callback) ⇒ `void`
    - .arrowIPCAll(sql, …params, callback) ⇒ `void`
    - .each(sql, …params, callback) ⇒ `void`
    - .finalize(sql, …params, callback) ⇒ `void`
    - .stream(sql, …params)
    - .columns() ⇒ `Array.<ColumnInfo>`
  - ~QueryResult
    - .nextChunk() ⇒
    - .nextIpcBuffer() ⇒
    - .asyncIterator()
  - ~Database
    - .close(callback) ⇒ `void`
    - .close_internal(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`
    - .scanArrowIpc(sql, …params, callback) ⇒ `void`
    - .each(sql, …params, callback) ⇒ `void`
    - .stream(sql, …params)
    - .all(sql, …params, callback) ⇒ `void`
    - .arrowIPCAll(sql, …params, callback) ⇒ `void`
    - .arrowIPCStream(sql, …params, callback) ⇒ `void`
    - .exec(sql, …params, callback) ⇒ `void`
    - .register_udf(name, return_type, fun) ⇒ `this`
    - .register_buffer(name) ⇒ `this`
    - .unregister_buffer(name) ⇒ `this`
    - .unregister_udf(name) ⇒ `this`
    - .registerReplacementScan(fun) ⇒ `this`
    - .tokenize(text) ⇒ `ScriptTokens`
    - .get()
  - ~TokenType
  - ~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`
  - .arrowIPCAll(sql, …params, callback) ⇒ `void`
  - .arrowIPCStream(sql, …params, callback) ⇒
  - .each(sql, …params, callback) ⇒ `void`
  - .stream(sql, …params)
  - .register_udf(name, return_type, fun) ⇒ `void`
  - .prepare(sql, …params, callback) ⇒ `Statement`
  - .exec(sql, …params, callback) ⇒ `void`
  - .register_udf_bulk(name, return_type, callback) ⇒ `void`
  - .unregister_udf(name, return_type, callback) ⇒ `void`
  - .register_buffer(name, array, force, callback) ⇒ `void`
  - .unregister_buffer(name, callback) ⇒ `void`
  - .close(callback) ⇒ `void`

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

Run a SQL statement and trigger a callback when done

Kind: instance method of `Connection`

Param | Type
--- | ---
sql |
…params | `\*`
callback |

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

Run a SQL query and triggers the callback once for all result rows

Kind: instance method of `Connection`

Param | Type
--- | ---
sql |
…params | `\*`
callback |

#### connection.arrowIPCAll(sql, …params, callback) ⇒ `void`

Run a SQL query and serialize the result into the Apache Arrow IPC format (requires arrow extension to be loaded)

Kind: instance method of `Connection`

Param | Type
--- | ---
sql |
…params | `\*`
callback |

#### connection.arrowIPCStream(sql, …params, callback) ⇒

Run a SQL query, returns a IpcResultStreamIterator that allows streaming the result into the Apache Arrow IPC format (requires arrow extension to be loaded)

Kind: instance method of `Connection`
Returns: Promise

Param | Type
--- | ---
sql |
…params | `\*`
callback |

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

Runs a SQL query and triggers the callback for each result row

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_udf(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`

Prepare a SQL query for execution

Kind: instance method of `Connection`

Param | Type
--- | ---
sql |
…params | `\*`
callback |

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

Execute a SQL query

Kind: instance method of `Connection`

Param | Type
--- | ---
sql |
…params | `\*`
callback |

#### connection.register_udf_bulk(name, return_type, callback) ⇒ `void`

Register a User Defined Function

Kind: instance method of `Connection`

Param
name
return_type
callback

#### connection.unregister_udf(name, return_type, callback) ⇒ `void`

Unregister a User Defined Function

Kind: instance method of `Connection`

Param
name
return_type
callback

#### connection.register_buffer(name, array, force, callback) ⇒ `void`

Register a Buffer to be scanned using the Apache Arrow IPC scanner (requires arrow extension to be loaded)

Kind: instance method of `Connection`

Param
name
array
force
callback

#### connection.unregister_buffer(name, callback) ⇒ `void`

Unregister the Buffer

Kind: instance method of `Connection`

Param
name
callback

#### connection.close(callback) ⇒ `void`

Closes connection

Kind: instance method of `Connection`

Param
callback

### duckdb~Statement

Kind: inner class of `duckdb`

- ~Statement
  - .sql ⇒
  - .get()
  - .run(sql, …params, callback) ⇒ `void`
  - .all(sql, …params, callback) ⇒ `void`
  - .arrowIPCAll(sql, …params, callback) ⇒ `void`
  - .each(sql, …params, callback) ⇒ `void`
  - .finalize(sql, …params, callback) ⇒ `void`
  - .stream(sql, …params)
  - .columns() ⇒ `Array.<ColumnInfo>`

#### statement.sql ⇒

Kind: instance property of `Statement`
Returns: sql contained in statement
Field:

#### 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.arrowIPCAll(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 | `\*`

#### statement.columns() ⇒ `Array.<ColumnInfo>`

Kind: instance method of `Statement`
Returns: `Array.<ColumnInfo>` - - Array of column names and types

### duckdb~QueryResult

Kind: inner class of `duckdb`

- ~QueryResult
  - .nextChunk() ⇒
  - .nextIpcBuffer() ⇒
  - .asyncIterator()

#### queryResult.nextChunk() ⇒

Kind: instance method of `QueryResult`
Returns: data chunk

#### queryResult.nextIpcBuffer() ⇒

Function to fetch the next result blob of an Arrow IPC Stream in a zero-copy way. (requires arrow extension to be loaded)

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`

Param | Description
--- | ---
path | path to database file or :memory: for in-memory database
access_mode | access mode
config | the configuration object
callback | callback function

- ~Database
  - .close(callback) ⇒ `void`
  - .close_internal(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`
  - .scanArrowIpc(sql, …params, callback) ⇒ `void`
  - .each(sql, …params, callback) ⇒ `void`
  - .stream(sql, …params)
  - .all(sql, …params, callback) ⇒ `void`
  - .arrowIPCAll(sql, …params, callback) ⇒ `void`
  - .arrowIPCStream(sql, …params, callback) ⇒ `void`
  - .exec(sql, …params, callback) ⇒ `void`
  - .register_udf(name, return_type, fun) ⇒ `this`
  - .register_buffer(name) ⇒ `this`
  - .unregister_buffer(name) ⇒ `this`
  - .unregister_udf(name) ⇒ `this`
  - .registerReplacementScan(fun) ⇒ `this`
  - .tokenize(text) ⇒ `ScriptTokens`
  - .get()

#### database.close(callback) ⇒ `void`

Closes database instance

Kind: instance method of `Database`

Param
callback

#### database.close_internal(callback) ⇒ `void`

Internal method. Do not use, call Connection#close instead

Kind: instance method of `Database`

Param
callback

#### database.wait(callback) ⇒ `void`

Triggers callback when all scheduled database tasks have completed.

Kind: instance method of `Database`

Param
callback

#### database.serialize(callback) ⇒ `void`

Currently a no-op. Provided for SQLite compatibility

Kind: instance method of `Database`

Param
callback

#### database.parallelize(callback) ⇒ `void`

Currently a no-op. Provided for SQLite compatibility

Kind: instance method of `Database`

Param
callback

#### database.connect(path) ⇒ `Connection`

Create a new database connection

Kind: instance method of `Database`

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

#### database.interrupt(callback) ⇒ `void`

Supposedly interrupt queries, but currently does not do anything.

Kind: instance method of `Database`

Param
callback

#### database.prepare(sql) ⇒ `Statement`

Prepare a SQL query for execution

Kind: instance method of `Database`

Param
sql

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

Convenience method for Connection#run using a built-in default connection

Kind: instance method of `Database`

Param | Type
--- | ---
sql |
…params | `\*`
callback |

#### database.scanArrowIpc(sql, …params, callback) ⇒ `void`

Convenience method for Connection#scanArrowIpc using a built-in default connection

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.stream(sql, …params)

Kind: instance method of `Database`

Param | Type
--- | ---
sql |
…params | `\*`

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

Convenience method for Connection#apply using a built-in default connection

Kind: instance method of `Database`

Param | Type
--- | ---
sql |
…params | `\*`
callback |

#### database.arrowIPCAll(sql, …params, callback) ⇒ `void`

Convenience method for Connection#arrowIPCAll using a built-in default connection

Kind: instance method of `Database`

Param | Type
--- | ---
sql |
…params | `\*`
callback |

#### database.arrowIPCStream(sql, …params, callback) ⇒ `void`

Convenience method for Connection#arrowIPCStream using a built-in default connection

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_udf(name, return_type, fun) ⇒ `this`

Register a User Defined Function

Convenience method for Connection#register_udf

Kind: instance method of `Database`

Param
name
return_type
fun

#### database.register_buffer(name) ⇒ `this`

Register a buffer containing serialized data to be scanned from DuckDB.

Convenience method for Connection#unregister_buffer

Kind: instance method of `Database`

Param
name

#### database.unregister_buffer(name) ⇒ `this`

Unregister a Buffer

Convenience method for Connection#unregister_buffer

Kind: instance method of `Database`

Param
name

#### database.unregister_udf(name) ⇒ `this`

Unregister a UDF

Convenience method for Connection#unregister_udf

Kind: instance method of `Database`

Param
name

#### database.registerReplacementScan(fun) ⇒ `this`

Register a table replace scan function

Kind: instance method of `Database`

Param | Description
--- | ---
fun | Replacement scan function

#### database.tokenize(text) ⇒ `ScriptTokens`

Return positions and types of tokens in given text

Kind: instance method of `Database`

Param
text

#### database.get()

Not implemented

Kind: instance method of `Database`

### duckdb~TokenType

Types of tokens return by `tokenize`.

Kind: inner property of `duckdb`

### 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`

## ColumnInfo : `object`

Kind: global typedef
Properties

Name | Type | Description
--- | --- | ---
name | `string` | Column name
type | `TypeInfo` | Column type

## TypeInfo : `object`

Kind: global typedef
Properties

Name | Type | Description
--- | --- | ---
id | `string` | Type ID
[alias] | `string` | SQL type alias
sql_type | `string` | SQL type name

## DuckDbError : `object`

Kind: global typedef
Properties

Name | Type | Description
--- | --- | ---
errno | `number` | -1 for DuckDB errors
message | `string` | Error message
code | `string` | 'DUCKDB_NODEJS_ERROR' for DuckDB errors
errorType | `string` | DuckDB error type code (eg, HTTP, IO, Catalog)

## HTTPError : `object`

Kind: global typedef
Extends: `DuckDbError`
Properties

Name | Type | Description
--- | --- | ---
statusCode | `number` | HTTP response status code
reason | `string` | HTTP response reason
response | `string` | HTTP response body
headers | `object` | HTTP headers

##### About this page

- Report content issue
- Edit this page on GitHub