Implementation:Apache Druid ExampleSpecs
| Knowledge Sources | |
|---|---|
| Domains | Web_Console, Data_Ingestion |
| Last Updated | 2026-02-10 10:00 GMT |
Overview
Provides predefined example ingestion specifications for the Load Data wizard in the Apache Druid web console.
Description
The ExampleSpecs module defines an ExampleSpec interface and exports a constant array EXAMPLE_SPECS containing pre-built ingestion specifications. Each example spec includes a name, description, and a complete Druid ingestion spec object configured for parallel index ingestion from HTTP data sources. The module ships with three built-in examples: Wikipedia Edits, KoalasToTheMax flat events, and KoalasToTheMax nested events.
Usage
Used in the Load Data view to let users quickly bootstrap an ingestion workflow by selecting a pre-configured example dataset rather than manually configuring a data source from scratch.
Code Reference
Source Location
- Repository: Apache Druid
- File: web-console/src/views/load-data-view/example-specs.ts
- Lines: 1-102
Signature
export interface ExampleSpec {
name: string;
description: string;
spec: any;
}
export const EXAMPLE_SPECS: ExampleSpec[];
Import
import { ExampleSpec, EXAMPLE_SPECS } from './views/load-data-view/example-specs';
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| N/A | N/A | N/A | This module exports constants and has no runtime inputs |
Outputs
| Name | Type | Description |
|---|---|---|
| EXAMPLE_SPECS | ExampleSpec[] | Array of three predefined ingestion spec objects (Wikipedia Edits, KoalasToTheMax flat, KoalasToTheMax nested) |
Usage Examples
Selecting an example spec
import { EXAMPLE_SPECS } from './example-specs';
// Present example specs as options in the Load Data wizard
const exampleOptions = EXAMPLE_SPECS.map(example => ({
label: example.name,
description: example.description,
value: example.spec,
}));
Accessing a specific example
import { EXAMPLE_SPECS } from './example-specs';
// Load the Wikipedia Edits example
const wikipediaSpec = EXAMPLE_SPECS.find(e => e.name === 'Wikipedia Edits');
if (wikipediaSpec) {
initIngestion(wikipediaSpec.spec);
}