Skip to main content

interloper-sql

A SQL database destination for interloper: SQLDestination, a DatabaseDestination over SQLAlchemy Core, and the SQLConnection that holds the database URL.

One backend serves every SQLAlchemy dialect whose driver is installed. PostgreSQL works out of the box (the package depends on psycopg[binary]); MySQL, SQLite, Redshift, SQL Server and the rest need their own driver.

Setup

The connection is a single SQLAlchemy URL:

Database URL Driver to install
PostgreSQL postgresql+psycopg://user:password@host:5432/db none, ships with the package
MySQL / MariaDB mysql+pymysql://user:password@host:3306/db pymysql
SQL Server mssql+pyodbc://user:password@host/db?driver=ODBC+Driver+18+for+SQL+Server pyodbc (and the ODBC driver)
Redshift redshift+redshift_connector://user:password@host:5439/db sqlalchemy-redshift, redshift_connector
SQLite sqlite:///path/to/file.db none, in the standard library

Install the driver next to interloper (uv pip install pymysql, or a custom image built from the slim variant). Special characters in the password must be URL-encoded.

The URL carries the password, so it is a secret field: encrypted at rest in a deployed instance and masked in the UI. It also loads from the environment (SQL_URL), so SQLConnection() works with no arguments.

The connection's check runs SELECT 1.

Usage

import interloper as il
from interloper_sql import SQLConnection, SQLDestination

warehouse = SQLDestination(
    connection=SQLConnection(url="postgresql+psycopg://user:password@host:5432/analytics"),
    default_dataset="marketing",
)

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

Datasets are schemas

An asset's dataset is the SQL schema its table lives in. Without one, the destination's default_dataset applies; without either, the table goes in the connection's default schema (public on PostgreSQL, the database itself on MySQL). A named schema is created on first write when the database supports schemas and it does not exist yet.

Tables

A table is created on first write from the asset's effective schema (declared, or inferred during conform): integers are BIGINT, floats DOUBLE, decimals NUMERIC(38, 9), datetimes timezone-aware timestamps, strings TEXT, and nested or repeated fields JSON. An existing table is never altered: columns it lacks are dropped from the write with a warning, and NaN or infinite floats are written as NULL.

Partitions

Writes replace, inside one transaction:

  • unpartitioned: every row is deleted, then the data inserted;
  • a time partition: the rows inside its half-open bounds (column >= start AND column < end) are deleted, then the data inserted;
  • any other partition: the rows equal to its id are deleted;
  • a window: each partition's rows are deleted, then the whole batch is inserted once.

A failed insert rolls the delete back, so a partition is never left empty. Inserts go in batches of 1000 rows. Reads return rows as list[dict]; reading a table that was never written raises DataNotFoundError.

Metadata

Release files for interloper-sql 0.96.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-sql 0.96.0
File Size Uploaded
interloper_sql-0.96.0.tar.gz 7.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for interloper-sql 0.96.0
File Interpreter ABI Platform
interloper_sql-0.96.0-py3-none-any.whl Python 3 none any Details

Total release size: 16.8 kB

Release files / interloper_sql-0.96.0.tar.gz

Download URL interloper_sql-0.96.0.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f7637e000d6eed4319a65524be4bc177cc4cdebae39d02bb448a3c9b55fa4ec3
BLAKE2b-256 checksum
How to use checksums
7a1afe22fc85e6f7bd2311a59b52682a4258112b5c00d69657c446b668d0c3c1
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_sql-0.96.0-py3-none-any.whl

Download URL interloper_sql-0.96.0-py3-none-any.whl
Size 9.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3af4fd29196decaa45931ba53b984b0f0c0382a8a1a9bb64abe5c73851c9729f
BLAKE2b-256 checksum
How to use checksums
d94c8dac84bcd821bacf8a1db2a50660ecbc18d9df4f43316af7511459218d08
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