Tutorial: Loading a file

This tutorial demonstrates how to load data into Apache Druid from a file using Apache Druid’s native batch ingestion feature.

You initiate data loading in Druid by submitting an ingestion task spec to the Druid Overlord. You can write ingestion specs by hand or using the data loader built into the Druid console.

The Quickstart shows you how to use the data loader to build an ingestion spec. For production environments, it’s likely that you’ll want to automate data ingestion. This tutorial starts by showing you how to submit an ingestion spec directly in the Druid console, and then introduces ways to ingest batch data that lend themselves to automation—from the command line and from a script.

Loading data with a spec (via console)

The Druid package includes the following sample native batch ingestion task spec at quickstart/tutorial/wikipedia-index.json, shown here for convenience, which has been configured to read the quickstart/tutorial/wikiticker-2015-09-12-sampled.json.gz input file:

  1. {
  2.   "type" : "index_parallel",
  3.   "spec" : {
  4.     "dataSchema" : {
  5.       "dataSource" : "wikipedia",
  6.       "dimensionsSpec" : {
  7.         "dimensions" : [
  8.           "channel",
  9.           "cityName",
  10.           "comment",
  11.           "countryIsoCode",
  12.           "countryName",
  13.           "isAnonymous",
  14.           "isMinor",
  15.           "isNew",
  16.           "isRobot",
  17.           "isUnpatrolled",
  18.           "metroCode",
  19.           "namespace",
  20.           "page",
  21.           "regionIsoCode",
  22.           "regionName",
  23.           "user",
  24.           { "name": "added", "type": "long" },
  25.           { "name": "deleted", "type": "long" },
  26.           { "name": "delta", "type": "long" }
  27.         ]
  28.       },
  29.       "timestampSpec": {
  30.         "column": "time",
  31.         "format": "iso"
  32.       },
  33.       "metricsSpec" : [],
  34.       "granularitySpec" : {
  35.         "type" : "uniform",
  36.         "segmentGranularity" : "day",
  37.         "queryGranularity" : "none",
  38.         "intervals" : ["2015-09-12/2015-09-13"],
  39.         "rollup" : false
  40.       }
  41.     },
  42.     "ioConfig" : {
  43.       "type" : "index_parallel",
  44.       "inputSource" : {
  45.         "type" : "local",
  46.         "baseDir" : "quickstart/tutorial/",
  47.         "filter" : "wikiticker-2015-09-12-sampled.json.gz"
  48.       },
  49.       "inputFormat" :  {
  50.         "type": "json"
  51.       },
  52.       "appendToExisting" : false
  53.     },
  54.     "tuningConfig" : {
  55.       "type" : "index_parallel",
  56.       "maxRowsPerSegment" : 5000000,
  57.       "maxRowsInMemory" : 25000
  58.     }
  59.   }
  60. }

This spec creates a datasource named “wikipedia”.

From the Ingestion view, click the ellipses next to Tasks and choose Submit JSON task.

Tasks view add task

This brings up the spec submission dialog where you can paste the spec above.

Query view

Once the spec is submitted, wait a few moments for the data to load, after which you can query it.

Loading data with a spec (via command line)

For convenience, the Druid package includes a batch ingestion helper script at bin/post-index-task.

This script will POST an ingestion task to the Druid Overlord and poll Druid until the data is available for querying.

Run the following command from Druid package root:

  1. bin/post-index-task --file quickstart/tutorial/wikipedia-index.json --url http://localhost:8081

You should see output like the following:

  1. Beginning indexing data for wikipedia
  2. Task started: index_wikipedia_2018-07-27T06:37:44.323Z
  3. Task log:     http://localhost:8081/druid/indexer/v1/task/index_wikipedia_2018-07-27T06:37:44.323Z/log
  4. Task status:  http://localhost:8081/druid/indexer/v1/task/index_wikipedia_2018-07-27T06:37:44.323Z/status
  5. Task index_wikipedia_2018-07-27T06:37:44.323Z still running...
  6. Task index_wikipedia_2018-07-27T06:37:44.323Z still running...
  7. Task finished with status: SUCCESS
  8. Completed indexing data for wikipedia. Now loading indexed data onto the cluster...
  9. wikipedia loading complete! You may now query your data

Once the spec is submitted, you can follow the same instructions as above to wait for the data to load and then query it.

Loading data without the script

Let’s briefly discuss how we would’ve submitted the ingestion task without using the script. You do not need to run these commands.

To submit the task, POST it to Druid in a new terminal window from the apache-druid-0.23.0 directory:

  1. curl -X 'POST' -H 'Content-Type:application/json' -d @quickstart/tutorial/wikipedia-index.json http://localhost:8081/druid/indexer/v1/task

Which will print the ID of the task if the submission was successful:

  1. {"task":"index_wikipedia_2018-06-09T21:30:32.802Z"}

You can monitor the status of this task from the console as outlined above.

Querying your data

Once the data is loaded, please follow the query tutorial to run some example queries on the newly loaded data.

Cleanup

If you wish to go through any of the other ingestion tutorials, you will need to shut down the cluster and reset the cluster state by removing the contents of the var directory under the druid package, as the other tutorials will write to the same “wikipedia” datasource.

Further reading

For more information on loading batch data, please see the native batch ingestion documentation.