Skip to content

antonycourtney/tad

Repository files navigation

Tad

This repository contains the source code for Tad, an application for viewing and analyzing tabular data sets.

The Tad desktop application enables you to quickly view and explore tabular data in several of the most popular tabular data file formats: CSV, Parquet, and SQLite and DuckDb database files. Internally, the application is powered by an in-memory instance of DuckDb, a fast, embeddable database engine optimized for analytic queries.

The core of Tad is a React UI component that implements a hierarchical pivot table that allows you to specify a combination of pivot, filter, aggregate, sort, column selection, column ordering and basic column formatting operations. Tad delegates to a SQL database for storage and analytics, and generates SQL queries to perform all analytic operations specified in the UI.

Tad can be launched from the command line like this:

$ tad MetObjects.csv

This will open a window with a scrollable view of the full contents of the CSV file:

Tad screenshot

Tad uses SlickGrid for rendering the data grid. This allows Tad to support efficient linear scrolling of the entire file, even for very large (millions of rows) data sets.

A few additional mouse clicks on the above view yields this view, pivoted by a few columns (Department, Classification, Period and Culture), sorted by the Object Start Date column, and with columns re-ordered:

tad screenshot

Installing Tad

The easiest way to install the Tad desktop app is to use a pre-packaged binary release. See The Tad Landing Page for information on the latest release and download links, or go straight to the releases page.

History and What's Here

Tad was initially released in 2017 as a standalone desktop application for viewing and exploring CSV files.

The core of Tad is a React UI component that implements a hierarchical pivot table that allows you to specify a combination of pivot, filter, aggregate, sort, column selection, column ordering and basic column formatting operations. Tad delegates to a SQL database for storage and analytics, and generates SQL queries to perform all analytic operations specified in the UI.

This repository is a modular refactor of the original Tad source code, with several key improvements on the original code base:

  • The repository is organized as a modular Lerna based monorepo.
  • The code has been ported to TypeScript and the UI code has been updated to React Hooks.
  • There is support for communicating with multiple database back ends for reltab (Tad's SQL generation and query evaluation layer), in addition to the original sqlite. Current backends (in varying degrees of completeness) include DuckDb, Snowflake, Google BigQuery, and AWS Athena (Presto)
  • There is a minimal proof-of-concept web-based front-end to demonstrate how Tad can be deployed on the web.
  • The core Tad pivot table component now builds in its own module independent of any front end. This should allow embedding the Tad pivot table in other applications or contexts.

The Essential Packages

The core packages that are used to build Tad are found in the packages sub-directory. These are the packages used to build the Tad desktop application:

  • reltab - The core abstraction used in Tad for programmatically constructing and executing relational SQL queries. This also defines the driver interface implemented by specific database back-ends, and a small, transport-agnostic remoting layer to allow queries and results to be transmitted between a web browser (or electron renderer process) and a reltab backend server.
  • reltab-duckdb -- reltab driver for DuckDb
  • reltab-sqlite -- reltab driver for SQLite
  • aggtree - A library built on top of reltab for constructing pivot trees from relational queries.
  • tadviewer - The core Tad pivot table UI as a standalone, embeddable React component.
  • tad-app - The Tad desktop application, built with Electron

Experimental Packages

This repository also includes a number of proof-of-concept experimental packages, in varying states of completeness. These are provided for reference and as a starting point for further investigation and development.

Building Tad from Source

Detailed instructions on building tad from sources available in doc/building.md