Skip to main content

interloper-duckdb

DuckDB tables as an interloper destination: a DuckDBDestination writing to a local .duckdb file or a MotherDuck database, and the DuckDBConnection that opens it.

Setup

A local file needs nothing but a path; DuckDB creates the file on first write:

from interloper_duckdb import DuckDBConnection

connection = DuckDBConnection(database="./warehouse.duckdb")

A MotherDuck database is named md:<database> and authenticates with a service token from the MotherDuck settings page:

connection = DuckDBConnection(database="md:my_db", motherduck_token="...")

Both fields also load from the environment (DUCKDB_DATABASE, DUCKDB_MOTHERDUCK_TOKEN), so DuckDBConnection() works with no arguments.

Usage

import interloper as il
from interloper_duckdb import DuckDBConnection, DuckDBDestination

destination = DuckDBDestination(
    connection=DuckDBConnection(database="./warehouse.duckdb"),
    default_dataset="raw",
)

In a deployed instance you configure this through the UI instead: add a DuckDB connection, then a DuckDB destination using it.

Datasets are schemas

An asset's dataset is a DuckDB schema. A table lands in the asset's dataset, else in the destination's default_dataset, else in main. The schema and the table are created on the first write, the columns typed from the asset's schema (or from one inferred from the data), and never altered afterwards: a column the table does not have is dropped from the write with a warning.

Field type Column type
bool BOOLEAN
int BIGINT
float DOUBLE
Decimal DECIMAL(38,9)
datetime TIMESTAMP
date DATE
bytes BLOB
str, Any VARCHAR
nested model, list[...] JSON

Partitions

A write replaces what it covers, in one transaction: the whole table for an unpartitioned asset, the rows inside a time partition's bounds (day >= start AND day < end), or the rows equal to a partition's id for any other partitioning. A window deletes each partition it covers and inserts the whole batch once. If the insert fails, the delete is rolled back and the table keeps its previous rows.

One writer per file

A local DuckDB file admits one writing process at a time. Concurrent assets in one process are fine (each write runs on its own cursor), but two processes writing to the same file, such as two pods or a scheduler and a notebook, fail to open it. A connection holds the file from its first use until its process exits, and that includes the connection check the app runs from the API process. Run the instance's writes in one process, or use MotherDuck, which serves many writers.

Querying the tables

The tables are plain DuckDB tables, so any DuckDB client reads them:

duckdb warehouse.duckdb -c 'SELECT * FROM raw.ads_stats LIMIT 10'
import duckdb

duckdb.connect("warehouse.duckdb", read_only=True).sql("SELECT * FROM raw.ads_stats").df()

Another process can open the file only while no process holds it for writing. Open it read_only, so the reader does not lock the instance out in turn.

Metadata

Release files for interloper-duckdb 0.97.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for interloper-duckdb 0.97.0
File Size Uploaded
interloper_duckdb-0.97.0.tar.gz 7.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for interloper-duckdb 0.97.0
File Interpreter ABI Platform
interloper_duckdb-0.97.0-py3-none-any.whl Python 3 none any Details

Total release size: 17.7 kB

Release files / interloper_duckdb-0.97.0.tar.gz

Download URL interloper_duckdb-0.97.0.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7e42b8c2380e83a15cb76fbf424f908989796ce3980e3632556fdff835cae810
BLAKE2b-256 checksum
How to use checksums
a9348776f0e74dd29999624a11944c38a806d7f1b5b341db0ac991aecc1e4c31
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.22 {"installer":{"name":"uv","version":"0.12.22","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / interloper_duckdb-0.97.0-py3-none-any.whl

Download URL interloper_duckdb-0.97.0-py3-none-any.whl
Size 9.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dbacb607e9a07cfdb756af2e12a4133e90dfe9ee5267351687a3db582f0c2bb4
BLAKE2b-256 checksum
How to use checksums
c3137cd478097eebea8fd57b17aedb65bcf2582281a80ee6aa082124b4d7c3dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.22 {"installer":{"name":"uv","version":"0.12.22","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page