- Installation
- Documentation
- Overview
- Connect
- Data Import
- Overview
- CSV Files
- JSON Files
- Multiple Files
- Parquet Files
- Partitioning
- Appender
- INSERT Statements
- Client APIs
- Overview
- C
- Overview
- Startup
- Configuration
- Query
- Data Chunks
- Values
- Types
- Prepared Statements
- Appender
- Table Functions
- Replacement Scans
- API Reference
- C++
- CLI
- Go
- Java
- Julia
- Node.js
- 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
- ADBC
- ODBC
- Configuration
- SQL
- Introduction
- Statements
- Overview
- ALTER TABLE
- ALTER VIEW
- ATTACH/DETACH
- CALL
- CHECKPOINT
- COMMENT ON
- COPY
- CREATE INDEX
- CREATE MACRO
- CREATE SCHEMA
- CREATE SECRET
- CREATE SEQUENCE
- CREATE TABLE
- CREATE VIEW
- CREATE TYPE
- DELETE
- DROP
- EXPORT/IMPORT DATABASE
- INSERT
- PIVOT
- Profiling
- SELECT
- SET/RESET
- Transaction Management
- UNPIVOT
- UPDATE
- USE
- VACUUM
- Query Syntax
- SELECT
- FROM & JOIN
- WHERE
- GROUP BY
- GROUPING SETS
- HAVING
- ORDER BY
- LIMIT
- 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
- Bitstring Functions
- Blob Functions
- Date Format Functions
- Date Functions
- Date Part Functions
- Enum Functions
- Interval Functions
- Lambda Functions
- Nested Functions
- Numeric Functions
- Pattern Matching
- Regular Expressions
- Text Functions
- Time Functions
- Timestamp Functions
- Timestamp with Time Zone Functions
- Utility Functions
- Aggregate Functions
- Constraints
- Indexes
- Information Schema
- Metadata Functions
- Keywords and Identifiers
- Samples
- Window Functions
- Extensions
- Overview
- Official Extensions
- Working with Extensions
- Versioning of Extensions
- Arrow
- AutoComplete
- AWS
- Azure
- Excel
- Full Text Search
- httpfs (HTTP and S3)
- Iceberg
- ICU
- inet
- jemalloc
- JSON
- MySQL
- PostgreSQL
- Spatial
- SQLite
- Substrait
- TPC-DS
- TPC-H
- Guides
- Overview
- Data Import & Export
- Overview
- CSV Import
- CSV Export
- Parquet Import
- Parquet Export
- Querying Parquet Files
- HTTP Parquet Import
- S3 Parquet Import
- S3 Parquet Export
- S3 Iceberg Import
- S3 Express One
- GCS Import
- Cloudflare R2 Import
- JSON Import
- JSON Export
- Excel Import
- Excel Export
- MySQL Import
- PostgreSQL Import
- SQLite Import
- Directly Reading Files
- Performance
- Overview
- Schema
- Indexing
- Environment
- File Formats
- How to Tune Workloads
- My Workload Is Slow
- Benchmarks
- Meta Queries
- Describe Table
- EXPLAIN: Inspect Query Plans
- EXPLAIN ANALYZE: Profile Queries
- List Tables
- Summarize
- DuckDB Environment
- ODBC
- Python
- Installation
- Executing SQL
- Jupyter Notebooks
- SQL on Pandas
- Import from Pandas
- Export to Pandas
- 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 Features
- SQL Editors
- Data Viewers
- Development
- DuckDB Repositories
- Testing
- Overview
- sqllogictest Introduction
- Writing Tests
- Debugging
- Result Verification
- Persistent Testing
- Loops
- Multiple Connections
- Catch
- Profiling
- Release Calendar
- Building
- Benchmark Suite
- Internals
- Sitemap
- Why DuckDB
- Media
- FAQ
- Code of Conduct
- Live Demo
The Microsoft Windows requires an ODBC Driver Manager to manage communication between applications and the ODBC drivers.
The DM on Windows is provided in a DLL file odbccp32.dll
, and other files and tools.
For detailed information check out the Common ODBC Component Files.
Step 1: Download ODBC Driver
DuckDB releases the ODBC driver as asset. For Windows, download it from Windows Asset that contains the following artifacts:
duckdb_odbc.dll: the DuckDB driver compiled for Windows.
duckdb_odbc_setup.dll: a setup DLL used by the Windows ODBC Data Source Administrator tool.
odbc_install.exe: an installation script to aid the configuration on Windows.
Step 2: Extracting ODBC Artifacts
Unzip the file to a permanent directory (e.g., duckdb_odbc).
An example with PowerShell
and unzip
command would be:
mkdir duckdb_odbc
unzip duckdb_odbc-linux-amd64.zip -d duckdb_odbc
Step 3: ODBC Windows Installer
The odbc_install.exe
aids the configuration of the DuckDB ODBC Driver on Windows.
It depends on the Odbccp32.dll
that provides functions to configure the ODBC registry entries.
Inside the permanent directory (e.g., duckdb_odbc
), double-click on the odbc_install.exe
.
Windows administrator privileges is required, in case of a non-administrator a User Account Control shall display:
Step 4: Configure the ODBC Driver
The odbc_install.exe
adds a default DSN configuration into the ODBC registries with a default database :memory:
.
DSN Windows Setup
After the installation, it is possible to change the default DSN configuration or add a new one using the Windows ODBC Data Source Administrator tool odbcad32.exe
.
It also can be launched thought the Windows start:
Default DuckDB DSN
The newly installed DSN is visible on the System DSN in the Windows ODBC Data Source Administrator tool:
Changing DuckDB DSN
When selecting the default DSN (i.e., DuckDB
) or adding a new configuration, the following setup window will display:
This window allows you to set the DSN and the database file path associated with that DSN.
More Detailed Windows Setup
There are two ways to configure the ODBC driver, either by altering the registry keys as detailed below,
or by connecting with SQLDriverConnect
.
A combination of the two is also possible.
Furthermore, the ODBC driver supports all the configuration options included in DuckDB.
If a configuration is set in both the connection string passed to
SQLDriverConnect
and in theodbc.ini
file, the one passed toSQLDriverConnect
will take precedence.
Registry Keys
The ODBC setup on Windows is based on registry keys (see Registry Entries for ODBC Components
).
The ODBC entries can be placed at the current user registry key (HKCU
) or the system registry key (HKLM
).
We have tested and used the system entries based on HKLM->SOFTWARE->ODBC
.
The odbc_install.exe
changes this entry that has two subkeys: ODBC.INI
and ODBCINST.INI
.
The ODBC.INI
is where users usually insert DSN registry entries for the drivers.
For example, the DSN registry for DuckDB would look like this:
The ODBCINST.INI
contains one entry for each ODBC driver and other keys predefined for Windows ODBC configuration.
About this page
Last modified: 2024-03-28