Skip to main content

KnackELT

Get your data out of Knack and into a real database — on a schedule, read-only, with full history.

Knack is a good place to run a business and a poor place to remember one. Every plan caps how many records you can hold, there is no SQL and no aggregates, and once a record is deleted it is gone.

KnackELT copies every record out through Knack's own REST API and keeps every version of every row. Nothing is ever overwritten, so the warehouse can still answer questions about records your app no longer has. It is built on dlt, and it never writes back to Knack.

How it fits together

flowchart TB
    subgraph src["SOURCE OF RECORD"]
        app["<b>Knack App</b><br/>where your team works"]
        api["<b>Knack REST API</b><br/>Knack's own data API"]
        app --> api
    end

    subgraph ing["INGESTION — this repo"]
        elt["<b>KnackELT</b><br/>pulls every record,<br/>never writes back"]
    end

    subgraph wh["DATA WAREHOUSE / DATABASE"]
        hist["<b>Complete history</b><br/>every version of every record —<br/>including ones deleted in Knack"]
        rep["<b>Reporting tables</b><br/>tidied into a shape you can<br/>filter, sort and add up"]
        hist -->|"modeled for reporting"| rep
    end

    subgraph bi["BI / DATA TOOLS"]
        dash["<b>Dashboards</b><br/>look up, drill down"]
        adhoc["<b>Ad-hoc + export</b><br/>new questions,<br/>Excel and CSV out"]
    end

    cron["<b>Scheduled run</b><br/>daily cron or CI job"]
    backup["<b>Offsite backup</b> — optional<br/>S3-compatible object storage:<br/>a third copy, outside both<br/>Knack and the warehouse"]

    api -->|"read-only"| elt
    cron -.->|"triggers"| elt
    elt -->|"keeps every version"| hist
    rep -->|"SQL"| dash
    rep -->|"SQL"| adhoc
    hist -.->|"optional"| backup

    classDef keep stroke:#d97706,stroke-width:3px
    classDef opt stroke-dasharray:5 5
    class hist keep
    class backup opt
    linkStyle 4 stroke:#d97706,stroke-width:2px

This repo is the INGESTION box. Everything flows one way: KnackELT reads through the same REST API your app already exposes, so it cannot alter or break anything in Knack. The amber box is the point of the exercise — your app deletes records to stay under its limit, and the warehouse keeps them anyway.

The other boxes are deliberately generic. KnackELT loads into anything dlt supports as a destination, and any BI tool that speaks SQL to that destination will do. For a concrete, working combination of all four — MotherDuck, dbt and Preset, orchestrated by a daily GitHub Actions job — see docs/ARCHITECTURE.md.

What it does

  • Discovers your schema. Reads the Knack application metadata and builds a resource per object, so there is no table list to maintain. Add an object in Knack and the next run picks it up.
  • Gives you readable column names. field_43 becomes event_name, slugified from the field label you already chose in the builder. Knack's own row id is loaded as record_id, so a field you named id keeps the id column it was named for.
  • Cleans what the API hands back. Empty strings become NULL in numeric fields, boolean fields get the default declared in Knack, and malformed JSON becomes NULL instead of failing the load.
  • Keeps history. Loads with dlt's SCD2 merge strategy keyed on the Knack record id, so an edit retires the old row and appends a new one. Tables are kept flat (max_table_nesting=0) — one table per Knack object, no nested child tables.

Quick start

Requires Python 3.13+ and uv.

uv sync

export KNACK_APP_ID=your_app_id
export KNACK_API_KEY=your_rest_api_key

uv run knack-elt run-pipeline --app-id "$KNACK_APP_ID"

Names are derived from your app's slug, so a second app never lands on the first one's tables: database knack_{slug}_data, dataset {slug}, pipeline knack_{slug}_pipeline.

Destinations

--destination local (the default) writes a DuckDB file — nothing to sign up for, so a fresh clone can be pointed at a Knack app and produce a queryable warehouse immediately. The file lands at ./tests/data/knack_{slug}_data.duckdb unless you pass --db-path; the resolved path is printed on every run.

