@altertable/data-app
v0.77.0
Published
Portable definitions, contracts, formatting, browser clients, and request handlers for Altertable data apps.
Readme
@altertable/data-app
The SDK behind Altertable data apps: interactive apps that agents build over your data. Queries are declared up front, so every result stays governed, cacheable, and traceable to its source while the interface adapts to each question.
Do you need this package?
- Building an app in Altertable, Slack, or an MCP client: follow Build a data app. The agent uses this SDK for you; no install is needed.
- Developing locally: scaffold, run, and publish with the Altertable CLI
(
altertable app create). See local development. - Writing an app by hand or embedding apps in a product: install the packages below.
Installation
bun add @altertable/data-app
# or
npm install @altertable/data-app
# or
pnpm add @altertable/data-appUsage
Declare an app's identity and its named queries:
import { defineDataApp } from '@altertable/data-app';
const dataApp = defineDataApp({
title: 'Activity',
description: 'Explore activity across your organization.',
scope: { organization: 'demo', environment: 'production' },
queries: {
eventsByDay: {
statement: `
SELECT CAST(date_trunc('day', occurred_at) AS VARCHAR) AS day, count(*) AS events
FROM events
WHERE occurred_at >= $period.from AND occurred_at < $period.to
GROUP BY day ORDER BY day`,
params: { period: { type: 'dateTimeRange' } },
projections: {
day: { type: 'string' },
events: { type: 'number' },
},
},
},
});See queries and operations to run them.
Packages
Add the packages your app needs:
| Package | Use it to |
| ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| @altertable/data-app | Define apps and queries (/contract, /client, /server) |
| @altertable/data-app-react | Build app UI with views, filters, charts, and tables |
| @altertable/data-app-embed | Host apps in your product through an iframe sandbox |
| @altertable/data-app-bun | Serve and preview apps locally against your lakehouse |
| @altertable/data-app-worker | Serve apps from a self-contained sandbox Worker |
| @altertable/data-app-manifest | Extract and rewrite manifests in build tooling |
| @altertable/data-app-examples | Start from canonical app templates |
Documentation
- Data apps documentation: build, share, and develop apps in Altertable.
- Interfaces for the next question: why data apps exist and how they are designed.
- App authoring: start here to write an app. Guides, agent instructions, and the API reference ship with this package.
