Skip to content
ProductFeaturesPricingDownloadChangelogDocs
Sign inStart free
Introduction
Documentation

Getting Started with DataRunner

DataRunner connects your databases, schedules SQL queries, and delivers formatted reports automatically. You can run your first automated report in under 5 minutes.

Read
5 min
Sections
22
Updated
July 2026

Quick start

Follow these steps to go from zero to your first automated report:

  1. 01Create an account and workspaceSign up at DataRunner and create your first workspace. A workspace is an isolated environment with its own connections, reports, and members. You can create multiple workspaces for different teams or projects.
  2. 02Add a database connectionGo to Connections and click New connection. Enter your database host, port, credentials, and database name. DataRunner tests the connection immediately and displays your live schema — tables, columns, types, and row counts.
  3. 03Write your SQL queryOpen the SQL Workbench (or click Queries → New query). Select your connection and write your SQL. The editor provides schema-aware autocomplete — start typing a table name and it completes from your live schema. Run the query to preview results before scheduling.
  4. 04Create a scheduled reportGo to Reports → New report. Select your query, choose an output format (CSV today), set a cron schedule, and configure at least one delivery channel — email, Slack, S3, or webhook. Save the report and it runs automatically from that point on.
  5. 05Check run historyEvery execution appears in History— the timestamp, duration, row count, and delivery confirmation. If a run fails, you'll see the full error message. You can also download any past output directly from the history view.
Tip:You don't need a public-facing database. For databases in private networks, DataRunner supports SSH tunneling — configure the bastion host and private key on the connection settings page.

Core concepts

DataRunner is built around four primary objects. Understanding how they relate makes the rest of the docs much easier to navigate.

Connections
A connection stores credentials and configuration for one database. You can create as many connections as your plan allows. Credentials are encrypted at rest and never returned to the browser in plaintext. DataRunner supports 16 database kinds: the PostgreSQL family (including Redshift, CockroachDB, TimescaleDB, Greenplum), the MySQL family (including MariaDB), SQL Server, SQLite, Oracle, ClickHouse, MongoDB, Redis, DuckDB, MotherDuck, and BigQuery.
Queries
Queries are SQL statements saved to your workspace. They are edited in the Monaco workbench — the same editor that powers VS Code — with syntax highlighting and schema-aware autocomplete. Queries can include parameters using {{parameter_name}} syntax, which you can set defaults for and override at runtime or per schedule.
Reports
A report is a query + a schedule + one or more delivery channels. DataRunner runs the query on the configured cron schedule and delivers the output to every configured channel on every run. Each report has its own run history.
Watches
Watches are event-driven triggers. Instead of running on a fixed schedule, DataRunner polls your database at a configurable interval (minimum 60 seconds) and fires when new rows match your SQL condition. On trigger, it can send an email alert, post a Slack message, call a webhook, or deliver a full report.

Explore the docs

Jump straight into a section.

ConnectionsAdd databases, configure SSL/SSH, browse schemaQueriesSQL workbench, parameters, versioningSchedulesCron expressions, parameters, run windowsReportsOutput formats, recipients, delivery routesWatchesEvent-driven triggers on row changesDashboardsWidgets over queries, monitors and hostsMetricsSemantic layer — one definition per numberCatalogSearchable table & column inventoryHistory & runsRun log, timings, failures, retentionMonitorsHTTP/TCP probes, incidents, recovery alertsHostsServer metrics via a lightweight push agentStatus pagesPublic uptime pages from your monitorsAlerting & on-callRoutes, escalation, rotations, maintenanceDelivery channelsEmail, Slack, Telegram, S3, SFTP, webhooksCampaignsEmail blasts, A/B tests, open & click trackingContacts & listsAudience, consent, double opt-in, suppressionSequencesAutomated multi-step email dripsFormsEmbeddable signup forms with captchaPhishing simulationAwareness campaigns, sender domains, trainingTeams & rolesMembers, permissions, workspaces, auditAPI & webhooksAPI keys, REST surface, outbound webhooksSelf-hostedEnterprise deployment, licensing, BYOK