|
1 | 1 | # AppKit |
2 | 2 |
|
3 | | -Build Databricks Apps faster with our brand-new Node.js + React SDK. Built for humans and AI. |
| 3 | +Build Databricks Apps faster with a Node.js + React SDK. Built for humans and AI. |
4 | 4 |
|
5 | | -## Introduction |
| 5 | +AppKit is a TypeScript SDK for building production-ready Databricks applications with a plugin-based architecture. It gives you opinionated defaults, built-in observability, and first-class integration with Databricks services — so you spend time on your app, not the plumbing. |
6 | 6 |
|
7 | | -AppKit is a TypeScript SDK for building production-ready Databricks applications with a plugin-based architecture. It provides opinionated defaults, built-in observability, and seamless integration with Databricks services. |
| 7 | +- **Plugin architecture** — Compose your app from focused plugins; a base server plus analytics, Genie, files, and more. |
| 8 | +- **Type safety** — End-to-end TypeScript with automatic query type generation. |
| 9 | +- **Production-ready** — Built-in caching, telemetry, retries, and error handling. |
| 10 | +- **Great DX** — Hot reload, file-based queries, and a workflow tuned for AI-assisted development. |
| 11 | +- **Databricks native** — SQL Warehouses, Unity Catalog, Lakebase, and other workspace resources out of the box. |
8 | 12 |
|
9 | | -AppKit simplifies building data applications on Databricks by providing: |
| 13 | +## Quickstart |
10 | 14 |
|
11 | | -- **Plugin architecture**: Modular design with built-in server and analytics plugins |
12 | | -- **Type safety**: End-to-end TypeScript with automatic query type generation |
13 | | -- **Production-ready features**: Built-in caching, telemetry, retry logic, and error handling |
14 | | -- **Developer experience**: Remote hot reload, file-based queries, optimized for AI-assisted development |
15 | | -- **Databricks native**: Seamless integration with SQL Warehouses, Unity Catalog, and other workspace resources |
| 15 | +Requires the Databricks CLI and Node.js. |
16 | 16 |
|
17 | | -## Plugins |
| 17 | +**AI-assisted (recommended)** — scaffold and evolve your app by prompting an AI assistant. Install the Agent Skills once: |
18 | 18 |
|
19 | | -AppKit's power comes from its plugin system. Each plugin adds a focused capability to your app with minimal configuration. |
| 19 | +```sh |
| 20 | +databricks aitools install |
| 21 | +``` |
20 | 22 |
|
21 | | -- **Analytics Plugin** — Query your Lakehouse data directly from your app. Define SQL queries as files, execute them against Databricks SQL Warehouses, and get automatic caching, parameterization, and on-behalf-of user execution out of the box. |
22 | | -- **Genie Plugin** — Conversational AI interface powered by Databricks AI/BI Genie. Let users ask natural language questions against your data and get answers with automatic chart inference and visualization. |
23 | | -- **Files Plugin** — Browse, upload, and manage files in Unity Catalog Volumes. Supports multiple volumes, content type validation, and on-behalf-of user access. |
24 | | -- **Lakebase Plugin** — OLTP database operations against Databricks Lakebase with automatic OAuth token management. Returns a standard `pg.Pool` compatible with Prisma, Drizzle, TypeORM, and other ORMs. |
| 23 | +Then ask your assistant to build the app, e.g. _"Create a Databricks app that shows a dashboard of the NYC taxi trips dataset."_ See the [AI-assisted development](https://developers.databricks.com/docs/appkit/v0/development/ai-assisted-development) guide. |
25 | 24 |
|
26 | | -> Missing a plugin? [Open an issue](https://github.com/databricks/appkit/issues/new) and tell us what you need — community input directly shapes the roadmap. |
| 25 | +**Manual** — scaffold and deploy with the CLI directly: |
| 26 | + |
| 27 | +```sh |
| 28 | +databricks apps init # scaffold the app + install dependencies (follow the prompts) |
| 29 | +databricks apps deploy # deploy to your workspace |
| 30 | +``` |
| 31 | + |
| 32 | +## What an app looks like |
| 33 | + |
| 34 | +Every app is a set of plugins hosted by `server()`: |
27 | 35 |
|
28 | | -## Getting started |
| 36 | +```ts |
| 37 | +import { createApp, server, analytics } from '@databricks/appkit'; |
29 | 38 |
|
30 | | -Follow the [Getting Started](https://developers.databricks.com/docs/appkit/v0/) guide to get started with AppKit. |
| 39 | +createApp({ |
| 40 | + plugins: [server(), analytics()], |
| 41 | +}); |
| 42 | +``` |
31 | 43 |
|
32 | | -🤖 For AI/code assistants, see the [AI-assisted development](https://developers.databricks.com/docs/appkit/v0/development/ai-assisted-development) guide. |
| 44 | +With `analytics()`, drop a `.sql` file in `config/queries/` and it's served at `POST /api/analytics/query/<query_key>` — parameterized, cached, and (with a `.obo.sql` name) executed on behalf of the signed-in user. |
| 45 | + |
| 46 | +## Plugins |
| 47 | + |
| 48 | +AppKit's power comes from its plugin system. Each plugin adds a focused capability — analytics, genie, files, and more — with minimal configuration. See the [plugins documentation](https://developers.databricks.com/docs/appkit/v0/plugins) for the full list and API. |
| 49 | + |
| 50 | +> Missing a plugin? [Open an issue](https://github.com/databricks/appkit/issues/new) and tell us what you need — community input directly shapes the roadmap. |
33 | 51 |
|
34 | 52 | ## Documentation |
35 | 53 |
|
36 | | -📖 For full AppKit documentation, visit the [AppKit Documentation](https://developers.databricks.com/docs/appkit/v0/) website. |
| 54 | +- **[AppKit documentation](https://developers.databricks.com/docs/appkit/v0/)** — getting started, guides, and full API reference. |
| 55 | +- **[AI-assisted development](https://developers.databricks.com/docs/appkit/v0/development/ai-assisted-development)** — build and evolve apps with an AI assistant. |
| 56 | +- New to the Databricks Apps platform? Start with the [Apps quickstart](https://developers.databricks.com/docs/apps/quickstart). |
37 | 57 |
|
38 | 58 | ## Contributing |
39 | 59 |
|
|
0 commit comments