uv run knack-elt run-pipeline --app-id "$KNACK_APP_ID" --db-path ~/knack.duckdb
uv run knack-elt run-pipeline --app-id "$KNACK_APP_ID" --destination motherduck

--destination motherduck loads to md:///knack_{slug}_data and needs motherduck_api_key in the environment. Both destinations also write the run's _load_info and _trace tables.

Other flags

Flag What it does
--api-key Knack REST API key, if you would rather not set KNACK_API_KEY
--refresh-metadata Re-fetch app metadata instead of reusing knack-sleuth's 24h on-disk cache
--skip-unreadable Log and continue past objects that fail before yielding any row (typically no read permission). An object that fails partway through still aborts the run — loading a partial batch would retire live SCD2 rows as if the missing records had been deleted in Knack.

Configuration

Read from the environment or a .env file via pydantic-settings (src/knack_elt/config.py):

Variable Purpose
KNACK_APP_ID Knack application id — also the default for --app-id
KNACK_API_KEY Knack REST API key, sent as X-Knack-REST-API-Key
motherduck_api_key MotherDuck token, when the destination is MotherDuck

Querying what you get

Because loads are SCD2, a record's history is several rows sharing one record_id, tagged with _dlt_valid_from and _dlt_valid_to. Two flags are worth deriving up front — conflating them is the most common way to get a wrong answer:

with flagged as (
    select
        *,
        row_number() over (partition by record_id order by _dlt_valid_from desc) = 1
            as latest_version,      -- one row per record
        _dlt_valid_to is null as is_live_in_knack   -- still in the app?
    from your_dataset.some_table
)
select * from flagged where latest_version

A record deleted in Knack survives only as a retired row, so filtering on _dlt_valid_to is null alone silently drops exactly the history you built the warehouse for. And aggregating without latest_version double-counts, because every past version is still a row. The architecture doc works through both.

One caveat on is_live_in_knack. If an object returns zero records, dlt has nothing to load for that table and the merge never runs, so rows loaded earlier keep _dlt_valid_to is null and still read as live. Emptying an object in Knack is therefore invisible to the flag — a table whose row count stops moving is worth checking against the app.

Documentation

  • docs/ARCHITECTURE.md — the reference architecture in plain language and in technical detail, the pipeline internals, a run sequence, and the SCD2 row model with the query patterns it requires. Also available as a PDF.

The PDF is generated from the markdown rather than maintained alongside it. After editing the diagrams, rebuild it with uv run scripts/build_architecture_pdf.py (needs node and Chrome) so the two don't drift apart.

  • dlt — the load framework this is built on
  • knack-sleuth — Knack application metadata models and schema export, used here to read your app's structure

License

GPL-3.0. See LICENSE.

Metadata

Release files for knack-elt 0.2.1

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

Source distribution (sdist)

Source distribution for knack-elt 0.2.1
File Size Uploaded
knack_elt-0.2.1.tar.gz 11.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for knack-elt 0.2.1
File Interpreter ABI Platform
knack_elt-0.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 24.5 kB

Release files / knack_elt-0.2.1.tar.gz

Download URL knack_elt-0.2.1.tar.gz
Size 11.4 kB
Tags Source
SHA-256 checksum
How to use checksums
d9971c49345e079637bf6fe830185244246ad494e33780ee6d7ce374e5e72796
BLAKE2b-256 checksum
How to use checksums
726aa6943b10f739515c7b8c271b5e1bc377f279b55b3afe82c9948803a1c71e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / knack_elt-0.2.1-py3-none-any.whl

Download URL knack_elt-0.2.1-py3-none-any.whl
Size 13.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
72af226af49aa38440072f0d6534d1f852845f6ca21c14fb0063aff694028662
BLAKE2b-256 checksum
How to use checksums
9b9d0b29c7d0a98e6a14f2cdd139d74759ff4fd6c8998177dccbd3280e5d45c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release history Release notifications | RSS feed

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.2

2 release files

This release

0.2.1 This release

2 release files

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